diff options
| author | F. Eugene Aumson <gene@aumson.org> | 2018-06-14 11:09:36 +0800 |
|---|---|---|
| committer | F. Eugene Aumson <gene@aumson.org> | 2018-06-15 01:51:10 +0800 |
| commit | 4a2e4d2b55c89c91cebf434570feee91ccc449fa (patch) | |
| tree | f48817229d2d4959988090caf51dd6cd8881a4fd | |
| parent | 0e354e5ea1f9951088331a310999bf87c8f8f4b3 (diff) | |
| download | dexon-sol-tools-4a2e4d2b55c89c91cebf434570feee91ccc449fa.tar dexon-sol-tools-4a2e4d2b55c89c91cebf434570feee91ccc449fa.tar.gz dexon-sol-tools-4a2e4d2b55c89c91cebf434570feee91ccc449fa.tar.bz2 dexon-sol-tools-4a2e4d2b55c89c91cebf434570feee91ccc449fa.tar.lz dexon-sol-tools-4a2e4d2b55c89c91cebf434570feee91ccc449fa.tar.xz dexon-sol-tools-4a2e4d2b55c89c91cebf434570feee91ccc449fa.tar.zst dexon-sol-tools-4a2e4d2b55c89c91cebf434570feee91ccc449fa.zip | |
Document contract_templates
| -rw-r--r-- | packages/contract_templates/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/packages/contract_templates/README.md b/packages/contract_templates/README.md new file mode 100644 index 000000000..39aa2d2c0 --- /dev/null +++ b/packages/contract_templates/README.md @@ -0,0 +1,15 @@ +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 @0xproject/base-contract @0xproject/sol-compiler @0xproject/types @0xproject/utils @0xproject/web3-wrapper 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/@0xproject/typescript-typings/types", + "node_modules/@types" + ] +} +``` |