aboutsummaryrefslogtreecommitdiffstats
path: root/packages/contract-templates/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/contract-templates/README.md')
-rw-r--r--packages/contract-templates/README.md17
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"
+ ]
+}
+```