","main":"dist/index.js","repository":{"url":"","type":"git"},"homepage":"","scripts":{"prepare":"tsc","start":"nodemon --exec ts-node src/index.ts","test":"echo \"Error: no test specified\" && exit 1","challenge":"ts-node src/scripts/auth/index.ts","profile":"ts-node src/scripts/profile/index.ts","stats":"ts-node src/scripts/profile/stats.ts"},"keywords":[],"author":{"name":"sanchit"},"license":"Apache License, Version 2.0","dependencies":{"@urql/core":"^3.0.5","graphql":"^15.8.0","isomorphic-unfetch":"^3.1.0","web3":"^1.8.0"},"devDependencies":{"nodemon":"^2.0.20","ts-node":"^10.9.1","typescript":"^4.8.4"},"gitHead":"f0fae3f0702090df62a147739592d0dd11a80fe7","_id":"stbl-sdk@0.4.3","_nodeVersion":"14.18.1","_npmVersion":"6.14.15","dist":{"integrity":"sha512-w3vyh8PJ43ECc6m6j/ltqcxKbtWdWnUXm7lV2LZ56rxYESex6C02n+j+2qKjInpwSFWkk4yamiXt7zsZexqRcQ==","shasum":"939cbbbedb5024f3479434fdece8d1d742aeb5c6","tarball":"https://registry.npmjs.org/stbl-sdk/-/stbl-sdk-0.4.3.tgz","fileCount":76,"unpackedSize":224481,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD/gY8wQUzwo1yiLq0Tof8/bipxirTGyMu5J2qRZnoYigIgefKWdL1CfxjouZJrhB6ah7pl61pi8GqbMS9vmkEC9kI="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkA3A9ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmpd0w//aRQSjAtR2kYAmFz4fyOtWqrBOQClj0Sh7A/Rcl5Gi2jA3hdg\r\nN2QsmYwtDRkL2FQWpOGkxDJJ9V8WVZhNyrpBWSrOzONXsLDg3hYg1hy7EodV\r\nO0KzWgXSQ1HjkOPbwlzqzQzqlEZ7hgS3S2W7Md1RtWzsW0YZPh2SudyWi28I\r\nlj1TfHQ+3GlOMna5+9sS6+kHwLN4HQFX1QJA4S/rXgzUYa9Wxdy9B2GyB/ir\r\ndZReDQ2H7RsMf1baLcAxMnnvxRODmRvedtnNAD55PBo63R0yerXWOjGe0lQc\r\n3zvWew19FS/nRLCFBmVyk7ziXle4wSh1ExyPLYE01+kpXYoufVhYSO0xcR4G\r\n9+3si01pDNiiL6A844rjJsLx3hd2lJBbBv5TsrUPN2rzsN3yQ/a/JKfYgwNn\r\nGuT5b8zTZa/AnEU1QJ6RZSxYt/ajr1btTIcJmJu8r3UYvNiEr8SszCJ2Zbf0\r\ngW3F0qNMa0KBiwCnoM/qnuTc/7R6sxdAthD7g69+32BxP4nKkJB8vqeNKFuE\r\nek3/VIzmf6nE/WN24UrPskPlxOV3maEKcQvirjzs4GpWwHXfy9pNRYJFwhGa\r\n6iMibvXCq6c1wlq0FDM39fvs1LnOFa72awi0/5fcFU3BfqtY99YR09NnlV1M\r\nEOgXRXm/eFxIhPZvIDIV62NfQzyxa8xcDAE=\r\n=1l+K\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"brown_murphy","email":"brownmurphy642@gmail.com"},"directories":{},"maintainers":[{"name":"brown_murphy","email":"brownmurphy642@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/stbl-sdk_0.4.3_1677946941021_0.8992908051092561"},"_hasShrinkwrap":false},"0.4.4":{"name":"stbl-sdk","version":"0.4.4","description":"
","main":"dist/index.js","repository":{"url":"","type":"git"},"homepage":"","scripts":{"prepare":"tsc","start":"nodemon --exec ts-node src/index.ts","test":"echo \"Error: no test specified\" && exit 1","challenge":"ts-node src/scripts/auth/index.ts","profile":"ts-node src/scripts/profile/index.ts","stats":"ts-node src/scripts/profile/stats.ts"},"keywords":[],"author":{"name":"sanchit"},"license":"Apache License, Version 2.0","dependencies":{"@urql/core":"^3.0.5","graphql":"^15.8.0","isomorphic-unfetch":"^3.1.0","web3":"^1.8.0"},"devDependencies":{"nodemon":"^2.0.20","ts-node":"^10.9.1","typescript":"^4.8.4"},"gitHead":"8d2699f66a00c32f2874cca78142ca5b81fb3a65","_id":"stbl-sdk@0.4.4","_nodeVersion":"14.18.1","_npmVersion":"6.14.15","dist":{"integrity":"sha512-hdrqQy6LaiVp7lPxJre59DBMAUK0EX0syqbLiI8zYq2jCIcMAPQwCWO8x5e2LOuA1Jj6KATBRoSLh2s9dr04pw==","shasum":"6e366ff847fb6035380c19615fb0518c01ec1c07","tarball":"https://registry.npmjs.org/stbl-sdk/-/stbl-sdk-0.4.4.tgz","fileCount":76,"unpackedSize":225323,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIF8OtmbcG+tlWCM8pQCCj+qKNLwq5hwYhwHS65A4HVsxAiBZDw3v+naRe8EnjJaYFS4qB4w9e8W7AF3ryyPV51iyZQ=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkBpmYACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrgLhAAojS/Mk26L4g1mg9aJNCHcrebHHuZJKNY+7uJuUtb8IMOGOgr\r\nGmpuPhbXpx1J7XXWFh+YQS2joAhHhpCFMpy+AyVIw/db+SJzYTic0KMjmmlz\r\nhSliXnrQT+eyuvD0cEGNC8nQjP3B3QodSWInQa4MhVs8Hw/GRIWDQV3UFU3M\r\nGTiRZstQxX8YuMJLfis9RGYJiSMoxeoTbdED7bKpRikX31eGXVVGiy+7vNes\r\nE6tkYskjTerrXQ5eLMqpzPy60B9mjOOMSqz9MFwox0etIbOQ0NnshIS9zBz3\r\nAcMSSxWeITMpXGVhb20vgNhZE/+OcYq72n7poXK+5NMLP0xkYHyzxHC9dAXm\r\nhCUOxU0xrbqHaEP/XejNazTybB87cdbeLj8dCz633+pXpokvghaGoEdH4DXU\r\nlVGQVuzbhGWj2puxEa/X1/a2CJeWDJvowwmQAc3fgWRRudAJIpyP1wwkfdQj\r\n08tBNgpY01YkZHTRCE6+o8hpkng1degi9xDLB8tFEwHkI+E6u/0uyBc3QEVs\r\niyxGKIr+14L3iRCDdz194982umFl8qtJ5JSN3u+E4BSdoPqe5+w1oN8+m5mH\r\n0bGpiLNIZSdSZtGoTsXty5EilKJCnJXPp9x+qMsVNMOP17imZyGEra6pQM1+\r\nWx9OqgYjzNsG0aGLAqCOb+/QCIFTFgM6WBM=\r\n=2uft\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"brown_murphy","email":"brownmurphy642@gmail.com"},"directories":{},"maintainers":[{"name":"brown_murphy","email":"brownmurphy642@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/stbl-sdk_0.4.4_1678154135953_0.6304265733607863"},"_hasShrinkwrap":false}},"time":{"created":"2023-03-04T04:39:33.711Z","0.0.1":"2023-03-04T04:39:33.957Z","modified":"2023-03-07T01:55:36.319Z","0.0.2":"2023-03-04T04:42:24.177Z","0.0.3":"2023-03-04T05:05:36.934Z","0.0.4":"2023-03-04T05:14:04.119Z","0.0.5":"2023-03-04T05:28:14.000Z","0.0.6":"2023-03-04T05:29:35.804Z","0.0.7":"2023-03-04T05:32:56.518Z","0.0.8":"2023-03-04T05:34:54.019Z","0.0.9":"2023-03-04T05:37:11.804Z","0.1.0":"2023-03-04T05:39:37.216Z","0.1.1":"2023-03-04T05:42:57.049Z","0.1.2":"2023-03-04T05:48:10.045Z","0.1.3":"2023-03-04T05:50:01.794Z","0.1.4":"2023-03-04T05:51:44.773Z","0.1.5":"2023-03-04T05:54:34.874Z","0.1.7":"2023-03-04T06:04:21.571Z","0.1.8":"2023-03-04T06:14:20.819Z","0.1.9":"2023-03-04T06:28:07.734Z","0.2.0":"2023-03-04T06:52:17.185Z","0.2.1":"2023-03-04T07:40:07.112Z","0.2.2":"2023-03-04T07:57:09.047Z","0.2.3":"2023-03-04T15:23:13.123Z","0.2.4":"2023-03-04T15:27:37.781Z","0.2.5":"2023-03-04T15:29:08.647Z","0.2.6":"2023-03-04T15:29:52.480Z","0.2.7":"2023-03-04T15:31:28.692Z","0.2.8":"2023-03-04T15:34:45.249Z","0.2.9":"2023-03-04T15:37:10.598Z","0.3.0":"2023-03-04T15:39:23.109Z","0.3.1":"2023-03-04T15:40:52.630Z","0.3.2":"2023-03-04T15:42:14.459Z","0.3.3":"2023-03-04T15:45:10.168Z","0.3.4":"2023-03-04T15:48:21.129Z","0.3.5":"2023-03-04T15:53:30.446Z","0.3.6":"2023-03-04T15:58:49.176Z","0.3.7":"2023-03-04T16:03:49.836Z","0.3.8":"2023-03-04T16:07:33.980Z","0.3.9":"2023-03-04T16:08:51.803Z","0.4.0":"2023-03-04T16:09:59.453Z","0.4.1":"2023-03-04T16:12:08.407Z","0.4.2":"2023-03-04T16:19:29.001Z","0.4.3":"2023-03-04T16:22:21.217Z","0.4.4":"2023-03-07T01:55:36.164Z"},"maintainers":[{"name":"brown_murphy","email":"brownmurphy642@gmail.com"}],"description":"
","keywords":[],"repository":{"url":"","type":"git"},"author":{"name":"sanchit"},"license":"Apache License, Version 2.0","readme":"
\n
\n \n
stbl-sdk
\n\n
\n An awesome JavaScript SDK to mint/withdraw $CASH\n
\n
\n
\n\n\n\n## About The Project\n\nWhy use this sdk?\n\n- You shouldn't creating the same tasks over and over like creating instances or handling amounts. :smile:\n\n### Build With\n\n- \n\n
(back to top)
\n\n\n\n## Getting Started\n\nstbl-sdk is a JavaScript SDK or a API wrapper for the vault contract using usdc.\n\nstbl-sdk simplify the process of minting and withdrawing the cash from the vault.\n\nIt is a simple, easy to use, and powerful API for interacting with Stbl Protocol.\n\n> You can use Stbl-sdk on node server, browser, or mobile.\n\n
\n\nYou can install stbl-sdk either using NPM .\n\nInside your project directory, run the following command:\n\n```sh\nnpm install stbl-sdk@0.4.4\n```\n\n
(back to top)
\n\n\n\n## Usage\n\nUsing stbl-sdk is way easier, you can import the library in your project and use it.\n\n```js\nimport { stblsdk } from \"stbl-sdk\";\n```\n\n### API Operation\n\nHere is an example of how to mint the $CASH:\n\n`````js\nconst { createAlchemyWeb3 } = require(\"@alch/alchemy-web3\");\nconst web3 = createAlchemyWeb3(alchemyKey);\n\n1) Check allowance of $USDC on the vault address using\n\nlet allowance = await stblsdk.allowanceCheck(web3,walletAddress)\n\n2) If allowance is not sufficient call approve function using\n\nconst tx = Promise.resolve(\n await stblsdk.ApproveVault(web3,amount,walletAddress)\n );\n tx.then((res) => {\n console.log(res);\n });\n\n3) Mint $CASH using $USDC\n\nconst tx = Promise.resolve(\n await stblsdk.Mint(web3, amount, walletAddress)\n );\n tx.then((res) => {\n console.log(res);\n });\n\n// amount = the amount of $USDC you want to exchange for $CASH\n// walletAddress = account which will be doing the transaction\n// web3 is an instance of web3 show be polygon mainnet rpc in alchemy key\n\nHere is an example of how to withdraw the $CASH:\n\n````js\nconst { createAlchemyWeb3 } = require(\"@alch/alchemy-web3\");\nconst web3 = createAlchemyWeb3(alchemyKey);\n\n1) Check the balance if its sufficient or not using\n\nlet balanceOf = await stblsdk.balanceOf(web3,walletAddress)\n\n2) Withdraw Transaction\n\nconst tx = Promise.resolve(\n await stblsdk.Withdraw(web3, amount, walletAddress)\n );\n tx.then((res) => {\n console.log(res);\n });\n\n// amount = the amount of $CASH you want to exchange for $USDC\n// walletAddress = account which will be doing the transaction\n// web3 is an instance of web3 show be polygon mainnet rpc in alchemy key\n\n### API Response\n\n```json\n{blockHash\n:\n\"0x0621404b0df5cd83564c9cf0cc58fd5e88f8f0e8f0386f8c5d22072c5ec3c864\"\nblockNumber\n:\n39946647\ncontractAddress\n:\nnull\ncumulativeGasUsed\n:\n16659680\neffectiveGasPrice\n:\n123340143261\nfrom\n:\n\"0x2cd9baace3f4d4ea9f246004914d7d0e666bbab3\"\ngasUsed\n:\n2587699\nlogs\n:\n(29) [{…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}, {…}]\nlogsBloom\n:\n\"0x0201005001000000000008000000000000800000000000000011000000000100000000000400010000110000004000010000800200000000000000001020000100000000000000000020080a04014982000200000000000008010008400000001000000002020000000000000000080000000000000c020180100018080004001001001000080000000000000002040000060010000000000000004000000000224004000081010000000000004000000000400000000000000080000000014480000802000000000021006008020000c80000000000880000100400800020000010009000002020600000000000010012000040000404000000000000100020\"\nstatus\n:\ntrue\nto\n:\n\"0xd1bb7d35db39954d43e16f65f09dd0766a772cff\"\ntransactionHash\n:\n\"0xe46df93ab1722fe80a7db353d70213ebfc8a50360a9cc445f1183865e51be4d3\"\ntransactionIndex\n:\n78\n}\n`````\n\n\n\n## License\n\nDistributed under the Apache-2.0 License. See `LICENSE` for more information.\n\n
(back to top)
\n\n\n\n## Contact\n\nSanchit Dawar - [sanchitdawar3](https://twitter.com/sanchitdawar3)\n","readmeFilename":"README.MD"}