diff options
| author | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-11-22 21:16:08 +0800 |
|---|---|---|
| committer | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-11-22 21:48:15 +0800 |
| commit | 06cc66005cf0713fcc877ae67b51b38fb110b09d (patch) | |
| tree | 9823f26c8f83f5051aa2b5a6068fe9c542eaeb4c /packages/contract-templates/README.md | |
| parent | a5359df002d121c1b7c1f29e8a2bd8b351090ee3 (diff) | |
| download | dexon-sol-tools-06cc66005cf0713fcc877ae67b51b38fb110b09d.tar dexon-sol-tools-06cc66005cf0713fcc877ae67b51b38fb110b09d.tar.gz dexon-sol-tools-06cc66005cf0713fcc877ae67b51b38fb110b09d.tar.bz2 dexon-sol-tools-06cc66005cf0713fcc877ae67b51b38fb110b09d.tar.lz dexon-sol-tools-06cc66005cf0713fcc877ae67b51b38fb110b09d.tar.xz dexon-sol-tools-06cc66005cf0713fcc877ae67b51b38fb110b09d.tar.zst dexon-sol-tools-06cc66005cf0713fcc877ae67b51b38fb110b09d.zip | |
Make contract-templates an npm package
Diffstat (limited to 'packages/contract-templates/README.md')
| -rw-r--r-- | packages/contract-templates/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/packages/contract-templates/README.md b/packages/contract-templates/README.md new file mode 100644 index 000000000..c6cc3b1b3 --- /dev/null +++ b/packages/contract-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" + ] +} +``` |