diff options
author | Fabio Berger <me@fabioberger.com> | 2018-08-03 23:13:10 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2018-08-03 23:13:10 +0800 |
commit | 3ee3fc2fb35b5ecc8237363d6307b7135ed4f927 (patch) | |
tree | 9667469849a83172ab3ee2e536f0dc780af7d16c /packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts | |
parent | 10f6647ab3ac17e25a755d9d1424c53f88e7151c (diff) | |
download | dexon-sol-tools-3ee3fc2fb35b5ecc8237363d6307b7135ed4f927.tar dexon-sol-tools-3ee3fc2fb35b5ecc8237363d6307b7135ed4f927.tar.gz dexon-sol-tools-3ee3fc2fb35b5ecc8237363d6307b7135ed4f927.tar.bz2 dexon-sol-tools-3ee3fc2fb35b5ecc8237363d6307b7135ed4f927.tar.lz dexon-sol-tools-3ee3fc2fb35b5ecc8237363d6307b7135ed4f927.tar.xz dexon-sol-tools-3ee3fc2fb35b5ecc8237363d6307b7135ed4f927.tar.zst dexon-sol-tools-3ee3fc2fb35b5ecc8237363d6307b7135ed4f927.zip |
Add missing doc comments
Diffstat (limited to 'packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts')
-rw-r--r-- | packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts b/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts index 5046d3667..d7b6effd8 100644 --- a/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts +++ b/packages/contract-wrappers/src/contract_wrappers/ether_token_wrapper.ts @@ -24,6 +24,14 @@ export class EtherTokenWrapper extends ContractWrapper { [address: string]: WETH9Contract; } = {}; private _erc20TokenWrapper: ERC20TokenWrapper; + /** + * Instantiate EtherTokenWrapper. We recommend you don't instantiate this yourself, rather + * use it through the ContractWrappers class property (contractWrappers.etherToken). + * @param web3Wrapper Web3Wrapper instance to use + * @param networkId Desired networkId + * @param erc20TokenWrapper The ERC20TokenWrapper instance to use + * @param blockPollingIntervalMs The block polling interval to use for active subscriptions + */ constructor( web3Wrapper: Web3Wrapper, networkId: number, |