Merge pull request #1465 from 0xProject/feature/contracts/dutchAuctio…

…nWrapper Dutch Auction Wrapper
0xProject · Jan 8, 2019 · 0ac36ce · 0ac36ce
2 parents 7dda953 + 04db7f0
commit 0ac36ce
Show file tree

Hide file tree

Showing 29 changed files with 1,356 additions and 140 deletions.
diff --git a/contracts/extensions/CHANGELOG.json b/contracts/extensions/CHANGELOG.json
@@ -1,4 +1,13 @@
 [
+    {
+        "version": "1.2.0",
+        "changes": [
+            {
+                "note": "Added Dutch Auction Wrapper",
+                "pr": 1465
+            }
+        ]
+    },
     {
         "version": "1.1.0",
         "changes": [

diff --git a/contracts/extensions/package.json b/contracts/extensions/package.json
@@ -45,6 +45,7 @@
     "homepage": "https://github.com/0xProject/0x-monorepo/contracts/extensions/README.md",
     "devDependencies": {
         "@0x/abi-gen": "^1.0.19",
+        "@0x/contract-wrappers": "^4.1.3",
         "@0x/contracts-test-utils": "^1.0.2",
         "@0x/dev-utils": "^1.0.21",
         "@0x/sol-compiler": "^1.1.16",

diff --git a/contracts/extensions/test/extensions/dutch_auction.ts b/contracts/extensions/test/extensions/dutch_auction.ts
diff --git a/contracts/extensions/test/utils/dutch_auction_test_wrapper.ts b/contracts/extensions/test/utils/dutch_auction_test_wrapper.ts
@@ -0,0 +1,62 @@
+import { artifacts as protocolArtifacts } from '@0x/contracts-protocol';
+import { LogDecoder } from '@0x/contracts-test-utils';
+import { artifacts as tokensArtifacts } from '@0x/contracts-tokens';
+import { DutchAuctionDetails, SignedOrder } from '@0x/types';
+import { Web3Wrapper } from '@0x/web3-wrapper';
+import { Provider, TransactionReceiptWithDecodedLogs } from 'ethereum-types';
+import * as _ from 'lodash';
+
+import { DutchAuctionContract } from '../../generated-wrappers/dutch_auction';
+import { artifacts } from '../../src/artifacts';
+
+export class DutchAuctionTestWrapper {
+    private readonly _dutchAuctionContract: DutchAuctionContract;
+    private readonly _web3Wrapper: Web3Wrapper;
+    private readonly _logDecoder: LogDecoder;
+
+    constructor(contractInstance: DutchAuctionContract, provider: Provider) {
+        this._dutchAuctionContract = contractInstance;
+        this._web3Wrapper = new Web3Wrapper(provider);
+        this._logDecoder = new LogDecoder(this._web3Wrapper, {
+            ...artifacts,
+            ...tokensArtifacts,
+            ...protocolArtifacts,
+        });
+    }
+    /**
+     * Matches the buy and sell orders at an amount given the following: the current block time, the auction
+     * start time and the auction begin amount. The sell order is a an order at the lowest amount
+     * at the end of the auction. Excess from the match is transferred to the seller.
+     * Over time the price moves from beginAmount to endAmount given the current block.timestamp.
+     * @param buyOrder The Buyer's order. This order is for the current expected price of the auction.
+     * @param sellOrder The Seller's order. This order is for the lowest amount (at the end of the auction).
+     * @param from Address the transaction is being sent from.
+     * @return Transaction receipt with decoded logs.
+     */
+    public async matchOrdersAsync(
+        buyOrder: SignedOrder,
+        sellOrder: SignedOrder,
+        from: string,
+    ): Promise<TransactionReceiptWithDecodedLogs> {
+        const txHash = await this._dutchAuctionContract.matchOrders.sendTransactionAsync(
+            buyOrder,
+            sellOrder,
+            buyOrder.signature,
+            sellOrder.signature,
+            {
+                from,
+            },
+        );
+        const tx = await this._logDecoder.getTxWithDecodedLogsAsync(txHash);
+        return tx;
+    }
+    /**
+     * Calculates the Auction Details for the given order
+     * @param sellOrder The Seller's order. This order is for the lowest amount (at the end of the auction).
+     * @return The dutch auction details.
+     */
+    public async getAuctionDetailsAsync(sellOrder: SignedOrder): Promise<DutchAuctionDetails> {
+        const auctionDetails = await this._dutchAuctionContract.getAuctionDetails.callAsync(sellOrder);
+        return auctionDetails;
+    }
+}
diff --git a/packages/0x.js/src/index.ts b/packages/0x.js/src/index.ts
@@ -4,6 +4,7 @@ export { assetDataUtils, signatureUtils, generatePseudoRandomSalt, orderHashUtil
 
 export {
     ContractWrappers,
+    DutchAuctionWrapper,
     ERC20TokenWrapper,
     ERC721TokenWrapper,
     EtherTokenWrapper,
@@ -27,6 +28,7 @@ export {
     OrderAndTraderInfo,
     TraderInfo,
     ValidateOrderFillableOpts,
+    DutchAuctionData,
 } from '@0x/contract-wrappers';
 
 export {
@@ -79,6 +81,7 @@ export {
     OrderStateInvalid,
     OrderState,
     AssetProxyId,
+    AssetData,
     SingleAssetData,
     ERC20AssetData,
     ERC721AssetData,
@@ -88,6 +91,7 @@ export {
     ObjectMap,
     OrderRelevantState,
     Stats,
+    DutchAuctionDetails,
 } from '@0x/types';
 
 export {

diff --git a/packages/abi-gen-wrappers/CHANGELOG.json b/packages/abi-gen-wrappers/CHANGELOG.json
@@ -1,4 +1,13 @@
 [
+    {
+        "version": "2.1.0",
+        "changes": [
+            {
+                "note": "Added Dutch Auction Wrapper",
+                "pr": 1465
+            }
+        ]
+    },
     {
         "version": "2.0.2",
         "changes": [

diff --git a/packages/abi-gen-wrappers/package.json b/packages/abi-gen-wrappers/package.json
@@ -18,7 +18,7 @@
         "generate_contract_wrappers": "abi-gen --abis  ${npm_package_config_abis} --template ../../node_modules/@0x/abi-gen-templates/contract.handlebars --partials '../../node_modules/@0x/abi-gen-templates/partials/**/*.handlebars' --output src/generated-wrappers --backend ethers"
     },
     "config": {
-        "abis": "../contract-artifacts/artifacts/@(AssetProxyOwner|DummyERC20Token|DummyERC721Token|ERC20Proxy|ERC20Token|ERC721Proxy|ERC721Token|Exchange|Forwarder|IValidator|IWallet|OrderValidator|WETH9|ZRXToken).json"
+        "abis": "../contract-artifacts/artifacts/@(AssetProxyOwner|DutchAuction|DummyERC20Token|DummyERC721Token|ERC20Proxy|ERC20Token|ERC721Proxy|ERC721Token|Exchange|Forwarder|IValidator|IWallet|OrderValidator|WETH9|ZRXToken).json"
     },
     "repository": {
         "type": "git",