diff options
author | Fabio Berger <me@fabioberger.com> | 2018-06-19 19:48:58 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2018-06-19 19:48:58 +0800 |
commit | 6641f34d76951273a0efa909d4abed72ab8b3472 (patch) | |
tree | 5feb7d2bf439f97132001999d0d4b1010c48b53d /packages/contract_templates/README.md | |
parent | 08ea71cb243067d8f4a4b08b2ed83ee11225d494 (diff) | |
parent | f3ae5d8160f2e8a2fea8d045d9a02e37a7cdaa21 (diff) | |
download | dexon-sol-tools-6641f34d76951273a0efa909d4abed72ab8b3472.tar dexon-sol-tools-6641f34d76951273a0efa909d4abed72ab8b3472.tar.gz dexon-sol-tools-6641f34d76951273a0efa909d4abed72ab8b3472.tar.bz2 dexon-sol-tools-6641f34d76951273a0efa909d4abed72ab8b3472.tar.lz dexon-sol-tools-6641f34d76951273a0efa909d4abed72ab8b3472.tar.xz dexon-sol-tools-6641f34d76951273a0efa909d4abed72ab8b3472.tar.zst dexon-sol-tools-6641f34d76951273a0efa909d4abed72ab8b3472.zip |
Merge branch 'v2-prototype' into feature/combinatorial-testing
* v2-prototype:
Prettier fix
Update default params in sendRawPaylodAsync for improved JSON-RPC compatibility
Fix missed merge conflicts
Fix additional versions and update yarn.lock
Add OrderWatcherConfig type to 0x.js docs page
Export OrderWatcherConfig from 0x.js
Update all package versions to match latest published to NPM
Update CHANGELOG's with publishes performed on development branch
Rebase with latest removing PROXY_ID from transfer
Split transfer impl and AssetProxyMixin
change @0xproject/types to ethereum-types
remove mistaken comment
workaround for TypeScript trailing comma bug
Document contract_templates
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..e5f4b09d1 --- /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 @0xproject/base-contract @0xproject/sol-compiler @0xproject/utils @0xproject/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/@0xproject/typescript-typings/types", + "node_modules/@types" + ] +} +``` |