diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-06-05 18:22:24 +0800 |
|---|---|---|
| committer | Fabio Berger <me@fabioberger.com> | 2018-06-05 18:22:24 +0800 |
| commit | 3db4e2ee2f3a0b668f3770f8bfbe8ec06ae69576 (patch) | |
| tree | 42820b2334be45cbfe21ec1ff61afca3da1b9834 /packages/abi-gen/README.md | |
| parent | 86a6a5b826158fbf3b16081a2ecdbb020140adda (diff) | |
| parent | 44a736c53b8901ee36dbe009ad570930bbc8e676 (diff) | |
| download | dexon-sol-tools-3db4e2ee2f3a0b668f3770f8bfbe8ec06ae69576.tar.gz dexon-sol-tools-3db4e2ee2f3a0b668f3770f8bfbe8ec06ae69576.tar.zst dexon-sol-tools-3db4e2ee2f3a0b668f3770f8bfbe8ec06ae69576.zip | |
Merge branch 'v2-prototype' into fixes/misc-small-fixes
* v2-prototype:
Fix broken link to `contract_templates`
# Conflicts:
# packages/abi-gen/README.md
Diffstat (limited to 'packages/abi-gen/README.md')
| -rw-r--r-- | packages/abi-gen/README.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/packages/abi-gen/README.md b/packages/abi-gen/README.md index 123be11d9..b6dd37cd1 100644 --- a/packages/abi-gen/README.md +++ b/packages/abi-gen/README.md @@ -4,7 +4,7 @@ This package allows you to generate TypeScript contract wrappers from ABI files. It's heavily inspired by [Geth abigen](https://github.com/ethereum/go-ethereum/wiki/Native-DApps:-Go-bindings-to-Ethereum-contracts) but takes a different approach. You can write your custom handlebars templates which will allow you to seamlessly integrate the generated code into your existing codebase with existing conventions. -[Here](https://github.com/0xProject/0x-monorepo/tree/development/packages/0x.js/contract_templates) are the templates used to generate the contract wrappers used by 0x.js. +[Here](https://github.com/0xProject/0x-monorepo/tree/development/packages/0x.js/contract_templates) are the templates used to generate the contract wrappers used by 0x.js.e ## Installation @@ -44,7 +44,7 @@ You need to also specify the location of your main template used for every contr ## How to write custom templates? -The best way to get started is to copy [0x.js templates](https://github.com/0xProject/0x-monorepo/tree/development/packages/0x.js/contract_templates) and start adjusting them for your needs. +The best way to get started is to copy [0x.js templates](https://github.com/0xProject/0x-monorepo/tree/development/packages/contract_templates) and start adjusting them for your needs. We use [handlebars](http://handlebarsjs.com/) template engine under the hood. You need to have a master template called `contract.mustache`. it will be used to generate each contract wrapper. Although - you don't need and probably shouldn't write all your logic in a single template file. You can write [partial templates](http://handlebarsjs.com/partials.html) and as long as they are within a partials folder - they will be registered and available. |