diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-11-26 23:08:57 +0800 |
|---|---|---|
| committer | Fabio Berger <me@fabioberger.com> | 2018-11-26 23:08:57 +0800 |
| commit | 420a677828ed102b7980e9b18911885e0ecb08e8 (patch) | |
| tree | 712034da6837333a4a584ced6866c1223541aa08 /packages/abi-gen-templates/README.md | |
| parent | 9da43878b169226e628ad2ea834e0fab78d5909b (diff) | |
| parent | 2648f5ba654ccc22d96a0755c0a24ef628054d02 (diff) | |
| download | dexon-sol-tools-420a677828ed102b7980e9b18911885e0ecb08e8.tar dexon-sol-tools-420a677828ed102b7980e9b18911885e0ecb08e8.tar.gz dexon-sol-tools-420a677828ed102b7980e9b18911885e0ecb08e8.tar.bz2 dexon-sol-tools-420a677828ed102b7980e9b18911885e0ecb08e8.tar.lz dexon-sol-tools-420a677828ed102b7980e9b18911885e0ecb08e8.tar.xz dexon-sol-tools-420a677828ed102b7980e9b18911885e0ecb08e8.tar.zst dexon-sol-tools-420a677828ed102b7980e9b18911885e0ecb08e8.zip | |
merge development
Diffstat (limited to 'packages/abi-gen-templates/README.md')
| -rw-r--r-- | packages/abi-gen-templates/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/packages/abi-gen-templates/README.md b/packages/abi-gen-templates/README.md new file mode 100644 index 000000000..c6cc3b1b3 --- /dev/null +++ b/packages/abi-gen-templates/README.md @@ -0,0 +1,17 @@ +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 @0x/base-contract @0x/sol-compiler @0x/utils @0x/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/@0x/typescript-typings/types", + "node_modules/@types" + ] +} +``` |