Skip to content

Commit

Permalink
Document contract_templates
Browse files Browse the repository at this point in the history
  • Loading branch information
feuGeneA committed Jun 14, 2018
1 parent 8162394 commit b643121
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions packages/contract_templates/README.md
Original file line number Diff line number Diff line change
@@ -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"
]
}
```

0 comments on commit b643121

Please sign in to comment.