aboutsummaryrefslogtreecommitdiffstats
path: root/packages/abi-gen-templates
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2017-12-06 06:18:36 +0800
committerFabio Berger <me@fabioberger.com>2017-12-06 06:18:36 +0800
commit08168c6e7d52711aeb46e27444ba26970e16e244 (patch)
tree40a006de279221009d0ee05d73bfbb74f0a9ea91 /packages/abi-gen-templates
parentb5030df4e3afe17b4e652b438d655edda79c5f54 (diff)
parent4441d76725af4e83f90eeb373983b600b6903e8e (diff)
downloaddexon-sol-tools-08168c6e7d52711aeb46e27444ba26970e16e244.tar
dexon-sol-tools-08168c6e7d52711aeb46e27444ba26970e16e244.tar.gz
dexon-sol-tools-08168c6e7d52711aeb46e27444ba26970e16e244.tar.bz2
dexon-sol-tools-08168c6e7d52711aeb46e27444ba26970e16e244.tar.lz
dexon-sol-tools-08168c6e7d52711aeb46e27444ba26970e16e244.tar.xz
dexon-sol-tools-08168c6e7d52711aeb46e27444ba26970e16e244.tar.zst
dexon-sol-tools-08168c6e7d52711aeb46e27444ba26970e16e244.zip
Merge branch 'development' into feature/addSubproviders
* development: (50 commits) Add PR number to changelog Address feedback Add requestId to subscription messages and update json-schemas Remove isomorphic-fetch types from contracts package Update README Regenerate files Make it private Change package name Update README Make fileExtension configurable Rename abi-gen to typed-contracts Add docs for typed-contracts Remove TODOs Introduce separate ContextData type and rework it Check ABI is defined Introduce a const for 'contract.mustache' Improve error message Reuse util Fix a typo Introduce a const for 'function' ... # Conflicts: # yarn.lock
Diffstat (limited to 'packages/abi-gen-templates')
-rw-r--r--packages/abi-gen-templates/contract.mustache27
-rw-r--r--packages/abi-gen-templates/package.json15
-rw-r--r--packages/abi-gen-templates/partials/call.mustache15
-rw-r--r--packages/abi-gen-templates/partials/params.mustache3
-rw-r--r--packages/abi-gen-templates/partials/return_type.mustache6
-rw-r--r--packages/abi-gen-templates/partials/tx.mustache51
-rw-r--r--packages/abi-gen-templates/partials/typed_params.mustache3
7 files changed, 120 insertions, 0 deletions
diff --git a/packages/abi-gen-templates/contract.mustache b/packages/abi-gen-templates/contract.mustache
new file mode 100644
index 000000000..27783fb6e
--- /dev/null
+++ b/packages/abi-gen-templates/contract.mustache
@@ -0,0 +1,27 @@
+/**
+ * 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/abi-gen-templates.
+ */
+import {BigNumber} from 'bignumber.js';
+import * as Web3 from 'web3';
+
+import {TxData, TxDataPayable} from '../../types';
+import {classUtils} from '../../utils/class_utils';
+import {promisify} from '../../utils/promisify';
+
+import {BaseContract} from './base_contract';
+
+export class {{contractName}}Contract extends BaseContract {
+{{#each methods}}
+ {{#this.constant}}
+ {{> call contractName=../contractName}}
+ {{/this.constant}}
+ {{^this.constant}}
+ {{> tx contractName=../contractName}}
+ {{/this.constant}}
+{{/each}}
+ constructor(web3ContractInstance: Web3.ContractInstance, defaults: Partial<TxData>) {
+ super(web3ContractInstance, defaults);
+ classUtils.bindAll(this, ['web3ContractInstance', 'defaults']);
+ }
+} // tslint:disable:max-file-line-count
diff --git a/packages/abi-gen-templates/package.json b/packages/abi-gen-templates/package.json
new file mode 100644
index 000000000..104013c05
--- /dev/null
+++ b/packages/abi-gen-templates/package.json
@@ -0,0 +1,15 @@
+{
+ "name": "abi-gen-templates",
+ "private": true,
+ "version": "0.0.0",
+ "description": "Handlebars templates to generate TS contract wrappers",
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/0xProject/0x.js.git"
+ },
+ "license": "Apache-2.0",
+ "bugs": {
+ "url": "https://github.com/0xProject/0x.js/issues"
+ },
+ "homepage": "https://github.com/0xProject/0x.js/packages/abi-gen-templates/README.md"
+}
diff --git a/packages/abi-gen-templates/partials/call.mustache b/packages/abi-gen-templates/partials/call.mustache
new file mode 100644
index 000000000..ef4bda724
--- /dev/null
+++ b/packages/abi-gen-templates/partials/call.mustache
@@ -0,0 +1,15 @@
+public {{this.name}} = {
+ async callAsync(
+ {{> typed_params inputs=inputs}}
+ defaultBlock?: Web3.BlockParam,
+ ): Promise<{{> return_type outputs=outputs}}> {
+ const self = this as {{contractName}}Contract;
+ const result = await promisify<{{> return_type outputs=outputs}}>(
+ self.web3ContractInstance.{{this.name}}.call,
+ self.web3ContractInstance,
+ )(
+ {{> params inputs=inputs}}
+ );
+ return result;
+ },
+};
diff --git a/packages/abi-gen-templates/partials/params.mustache b/packages/abi-gen-templates/partials/params.mustache
new file mode 100644
index 000000000..ac5d4ae85
--- /dev/null
+++ b/packages/abi-gen-templates/partials/params.mustache
@@ -0,0 +1,3 @@
+{{#each inputs}}
+{{name}},
+{{/each}}
diff --git a/packages/abi-gen-templates/partials/return_type.mustache b/packages/abi-gen-templates/partials/return_type.mustache
new file mode 100644
index 000000000..383961a40
--- /dev/null
+++ b/packages/abi-gen-templates/partials/return_type.mustache
@@ -0,0 +1,6 @@
+{{#singleReturnValue}}
+{{#returnType outputs.0.type}}{{/returnType}}
+{{/singleReturnValue}}
+{{^singleReturnValue}}
+[{{#each outputs}}{{#returnType type}}{{/returnType}}{{#unless @last}}, {{/unless}}{{/each}}]
+{{/singleReturnValue}}
diff --git a/packages/abi-gen-templates/partials/tx.mustache b/packages/abi-gen-templates/partials/tx.mustache
new file mode 100644
index 000000000..8a43e5319
--- /dev/null
+++ b/packages/abi-gen-templates/partials/tx.mustache
@@ -0,0 +1,51 @@
+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 txDataWithDefaults = await self.applyDefaultsToTxDataAsync(
+ txData,
+ self.{{this.name}}.estimateGasAsync.bind(
+ self,
+ {{> params inputs=inputs}}
+ ),
+ );
+ const txHash = await promisify<string>(
+ self.web3ContractInstance.{{this.name}}, self.web3ContractInstance,
+ )(
+ {{> params inputs=inputs}}
+ txDataWithDefaults,
+ );
+ return txHash;
+ },
+ async estimateGasAsync(
+ {{> typed_params inputs=inputs}}
+ txData: TxData = {},
+ ): Promise<number> {
+ const self = this as {{contractName}}Contract;
+ const txDataWithDefaults = await self.applyDefaultsToTxDataAsync(
+ txData,
+ );
+ const gas = await promisify<number>(
+ self.web3ContractInstance.{{this.name}}.estimateGas, self.web3ContractInstance,
+ )(
+ {{> params inputs=inputs}}
+ txDataWithDefaults,
+ );
+ return gas;
+ },
+ getABIEncodedTransactionData(
+ {{> typed_params inputs=inputs}}
+ txData: TxData = {},
+ ): string {
+ const self = this as {{contractName}}Contract;
+ const abiEncodedTransactionData = self.web3ContractInstance.{{this.name}}.getData();
+ return abiEncodedTransactionData;
+ },
+};
diff --git a/packages/abi-gen-templates/partials/typed_params.mustache b/packages/abi-gen-templates/partials/typed_params.mustache
new file mode 100644
index 000000000..3ea4b2e95
--- /dev/null
+++ b/packages/abi-gen-templates/partials/typed_params.mustache
@@ -0,0 +1,3 @@
+{{#each inputs}}
+ {{name}}: {{#parameterType type}}{{/parameterType}},
+{{/each}}