aboutsummaryrefslogtreecommitdiffstats
path: root/packages/contract-templates/README.md
blob: c6cc3b1b38a5f0e0140f8ed968ab87a7088f4b98 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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"
  ]
}
```