aboutsummaryrefslogtreecommitdiffstats
path: root/packages/abi-gen/README.md
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2017-12-08 22:58:54 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2017-12-14 22:47:02 +0800
commit02e7354b5324b80f1e5a6a2968d05de44820498c (patch)
tree83dd425b01afa2eddcb36456da40ae721953020b /packages/abi-gen/README.md
parent0a0d3503c0cdf16c0630dabc9eefba6e7b0a42fe (diff)
downloaddexon-sol-tools-02e7354b5324b80f1e5a6a2968d05de44820498c.tar
dexon-sol-tools-02e7354b5324b80f1e5a6a2968d05de44820498c.tar.gz
dexon-sol-tools-02e7354b5324b80f1e5a6a2968d05de44820498c.tar.bz2
dexon-sol-tools-02e7354b5324b80f1e5a6a2968d05de44820498c.tar.lz
dexon-sol-tools-02e7354b5324b80f1e5a6a2968d05de44820498c.tar.xz
dexon-sol-tools-02e7354b5324b80f1e5a6a2968d05de44820498c.tar.zst
dexon-sol-tools-02e7354b5324b80f1e5a6a2968d05de44820498c.zip
Move 0x.js temnplates to 0x.js instead of having them as a separate package
Diffstat (limited to 'packages/abi-gen/README.md')
-rw-r--r--packages/abi-gen/README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/packages/abi-gen/README.md b/packages/abi-gen/README.md
index 16dd9b969..0eaacd86f 100644
--- a/packages/abi-gen/README.md
+++ b/packages/abi-gen/README.md
@@ -5,7 +5,7 @@ It's heavily inspired by [Geth abigen](https://github.com/ethereum/go-ethereum/w
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.js/tree/development/packages/0x.js/src/contract_wrappers/generated) check out 0x.js.
-[Here](https://github.com/0xProject/0x.js/tree/development/packages/abi-gen-templates) are the templates used to generate those files.
+[Here](https://github.com/0xProject/0x.js/tree/development/packages/0x.js/src/contract_templates) are the templates used to generate those files.
## Instalation
`yarn add -g @0xproject/abi-gen`
@@ -29,7 +29,7 @@ We could've just used `--abiGlob 'src/artifacts/*.json` but we wanted to exclude
The abi file should be either a [Truffle](http://truffleframework.com/) contract artifact (a JSON object with an abi key) or a JSON abi array.
## How to write custom templates?
-The best way to get started is to copy [0x.js templates](https://github.com/0xProject/0x.js/tree/development/packages/abi-gen-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.js/tree/development/packages/0x.js/src/contract_templates) and start adjusting them for your needs.
We use [handlebars](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.
## Which data/context do I get in my templates?