crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #28 from 0xProject/erc20transfer

Browse Source 
Add transfer function and tests for it
This commit is contained in:
Leonid
2017-05-31 19:25:03 +02:00
committed by GitHub
parent 11b6b36cca 4d43f4d610
commit 1c765cd55f
3 changed files with 60 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/contract_wrappers/token_wrapper.ts
View File

@@ -52,7 +52,7 @@ export class TokenWrapper extends ContractWrapper {
* of an owner address.
*/
public async setProxyAllowanceAsync(tokenAddress: string, ownerAddress: string,
amountInBaseUnits: BigNumber.BigNumber) {
amountInBaseUnits: BigNumber.BigNumber): Promise<void> {
assert.isETHAddressHex('ownerAddress', ownerAddress);
assert.isETHAddressHex('tokenAddress', tokenAddress);
assert.isBigNumber('amountInBaseUnits', amountInBaseUnits);
@@ -69,6 +69,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<void> {
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<TokenContract> {
let tokenContract = this.tokenContractsByAddress[tokenAddress];
if (!_.isUndefined(tokenContract)) {

1
src/types.ts
View File

@@ -38,6 +38,7 @@ export interface TokenContract {
allowance: {
call: (ownerAddress: string, allowedAddress: string) => Promise<BigNumber.BigNumber>;
};
transfer: (to: string, amountInBaseUnits: BigNumber.BigNumber, txOpts: TxOpts) => Promise<boolean>;
approve: (proxyAddress: string, amountInBaseUnits: BigNumber.BigNumber, txOpts: TxOpts) => void;
}

65
test/token_wrapper_test.ts
View File

@@ -28,63 +28,84 @@ 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);
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(transferAmount);
});
it('should throw a CONTRACT_DOES_NOT_EXIST error for a non-existent token contract', async () => {
const nonExistentTokenAddress = '0x9dd402f14d67e001d8efbe6583e51bf9706aa065';
const fromAddress = userAddresses[0];
const toAddress = userAddresses[0];
expect(zeroEx.token.transferAsync(
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);
});