diff options
| author | Leonid <logvinov.leon@gmail.com> | 2017-12-15 00:48:45 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-12-15 00:48:45 +0800 |
| commit | a0aa21103b51ad287de1579832a4a490ca90175a (patch) | |
| tree | d65274497474e65302a91e78efa1796558aa4380 /packages/abi-gen/README.md | |
| parent | d69143487ec441939a85ef2a7e92bb0a15cb2e6c (diff) | |
| parent | ce242b10e2c4d35bbba3842d198b78373dd609f0 (diff) | |
| download | dexon-sol-tools-a0aa21103b51ad287de1579832a4a490ca90175a.tar dexon-sol-tools-a0aa21103b51ad287de1579832a4a490ca90175a.tar.gz dexon-sol-tools-a0aa21103b51ad287de1579832a4a490ca90175a.tar.bz2 dexon-sol-tools-a0aa21103b51ad287de1579832a4a490ca90175a.tar.lz dexon-sol-tools-a0aa21103b51ad287de1579832a4a490ca90175a.tar.xz dexon-sol-tools-a0aa21103b51ad287de1579832a4a490ca90175a.tar.zst dexon-sol-tools-a0aa21103b51ad287de1579832a4a490ca90175a.zip | |
Merge pull request #258 from 0xProject/feature/contracts-refactor
A bunch of refactorings
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 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? |