diff options
author | Fabio Berger <me@fabioberger.com> | 2017-06-27 05:14:03 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2017-06-27 05:14:03 +0800 |
commit | 718b801f48402dea451bd82f674f0b8c2314ea90 (patch) | |
tree | 7e74ef6e881e5e843c5a78ef1a6eccc104b1d497 /src | |
parent | 73eb78d7934008647eb40d5c1bd16686ea15e229 (diff) | |
download | dexon-0x-contracts-718b801f48402dea451bd82f674f0b8c2314ea90.tar dexon-0x-contracts-718b801f48402dea451bd82f674f0b8c2314ea90.tar.gz dexon-0x-contracts-718b801f48402dea451bd82f674f0b8c2314ea90.tar.bz2 dexon-0x-contracts-718b801f48402dea451bd82f674f0b8c2314ea90.tar.lz dexon-0x-contracts-718b801f48402dea451bd82f674f0b8c2314ea90.tar.xz dexon-0x-contracts-718b801f48402dea451bd82f674f0b8c2314ea90.tar.zst dexon-0x-contracts-718b801f48402dea451bd82f674f0b8c2314ea90.zip |
Improve EtherToken comments
Diffstat (limited to 'src')
-rw-r--r-- | src/contract_wrappers/ether_token_wrapper.ts | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/src/contract_wrappers/ether_token_wrapper.ts b/src/contract_wrappers/ether_token_wrapper.ts index 76e7289b7..0f0d7c995 100644 --- a/src/contract_wrappers/ether_token_wrapper.ts +++ b/src/contract_wrappers/ether_token_wrapper.ts @@ -8,7 +8,7 @@ import * as EtherTokenArtifacts from '../artifacts/EtherToken.json'; /** * This class includes all the functionality related to interacting with a wrapped Ether ERC20 token contract. - * The caller can convert ETH into the equivalent number of wrapped ETH ERC20 tokens and back. + * The caller can convert Ether into the equivalent number of wrapped Ether ERC20 tokens and back. */ export class EtherTokenWrapper extends ContractWrapper { private _etherTokenContractIfExists?: EtherTokenContract; @@ -18,11 +18,11 @@ export class EtherTokenWrapper extends ContractWrapper { this._tokenWrapper = tokenWrapper; } /** - * Deposit ETH into the Wrapped ETH smart contract and issues the equivalent number of wrapped ETH tokens - * to the depositor address. These wrapped ETH tokens can be used in 0x trades and are redeemable for 1-to-1 - * for ETH. - * @param amountInWei Amount of ETH in Wei the caller wishes to deposit. - * @param depositor The hex encoded user Ethereum address that would like to make the deposit. + * Deposits Ether into the wrapped Ether smart contract and issues the equivalent number of wrapped Ether tokens + * to the depositor address. These wrapped Ether tokens can be used in 0x trades and are redeemable 1-to-1 + * for Ether. + * @param amountInWei Amount of Ether denominated in wei the caller wishes to deposit. + * @param depositor The hex encoded user Ethereum address that would like to make the deposit. */ public async depositAsync(amountInWei: BigNumber.BigNumber, depositor: string): Promise<void> { assert.isBigNumber('amountInWei', amountInWei); @@ -38,10 +38,10 @@ export class EtherTokenWrapper extends ContractWrapper { }); } /** - * Withdraw ETH to the withdrawer's address from the wrapped ETH smart contract in exchange for the - * equivalent number of wrapped ETH tokens. - * @param amountInWei Amount of ETH in Wei the caller wishes to withdraw. - * @param withdrawer The hex encoded user Ethereum address that would like to make the withdrawl. + * Withdraw Ether to the withdrawer's address from the wrapped Ether smart contract in return for the + * equivalent number of wrapped Ether tokens. + * @param amountInWei Amount of Ether denominated in wei the caller wishes to withdraw. + * @param withdrawer The hex encoded user Ethereum address that would like to make the withdrawal. */ public async withdrawAsync(amountInWei: BigNumber.BigNumber, withdrawer: string): Promise<void> { assert.isBigNumber('amountInWei', amountInWei); |