{"_id":"@blockswan/contract-helpers","_rev":"3-e019ad310623420aed2b07b0f097c4c0","name":"@blockswan/contract-helpers","dist-tags":{"latest":"0.0.12"},"versions":{"0.0.8":{"name":"@blockswan/contract-helpers","version":"0.0.8","description":"Helper functions for interacting with blockswan periphery & protocol contracts","main":"dist/index.js","types":"dist/types/index.d.ts","scripts":{"clean":"rm -rf dist cache","test":"jest","build":"tsc","typechain":"cp -r ../../contracts/abi/ tmp && rm ./tmp/abi.json && typechain --target=ethers-v5 --out-dir=./src/typechain/ './tmp/**/*.json' && rm -rf tmp"},"author":{"name":"blockswan"},"license":"MIT","devDependencies":{"@nomicfoundation/hardhat-toolbox":"^2.0.2","@nomiclabs/hardhat-ethers":"^2.2.2","@typechain/ethers-v5":"^10.2.0","@types/jest":"^29.5.0","@types/node":"^18.15.3","hardhat":"^2.13.0","jest":"^29.5.0","reflect-metadata":"^0.1.13","ts-jest":"^29.0.5","typechain":"^8.1.1","typescript":"^4.9.5"},"dependencies":{"bignumber.js":"^9.1.1"},"gitHead":"ad7004146a04dd311d6d464c36178f4889ba8d78","publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_id":"@blockswan/contract-helpers@0.0.8","_nodeVersion":"18.13.0","_npmVersion":"lerna/6.5.1/node@v18.13.0+arm64 (darwin)","dist":{"integrity":"sha512-q3m4m334We1BdlrjDlO0vVeEDNncq18v8+sROnb2itBLvHI4cHt/HtnnO712xLRi/5gwjHc7LmOSMECr6PIgSw==","shasum":"4e040c0692953d2bba14f518ec84e59322f35a9a","tarball":"https://registry.npmjs.org/@blockswan/contract-helpers/-/contract-helpers-0.0.8.tgz","fileCount":130,"unpackedSize":1128159,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBNrXSyW03ITcPc1Ufw3N4GQDhEvaomAGovjTva5hMrBAiEAuO2Qs/xoe4sJ/MZRW4kOSLufv5iLPZWUQBzvrqoVI0I="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkFL1cACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmrjjw/+PfS6O2lOcHvw/T6zm2gTj6Ff1AuTP9G7gw3R8qqMqgTFO1q0\r\nOEz98H0SvIv2oA5bmWMJQeEunxXB+N4LNHlQN0vbxozC9JJ33z5kcYWAE6uS\r\nXGqbjKetpKXxIs7y05hHhF8jhI9d7uVqDgjfANAdjC9iNIXhzaQs9p/AjvGL\r\nokQInj6N3OQ+unpyNa2oaX2vJYWfODAf73Eykc7VpiGECyISwoxST0DUHxDd\r\n9m9oOEqpxxtpCrg/IKBnTHS8QSsnVhHJ0879PJ/lj7OID/38cayuPm4jWdoP\r\nZ90azkJJCqLsYG5Bghio/4mbjINgCVq3cdnoTeRJyeQEYD3pp7syv81ae/Mo\r\nBhnBqqJdYBIyjyDHkFujfFAk8oKOeUWSCvw+QRKGhqAy6Z4F5xcTriVcdjpX\r\n9j0JTjiiDIjWwChiyQ2O3oKzSBwaPN1fAtesOeOuKC+EkXHJOZdbmubvIGEU\r\nRIRGZOSNmrvTKEKkAKMbh7O/+zZ1gnw/pbX4YpFo6/u1i1G/zvmqnK1a4Scj\r\nscqSmf45oWxlN5uwek4T9Q4E6iLSe8HlQv80gShj9KnTGp3EJ+RurMHVVrhR\r\n9dimBOL3/vvz1vrdY3yH+KGDmojsM4t2mUtQxOFI8FXmjo6bk9vM0nt2u9yw\r\nDafDEdqSCbl0MLMuAmr6nJ78kJBt0pPd5gc=\r\n=hf/3\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"blockswan","email":"contact@blockswan.app"},"directories":{},"maintainers":[{"name":"blockswan","email":"contact@blockswan.app"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/contract-helpers_0.0.8_1679080796580_0.031481022426652405"},"_hasShrinkwrap":false},"0.0.9":{"name":"@blockswan/contract-helpers","version":"0.0.9","description":"Helper functions for interacting with blockswan periphery & protocol contracts","main":"dist/index.js","types":"dist/types/index.d.ts","scripts":{"clean":"rm -rf dist cache","test":"jest","build":"rm -rf dist && tsc","typechain":"cp -r ../../contracts/abi/ tmp && rm ./tmp/abi.json && typechain --target=ethers-v5 --out-dir=./src/typechain/ './tmp/**/*.json' && rm -rf tmp","prepublishOnly":"npm run clean && npm run typechain && npm run build"},"author":{"name":"blockswan"},"license":"MIT","devDependencies":{"@nomicfoundation/hardhat-toolbox":"^2.0.2","@nomiclabs/hardhat-ethers":"^2.2.2","@typechain/ethers-v5":"^10.2.0","@types/jest":"^29.5.0","@types/node":"^18.15.3","hardhat":"^2.13.0","jest":"^29.5.0","reflect-metadata":"^0.1.13","ts-jest":"^29.0.5","typechain":"^8.1.1","typescript":"^4.9.5"},"dependencies":{"bignumber.js":"^9.1.1"},"gitHead":"908ded91aef7effb1ec8705c8ee8aa986f045c81","publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_id":"@blockswan/contract-helpers@0.0.9","_nodeVersion":"18.13.0","_npmVersion":"lerna/6.5.1/node@v18.13.0+arm64 (darwin)","dist":{"integrity":"sha512-gvBtwHH2BLQZgIeuqHMUijT+H3jtPu42N2rB7fW1shLjK9v51XSsXEJ69OSr5V3Zn1ppPDOEnElW5VscAHMoEg==","shasum":"022bf8754894d592d80761e065b02cfe9f6273ae","tarball":"https://registry.npmjs.org/@blockswan/contract-helpers/-/contract-helpers-0.0.9.tgz","fileCount":455,"unpackedSize":3211643,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBOz30PwLwXK3b7DTAxFP97EG0VK0OJbFpeOa6Tq3TZiAiAxZN4UeiNk6ae0lX3paKFzqsAB+aYLM3uGSQ/Fu/DHgw=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkFNV0ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq/QBAAiWATKWQfdmzPcw+F7lcGPhugW/giPRQBqtD668gQiumxi/Sp\r\nlMVC21TKlcqxCOCgAUGPOCPSEB9xEmmlw85IDl9vpIvxsyQok0NOGFXtkuCC\r\nws7e8hVUq07XtQGkNAjr78vQLnF1hxtIrjJcfxIl2MIhnFkIBv4paXAmcwep\r\n0Z6CW2SNhKtNjL3XE6yE/3wHVpeRt772CXBhO0f0RNVv5oxE6sEC0aO2tZs5\r\nl5lORksm2akYIgdqgL4eTX4HiOVOLRiswIIuxD7v37NyVyBYkCdN1odezPv8\r\n+qRXBL8tE+u4ub2T7KFLvWlI+Hm+nqUWfg5tYrB9rFHx/DdHi6ZC8BA+4xkt\r\n3wJlNFbI5/ORSB6Vr/DV5j7SsBUZeK/NNxOUwY40De3CvVaej6H47kMlC7Xj\r\nuWwxbeXUPOEzGFwrdlKyOX+ALjZM+3r10rcHrvsyOZAHzRsPUXShNEAtqLRt\r\nrj8AYZSpyArIaYg+EOFaz63n70juPGygsDJhNxYJtDNhPEUC5TZwo0q2L5Zz\r\niBKfI5Dz3pq0u7rBqdHBip+Ot5ui90JgjQS++a3gGwd0/MgFKalQtbGHVyHo\r\nQ6m694tLUR0AOhzaKuf/qpCVPn0gePH7admTxDEqRDEfbPUpH8CgQCG6Yyz3\r\nKKqObtC+x1ytb0y8TDsTKTvKHRLlRDhSdIg=\r\n=TO/s\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"blockswan","email":"contact@blockswan.app"},"directories":{},"maintainers":[{"name":"blockswan","email":"contact@blockswan.app"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/contract-helpers_0.0.9_1679086964376_0.4231177670207562"},"_hasShrinkwrap":false},"0.0.11":{"name":"@blockswan/contract-helpers","version":"0.0.11","description":"Helper functions for interacting with blockswan periphery & protocol contracts","main":"dist/index.js","types":"dist/types/index.d.ts","scripts":{"clean":"rm -rf dist cache","test":"jest","build":"rm -rf dist && tsc","typechain":"cp -r ../../contracts/abi/ tmp && rm ./tmp/abi.json && mv ./tmp/contracts.json ./src/json/contracts.json && typechain --target=ethers-v5 --out-dir=./src/typechain/ './tmp/**/*.json' && rm -rf ./tmp","prepublishOnly":"npm run clean && npm run typechain && npm run build"},"author":{"name":"blockswan"},"license":"MIT","devDependencies":{"@nomicfoundation/hardhat-toolbox":"^2.0.2","@nomiclabs/hardhat-ethers":"^2.2.2","@typechain/ethers-v5":"^10.2.0","@types/jest":"^29.5.0","@types/node":"^18.15.3","hardhat":"^2.13.0","jest":"^29.5.0","reflect-metadata":"^0.1.13","ts-jest":"^29.0.5","typechain":"^8.1.1","typescript":"^4.9.5"},"dependencies":{"bignumber.js":"^9.1.1"},"gitHead":"1bbd9c75c9bddd7fdd988004e567dfb74845e13f","publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_id":"@blockswan/contract-helpers@0.0.11","_nodeVersion":"18.13.0","_npmVersion":"lerna/6.5.1/node@v18.13.0+arm64 (darwin)","dist":{"integrity":"sha512-iHV1AKI35yjAylVRUy5K3Y6FFLK39B9SdkkjJ3VQjmEHNJ2tfDGtPJsbrP+eLxHnuCPWXNRD2Vfy9JzW8Zhe1w==","shasum":"1c6797e7c590481765e539d90a446a8e37cb84ca","tarball":"https://registry.npmjs.org/@blockswan/contract-helpers/-/contract-helpers-0.0.11.tgz","fileCount":455,"unpackedSize":3211746,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD+9Hr4NdLL2t/ociASIf5INoDS9MIAB7fxAmVNQYFd/QIhAPXJgspXv+QUJk9W7hbAhPh6m2BxtA44NftfsjVJ0xDl"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkGzDsACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmo9bQ//XxBh6GKrAvbxE4yqKfM7QcaTnnVjHXOuZU+ZeuHF73iQI7sU\r\nBG08YoHrQboiWmZOWlDGZkb425buCfeux92mcnrooTQe0b7CNa8+Aj+BPVUB\r\nKoeR98uwI9yttSiYosVVnaU5UIiiksF788dPslXT8XzcWv+9NrObdfQWlMwy\r\nVdBFON41TzFiVcGHwjKeYGA9wnObsxL3dZb3/BWVK5KAvHWSQr+iNc4tREU7\r\n062AtFoUni+F1FlcibJ22iPJVu8B+duL5UVx1iXChGevkKDf7304qb6BDZYy\r\nSLTpECzrGv6ayYOpMrvJImd4J4o/TCesewSgPMlTaC+OHwJGoTbbRqiXMrm9\r\n6iyXJIomlPJPUhW+A67QOuPl22NPtC6GwA4wGIL5R30izXLdcwN3ingZZq7A\r\n0mMhJgrOd+pNTFze7ONSsia8OHry0Bbd90l/DWOYBEVDImhF51YnSGA5/NFY\r\nYx6P3h2F6KdSVh8hC3st0KnWAWlDmmyQSzlUFJzdBAVOn46ql8vtSkaSd0hR\r\nLBn3d1SHsoOMZSDA5JZngeg8gNREgaomQSl0AfTqUbOZXCl9Geku9Lo55ccP\r\nG7kK9b/Dr8WPFMXC27McYTbN4CYFFdCCIg5P8YiLxUL8cJ8osP9rybeU6FeJ\r\nTNQUYvutSkKFMskOz5mk5ubTvGpYYhPrypI=\r\n=Mn7y\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"blockswan","email":"contact@blockswan.app"},"directories":{},"maintainers":[{"name":"blockswan","email":"contact@blockswan.app"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/contract-helpers_0.0.11_1679503596099_0.6529165462810209"},"_hasShrinkwrap":false},"0.0.12":{"name":"@blockswan/contract-helpers","version":"0.0.12","description":"Helper functions for interacting with blockswan periphery & protocol contracts","main":"dist/index.js","types":"dist/types/index.d.ts","scripts":{"clean":"rm -rf dist cache","test":"jest","build":"rm -rf dist && tsc","typechain":"cp -r ../../contracts/abi/ tmp && rm ./tmp/abi.json && mv ./tmp/contracts.json ./src/json/contracts.json && typechain --target=ethers-v5 --out-dir=./src/typechain/ './tmp/**/*.json' && rm -rf ./tmp","prepublishOnly":"npm run clean && npm run typechain && npm run build"},"author":{"name":"blockswan"},"license":"MIT","devDependencies":{"@nomicfoundation/hardhat-toolbox":"^2.0.2","@nomiclabs/hardhat-ethers":"^2.2.2","@typechain/ethers-v5":"^10.2.0","@types/jest":"^29.5.0","@types/node":"^18.15.3","hardhat":"^2.13.0","jest":"^29.5.0","reflect-metadata":"^0.1.13","ts-jest":"^29.0.5","typechain":"^8.1.1","typescript":"^4.9.5"},"dependencies":{"bignumber.js":"^9.1.1"},"gitHead":"943522c3cd26ed5332c96e31232c3f541bbfcbe9","publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_id":"@blockswan/contract-helpers@0.0.12","_nodeVersion":"18.13.0","_npmVersion":"lerna/6.5.1/node@v18.13.0+arm64 (darwin)","dist":{"integrity":"sha512-Hi9rtEkdyPs9xt1Km2VC8xFVdeWjT3te8DP083Es3P0+TZHZGXv4qadJGOg3hM62XWY7is6GDqw+WudYf2yb8g==","shasum":"76a9fdd03280585db7778e3c597d50638d77adc9","tarball":"https://registry.npmjs.org/@blockswan/contract-helpers/-/contract-helpers-0.0.12.tgz","fileCount":458,"unpackedSize":3214851,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGJ/5Fmem98bba/0ohLVJ4i5R/tOlYukCZ9ezt+MVFOJAiBbOtaWQPFp5vX0sVJ/Djsvz9nBR03NLE3xt434OPhkjw=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkGzPIACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoJ4Q/+O7qDpaOu/DwndzXgev2IJ1NeEHJeZn4DiqvL4p954MS1nXFF\r\nLMXxtYrGYR3T84ufbLiM6Nde5D2aOJHv/57CBzsVnEE0LwyONoVFuIRuvhsj\r\nL5AId1yCCiv6IyGOn1tXmepDRJbarvDRQHhatjt3J4vTp0d9y0iXcXjb2B0U\r\nhlUUz7oNb6OQ6bKsoJwz3+OMVlzx7U+KBWpqVFxQ63LK9Dkf9aRLbCKkRFdP\r\nOugiLfkpaYIDzCH2CLld1pk9+mgiEONYMvniSA2dq3E93eQU2QE/sb6FqOEc\r\nVadiazXf2e+6HVwvS/8Sc70vy1rdpuE3OoTLgdXd+Pd7ZgYa2THdVHOn8zoH\r\nYHFB44fLjBffYwXdae64FOAlKdObOmm69z6az7pUjRncXjgBXh8NQcepKuCp\r\n8gAeix0h2b2wOblVOf/dViSoP4cLPQFKthMCTnYBcWtM/VsBkluCuAe0S/kM\r\nNPjQX0Pb9iV/x6o++8MR6uKbhyQ/nQu0nl7a+R4FAzxpvWZQCNCyfS6GmUod\r\nmI0IdakWbGnAGdVuc2OiUkFNQQJ5S4huiUaRT6byR3DBX3K/NBelKZyGIEbA\r\n2KDrqLgAgEX68+UsuzyPYEnT2Ysp5q45YYbZxWplMiOyzLKPq0C5igEAH36P\r\n+06FVIaX4Af1LBxbx1QRaDl/AqW5kc0DzK4=\r\n=0L8x\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"blockswan","email":"contact@blockswan.app"},"directories":{},"maintainers":[{"name":"blockswan","email":"contact@blockswan.app"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/contract-helpers_0.0.12_1679504328535_0.8683913574704831"},"_hasShrinkwrap":false}},"time":{"created":"2023-03-17T19:19:56.512Z","0.0.8":"2023-03-17T19:19:56.757Z","modified":"2023-03-22T16:58:48.970Z","0.0.9":"2023-03-17T21:02:44.608Z","0.0.11":"2023-03-22T16:46:36.326Z","0.0.12":"2023-03-22T16:58:48.823Z"},"maintainers":[{"name":"blockswan","email":"contact@blockswan.app"}],"description":"Helper functions for interacting with blockswan periphery & protocol contracts","author":{"name":"blockswan"},"license":"MIT","readme":"```\n______ _            _    _____\n| ___ \\ |          | |  /  ___|\n| |_/ / | ___   ___| | _\\ `--.__      ____ _ _ __\n| ___ \\ |/ _ \\ / __| |/ /`--. \\ \\ /\\ / / _` | '_ \\\n| |_/ / | (_) | (__|   </\\__/ /\\ V  V / (_| | | | |\n\\____/|_|\\___/ \\___|_|\\_\\____/  \\_/\\_/ \\__,_|_| |_|\n```\n\n# Blockswan contract-helpers\n\nThis package provides a collection of utility functions to interact with EVM-based blockswan smart contracts. It is built using TypeScript and works with the Hardhat development environment and jest for testing.\n\n![NPM](https://img.shields.io/badge/NPM-%23CB3837.svg?style=for-the-badge&logo=npm&logoColor=white) ![Solidity](https://img.shields.io/badge/Solidity-%23363636.svg?style=for-the-badge&logo=solidity&logoColor=white) ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)\n\nThe packages within the blockswan-protocol repository are also managed at the root of the folder via Lerna.\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Development](#development)\n    - [contract-helpers/src](#contract-helperssrc)\n        - [commons](#commons)\n            - [base-service](#base-service)\n            - [gas-station](#gas-station)\n            - [typechain](#typechain)\n            - [utils](#utils)\n            - [validators](#validators)\n        - [faucet-service](#faucet-service)\n        - [forwarder-service](#forwarder-service)\n        - [index.ts](#indexts)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Installation\n\nTo install the package, run the following command in your project directory:\n\n```shell\nnpm install @blockswan/contract-helpers\n```\n\n## Usage\n\nTo use the package, first import the necessary functions from the @mvp/contract-helpers module. For example:\n\n\n```typescript\nimport { ForwarderService, FaucetService } from '@blockswan/contract-helpers';\n```\n\nMore infomation coming soon. \n\n## Development\n\nTo build the package, run the following command:\n\n```shell\nnpm run build\n```\n\nTo run the tests, run the following command:\n\n```shell\nnpm run test\n```\n\n## contract-helpers/src\n\nThis directory contains the source code for the contract-helpers package. It includes various subdirectories that organize different parts of the package's functionality.\n\n### commons\n\nThe `commons` directory contains common utilities and shared code that is used across the package. It includes subdirectories for `base-service`, `gas-station`, `typechain`, `utils`, and `validators`.\n\n#### base-service\n\n`base-service` contains a base class for implementing services.\n\n#### gas-station\n\n`gas-station` contains code for estimating gas costs.\n\n#### typechain\n\n`typechain` contains TypeScript bindings for the package's contracts.\n\n#### utils\n\n`utils` contains various utility functions.\n\n#### validators\n\n`validators` contains input validation code for the package's functions. It includes subdirectories for methods, params, and validations.\n\n### faucet-service\n\nThe `faucet-service` directory contains the source code for a service that dispenses testnet tokens.\n\n### forwarder-service\n\nThe `forwarder-service` directory contains the source code for a service that forwards transactions.\n\n### index.ts\n\nThe top-level `index.ts` file is the entry point for the package's functionality, and it exports various modules and functions for use by other packages.\n\n\n\n\n## Contributing\n\nContributions to this package are welcome. To contribute, please fork this repository, make your changes, and submit a pull request.\n\n## License\n\nThis package is licensed under the MIT License. See the LICENSE file for more information.","readmeFilename":"README.md"}