From 9409e0aba1d1fa62a60c25149ae1b7115de9e2c9 Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Wed, 31 May 2017 11:16:57 +0200 Subject: Add transfer function and tests for it --- src/contract_wrappers/token_wrapper.ts | 17 ++++++++++++++++- src/types.ts | 1 + test/token_wrapper_test.ts | 19 +++++++++++++++++++ 3 files changed, 36 insertions(+), 1 deletion(-) diff --git a/src/contract_wrappers/token_wrapper.ts b/src/contract_wrappers/token_wrapper.ts index 59dfc0667..e93b6b7c2 100644 --- a/src/contract_wrappers/token_wrapper.ts +++ b/src/contract_wrappers/token_wrapper.ts @@ -54,7 +54,7 @@ export class TokenWrapper extends ContractWrapper { * of an owner address. */ public async setProxyAllowanceAsync(tokenAddress: string, ownerAddress: string, - amountInBaseUnits: BigNumber.BigNumber) { + amountInBaseUnits: BigNumber.BigNumber): Promise { assert.isETHAddressHex('ownerAddress', ownerAddress); assert.isETHAddressHex('tokenAddress', tokenAddress); assert.isBigNumber('amountInBaseUnits', amountInBaseUnits); @@ -71,6 +71,21 @@ export class TokenWrapper extends ContractWrapper { gas, }); } + /** + * Transfers `amountInBaseUnits` ERC20 tokens from `fromAddress` to `toAddress`. + */ + public async transferAsync(tokenAddress: string, fromAddress: string, toAddress: string, + amountInBaseUnits: BigNumber.BigNumber): Promise { + assert.isETHAddressHex('tokenAddress', tokenAddress); + assert.isETHAddressHex('fromAddress', fromAddress); + assert.isETHAddressHex('toAddress', toAddress); + assert.isBigNumber('amountInBaseUnits', amountInBaseUnits); + + const tokenContract = await this.getTokenContractAsync(tokenAddress); + await tokenContract.transfer(toAddress, amountInBaseUnits, { + from: fromAddress, + }); + } private async getTokenContractAsync(tokenAddress: string): Promise { let tokenContract = this.tokenContractsByAddress[tokenAddress]; if (!_.isUndefined(tokenContract)) { diff --git a/src/types.ts b/src/types.ts index bf0a1d8b4..418cf9802 100644 --- a/src/types.ts +++ b/src/types.ts @@ -42,6 +42,7 @@ export interface TokenContract { allowance: { call: (ownerAddress: string, allowedAddress: string) => Promise; }; + transfer: (to: string, amountInBaseUnits: BigNumber.BigNumber, opts: any) => Promise; approve: (proxyAddress: string, amountInBaseUnits: BigNumber.BigNumber, opts: any) => void; } diff --git a/test/token_wrapper_test.ts b/test/token_wrapper_test.ts index 5ce3efb14..113dd32d6 100644 --- a/test/token_wrapper_test.ts +++ b/test/token_wrapper_test.ts @@ -28,6 +28,25 @@ describe('TokenWrapper', () => { afterEach(async () => { await blockchainLifecycle.revertAsync(); }); + describe('#transferAsync', () => { + it('should successfully transfer tokens', async () => { + const token = tokens[0]; + const fromAddress = userAddresses[0]; + const toAddress = userAddresses[1]; + const preBalance = await zeroEx.token.getBalanceAsync(token.address, toAddress); + expect(preBalance).to.be.bignumber.equal(0); + await zeroEx.token.transferAsync(token.address, fromAddress, toAddress, new BigNumber(42)); + const postBalance = await zeroEx.token.getBalanceAsync(token.address, toAddress); + expect(postBalance).to.be.bignumber.equal(42); + }); + it('should throw a CONTRACT_DOES_NOT_EXIST error for a non-existent token contract', async () => { + const nonExistentTokenAddress = '0x9dd402f14d67e001d8efbe6583e51bf9706aa065'; + const aOwnerAddress = userAddresses[0]; + expect(zeroEx.token.transferAsync( + nonExistentTokenAddress, userAddresses[0], userAddresses[1], new BigNumber(42), + )).to.be.rejectedWith(ZeroExError.CONTRACT_DOES_NOT_EXIST); + }); + }); describe('#getBalanceAsync', () => { it('should return the balance for an existing ERC20 token', async () => { const aToken = tokens[0]; -- cgit v1.2.3 From 4d43f4d6108575b889aca8e8c969574c121ce0c9 Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Wed, 31 May 2017 17:51:37 +0200 Subject: Address feedback --- test/token_wrapper_test.ts | 54 ++++++++++++++++++++++++---------------------- 1 file changed, 28 insertions(+), 26 deletions(-) diff --git a/test/token_wrapper_test.ts b/test/token_wrapper_test.ts index 113dd32d6..4af07a8b2 100644 --- a/test/token_wrapper_test.ts +++ b/test/token_wrapper_test.ts @@ -35,75 +35,77 @@ describe('TokenWrapper', () => { const toAddress = userAddresses[1]; const preBalance = await zeroEx.token.getBalanceAsync(token.address, toAddress); expect(preBalance).to.be.bignumber.equal(0); - await zeroEx.token.transferAsync(token.address, fromAddress, toAddress, new BigNumber(42)); + const transferAmount = new BigNumber(42); + await zeroEx.token.transferAsync(token.address, fromAddress, toAddress, transferAmount); const postBalance = await zeroEx.token.getBalanceAsync(token.address, toAddress); - expect(postBalance).to.be.bignumber.equal(42); + expect(postBalance).to.be.bignumber.equal(transferAmount); }); it('should throw a CONTRACT_DOES_NOT_EXIST error for a non-existent token contract', async () => { const nonExistentTokenAddress = '0x9dd402f14d67e001d8efbe6583e51bf9706aa065'; - const aOwnerAddress = userAddresses[0]; + const fromAddress = userAddresses[0]; + const toAddress = userAddresses[0]; expect(zeroEx.token.transferAsync( - nonExistentTokenAddress, userAddresses[0], userAddresses[1], new BigNumber(42), + nonExistentTokenAddress, fromAddress, toAddress, new BigNumber(42), )).to.be.rejectedWith(ZeroExError.CONTRACT_DOES_NOT_EXIST); }); }); describe('#getBalanceAsync', () => { it('should return the balance for an existing ERC20 token', async () => { - const aToken = tokens[0]; - const aOwnerAddress = userAddresses[0]; - const balance = await zeroEx.token.getBalanceAsync(aToken.address, aOwnerAddress); + const token = tokens[0]; + const ownerAddress = userAddresses[0]; + const balance = await zeroEx.token.getBalanceAsync(token.address, ownerAddress); const expectedBalance = new BigNumber('100000000000000000000000000'); expect(balance).to.be.bignumber.equal(expectedBalance); }); it('should throw a CONTRACT_DOES_NOT_EXIST error for a non-existent token contract', async () => { const nonExistentTokenAddress = '0x9dd402f14d67e001d8efbe6583e51bf9706aa065'; - const aOwnerAddress = userAddresses[0]; - expect(zeroEx.token.getBalanceAsync(nonExistentTokenAddress, aOwnerAddress)) + const ownerAddress = userAddresses[0]; + expect(zeroEx.token.getBalanceAsync(nonExistentTokenAddress, ownerAddress)) .to.be.rejectedWith(ZeroExError.CONTRACT_DOES_NOT_EXIST); }); it('should return a balance of 0 for a non-existent owner address', async () => { - const aToken = tokens[0]; - const aNonExistentOwner = '0x198C6Ad858F213Fb31b6FE809E25040E6B964593'; - const balance = await zeroEx.token.getBalanceAsync(aToken.address, aNonExistentOwner); + const token = tokens[0]; + const nonExistentOwner = '0x198C6Ad858F213Fb31b6FE809E25040E6B964593'; + const balance = await zeroEx.token.getBalanceAsync(token.address, nonExistentOwner); const expectedBalance = new BigNumber('0'); expect(balance).to.be.bignumber.equal(expectedBalance); }); }); describe('#getProxyAllowanceAsync', () => { it('should get the proxy allowance', async () => { - const aToken = tokens[0]; - const aOwnerAddress = userAddresses[0]; + const token = tokens[0]; + const ownerAddress = userAddresses[0]; const amountInUnits = new BigNumber('50'); - const amountInBaseUnits = ZeroEx.toBaseUnitAmount(amountInUnits, aToken.decimals); - await zeroEx.token.setProxyAllowanceAsync(aToken.address, aOwnerAddress, amountInBaseUnits); + const amountInBaseUnits = ZeroEx.toBaseUnitAmount(amountInUnits, token.decimals); + await zeroEx.token.setProxyAllowanceAsync(token.address, ownerAddress, amountInBaseUnits); - const allowance = await zeroEx.token.getProxyAllowanceAsync(aToken.address, aOwnerAddress); + const allowance = await zeroEx.token.getProxyAllowanceAsync(token.address, ownerAddress); const expectedAllowance = amountInBaseUnits; expect(allowance).to.be.bignumber.equal(expectedAllowance); }); it('should return 0 if no allowance set yet', async () => { - const aToken = tokens[0]; - const aOwnerAddress = userAddresses[0]; - const allowance = await zeroEx.token.getProxyAllowanceAsync(aToken.address, aOwnerAddress); + const token = tokens[0]; + const ownerAddress = userAddresses[0]; + const allowance = await zeroEx.token.getProxyAllowanceAsync(token.address, ownerAddress); const expectedAllowance = new BigNumber('0'); expect(allowance).to.be.bignumber.equal(expectedAllowance); }); }); describe('#setProxyAllowanceAsync', () => { it('should set the proxy allowance', async () => { - const aToken = tokens[0]; - const aOwnerAddress = userAddresses[0]; + const token = tokens[0]; + const ownerAddress = userAddresses[0]; - const allowanceBeforeSet = await zeroEx.token.getProxyAllowanceAsync(aToken.address, aOwnerAddress); + const allowanceBeforeSet = await zeroEx.token.getProxyAllowanceAsync(token.address, ownerAddress); const expectedAllowanceBeforeAllowanceSet = new BigNumber('0'); expect(allowanceBeforeSet).to.be.bignumber.equal(expectedAllowanceBeforeAllowanceSet); const amountInUnits = new BigNumber('50'); - const amountInBaseUnits = ZeroEx.toBaseUnitAmount(amountInUnits, aToken.decimals); - await zeroEx.token.setProxyAllowanceAsync(aToken.address, aOwnerAddress, amountInBaseUnits); + const amountInBaseUnits = ZeroEx.toBaseUnitAmount(amountInUnits, token.decimals); + await zeroEx.token.setProxyAllowanceAsync(token.address, ownerAddress, amountInBaseUnits); - const allowanceAfterSet = await zeroEx.token.getProxyAllowanceAsync(aToken.address, aOwnerAddress); + const allowanceAfterSet = await zeroEx.token.getProxyAllowanceAsync(token.address, ownerAddress); const expectedAllowanceAfterAllowanceSet = amountInBaseUnits; expect(allowanceAfterSet).to.be.bignumber.equal(expectedAllowanceAfterAllowanceSet); }); -- cgit v1.2.3