Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
@typechain/ethers-v5
Advanced tools
Readme
🔌 TypeScript bindings for Ethers 5.x.x smartcontracts
This package requires TypeScript >= 4.0. If you need support for earlier TS versions check out: 1.0 version of this package.
The main files generated by this target are <contract-name>.ts
. They declare typesafe interfaces for your contracts
on top of ethers Contract
instances:
contract.someMethod(...)
and contract.functions.someMethod(...)
contract.interface.events.AnEvent
and filters in contract.filters.AnEvent
contract.estimateGas.someMethod
on
, once
, etc) that return the same contract type.Note: these are just type declarations to help you call the blockchain properly, so they're not available at runtime,
and all of the contracts are still instances of the same Contract
class.
This target also generates a concrete factory class for each contract, to help you deploy or connect to contract
instances. The factory classes are an extension of ethers' ContractFactory
. They serve two main purposes:
ContractFactory
class, so you don't have to load and parse the JSON
manuallyContractFactory
(since it returns plain Contract
instances).Abstract contracts or solidity interfaces are handled a bit different, because they have no bytecode. For those, a
simplified factory is generated that doesn't extends ContractFactory
, and only includes the static connect
method,
so you can easily connect to a deployed instance without having to pass the ABI manually.
Suppose you have an Erc20Token.sol
solidity interface and a DummyToken.sol
contract implementing it.
import { BigNumber } from 'ethers';
import { Wallet } from 'ethers';
import { DummyTokenFactory } from 'typechain-out-dir/DummyTokenFactory';
import { DummyToken } from 'typechain-out-dir/DummyToken';
import { Erc20TokenFactory } from 'typechain-out-dir/Erc20TokenFactory';
const provider = getYourProvider(...);
// use the concrete contract factory if you need to operate on the bytecode (ie. deploy)
async function deployTestToken(ownerPK: string): Promise<DummyToken> {
const owner = new Wallet(ownerPK, provider);
return new DummyTokenFactory(owner).deploy();
}
// to call existing contracts, a factory for both the concrete contract and for the interface
// can be used since the ABI is the same
async function getTokenBalance(walletAddress: string, tokenAddress: string): Promise<BigNumber> {
const token = Erc20TokenFactory.connect(tokenAddress, provider);
return token.balanceOf(walletAddress);
}
FAQs
🔌 TypeChain target for ethers-v5
The npm package @typechain/ethers-v5 receives a total of 123,686 weekly downloads. As such, @typechain/ethers-v5 popularity was classified as popular.
We found that @typechain/ethers-v5 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.