aboutsummaryrefslogtreecommitdiffstats
path: root/packages/abi-gen-templates
diff options
context:
space:
mode:
Diffstat (limited to 'packages/abi-gen-templates')
-rw-r--r--packages/abi-gen-templates/CHANGELOG.json11
-rw-r--r--packages/abi-gen-templates/README.md17
-rw-r--r--packages/abi-gen-templates/contract.handlebars91
-rw-r--r--packages/abi-gen-templates/package.json20
-rw-r--r--packages/abi-gen-templates/partials/call.handlebars3
-rw-r--r--packages/abi-gen-templates/partials/callAsync.handlebars28
-rw-r--r--packages/abi-gen-templates/partials/event.handlebars5
-rw-r--r--packages/abi-gen-templates/partials/params.handlebars3
-rw-r--r--packages/abi-gen-templates/partials/return_type.handlebars10
-rw-r--r--packages/abi-gen-templates/partials/tx.handlebars60
-rw-r--r--packages/abi-gen-templates/partials/typed_params.handlebars3
11 files changed, 251 insertions, 0 deletions
diff --git a/packages/abi-gen-templates/CHANGELOG.json b/packages/abi-gen-templates/CHANGELOG.json
new file mode 100644
index 000000000..adf615b3b
--- /dev/null
+++ b/packages/abi-gen-templates/CHANGELOG.json
@@ -0,0 +1,11 @@
+[
+ {
+ "version": "1.0.0",
+ "changes": [
+ {
+ "note": "Initial publish",
+ "pr": 1305
+ }
+ ]
+ }
+]
diff --git a/packages/abi-gen-templates/README.md b/packages/abi-gen-templates/README.md
new file mode 100644
index 000000000..c6cc3b1b3
--- /dev/null
+++ b/packages/abi-gen-templates/README.md
@@ -0,0 +1,17 @@
+These templates are used with [abi-gen](https://github.com/0xProject/0x-monorepo/tree/development/packages/abi-gen).
+
+To successfully compile the generated TypeScript contract wrappers, you must:
+
+* Install the packages on which the main contract template directly depends: `yarn add @0x/base-contract @0x/sol-compiler @0x/utils @0x/web3-wrapper ethereum-types ethers lodash`
+* Install the packages on which the main contract template *in*directly depends: `yarn add @types/lodash`
+* Ensure that your TypeScript configuration includes the following:
+
+```
+"compilerOptions": {
+ "lib": ["ES2015"],
+ "typeRoots": [
+ "node_modules/@0x/typescript-typings/types",
+ "node_modules/@types"
+ ]
+}
+```
diff --git a/packages/abi-gen-templates/contract.handlebars b/packages/abi-gen-templates/contract.handlebars
new file mode 100644
index 000000000..9b2a2b336
--- /dev/null
+++ b/packages/abi-gen-templates/contract.handlebars
@@ -0,0 +1,91 @@
+// tslint:disable:no-consecutive-blank-lines ordered-imports align trailing-comma whitespace class-name
+// tslint:disable:no-unused-variable
+// tslint:disable:no-unbound-method
+import { BaseContract } from '@0x/base-contract';
+import { BlockParam, BlockParamLiteral, CallData, ContractAbi, ContractArtifact, DecodedLogArgs, MethodAbi, Provider, TxData, TxDataPayable } from 'ethereum-types';
+import { BigNumber, classUtils, logUtils } from '@0x/utils';
+import { SimpleContractArtifact } from '@0x/types';
+import { Web3Wrapper } from '@0x/web3-wrapper';
+import * as ethers from 'ethers';
+import * as _ from 'lodash';
+// tslint:enable:no-unused-variable
+
+{{#if events}}
+export type {{contractName}}EventArgs =
+{{#each events}}
+ | {{@root.contractName}}{{name}}EventArgs{{#if @last}};{{/if}}
+{{/each}}
+
+export enum {{contractName}}Events {
+ {{#each events}}
+ {{name}} = '{{name}}',
+ {{/each}}
+}
+
+{{#each events}}
+{{> event}}
+
+{{/each}}
+{{/if}}
+
+/* istanbul ignore next */
+// tslint:disable:no-parameter-reassignment
+// tslint:disable-next-line:class-name
+export class {{contractName}}Contract extends BaseContract {
+{{#each methods}}
+ {{#this.constant}}
+ {{> call contractName=../contractName}}
+ {{/this.constant}}
+ {{^this.constant}}
+ {{> tx contractName=../contractName}}
+ {{/this.constant}}
+{{/each}}
+ public static async deployFrom0xArtifactAsync(
+ artifact: ContractArtifact | SimpleContractArtifact,
+ provider: Provider,
+ txDefaults: Partial<TxData>,
+ {{> typed_params inputs=ctor.inputs}}
+ ): Promise<{{contractName}}Contract> {
+ if (_.isUndefined(artifact.compilerOutput)) {
+ throw new Error('Compiler output not found in the artifact file');
+ }
+ const bytecode = artifact.compilerOutput.evm.bytecode.object;
+ const abi = artifact.compilerOutput.abi;
+ return {{contractName}}Contract.deployAsync(bytecode, abi, provider, txDefaults, {{> params inputs=ctor.inputs}});
+ }
+ public static async deployAsync(
+ bytecode: string,
+ abi: ContractAbi,
+ provider: Provider,
+ txDefaults: Partial<TxData>,
+ {{> typed_params inputs=ctor.inputs}}
+ ): Promise<{{contractName}}Contract> {
+ const constructorAbi = BaseContract._lookupConstructorAbi(abi);
+ [{{> params inputs=ctor.inputs}}] = BaseContract._formatABIDataItemList(
+ constructorAbi.inputs,
+ [{{> params inputs=ctor.inputs}}],
+ BaseContract._bigNumberToString,
+ );
+ const iface = new ethers.utils.Interface(abi);
+ const deployInfo = iface.deployFunction;
+ const txData = deployInfo.encode(bytecode, [{{> params inputs=ctor.inputs}}]);
+ const web3Wrapper = new Web3Wrapper(provider);
+ const txDataWithDefaults = await BaseContract._applyDefaultsToTxDataAsync(
+ {data: txData},
+ txDefaults,
+ web3Wrapper.estimateGasAsync.bind(web3Wrapper),
+ );
+ const txHash = await web3Wrapper.sendTransactionAsync(txDataWithDefaults);
+ logUtils.log(`transactionHash: ${txHash}`);
+ const txReceipt = await web3Wrapper.awaitTransactionSuccessAsync(txHash);
+ logUtils.log(`{{contractName}} successfully deployed at ${txReceipt.contractAddress}`);
+ const contractInstance = new {{contractName}}Contract(abi, txReceipt.contractAddress as string, provider, txDefaults);
+ contractInstance.constructorArgs = [{{> params inputs=ctor.inputs}}];
+ return contractInstance;
+ }
+ constructor(abi: ContractAbi, address: string, provider: Provider, txDefaults?: Partial<TxData>) {
+ super('{{contractName}}', abi, address, provider, txDefaults);
+ classUtils.bindAll(this, ['_ethersInterfacesByFunctionSignature', 'address', 'abi', '_web3Wrapper']);
+ }
+} // tslint:disable:max-file-line-count
+// tslint:enable:no-unbound-method
diff --git a/packages/abi-gen-templates/package.json b/packages/abi-gen-templates/package.json
new file mode 100644
index 000000000..e06be6127
--- /dev/null
+++ b/packages/abi-gen-templates/package.json
@@ -0,0 +1,20 @@
+{
+ "name": "@0x/abi-gen-templates",
+ "version": "1.0.0",
+ "engines": {
+ "node": ">=6.12"
+ },
+ "description": "Handlebars templates used by abi-gen to generate contract-wrappers",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/0xProject/0x-monorepo.git"
+ },
+ "license": "Apache-2.0",
+ "bugs": {
+ "url": "https://github.com/0xProject/0x-monorepo/issues"
+ },
+ "homepage": "https://github.com/0xProject/0x-monorepo/packages/abi-gen-templates/README.md",
+ "publishConfig": {
+ "access": "public"
+ }
+}
diff --git a/packages/abi-gen-templates/partials/call.handlebars b/packages/abi-gen-templates/partials/call.handlebars
new file mode 100644
index 000000000..7c9c934c3
--- /dev/null
+++ b/packages/abi-gen-templates/partials/call.handlebars
@@ -0,0 +1,3 @@
+public {{this.tsName}} = {
+ {{> callAsync}}
+};
diff --git a/packages/abi-gen-templates/partials/callAsync.handlebars b/packages/abi-gen-templates/partials/callAsync.handlebars
new file mode 100644
index 000000000..ddbbe7508
--- /dev/null
+++ b/packages/abi-gen-templates/partials/callAsync.handlebars
@@ -0,0 +1,28 @@
+async callAsync(
+{{> typed_params inputs=inputs}}
+ callData: Partial<CallData> = {},
+ defaultBlock?: BlockParam,
+): Promise<{{> return_type outputs=outputs}}> {
+ const self = this as any as {{contractName}}Contract;
+ const functionSignature = '{{this.functionSignature}}';
+ const inputAbi = self._lookupAbi(functionSignature).inputs;
+ [{{> params inputs=inputs}}] = BaseContract._formatABIDataItemList(inputAbi, [{{> params inputs=inputs}}], BaseContract._bigNumberToString.bind(self));
+ BaseContract.strictArgumentEncodingCheck(inputAbi, [{{> params inputs=inputs}}]);
+ const ethersFunction = self._lookupEthersInterface(functionSignature).functions.{{this.name}};
+ const encodedData = ethersFunction.encode([{{> params inputs=inputs}}]);
+ const callDataWithDefaults = await BaseContract._applyDefaultsToTxDataAsync(
+ {
+ to: self.address,
+ ...callData,
+ data: encodedData,
+ },
+ self._web3Wrapper.getContractDefaults(),
+ );
+ const rawCallResult = await self._web3Wrapper.callAsync(callDataWithDefaults, defaultBlock);
+ BaseContract._throwIfRevertWithReasonCallResult(rawCallResult);
+ let resultArray = ethersFunction.decode(rawCallResult);
+ const outputAbi = (_.find(self.abi, {name: '{{this.name}}'}) as MethodAbi).outputs;
+ resultArray = BaseContract._formatABIDataItemList(outputAbi, resultArray, BaseContract._lowercaseAddress.bind(this));
+ resultArray = BaseContract._formatABIDataItemList(outputAbi, resultArray, BaseContract._bnToBigNumber.bind(this));
+ return resultArray{{#singleReturnValue}}[0]{{/singleReturnValue}};
+},
diff --git a/packages/abi-gen-templates/partials/event.handlebars b/packages/abi-gen-templates/partials/event.handlebars
new file mode 100644
index 000000000..61d523ca2
--- /dev/null
+++ b/packages/abi-gen-templates/partials/event.handlebars
@@ -0,0 +1,5 @@
+export interface {{@root.contractName}}{{name}}EventArgs extends DecodedLogArgs {
+ {{#each inputs}}
+ {{name}}: {{#returnType type components}}{{/returnType}};
+ {{/each}}
+}
diff --git a/packages/abi-gen-templates/partials/params.handlebars b/packages/abi-gen-templates/partials/params.handlebars
new file mode 100644
index 000000000..2d9bb8ed9
--- /dev/null
+++ b/packages/abi-gen-templates/partials/params.handlebars
@@ -0,0 +1,3 @@
+{{#each inputs}}
+{{name}}{{#if @last}}{{else}},{{/if}}
+{{/each}}
diff --git a/packages/abi-gen-templates/partials/return_type.handlebars b/packages/abi-gen-templates/partials/return_type.handlebars
new file mode 100644
index 000000000..77d96e8c4
--- /dev/null
+++ b/packages/abi-gen-templates/partials/return_type.handlebars
@@ -0,0 +1,10 @@
+{{#if outputs.length}}
+{{#singleReturnValue}}
+{{#returnType outputs.0.type outputs.0.components}}{{/returnType}}
+{{/singleReturnValue}}
+{{^singleReturnValue}}
+[{{#each outputs}}{{#returnType type components}}{{/returnType}}{{#unless @last}}, {{/unless}}{{/each}}]
+{{/singleReturnValue}}
+{{else}}
+void
+{{/if}}
diff --git a/packages/abi-gen-templates/partials/tx.handlebars b/packages/abi-gen-templates/partials/tx.handlebars
new file mode 100644
index 000000000..b39156583
--- /dev/null
+++ b/packages/abi-gen-templates/partials/tx.handlebars
@@ -0,0 +1,60 @@
+public {{this.tsName}} = {
+ async sendTransactionAsync(
+ {{> typed_params inputs=inputs}}
+ {{#this.payable}}
+ txData: Partial<TxDataPayable> = {},
+ {{/this.payable}}
+ {{^this.payable}}
+ txData: Partial<TxData> = {},
+ {{/this.payable}}
+ ): Promise<string> {
+ const self = this as any as {{contractName}}Contract;
+ const inputAbi = self._lookupAbi('{{this.functionSignature}}').inputs;
+ [{{> params inputs=inputs}}] = BaseContract._formatABIDataItemList(inputAbi, [{{> params inputs=inputs}}], BaseContract._bigNumberToString.bind(self));
+ BaseContract.strictArgumentEncodingCheck(inputAbi, [{{> params inputs=inputs}}]);
+ const encodedData = self._lookupEthersInterface('{{this.functionSignature}}').functions.{{this.name}}.encode([{{> params inputs=inputs}}]);
+ const txDataWithDefaults = await BaseContract._applyDefaultsToTxDataAsync(
+ {
+ to: self.address,
+ ...txData,
+ data: encodedData,
+ },
+ self._web3Wrapper.getContractDefaults(),
+ self.{{this.tsName}}.estimateGasAsync.bind(
+ self,
+ {{> params inputs=inputs}}
+ ),
+ );
+ const txHash = await self._web3Wrapper.sendTransactionAsync(txDataWithDefaults);
+ return txHash;
+ },
+ async estimateGasAsync(
+ {{> typed_params inputs=inputs}}
+ txData: Partial<TxData> = {},
+ ): Promise<number> {
+ const self = this as any as {{contractName}}Contract;
+ const inputAbi = self._lookupAbi('{{this.functionSignature}}').inputs;
+ [{{> params inputs=inputs}}] = BaseContract._formatABIDataItemList(inputAbi, [{{> params inputs=inputs}}], BaseContract._bigNumberToString);
+ const encodedData = self._lookupEthersInterface('{{this.functionSignature}}').functions.{{this.name}}.encode([{{> params inputs=inputs}}]);
+ const txDataWithDefaults = await BaseContract._applyDefaultsToTxDataAsync(
+ {
+ to: self.address,
+ ...txData,
+ data: encodedData,
+ },
+ self._web3Wrapper.getContractDefaults(),
+ );
+ const gas = await self._web3Wrapper.estimateGasAsync(txDataWithDefaults);
+ return gas;
+ },
+ getABIEncodedTransactionData(
+ {{> typed_params inputs=inputs}}
+ ): string {
+ const self = this as any as {{contractName}}Contract;
+ const inputAbi = self._lookupAbi('{{this.functionSignature}}').inputs;
+ [{{> params inputs=inputs}}] = BaseContract._formatABIDataItemList(inputAbi, [{{> params inputs=inputs}}], BaseContract._bigNumberToString);
+ const abiEncodedTransactionData = self._lookupEthersInterface('{{this.functionSignature}}').functions.{{this.name}}.encode([{{> params inputs=inputs}}]);
+ return abiEncodedTransactionData;
+ },
+ {{> callAsync}}
+};
diff --git a/packages/abi-gen-templates/partials/typed_params.handlebars b/packages/abi-gen-templates/partials/typed_params.handlebars
new file mode 100644
index 000000000..c100e58f7
--- /dev/null
+++ b/packages/abi-gen-templates/partials/typed_params.handlebars
@@ -0,0 +1,3 @@
+{{#each inputs}}
+ {{name}}: {{#parameterType type components}}{{/parameterType}},
+{{/each}}