Merge pull request #413 from 0xProject/feature/ethers-contracts

abi-gen V2 abi and ethers-contracts

8 files changed, 158 insertions, 0 deletions

diff --git a/packages/contract_templates/contract.handlebars b/packages/contract_templates/contract.handlebars
new file mode 100644
index 000000000..b5c2dd9f2
--- /dev/null
+++ b/packages/contract_templates/contract.handlebars
@@ -0,0 +1,46 @@
+/**
+ * This file is auto-generated using abi-gen. Don't edit directly.
+ * Templates can be found at https://github.com/0xProject/0x.js/tree/development/packages/contract_templates.
+ */
+// tslint:disable:no-consecutive-blank-lines
+// tslint:disable-next-line:no-unused-variable
+import { TxData, TxDataPayable } from '@0xproject/types';
+import { BigNumber, classUtils, promisify } from '@0xproject/utils';
+import { BaseContract, Web3Wrapper } from '@0xproject/web3-wrapper';
+import * as ethersContracts from 'ethers-contracts';
+import * as _ from 'lodash';
+import * as Web3 from 'web3';
+
+{{#if events}}
+export type {{contractName}}ContractEventArgs =
+{{#each events}}
+    | {{name}}ContractEventArgs{{#if @last}};{{/if}}
+{{/each}}
+
+export enum {{contractName}}Events {
+    {{#each events}}
+    {{name}} = '{{name}}',
+    {{/each}}
+}
+
+{{#each events}}
+{{> event}}
+
+{{/each}}
+{{/if}}
+
+// tslint:disable:no-parameter-reassignment
+export class {{contractName}}Contract extends BaseContract {
+{{#each methods}}
+    {{#this.constant}}
+    {{> call contractName=../contractName}}
+    {{/this.constant}}
+    {{^this.constant}}
+    {{> tx contractName=../contractName}}
+    {{/this.constant}}
+{{/each}}
+    constructor(web3Wrapper: Web3Wrapper, abi: Web3.ContractAbi, address: string) {
+        super(web3Wrapper, abi, address);
+        classUtils.bindAll(this, ['_ethersInterface', 'address', 'abi', '_web3Wrapper']);
+    }
+} // tslint:disable:max-file-line-count
diff --git a/packages/contract_templates/partials/call.handlebars b/packages/contract_templates/partials/call.handlebars
new file mode 100644
index 000000000..cfb9bea82
--- /dev/null
+++ b/packages/contract_templates/partials/call.handlebars
@@ -0,0 +1,3 @@
+public {{this.name}} = {
+    {{> callAsync}}
+};
diff --git a/packages/contract_templates/partials/callAsync.handlebars b/packages/contract_templates/partials/callAsync.handlebars
new file mode 100644
index 000000000..93d347145
--- /dev/null
+++ b/packages/contract_templates/partials/callAsync.handlebars
@@ -0,0 +1,30 @@
+{{#hasReturnValue}}
+async callAsync(
+{{> typed_params inputs=inputs}}
+{{#this.payable}}
+    txData: TxDataPayable = {},
+{{/this.payable}}
+{{^this.payable}}
+    txData: TxData = {},
+{{/this.payable}}
+    defaultBlock?: Web3.BlockParam,
+): Promise<{{> return_type outputs=outputs}}> {
+    const self = this as {{contractName}}Contract;
+    const inputAbi = _.find(this.abi, {name: '{{this.name}}'}).inputs;
+    [{{> params inputs=inputs}}] = BaseContract._transformABIData(inputAbi, [{{> params inputs=inputs}}], BaseContract._bigNumberToString.bind(this));
+    const encodedData = self._ethersInterface.functions.{{this.name}}(
+        {{> params inputs=inputs}}
+    ).data;
+    const callData = await self._applyDefaultsToTxDataAsync(
+        {
+            data: encodedData,
+        }
+    )
+    const rawCallResult = await self._web3Wrapper.callAsync(callData, defaultBlock);
+    const outputAbi = _.find(this.abi, {name: '{{this.name}}'}).outputs as Web3.DataItem[];
+    const outputParamsTypes = _.map(outputAbi, 'type');
+    let resultArray = ethersContracts.Interface.decodeParams(outputParamsTypes, rawCallResult) as any;
+    resultArray = BaseContract._transformABIData(outputAbi, resultArray, BaseContract._lowercaseAddress.bind(this));
+    return resultArray{{#singleReturnValue}}[0]{{/singleReturnValue}};
+},
+{{/hasReturnValue}}
diff --git a/packages/contract_templates/partials/event.handlebars b/packages/contract_templates/partials/event.handlebars
new file mode 100644
index 000000000..3c6100e4f
--- /dev/null
+++ b/packages/contract_templates/partials/event.handlebars
@@ -0,0 +1,5 @@
+export interface {{name}}ContractEventArgs {
+    {{#each inputs}}
+    {{name}}: {{#returnType type components}}{{/returnType}};
+    {{/each}}
+}
diff --git a/packages/contract_templates/partials/params.handlebars b/packages/contract_templates/partials/params.handlebars
new file mode 100644
index 000000000..ac5d4ae85
--- /dev/null
+++ b/packages/contract_templates/partials/params.handlebars
@@ -0,0 +1,3 @@
+{{#each inputs}}
+{{name}},
+{{/each}}
diff --git a/packages/contract_templates/partials/return_type.handlebars b/packages/contract_templates/partials/return_type.handlebars
new file mode 100644
index 000000000..9dd509953
--- /dev/null
+++ b/packages/contract_templates/partials/return_type.handlebars
@@ -0,0 +1,10 @@
+{{#if outputs.length}}
+{{#singleReturnValue}}
+{{#returnType outputs.0.type components}}{{/returnType}}
+{{/singleReturnValue}}
+{{^singleReturnValue}}
+[{{#each outputs}}{{#returnType type components}}{{/returnType}}{{#unless @last}}, {{/unless}}{{/each}}]
+{{/singleReturnValue}}
+{{else}}
+void
+{{/if}}
diff --git a/packages/contract_templates/partials/tx.handlebars b/packages/contract_templates/partials/tx.handlebars
new file mode 100644
index 000000000..347a482d6
--- /dev/null
+++ b/packages/contract_templates/partials/tx.handlebars
@@ -0,0 +1,58 @@
+public {{this.name}} = {
+    async sendTransactionAsync(
+    {{> typed_params inputs=inputs}}
+    {{#this.payable}}
+        txData: TxDataPayable = {},
+    {{/this.payable}}
+    {{^this.payable}}
+        txData: TxData = {},
+    {{/this.payable}}
+    ): Promise<string> {
+        const self = this as {{contractName}}Contract;
+        const inputAbi = _.find(this.abi, {name: '{{this.name}}'}).inputs;
+        [{{> params inputs=inputs}}] = BaseContract._transformABIData(inputAbi, [{{> params inputs=inputs}}], BaseContract._bigNumberToString.bind(this));
+        const encodedData = this._ethersInterface.functions.{{this.name}}(
+            {{> params inputs=inputs}}
+        ).data
+        const txDataWithDefaults = await self._applyDefaultsToTxDataAsync(
+            {
+                ...txData,
+                data: encodedData,
+            },
+            self.{{this.name}}.estimateGasAsync.bind(
+                self,
+                {{> params inputs=inputs}}
+            ),
+        );
+        const txHash = await this._web3Wrapper.sendTransactionAsync(txDataWithDefaults);
+        return txHash;
+    },
+    async estimateGasAsync(
+    {{> typed_params inputs=inputs}}
+        txData: TxData = {},
+    ): Promise<number> {
+        const self = this as {{contractName}}Contract;
+        const encodedData = this._ethersInterface.functions.{{this.name}}(
+            {{> params inputs=inputs}}
+        ).data
+        const txDataWithDefaults = await self._applyDefaultsToTxDataAsync(
+            {
+                ...txData,
+                data: encodedData,
+            }
+        );
+        const gas = await this._web3Wrapper.estimateGasAsync(txDataWithDefaults);
+        return gas;
+    },
+    getABIEncodedTransactionData(
+    {{> typed_params inputs=inputs}}
+        txData: TxData = {},
+    ): string {
+        const self = this as {{contractName}}Contract;
+        const abiEncodedTransactionData = this._ethersInterface.functions.{{this.name}}(
+            {{> params inputs=inputs}}
+        ).data
+        return abiEncodedTransactionData;
+    },
+    {{> callAsync}}
+};
diff --git a/packages/contract_templates/partials/typed_params.handlebars b/packages/contract_templates/partials/typed_params.handlebars
new file mode 100644
index 000000000..c100e58f7
--- /dev/null
+++ b/packages/contract_templates/partials/typed_params.handlebars
@@ -0,0 +1,3 @@
+{{#each inputs}}
+    {{name}}: {{#parameterType type components}}{{/parameterType}},
+{{/each}}