aboutsummaryrefslogtreecommitdiffstats
path: root/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-08-03 23:13:10 +0800
committerFabio Berger <me@fabioberger.com>2018-08-03 23:13:10 +0800
commit3ee3fc2fb35b5ecc8237363d6307b7135ed4f927 (patch)
tree9667469849a83172ab3ee2e536f0dc780af7d16c /packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts
parent10f6647ab3ac17e25a755d9d1424c53f88e7151c (diff)
downloaddexon-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/erc20_token_wrapper.ts')
-rw-r--r--packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts8
1 files changed, 8 insertions, 0 deletions
diff --git a/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts b/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts
index 17bda5085..7ff0ee72e 100644
--- a/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts
+++ b/packages/contract-wrappers/src/contract_wrappers/erc20_token_wrapper.ts
@@ -34,6 +34,14 @@ export class ERC20TokenWrapper extends ContractWrapper {
public UNLIMITED_ALLOWANCE_IN_BASE_UNITS = constants.UNLIMITED_ALLOWANCE_IN_BASE_UNITS;
private _tokenContractsByAddress: { [address: string]: ERC20TokenContract };
private _erc20ProxyWrapper: ERC20ProxyWrapper;
+ /**
+ * Instantiate ERC20TokenWrapper. We recommend you don't instantiate this yourself, rather
+ * use it through the ContractWrappers class property (contractWrappers.erc20Token).
+ * @param web3Wrapper Web3Wrapper instance to use
+ * @param networkId Desired networkId
+ * @param erc20ProxyWrapper The ERC20ProxyWrapper instance to use
+ * @param blockPollingIntervalMs The block polling interval to use for active subscriptions
+ */
constructor(
web3Wrapper: Web3Wrapper,
networkId: number,