Switch over to Lerna + Yarn Workspaces setup for a mono-repo approach

1 files changed, 477 insertions, 0 deletions

diff --git a/packages/0x.js/test/token_wrapper_test.ts b/packages/0x.js/test/token_wrapper_test.ts
new file mode 100644
index 000000000..b30762e8c
--- /dev/null
+++ b/packages/0x.js/test/token_wrapper_test.ts
@@ -0,0 +1,477 @@
+import 'mocha';
+import * as chai from 'chai';
+import {chaiSetup} from './utils/chai_setup';
+import * as Web3 from 'web3';
+import BigNumber from 'bignumber.js';
+import promisify = require('es6-promisify');
+import {web3Factory} from './utils/web3_factory';
+import {
+    ZeroEx,
+    ZeroExError,
+    Token,
+    SubscriptionOpts,
+    TokenEvents,
+    ContractEvent,
+    TransferContractEventArgs,
+    ApprovalContractEventArgs,
+    TokenContractEventArgs,
+    LogWithDecodedArgs,
+    LogEvent,
+    DecodedLogEvent,
+} from '../src';
+import {BlockchainLifecycle} from './utils/blockchain_lifecycle';
+import {TokenUtils} from './utils/token_utils';
+import {DoneCallback, BlockParamLiteral} from '../src/types';
+
+chaiSetup.configure();
+const expect = chai.expect;
+const blockchainLifecycle = new BlockchainLifecycle();
+
+describe('TokenWrapper', () => {
+    let web3: Web3;
+    let zeroEx: ZeroEx;
+    let userAddresses: string[];
+    let tokens: Token[];
+    let tokenUtils: TokenUtils;
+    let coinbase: string;
+    let addressWithoutFunds: string;
+    before(async () => {
+        web3 = web3Factory.create();
+        zeroEx = new ZeroEx(web3.currentProvider);
+        userAddresses = await zeroEx.getAvailableAddressesAsync();
+        tokens = await zeroEx.tokenRegistry.getTokensAsync();
+        tokenUtils = new TokenUtils(tokens);
+        coinbase = userAddresses[0];
+        addressWithoutFunds = userAddresses[1];
+    });
+    beforeEach(async () => {
+        await blockchainLifecycle.startAsync();
+    });
+    afterEach(async () => {
+        await blockchainLifecycle.revertAsync();
+    });
+    describe('#transferAsync', () => {
+        let token: Token;
+        let transferAmount: BigNumber;
+        before(() => {
+            token = tokens[0];
+            transferAmount = new BigNumber(42);
+        });
+        it('should successfully transfer tokens', async () => {
+            const fromAddress = coinbase;
+            const toAddress = addressWithoutFunds;
+            const preBalance = await zeroEx.token.getBalanceAsync(token.address, toAddress);
+            expect(preBalance).to.be.bignumber.equal(0);
+            const txHash = await zeroEx.token.transferAsync(token.address, fromAddress, toAddress, transferAmount);
+            const receipt = await zeroEx.awaitTransactionMinedAsync(txHash);
+            const postBalance = await zeroEx.token.getBalanceAsync(token.address, toAddress);
+            return expect(postBalance).to.be.bignumber.equal(transferAmount);
+        });
+        it('should fail to transfer tokens if fromAddress has an insufficient balance', async () => {
+            const fromAddress = addressWithoutFunds;
+            const toAddress = coinbase;
+            return expect(zeroEx.token.transferAsync(
+                token.address, fromAddress, toAddress, transferAmount,
+            )).to.be.rejectedWith(ZeroExError.InsufficientBalanceForTransfer);
+        });
+        it('should throw a CONTRACT_DOES_NOT_EXIST error for a non-existent token contract', async () => {
+            const nonExistentTokenAddress = '0x9dd402f14d67e001d8efbe6583e51bf9706aa065';
+            const fromAddress = coinbase;
+            const toAddress = coinbase;
+            return expect(zeroEx.token.transferAsync(
+                nonExistentTokenAddress, fromAddress, toAddress, transferAmount,
+            )).to.be.rejectedWith(ZeroExError.ContractDoesNotExist);
+        });
+    });
+    describe('#transferFromAsync', () => {
+        let token: Token;
+        let toAddress: string;
+        let senderAddress: string;
+        before(async () => {
+            token = tokens[0];
+            toAddress = addressWithoutFunds;
+            senderAddress = userAddresses[2];
+        });
+        it('should fail to transfer tokens if fromAddress has insufficient allowance set', async () => {
+            const fromAddress = coinbase;
+            const transferAmount = new BigNumber(42);
+
+            const fromAddressBalance = await zeroEx.token.getBalanceAsync(token.address, fromAddress);
+            expect(fromAddressBalance).to.be.bignumber.greaterThan(transferAmount);
+
+            const fromAddressAllowance = await zeroEx.token.getAllowanceAsync(token.address, fromAddress,
+                                                                              toAddress);
+            expect(fromAddressAllowance).to.be.bignumber.equal(0);
+
+            return expect(zeroEx.token.transferFromAsync(
+                token.address, fromAddress, toAddress, senderAddress, transferAmount,
+            )).to.be.rejectedWith(ZeroExError.InsufficientAllowanceForTransfer);
+        });
+        it('[regression] should fail to transfer tokens if set allowance for toAddress instead of senderAddress',
+            async () => {
+            const fromAddress = coinbase;
+            const transferAmount = new BigNumber(42);
+
+            await zeroEx.token.setAllowanceAsync(token.address, fromAddress, toAddress, transferAmount);
+
+            return expect(zeroEx.token.transferFromAsync(
+                token.address, fromAddress, toAddress, senderAddress, transferAmount,
+            )).to.be.rejectedWith(ZeroExError.InsufficientAllowanceForTransfer);
+        });
+        it('should fail to transfer tokens if fromAddress has insufficient balance', async () => {
+            const fromAddress = addressWithoutFunds;
+            const transferAmount = new BigNumber(42);
+
+            const fromAddressBalance = await zeroEx.token.getBalanceAsync(token.address, fromAddress);
+            expect(fromAddressBalance).to.be.bignumber.equal(0);
+
+            await zeroEx.token.setAllowanceAsync(token.address, fromAddress, senderAddress, transferAmount);
+            const fromAddressAllowance = await zeroEx.token.getAllowanceAsync(token.address, fromAddress,
+                                                                              senderAddress);
+            expect(fromAddressAllowance).to.be.bignumber.equal(transferAmount);
+
+            return expect(zeroEx.token.transferFromAsync(
+                token.address, fromAddress, toAddress, senderAddress, transferAmount,
+            )).to.be.rejectedWith(ZeroExError.InsufficientBalanceForTransfer);
+        });
+        it('should successfully transfer tokens', async () => {
+            const fromAddress = coinbase;
+
+            const preBalance = await zeroEx.token.getBalanceAsync(token.address, toAddress);
+            expect(preBalance).to.be.bignumber.equal(0);
+
+            const transferAmount = new BigNumber(42);
+            await zeroEx.token.setAllowanceAsync(token.address, fromAddress, senderAddress, transferAmount);
+
+            await zeroEx.token.transferFromAsync(token.address, fromAddress, toAddress, senderAddress,
+                                                 transferAmount);
+            const postBalance = await zeroEx.token.getBalanceAsync(token.address, toAddress);
+            return expect(postBalance).to.be.bignumber.equal(transferAmount);
+        });
+        it('should throw a CONTRACT_DOES_NOT_EXIST error for a non-existent token contract', async () => {
+            const fromAddress = coinbase;
+            const nonExistentTokenAddress = '0x9dd402f14d67e001d8efbe6583e51bf9706aa065';
+            return expect(zeroEx.token.transferFromAsync(
+                nonExistentTokenAddress, fromAddress, toAddress, senderAddress, new BigNumber(42),
+            )).to.be.rejectedWith(ZeroExError.ContractDoesNotExist);
+        });
+    });
+    describe('#getBalanceAsync', () => {
+        describe('With web3 provider with accounts', () => {
+            it('should return the balance for an existing ERC20 token', async () => {
+                const token = tokens[0];
+                const ownerAddress = coinbase;
+                const balance = await zeroEx.token.getBalanceAsync(token.address, ownerAddress);
+                const expectedBalance = new BigNumber('1000000000000000000000000000');
+                return 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 ownerAddress = coinbase;
+                return expect(zeroEx.token.getBalanceAsync(nonExistentTokenAddress, ownerAddress))
+                    .to.be.rejectedWith(ZeroExError.ContractDoesNotExist);
+            });
+            it('should return a balance of 0 for a non-existent owner address', async () => {
+                const token = tokens[0];
+                const nonExistentOwner = '0x198c6ad858f213fb31b6fe809e25040e6b964593';
+                const balance = await zeroEx.token.getBalanceAsync(token.address, nonExistentOwner);
+                const expectedBalance = new BigNumber(0);
+                return expect(balance).to.be.bignumber.equal(expectedBalance);
+            });
+        });
+        describe('With web3 provider without accounts', () => {
+            let zeroExWithoutAccounts: ZeroEx;
+            before(async () => {
+                const hasAddresses = false;
+                const web3WithoutAccounts = web3Factory.create(hasAddresses);
+                zeroExWithoutAccounts = new ZeroEx(web3WithoutAccounts.currentProvider);
+            });
+            it('should return balance even when called with Web3 provider instance without addresses', async () => {
+                    const token = tokens[0];
+                    const ownerAddress = coinbase;
+                    const balance = await zeroExWithoutAccounts.token.getBalanceAsync(token.address, ownerAddress);
+                    const expectedBalance = new BigNumber('1000000000000000000000000000');
+                    return expect(balance).to.be.bignumber.equal(expectedBalance);
+            });
+        });
+    });
+    describe('#setAllowanceAsync', () => {
+        it('should set the spender\'s allowance', async () => {
+            const token = tokens[0];
+            const ownerAddress = coinbase;
+            const spenderAddress = addressWithoutFunds;
+
+            const allowanceBeforeSet = await zeroEx.token.getAllowanceAsync(token.address, ownerAddress,
+                                                                            spenderAddress);
+            const expectedAllowanceBeforeAllowanceSet = new BigNumber(0);
+            expect(allowanceBeforeSet).to.be.bignumber.equal(expectedAllowanceBeforeAllowanceSet);
+
+            const amountInBaseUnits = new BigNumber(50);
+            await zeroEx.token.setAllowanceAsync(token.address, ownerAddress, spenderAddress, amountInBaseUnits);
+
+            const allowanceAfterSet = await zeroEx.token.getAllowanceAsync(token.address, ownerAddress, spenderAddress);
+            const expectedAllowanceAfterAllowanceSet = amountInBaseUnits;
+            return expect(allowanceAfterSet).to.be.bignumber.equal(expectedAllowanceAfterAllowanceSet);
+        });
+    });
+    describe('#setUnlimitedAllowanceAsync', () => {
+        it('should set the unlimited spender\'s allowance', async () => {
+            const token = tokens[0];
+            const ownerAddress = coinbase;
+            const spenderAddress = addressWithoutFunds;
+
+            await zeroEx.token.setUnlimitedAllowanceAsync(token.address, ownerAddress, spenderAddress);
+            const allowance = await zeroEx.token.getAllowanceAsync(token.address, ownerAddress, spenderAddress);
+            return expect(allowance).to.be.bignumber.equal(zeroEx.token.UNLIMITED_ALLOWANCE_IN_BASE_UNITS);
+        });
+        it('should reduce the gas cost for transfers including tokens with unlimited allowance support', async () => {
+            const transferAmount = new BigNumber(5);
+            const zrx = tokenUtils.getProtocolTokenOrThrow();
+            const [, userWithNormalAllowance, userWithUnlimitedAllowance] = userAddresses;
+            await zeroEx.token.setAllowanceAsync(zrx.address, coinbase, userWithNormalAllowance, transferAmount);
+            await zeroEx.token.setUnlimitedAllowanceAsync(zrx.address, coinbase, userWithUnlimitedAllowance);
+
+            const initBalanceWithNormalAllowance = await promisify(web3.eth.getBalance)(userWithNormalAllowance);
+            const initBalanceWithUnlimitedAllowance = await promisify(web3.eth.getBalance)(userWithUnlimitedAllowance);
+
+            await zeroEx.token.transferFromAsync(
+                zrx.address, coinbase, userWithNormalAllowance, userWithNormalAllowance, transferAmount,
+            );
+            await zeroEx.token.transferFromAsync(
+                zrx.address, coinbase, userWithUnlimitedAllowance, userWithUnlimitedAllowance, transferAmount,
+            );
+
+            const finalBalanceWithNormalAllowance = await promisify(web3.eth.getBalance)(userWithNormalAllowance);
+            const finalBalanceWithUnlimitedAllowance = await promisify(web3.eth.getBalance)(userWithUnlimitedAllowance);
+
+            const normalGasCost = initBalanceWithNormalAllowance.minus(finalBalanceWithNormalAllowance);
+            const unlimitedGasCost = initBalanceWithUnlimitedAllowance.minus(finalBalanceWithUnlimitedAllowance);
+
+            // In theory the gas cost with unlimited allowance should be smaller, but with testrpc it's actually bigger.
+            // This needs to be investigated in ethereumjs-vm. This test is essentially a repro.
+            // TODO: Make this test pass with inverted assertion.
+            expect(unlimitedGasCost.toNumber()).to.be.gt(normalGasCost.toNumber());
+        });
+    });
+    describe('#getAllowanceAsync', () => {
+        describe('With web3 provider with accounts', () => {
+            it('should get the proxy allowance', async () => {
+                const token = tokens[0];
+                const ownerAddress = coinbase;
+                const spenderAddress = addressWithoutFunds;
+
+                const amountInBaseUnits = new BigNumber(50);
+                await zeroEx.token.setAllowanceAsync(token.address, ownerAddress, spenderAddress, amountInBaseUnits);
+
+                const allowance = await zeroEx.token.getAllowanceAsync(token.address, ownerAddress, spenderAddress);
+                const expectedAllowance = amountInBaseUnits;
+                return expect(allowance).to.be.bignumber.equal(expectedAllowance);
+            });
+            it('should return 0 if no allowance set yet', async () => {
+                const token = tokens[0];
+                const ownerAddress = coinbase;
+                const spenderAddress = addressWithoutFunds;
+                const allowance = await zeroEx.token.getAllowanceAsync(token.address, ownerAddress, spenderAddress);
+                const expectedAllowance = new BigNumber(0);
+                return expect(allowance).to.be.bignumber.equal(expectedAllowance);
+            });
+        });
+        describe('With web3 provider without accounts', () => {
+            let zeroExWithoutAccounts: ZeroEx;
+            before(async () => {
+                const hasAddresses = false;
+                const web3WithoutAccounts = web3Factory.create(hasAddresses);
+                zeroExWithoutAccounts = new ZeroEx(web3WithoutAccounts.currentProvider);
+            });
+            it('should get the proxy allowance', async () => {
+                const token = tokens[0];
+                const ownerAddress = coinbase;
+                const spenderAddress = addressWithoutFunds;
+
+                const amountInBaseUnits = new BigNumber(50);
+                await zeroEx.token.setAllowanceAsync(token.address, ownerAddress, spenderAddress, amountInBaseUnits);
+
+                const allowance = await zeroExWithoutAccounts.token.getAllowanceAsync(
+                    token.address, ownerAddress, spenderAddress,
+                );
+                const expectedAllowance = amountInBaseUnits;
+                return expect(allowance).to.be.bignumber.equal(expectedAllowance);
+            });
+        });
+    });
+    describe('#getProxyAllowanceAsync', () => {
+        it('should get the proxy allowance', async () => {
+            const token = tokens[0];
+            const ownerAddress = coinbase;
+
+            const amountInBaseUnits = new BigNumber(50);
+            await zeroEx.token.setProxyAllowanceAsync(token.address, ownerAddress, amountInBaseUnits);
+
+            const allowance = await zeroEx.token.getProxyAllowanceAsync(token.address, ownerAddress);
+            const expectedAllowance = amountInBaseUnits;
+            return expect(allowance).to.be.bignumber.equal(expectedAllowance);
+        });
+    });
+    describe('#setProxyAllowanceAsync', () => {
+        it('should set the proxy allowance', async () => {
+            const token = tokens[0];
+            const ownerAddress = coinbase;
+
+            const allowanceBeforeSet = await zeroEx.token.getProxyAllowanceAsync(token.address, ownerAddress);
+            const expectedAllowanceBeforeAllowanceSet = new BigNumber(0);
+            expect(allowanceBeforeSet).to.be.bignumber.equal(expectedAllowanceBeforeAllowanceSet);
+
+            const amountInBaseUnits = new BigNumber(50);
+            await zeroEx.token.setProxyAllowanceAsync(token.address, ownerAddress, amountInBaseUnits);
+
+            const allowanceAfterSet = await zeroEx.token.getProxyAllowanceAsync(token.address, ownerAddress);
+            const expectedAllowanceAfterAllowanceSet = amountInBaseUnits;
+            return expect(allowanceAfterSet).to.be.bignumber.equal(expectedAllowanceAfterAllowanceSet);
+        });
+    });
+    describe('#setUnlimitedProxyAllowanceAsync', () => {
+        it('should set the unlimited proxy allowance', async () => {
+            const token = tokens[0];
+            const ownerAddress = coinbase;
+
+            await zeroEx.token.setUnlimitedProxyAllowanceAsync(token.address, ownerAddress);
+            const allowance = await zeroEx.token.getProxyAllowanceAsync(token.address, ownerAddress);
+            return expect(allowance).to.be.bignumber.equal(zeroEx.token.UNLIMITED_ALLOWANCE_IN_BASE_UNITS);
+        });
+    });
+    describe('#subscribe', () => {
+        const indexFilterValues = {};
+        const shouldThrowOnInsufficientBalanceOrAllowance = true;
+        let tokenAddress: string;
+        const transferAmount = new BigNumber(42);
+        const allowanceAmount = new BigNumber(42);
+        before(() => {
+            const token = tokens[0];
+            tokenAddress = token.address;
+        });
+        afterEach(() => {
+            zeroEx.token.unsubscribeAll();
+        });
+        // Hack: Mocha does not allow a test to be both async and have a `done` callback
+        // Since we need to await the receipt of the event in the `subscribe` callback,
+        // we do need both. A hack is to make the top-level a sync fn w/ a done callback and then
+        // wrap the rest of the test in an async block
+        // Source: https://github.com/mochajs/mocha/issues/2407
+        it('Should receive the Transfer event when tokens are transfered', (done: DoneCallback) => {
+            (async () => {
+                const callback = (err: Error, logEvent: DecodedLogEvent<TransferContractEventArgs>) => {
+                    expect(logEvent).to.not.be.undefined();
+                    const args = logEvent.args;
+                    expect(args._from).to.be.equal(coinbase);
+                    expect(args._to).to.be.equal(addressWithoutFunds);
+                    expect(args._value).to.be.bignumber.equal(transferAmount);
+                    done();
+                };
+                zeroEx.token.subscribe(
+                    tokenAddress, TokenEvents.Transfer, indexFilterValues, callback);
+                await zeroEx.token.transferAsync(tokenAddress, coinbase, addressWithoutFunds, transferAmount);
+            })().catch(done);
+        });
+        it('Should receive the Approval event when allowance is being set', (done: DoneCallback) => {
+            (async () => {
+                const callback = (err: Error, logEvent: DecodedLogEvent<ApprovalContractEventArgs>) => {
+                    expect(logEvent).to.not.be.undefined();
+                    const args = logEvent.args;
+                    expect(args._owner).to.be.equal(coinbase);
+                    expect(args._spender).to.be.equal(addressWithoutFunds);
+                    expect(args._value).to.be.bignumber.equal(allowanceAmount);
+                    done();
+                };
+                zeroEx.token.subscribe(
+                    tokenAddress, TokenEvents.Approval, indexFilterValues, callback);
+                await zeroEx.token.setAllowanceAsync(tokenAddress, coinbase, addressWithoutFunds, allowanceAmount);
+            })().catch(done);
+        });
+        it('Outstanding subscriptions are cancelled when zeroEx.setProviderAsync called', (done: DoneCallback) => {
+            (async () => {
+                const callbackNeverToBeCalled = (err: Error, logEvent: DecodedLogEvent<ApprovalContractEventArgs>) => {
+                    done(new Error('Expected this subscription to have been cancelled'));
+                };
+                zeroEx.token.subscribe(
+                    tokenAddress, TokenEvents.Transfer, indexFilterValues, callbackNeverToBeCalled,
+                );
+                const callbackToBeCalled = (err: Error, logEvent: DecodedLogEvent<ApprovalContractEventArgs>) => {
+                    done();
+                };
+                const newProvider = web3Factory.getRpcProvider();
+                await zeroEx.setProviderAsync(newProvider);
+                zeroEx.token.subscribe(
+                    tokenAddress, TokenEvents.Transfer, indexFilterValues, callbackToBeCalled,
+                );
+                await zeroEx.token.transferAsync(tokenAddress, coinbase, addressWithoutFunds, transferAmount);
+            })().catch(done);
+        });
+        it('Should cancel subscription when unsubscribe called', (done: DoneCallback) => {
+            (async () => {
+                const callbackNeverToBeCalled = (err: Error, logEvent: DecodedLogEvent<ApprovalContractEventArgs>) => {
+                    done(new Error('Expected this subscription to have been cancelled'));
+                };
+                const subscriptionToken = zeroEx.token.subscribe(
+                    tokenAddress, TokenEvents.Transfer, indexFilterValues, callbackNeverToBeCalled);
+                zeroEx.token.unsubscribe(subscriptionToken);
+                await zeroEx.token.transferAsync(tokenAddress, coinbase, addressWithoutFunds, transferAmount);
+                done();
+            })().catch(done);
+        });
+    });
+    describe('#getLogsAsync', () => {
+        let tokenAddress: string;
+        let tokenTransferProxyAddress: string;
+        const subscriptionOpts: SubscriptionOpts = {
+            fromBlock: BlockParamLiteral.Earliest,
+            toBlock: BlockParamLiteral.Latest,
+        };
+        let txHash: string;
+        before(async () => {
+            const token = tokens[0];
+            tokenAddress = token.address;
+            tokenTransferProxyAddress = await zeroEx.proxy.getContractAddressAsync();
+        });
+        it('should get logs with decoded args emitted by Approval', async () => {
+            txHash = await zeroEx.token.setUnlimitedProxyAllowanceAsync(tokenAddress, coinbase);
+            await zeroEx.awaitTransactionMinedAsync(txHash);
+            const eventName = TokenEvents.Approval;
+            const indexFilterValues = {};
+            const logs = await zeroEx.token.getLogsAsync<ApprovalContractEventArgs>(
+                tokenAddress, eventName, subscriptionOpts, indexFilterValues,
+            );
+            expect(logs).to.have.length(1);
+            const args = logs[0].args;
+            expect(logs[0].event).to.be.equal(eventName);
+            expect(args._owner).to.be.equal(coinbase);
+            expect(args._spender).to.be.equal(tokenTransferProxyAddress);
+            expect(args._value).to.be.bignumber.equal(zeroEx.token.UNLIMITED_ALLOWANCE_IN_BASE_UNITS);
+        });
+        it('should only get the logs with the correct event name', async () => {
+            txHash = await zeroEx.token.setUnlimitedProxyAllowanceAsync(tokenAddress, coinbase);
+            await zeroEx.awaitTransactionMinedAsync(txHash);
+            const differentEventName = TokenEvents.Transfer;
+            const indexFilterValues = {};
+            const logs = await zeroEx.token.getLogsAsync(
+                tokenAddress, differentEventName, subscriptionOpts, indexFilterValues,
+            );
+            expect(logs).to.have.length(0);
+        });
+        it('should only get the logs with the correct indexed fields', async () => {
+            txHash = await zeroEx.token.setUnlimitedProxyAllowanceAsync(tokenAddress, coinbase);
+            await zeroEx.awaitTransactionMinedAsync(txHash);
+            txHash = await zeroEx.token.setUnlimitedProxyAllowanceAsync(tokenAddress, addressWithoutFunds);
+            await zeroEx.awaitTransactionMinedAsync(txHash);
+            const eventName = TokenEvents.Approval;
+            const indexFilterValues = {
+                _owner: coinbase,
+            };
+            const logs = await zeroEx.token.getLogsAsync<ApprovalContractEventArgs>(
+                tokenAddress, eventName, subscriptionOpts, indexFilterValues,
+            );
+            expect(logs).to.have.length(1);
+            const args = logs[0].args;
+            expect(args._owner).to.be.equal(coinbase);
+        });
+    });
+});