diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-06-19 19:44:55 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-06-19 19:44:55 +0800 |
| commit | d937541aa0d0354633e60e7ee3ce57bc703c6e17 (patch) | |
| tree | 83dab04b90f86461f0d3be5fe637d0a893be514e /packages | |
| parent | 21707d7ff64c8621840cbaa2365555351489d28c (diff) | |
| parent | 8bac1706a119c0c4c02bbca77553976080f5ee20 (diff) | |
| download | dexon-sol-tools-d937541aa0d0354633e60e7ee3ce57bc703c6e17.tar dexon-sol-tools-d937541aa0d0354633e60e7ee3ce57bc703c6e17.tar.gz dexon-sol-tools-d937541aa0d0354633e60e7ee3ce57bc703c6e17.tar.bz2 dexon-sol-tools-d937541aa0d0354633e60e7ee3ce57bc703c6e17.tar.lz dexon-sol-tools-d937541aa0d0354633e60e7ee3ce57bc703c6e17.tar.xz dexon-sol-tools-d937541aa0d0354633e60e7ee3ce57bc703c6e17.tar.zst dexon-sol-tools-d937541aa0d0354633e60e7ee3ce57bc703c6e17.zip | |
Merge pull request #701 from feuGeneA/v2-prototype
Document use of contract_templates (take 2; based on v2-prototype, not master)
Diffstat (limited to 'packages')
| -rw-r--r-- | packages/contract_templates/README.md | 15 | ||||
| -rw-r--r-- | packages/contract_templates/contract.handlebars | 4 | ||||
| -rw-r--r-- | packages/contract_templates/partials/params.handlebars | 2 |
3 files changed, 16 insertions, 5 deletions
diff --git a/packages/contract_templates/README.md b/packages/contract_templates/README.md new file mode 100644 index 000000000..9546506c5 --- /dev/null +++ b/packages/contract_templates/README.md @@ -0,0 +1,15 @@ +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 @0xproject/base-contract @0xproject/sol-compiler @0xproject/utils @0xproject/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/@0xproject/typescript-typings/types", + "node_modules/@types" + ] +} +``` diff --git a/packages/contract_templates/contract.handlebars b/packages/contract_templates/contract.handlebars index 431359109..997088c8f 100644 --- a/packages/contract_templates/contract.handlebars +++ b/packages/contract_templates/contract.handlebars @@ -1,7 +1,3 @@ -/** - * This file is auto-generated using abi-gen. Don't edit directly. - * Templates can be found at https://github.com/0xProject/0x-monorepo/tree/development/packages/contract_templates. - */ // tslint:disable:no-consecutive-blank-lines ordered-imports align trailing-comma whitespace // tslint:disable:no-unused-variable import { BaseContract } from '@0xproject/base-contract'; diff --git a/packages/contract_templates/partials/params.handlebars b/packages/contract_templates/partials/params.handlebars index ac5d4ae85..2d9bb8ed9 100644 --- a/packages/contract_templates/partials/params.handlebars +++ b/packages/contract_templates/partials/params.handlebars @@ -1,3 +1,3 @@ {{#each inputs}} -{{name}}, +{{name}}{{#if @last}}{{else}},{{/if}} {{/each}} |