aboutsummaryrefslogtreecommitdiffstats
path: root/packages/abi-gen
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-06-06 18:31:30 +0800
committerFabio Berger <me@fabioberger.com>2018-06-06 18:31:30 +0800
commit271fa26890c7d86fe516b51d653a308b2789d2c2 (patch)
treeeff3a17c8dd56cd1fbe4da76557b904253792cd2 /packages/abi-gen
parentfe437da7517b4ea8e308a7210a34e66b715d5c78 (diff)
parentcc39eea9991306eabadd912256452f67fb49c20b (diff)
downloaddexon-0x-contracts-271fa26890c7d86fe516b51d653a308b2789d2c2.tar
dexon-0x-contracts-271fa26890c7d86fe516b51d653a308b2789d2c2.tar.gz
dexon-0x-contracts-271fa26890c7d86fe516b51d653a308b2789d2c2.tar.bz2
dexon-0x-contracts-271fa26890c7d86fe516b51d653a308b2789d2c2.tar.lz
dexon-0x-contracts-271fa26890c7d86fe516b51d653a308b2789d2c2.tar.xz
dexon-0x-contracts-271fa26890c7d86fe516b51d653a308b2789d2c2.tar.zst
dexon-0x-contracts-271fa26890c7d86fe516b51d653a308b2789d2c2.zip
merge v2-prototype
Diffstat (limited to 'packages/abi-gen')
-rw-r--r--packages/abi-gen/README.md5
1 files changed, 2 insertions, 3 deletions
diff --git a/packages/abi-gen/README.md b/packages/abi-gen/README.md
index 4240ba7ba..b6dd37cd1 100644
--- a/packages/abi-gen/README.md
+++ b/packages/abi-gen/README.md
@@ -4,8 +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.
-For an example of the generated [wrapper files](https://github.com/0xProject/0x-monorepo/tree/development/packages/0x.js/src/contract_wrappers/generated) check out 0x.js.
-[Here](https://github.com/0xProject/0x-monorepo/tree/development/packages/0x.js/contract_templates) are the templates used to generate those files.
+[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
@@ -45,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.