$ npm install web3-eth-contract
This is a sub-package of web3.js.
web3-eth-contract
contains the contract package used in web3-eth
.
You can install the package either using NPM or using Yarn
npm install web3-eth-contract
yarn add web3-eth-contract
You can initialize the typesafe Contract API instance with the following.
import { Contract } from 'web3-eth-contract';
const abi = [...] as const;
const contract = new Contract(abi);
web3.eth.Contract
API in normal usage.as const
is necessary to have fully type-safe interface for the contract.as const
in your TS project.We have tested the TypeScript interface support for the ABIs compiled with solidity version v0.4.x
and above. If you face any issue regarding the contract typing, please create an issue to report to us.
The TypeScript support for fixed length array types are supported up 30 elements. See more details here. This limitation is only to provide more performant developer experience in IDEs. In future we may come up with a workaround to avoid this limitation. If you have any idea feel free to share.
Script | Description |
---|---|
clean | Uses rimraf to remove dist/ |
build | Uses tsc to build package and dependent packages |
lint | Uses eslint to lint package |
lint:fix | Uses eslint to check and fix any warnings |
format | Uses prettier to format the code |
test | Uses jest to run unit tests |
test:integration | Uses jest to run tests under /test/integration |
test:unit | Uses jest to run tests under /test/unit |
© 2010 - cnpmjs.org x YWFE | Home | YWFE