aboutsummaryrefslogtreecommitdiffstats
path: root/packages/contract_templates
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2018-11-22 21:16:08 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2018-11-22 21:48:15 +0800
commit06cc66005cf0713fcc877ae67b51b38fb110b09d (patch)
tree9823f26c8f83f5051aa2b5a6068fe9c542eaeb4c /packages/contract_templates
parenta5359df002d121c1b7c1f29e8a2bd8b351090ee3 (diff)
downloaddexon-sol-tools-06cc66005cf0713fcc877ae67b51b38fb110b09d.tar
dexon-sol-tools-06cc66005cf0713fcc877ae67b51b38fb110b09d.tar.gz
dexon-sol-tools-06cc66005cf0713fcc877ae67b51b38fb110b09d.tar.bz2
dexon-sol-tools-06cc66005cf0713fcc877ae67b51b38fb110b09d.tar.lz
dexon-sol-tools-06cc66005cf0713fcc877ae67b51b38fb110b09d.tar.xz
dexon-sol-tools-06cc66005cf0713fcc877ae67b51b38fb110b09d.tar.zst
dexon-sol-tools-06cc66005cf0713fcc877ae67b51b38fb110b09d.zip
Make contract-templates an npm package
Diffstat (limited to 'packages/contract_templates')
-rw-r--r--packages/contract_templates/README.md17
-rw-r--r--packages/contract_templates/contract.handlebars91
-rw-r--r--packages/contract_templates/partials/call.handlebars3
-rw-r--r--packages/contract_templates/partials/callAsync.handlebars28
-rw-r--r--packages/contract_templates/partials/event.handlebars5
-rw-r--r--packages/contract_templates/partials/params.handlebars3
-rw-r--r--packages/contract_templates/partials/return_type.handlebars10
-rw-r--r--packages/contract_templates/partials/tx.handlebars60
-rw-r--r--packages/contract_templates/partials/typed_params.handlebars3
9 files changed, 0 insertions, 220 deletions
diff --git a/packages/contract_templates/README.md b/packages/contract_templates/README.md
deleted file mode 100644
index c6cc3b1b3..000000000
--- a/packages/contract_templates/README.md
+++ /dev/null
@@ -1,17 +0,0 @@
-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/contract_templates/contract.handlebars b/packages/contract_templates/contract.handlebars
deleted file mode 100644
index 9b2a2b336..000000000
--- a/packages/contract_templates/contract.handlebars
+++ /dev/null
@@ -1,91 +0,0 @@
-// 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/contract_templates/partials/call.handlebars b/packages/contract_templates/partials/call.handlebars
deleted file mode 100644
index 7c9c934c3..000000000
--- a/packages/contract_templates/partials/call.handlebars
+++ /dev/null
@@ -1,3 +0,0 @@
-public {{this.tsName}} = {
- {{> callAsync}}
-};
diff --git a/packages/contract_templates/partials/callAsync.handlebars b/packages/contract_templates/partials/callAsync.handlebars
deleted file mode 100644
index ddbbe7508..000000000
--- a/packages/contract_templates/partials/callAsync.handlebars
+++ /dev/null
@@ -1,28 +0,0 @@
-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/contract_templates/partials/event.handlebars b/packages/contract_templates/partials/event.handlebars
deleted file mode 100644
index 61d523ca2..000000000
--- a/packages/contract_templates/partials/event.handlebars
+++ /dev/null
@@ -1,5 +0,0 @@
-export interface {{@root.contractName}}{{name}}EventArgs extends DecodedLogArgs {
- {{#each inputs}}
- {{name}}: {{#returnType type components}}{{/returnType}};
- {{/each}}
-}
diff --git a/packages/contract_templates/partials/params.handlebars b/packages/contract_templates/partials/params.handlebars
deleted file mode 100644
index 2d9bb8ed9..000000000
--- a/packages/contract_templates/partials/params.handlebars
+++ /dev/null
@@ -1,3 +0,0 @@
-{{#each inputs}}
-{{name}}{{#if @last}}{{else}},{{/if}}
-{{/each}}
diff --git a/packages/contract_templates/partials/return_type.handlebars b/packages/contract_templates/partials/return_type.handlebars
deleted file mode 100644
index 77d96e8c4..000000000
--- a/packages/contract_templates/partials/return_type.handlebars
+++ /dev/null
@@ -1,10 +0,0 @@
-{{#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/contract_templates/partials/tx.handlebars b/packages/contract_templates/partials/tx.handlebars
deleted file mode 100644
index b39156583..000000000
--- a/packages/contract_templates/partials/tx.handlebars
+++ /dev/null
@@ -1,60 +0,0 @@
-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/contract_templates/partials/typed_params.handlebars b/packages/contract_templates/partials/typed_params.handlebars
deleted file mode 100644
index c100e58f7..000000000
--- a/packages/contract_templates/partials/typed_params.handlebars
+++ /dev/null
@@ -1,3 +0,0 @@
-{{#each inputs}}
- {{name}}: {{#parameterType type components}}{{/parameterType}},
-{{/each}}