chore: Move to new structure

1 files changed, 486 insertions, 0 deletions

diff --git a/contracts/core/test/extensions/dutch_auction.ts b/contracts/core/test/extensions/dutch_auction.ts
new file mode 100644
index 000000000..c133d8c60
--- /dev/null
+++ b/contracts/core/test/extensions/dutch_auction.ts
@@ -0,0 +1,486 @@
+import { BlockchainLifecycle } from '@0x/dev-utils';
+import { assetDataUtils, generatePseudoRandomSalt } from '@0x/order-utils';
+import { RevertReason, SignedOrder } from '@0x/types';
+import { BigNumber } from '@0x/utils';
+import { Web3Wrapper } from '@0x/web3-wrapper';
+import * as chai from 'chai';
+import ethAbi = require('ethereumjs-abi');
+import * as ethUtil from 'ethereumjs-util';
+import * as _ from 'lodash';
+
+import { DummyERC20TokenContract } from '../../generated-wrappers/dummy_erc20_token';
+import { DummyERC721TokenContract } from '../../generated-wrappers/dummy_erc721_token';
+import { DutchAuctionContract } from '../../generated-wrappers/dutch_auction';
+import { ExchangeContract } from '../../generated-wrappers/exchange';
+import { WETH9Contract } from '../../generated-wrappers/weth9';
+import { artifacts } from '../../src/artifacts';
+import { expectTransactionFailedAsync } from '../utils/assertions';
+import { getLatestBlockTimestampAsync } from '../utils/block_timestamp';
+import { chaiSetup } from '../utils/chai_setup';
+import { constants } from '../utils/constants';
+import { ERC20Wrapper } from '../utils/erc20_wrapper';
+import { ERC721Wrapper } from '../utils/erc721_wrapper';
+import { ExchangeWrapper } from '../utils/exchange_wrapper';
+import { OrderFactory } from '../utils/order_factory';
+import { ContractName, ERC20BalancesByOwner } from '../utils/types';
+import { provider, txDefaults, web3Wrapper } from '../utils/web3_wrapper';
+
+chaiSetup.configure();
+const expect = chai.expect;
+const blockchainLifecycle = new BlockchainLifecycle(web3Wrapper);
+const DECIMALS_DEFAULT = 18;
+
+describe(ContractName.DutchAuction, () => {
+    let makerAddress: string;
+    let owner: string;
+    let takerAddress: string;
+    let feeRecipientAddress: string;
+    let defaultMakerAssetAddress: string;
+
+    let zrxToken: DummyERC20TokenContract;
+    let erc20TokenA: DummyERC20TokenContract;
+    let erc721Token: DummyERC721TokenContract;
+    let dutchAuctionContract: DutchAuctionContract;
+    let wethContract: WETH9Contract;
+
+    let sellerOrderFactory: OrderFactory;
+    let buyerOrderFactory: OrderFactory;
+    let erc20Wrapper: ERC20Wrapper;
+    let erc20Balances: ERC20BalancesByOwner;
+    let currentBlockTimestamp: number;
+    let auctionBeginTimeSeconds: BigNumber;
+    let auctionEndTimeSeconds: BigNumber;
+    let auctionBeginAmount: BigNumber;
+    let auctionEndAmount: BigNumber;
+    let sellOrder: SignedOrder;
+    let buyOrder: SignedOrder;
+    let erc721MakerAssetIds: BigNumber[];
+    const tenMinutesInSeconds = 10 * 60;
+
+    async function increaseTimeAsync(): Promise<void> {
+        const timestampBefore = await getLatestBlockTimestampAsync();
+        await web3Wrapper.increaseTimeAsync(5);
+        const timestampAfter = await getLatestBlockTimestampAsync();
+        // HACK send some transactions when a time increase isn't supported
+        if (timestampAfter === timestampBefore) {
+            await web3Wrapper.sendTransactionAsync({ to: makerAddress, from: makerAddress, value: new BigNumber(1) });
+        }
+    }
+
+    function extendMakerAssetData(makerAssetData: string, beginTimeSeconds: BigNumber, beginAmount: BigNumber): string {
+        return ethUtil.bufferToHex(
+            Buffer.concat([
+                ethUtil.toBuffer(makerAssetData),
+                ethUtil.toBuffer(
+                    (ethAbi as any).rawEncode(
+                        ['uint256', 'uint256'],
+                        [beginTimeSeconds.toString(), beginAmount.toString()],
+                    ),
+                ),
+            ]),
+        );
+    }
+
+    before(async () => {
+        await blockchainLifecycle.startAsync();
+        const accounts = await web3Wrapper.getAvailableAddressesAsync();
+        const usedAddresses = ([owner, makerAddress, takerAddress, feeRecipientAddress] = accounts);
+
+        erc20Wrapper = new ERC20Wrapper(provider, usedAddresses, owner);
+
+        const numDummyErc20ToDeploy = 2;
+        [erc20TokenA, zrxToken] = await erc20Wrapper.deployDummyTokensAsync(
+            numDummyErc20ToDeploy,
+            constants.DUMMY_TOKEN_DECIMALS,
+        );
+        const erc20Proxy = await erc20Wrapper.deployProxyAsync();
+        await erc20Wrapper.setBalancesAndAllowancesAsync();
+
+        const erc721Wrapper = new ERC721Wrapper(provider, usedAddresses, owner);
+        [erc721Token] = await erc721Wrapper.deployDummyTokensAsync();
+        const erc721Proxy = await erc721Wrapper.deployProxyAsync();
+        await erc721Wrapper.setBalancesAndAllowancesAsync();
+        const erc721Balances = await erc721Wrapper.getBalancesAsync();
+        erc721MakerAssetIds = erc721Balances[makerAddress][erc721Token.address];
+
+        wethContract = await WETH9Contract.deployFrom0xArtifactAsync(artifacts.WETH9, provider, txDefaults);
+        erc20Wrapper.addDummyTokenContract(wethContract as any);
+
+        const zrxAssetData = assetDataUtils.encodeERC20AssetData(zrxToken.address);
+        const exchangeInstance = await ExchangeContract.deployFrom0xArtifactAsync(
+            artifacts.Exchange,
+            provider,
+            txDefaults,
+            zrxAssetData,
+        );
+        const exchangeWrapper = new ExchangeWrapper(exchangeInstance, provider);
+        await exchangeWrapper.registerAssetProxyAsync(erc20Proxy.address, owner);
+        await exchangeWrapper.registerAssetProxyAsync(erc721Proxy.address, owner);
+
+        await erc20Proxy.addAuthorizedAddress.sendTransactionAsync(exchangeInstance.address, {
+            from: owner,
+        });
+        await erc721Proxy.addAuthorizedAddress.sendTransactionAsync(exchangeInstance.address, {
+            from: owner,
+        });
+
+        const dutchAuctionInstance = await DutchAuctionContract.deployFrom0xArtifactAsync(
+            artifacts.DutchAuction,
+            provider,
+            txDefaults,
+            exchangeInstance.address,
+        );
+        dutchAuctionContract = new DutchAuctionContract(
+            dutchAuctionInstance.abi,
+            dutchAuctionInstance.address,
+            provider,
+        );
+
+        defaultMakerAssetAddress = erc20TokenA.address;
+        const defaultTakerAssetAddress = wethContract.address;
+
+        // Set up taker WETH balance and allowance
+        await web3Wrapper.awaitTransactionSuccessAsync(
+            await wethContract.deposit.sendTransactionAsync({
+                from: takerAddress,
+                value: Web3Wrapper.toBaseUnitAmount(new BigNumber(50), DECIMALS_DEFAULT),
+            }),
+        );
+        await web3Wrapper.awaitTransactionSuccessAsync(
+            await wethContract.approve.sendTransactionAsync(
+                erc20Proxy.address,
+                constants.UNLIMITED_ALLOWANCE_IN_BASE_UNITS,
+                { from: takerAddress },
+            ),
+        );
+        web3Wrapper.abiDecoder.addABI(exchangeInstance.abi);
+        web3Wrapper.abiDecoder.addABI(zrxToken.abi);
+        erc20Wrapper.addTokenOwnerAddress(dutchAuctionContract.address);
+
+        currentBlockTimestamp = await getLatestBlockTimestampAsync();
+        // Default auction begins 10 minutes ago
+        auctionBeginTimeSeconds = new BigNumber(currentBlockTimestamp).minus(tenMinutesInSeconds);
+        // Default auction ends 10 from now
+        auctionEndTimeSeconds = new BigNumber(currentBlockTimestamp).plus(tenMinutesInSeconds);
+        auctionBeginAmount = Web3Wrapper.toBaseUnitAmount(new BigNumber(10), DECIMALS_DEFAULT);
+        auctionEndAmount = Web3Wrapper.toBaseUnitAmount(new BigNumber(1), DECIMALS_DEFAULT);
+
+        // Default sell order and buy order are exact mirrors
+        const sellerDefaultOrderParams = {
+            salt: generatePseudoRandomSalt(),
+            exchangeAddress: exchangeInstance.address,
+            makerAddress,
+            feeRecipientAddress,
+            // taker address or sender address should be set to the ducth auction contract
+            takerAddress: dutchAuctionContract.address,
+            makerAssetData: extendMakerAssetData(
+                assetDataUtils.encodeERC20AssetData(defaultMakerAssetAddress),
+                auctionBeginTimeSeconds,
+                auctionBeginAmount,
+            ),
+            takerAssetData: assetDataUtils.encodeERC20AssetData(defaultTakerAssetAddress),
+            makerAssetAmount: Web3Wrapper.toBaseUnitAmount(new BigNumber(200), DECIMALS_DEFAULT),
+            takerAssetAmount: auctionEndAmount,
+            expirationTimeSeconds: auctionEndTimeSeconds,
+            makerFee: constants.ZERO_AMOUNT,
+            takerFee: constants.ZERO_AMOUNT,
+        };
+        // Default buy order is for the auction begin price
+        const buyerDefaultOrderParams = {
+            ...sellerDefaultOrderParams,
+            makerAddress: takerAddress,
+            makerAssetData: sellerDefaultOrderParams.takerAssetData,
+            takerAssetData: sellerDefaultOrderParams.makerAssetData,
+            makerAssetAmount: auctionBeginAmount,
+            takerAssetAmount: sellerDefaultOrderParams.makerAssetAmount,
+        };
+        const makerPrivateKey = constants.TESTRPC_PRIVATE_KEYS[accounts.indexOf(makerAddress)];
+        const takerPrivateKey = constants.TESTRPC_PRIVATE_KEYS[accounts.indexOf(takerAddress)];
+        sellerOrderFactory = new OrderFactory(makerPrivateKey, sellerDefaultOrderParams);
+        buyerOrderFactory = new OrderFactory(takerPrivateKey, buyerDefaultOrderParams);
+    });
+    after(async () => {
+        await blockchainLifecycle.revertAsync();
+    });
+    beforeEach(async () => {
+        await blockchainLifecycle.startAsync();
+        erc20Balances = await erc20Wrapper.getBalancesAsync();
+        sellOrder = await sellerOrderFactory.newSignedOrderAsync();
+        buyOrder = await buyerOrderFactory.newSignedOrderAsync();
+    });
+    afterEach(async () => {
+        await blockchainLifecycle.revertAsync();
+    });
+    describe('matchOrders', () => {
+        it('should be worth the begin price at the begining of the auction', async () => {
+            auctionBeginTimeSeconds = new BigNumber(currentBlockTimestamp + 2);
+            sellOrder = await sellerOrderFactory.newSignedOrderAsync({
+                makerAssetData: extendMakerAssetData(
+                    assetDataUtils.encodeERC20AssetData(defaultMakerAssetAddress),
+                    auctionBeginTimeSeconds,
+                    auctionBeginAmount,
+                ),
+            });
+            const auctionDetails = await dutchAuctionContract.getAuctionDetails.callAsync(sellOrder);
+            expect(auctionDetails.currentAmount).to.be.bignumber.equal(auctionBeginAmount);
+            expect(auctionDetails.beginAmount).to.be.bignumber.equal(auctionBeginAmount);
+        });
+        it('should be be worth the end price at the end of the auction', async () => {
+            auctionBeginTimeSeconds = new BigNumber(currentBlockTimestamp - tenMinutesInSeconds * 2);
+            auctionEndTimeSeconds = new BigNumber(currentBlockTimestamp - tenMinutesInSeconds);
+            sellOrder = await sellerOrderFactory.newSignedOrderAsync({
+                makerAssetData: extendMakerAssetData(
+                    assetDataUtils.encodeERC20AssetData(defaultMakerAssetAddress),
+                    auctionBeginTimeSeconds,
+                    auctionBeginAmount,
+                ),
+                expirationTimeSeconds: auctionEndTimeSeconds,
+            });
+            const auctionDetails = await dutchAuctionContract.getAuctionDetails.callAsync(sellOrder);
+            expect(auctionDetails.currentAmount).to.be.bignumber.equal(auctionEndAmount);
+            expect(auctionDetails.beginAmount).to.be.bignumber.equal(auctionBeginAmount);
+        });
+        it('should match orders at current amount and send excess to buyer', async () => {
+            const beforeAuctionDetails = await dutchAuctionContract.getAuctionDetails.callAsync(sellOrder);
+            buyOrder = await buyerOrderFactory.newSignedOrderAsync({
+                makerAssetAmount: beforeAuctionDetails.currentAmount.times(2),
+            });
+            await web3Wrapper.awaitTransactionSuccessAsync(
+                await dutchAuctionContract.matchOrders.sendTransactionAsync(
+                    buyOrder,
+                    sellOrder,
+                    buyOrder.signature,
+                    sellOrder.signature,
+                    {
+                        from: takerAddress,
+                    },
+                ),
+            );
+            const afterAuctionDetails = await dutchAuctionContract.getAuctionDetails.callAsync(sellOrder);
+            const newBalances = await erc20Wrapper.getBalancesAsync();
+            expect(newBalances[dutchAuctionContract.address][wethContract.address]).to.be.bignumber.equal(
+                constants.ZERO_AMOUNT,
+            );
+            // HACK gte used here due to a bug in ganache where the timestamp can change
+            // between multiple calls to the same block. Which can move the amount in our case
+            // ref: https://github.com/trufflesuite/ganache-core/issues/111
+            expect(newBalances[makerAddress][wethContract.address]).to.be.bignumber.gte(
+                erc20Balances[makerAddress][wethContract.address].plus(afterAuctionDetails.currentAmount),
+            );
+            expect(newBalances[takerAddress][wethContract.address]).to.be.bignumber.gte(
+                erc20Balances[takerAddress][wethContract.address].minus(beforeAuctionDetails.currentAmount),
+            );
+        });
+        it('should have valid getAuctionDetails at some block in the future', async () => {
+            let auctionDetails = await dutchAuctionContract.getAuctionDetails.callAsync(sellOrder);
+            const beforeAmount = auctionDetails.currentAmount;
+            await increaseTimeAsync();
+            auctionDetails = await dutchAuctionContract.getAuctionDetails.callAsync(sellOrder);
+            const currentAmount = auctionDetails.currentAmount;
+            expect(beforeAmount).to.be.bignumber.greaterThan(currentAmount);
+
+            buyOrder = await buyerOrderFactory.newSignedOrderAsync({
+                makerAssetAmount: currentAmount,
+            });
+            const txHash = await dutchAuctionContract.matchOrders.sendTransactionAsync(
+                buyOrder,
+                sellOrder,
+                buyOrder.signature,
+                sellOrder.signature,
+                {
+                    from: takerAddress,
+                    // HACK geth seems to miscalculate the gas required intermittently
+                    gas: 400000,
+                },
+            );
+            await web3Wrapper.awaitTransactionSuccessAsync(txHash);
+            const newBalances = await erc20Wrapper.getBalancesAsync();
+            expect(newBalances[makerAddress][wethContract.address]).to.be.bignumber.equal(
+                erc20Balances[makerAddress][wethContract.address].plus(currentAmount),
+            );
+        });
+        it('maker fees on sellOrder are paid to the fee receipient', async () => {
+            sellOrder = await sellerOrderFactory.newSignedOrderAsync({
+                makerFee: new BigNumber(1),
+            });
+            const txHash = await dutchAuctionContract.matchOrders.sendTransactionAsync(
+                buyOrder,
+                sellOrder,
+                buyOrder.signature,
+                sellOrder.signature,
+                {
+                    from: takerAddress,
+                },
+            );
+            await web3Wrapper.awaitTransactionSuccessAsync(txHash);
+            const afterAuctionDetails = await dutchAuctionContract.getAuctionDetails.callAsync(sellOrder);
+            const newBalances = await erc20Wrapper.getBalancesAsync();
+            expect(newBalances[makerAddress][wethContract.address]).to.be.bignumber.gte(
+                erc20Balances[makerAddress][wethContract.address].plus(afterAuctionDetails.currentAmount),
+            );
+            expect(newBalances[feeRecipientAddress][zrxToken.address]).to.be.bignumber.equal(
+                erc20Balances[feeRecipientAddress][zrxToken.address].plus(sellOrder.makerFee),
+            );
+        });
+        it('maker fees on buyOrder are paid to the fee receipient', async () => {
+            buyOrder = await buyerOrderFactory.newSignedOrderAsync({
+                makerFee: new BigNumber(1),
+            });
+            const txHash = await dutchAuctionContract.matchOrders.sendTransactionAsync(
+                buyOrder,
+                sellOrder,
+                buyOrder.signature,
+                sellOrder.signature,
+                {
+                    from: takerAddress,
+                },
+            );
+            await web3Wrapper.awaitTransactionSuccessAsync(txHash);
+            const newBalances = await erc20Wrapper.getBalancesAsync();
+            const afterAuctionDetails = await dutchAuctionContract.getAuctionDetails.callAsync(sellOrder);
+            expect(newBalances[makerAddress][wethContract.address]).to.be.bignumber.gte(
+                erc20Balances[makerAddress][wethContract.address].plus(afterAuctionDetails.currentAmount),
+            );
+            expect(newBalances[feeRecipientAddress][zrxToken.address]).to.be.bignumber.equal(
+                erc20Balances[feeRecipientAddress][zrxToken.address].plus(buyOrder.makerFee),
+            );
+        });
+        it('should revert when auction expires', async () => {
+            auctionBeginTimeSeconds = new BigNumber(currentBlockTimestamp - tenMinutesInSeconds * 2);
+            auctionEndTimeSeconds = new BigNumber(currentBlockTimestamp - tenMinutesInSeconds);
+            sellOrder = await sellerOrderFactory.newSignedOrderAsync({
+                expirationTimeSeconds: auctionEndTimeSeconds,
+                makerAssetData: extendMakerAssetData(
+                    assetDataUtils.encodeERC20AssetData(defaultMakerAssetAddress),
+                    auctionBeginTimeSeconds,
+                    auctionBeginAmount,
+                ),
+            });
+            return expectTransactionFailedAsync(
+                dutchAuctionContract.matchOrders.sendTransactionAsync(
+                    buyOrder,
+                    sellOrder,
+                    buyOrder.signature,
+                    sellOrder.signature,
+                    {
+                        from: takerAddress,
+                    },
+                ),
+                RevertReason.AuctionExpired,
+            );
+        });
+        it('cannot be filled for less than the current price', async () => {
+            await increaseTimeAsync();
+            buyOrder = await buyerOrderFactory.newSignedOrderAsync({
+                makerAssetAmount: sellOrder.takerAssetAmount,
+            });
+            return expectTransactionFailedAsync(
+                dutchAuctionContract.matchOrders.sendTransactionAsync(
+                    buyOrder,
+                    sellOrder,
+                    buyOrder.signature,
+                    sellOrder.signature,
+                    {
+                        from: takerAddress,
+                    },
+                ),
+                RevertReason.AuctionInvalidAmount,
+            );
+        });
+        it('auction begin amount must be higher than final amount ', async () => {
+            sellOrder = await sellerOrderFactory.newSignedOrderAsync({
+                takerAssetAmount: auctionBeginAmount.plus(1),
+            });
+            return expectTransactionFailedAsync(
+                dutchAuctionContract.matchOrders.sendTransactionAsync(
+                    buyOrder,
+                    sellOrder,
+                    buyOrder.signature,
+                    sellOrder.signature,
+                    {
+                        from: takerAddress,
+                    },
+                ),
+                RevertReason.AuctionInvalidAmount,
+            );
+        });
+        it('begin time is less than end time', async () => {
+            auctionBeginTimeSeconds = new BigNumber(auctionEndTimeSeconds).plus(tenMinutesInSeconds);
+            sellOrder = await sellerOrderFactory.newSignedOrderAsync({
+                expirationTimeSeconds: auctionEndTimeSeconds,
+                makerAssetData: extendMakerAssetData(
+                    assetDataUtils.encodeERC20AssetData(defaultMakerAssetAddress),
+                    auctionBeginTimeSeconds,
+                    auctionBeginAmount,
+                ),
+            });
+            return expectTransactionFailedAsync(
+                dutchAuctionContract.matchOrders.sendTransactionAsync(
+                    buyOrder,
+                    sellOrder,
+                    buyOrder.signature,
+                    sellOrder.signature,
+                    {
+                        from: takerAddress,
+                    },
+                ),
+                RevertReason.AuctionInvalidBeginTime,
+            );
+        });
+        it('asset data contains auction parameters', async () => {
+            sellOrder = await sellerOrderFactory.newSignedOrderAsync({
+                makerAssetData: assetDataUtils.encodeERC20AssetData(defaultMakerAssetAddress),
+            });
+            return expectTransactionFailedAsync(
+                dutchAuctionContract.matchOrders.sendTransactionAsync(
+                    buyOrder,
+                    sellOrder,
+                    buyOrder.signature,
+                    sellOrder.signature,
+                    {
+                        from: takerAddress,
+                    },
+                ),
+                RevertReason.InvalidAssetData,
+            );
+        });
+        describe('ERC721', () => {
+            it('should match orders when ERC721', async () => {
+                const makerAssetId = erc721MakerAssetIds[0];
+                sellOrder = await sellerOrderFactory.newSignedOrderAsync({
+                    makerAssetAmount: new BigNumber(1),
+                    makerAssetData: extendMakerAssetData(
+                        assetDataUtils.encodeERC721AssetData(erc721Token.address, makerAssetId),
+                        auctionBeginTimeSeconds,
+                        auctionBeginAmount,
+                    ),
+                });
+                buyOrder = await buyerOrderFactory.newSignedOrderAsync({
+                    takerAssetAmount: new BigNumber(1),
+                    takerAssetData: sellOrder.makerAssetData,
+                });
+                await web3Wrapper.awaitTransactionSuccessAsync(
+                    await dutchAuctionContract.matchOrders.sendTransactionAsync(
+                        buyOrder,
+                        sellOrder,
+                        buyOrder.signature,
+                        sellOrder.signature,
+                        {
+                            from: takerAddress,
+                        },
+                    ),
+                );
+                const afterAuctionDetails = await dutchAuctionContract.getAuctionDetails.callAsync(sellOrder);
+                const newBalances = await erc20Wrapper.getBalancesAsync();
+                // HACK gte used here due to a bug in ganache where the timestamp can change
+                // between multiple calls to the same block. Which can move the amount in our case
+                // ref: https://github.com/trufflesuite/ganache-core/issues/111
+                expect(newBalances[makerAddress][wethContract.address]).to.be.bignumber.gte(
+                    erc20Balances[makerAddress][wethContract.address].plus(afterAuctionDetails.currentAmount),
+                );
+                const newOwner = await erc721Token.ownerOf.callAsync(makerAssetId);
+                expect(newOwner).to.be.bignumber.equal(takerAddress);
+            });
+        });
+    });
+});