Skip to content

Commit

Permalink
Merge pull request #252 from ethereum-ts/fork/ethers-v5-target
Browse files Browse the repository at this point in the history
  • Loading branch information
krzkaczor authored Aug 3, 2020
2 parents e41b8eb + 3538688 commit b0b2292
Show file tree
Hide file tree
Showing 63 changed files with 6,747 additions and 1,012 deletions.
1 change: 1 addition & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ jobs:
- run: yarn test
- run: yarn format # do it at the very end because test can generate types (which should be formatted)
- run: yarn check-examples
- run: yarn no-git-changes # ensure that committed types are up to date

workflows:
version: 2
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ examples/truffle-v4/types
examples/truffle-v4/migrations
examples/truffle-v5/types
examples/truffle-v5/migrations
examples/ethers-v4/types
examples/ethers-v5/types
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,10 @@ You will also need to install a desired target for example `@typechain/ethers-v4
| Package | Version | Description | Examples |
| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | --------------------- | -------------------------------- |
| [`typechain`](/packages/typechain) | [![npm](https://img.shields.io/npm/v/typechain.svg)](https://www.npmjs.com/package/typechain) | Core package | - |
| [`@typechain/ethers-v5`](/packages/target-ethers-v5) | [![npm](https://img.shields.io/npm/v/@typechain/ethers-v5.svg)](https://www.npmjs.com/package/@typechain/ethers-v5) | Ethers ver 5 support | [example](./examples/ethers-v5) |
| [`@typechain/ethers-v4`](/packages/target-ethers-v4) | [![npm](https://img.shields.io/npm/v/@typechain/ethers-v4.svg)](https://www.npmjs.com/package/@typechain/ethers-v4) | Ethers ver 4 support | [example](./examples/ethers-v4) |
| [`@typechain/truffle-v4`](/packages/target-truffle-v4) | [![npm](https://img.shields.io/npm/v/@typechain/truffle-v4.svg)](https://www.npmjs.com/package/@typechain/truffle-v4) | Truffle ver 4 support | [example](./examples/truffle-v4) |
| [`@typechain/truffle-v5`](/packages/target-truffle-v5) | [![npm](https://img.shields.io/npm/v/@typechain/truffle-v5.svg)](https://www.npmjs.com/package/@typechain/truffle-v5) | Truffle ver 5 support | [example](./examples/truffle-v5) |
| [`@typechain/truffle-v4`](/packages/target-truffle-v4) | [![npm](https://img.shields.io/npm/v/@typechain/truffle-v4.svg)](https://www.npmjs.com/package/@typechain/truffle-v4) | Truffle ver 4 support | [example](./examples/truffle-v4) |
| [`@typechain/web3-v1`](/packages/target-web3-v1) | [![npm](https://img.shields.io/npm/v/@typechain/web3-v1.svg)](https://www.npmjs.com/package/@typechain/web3-v1) | Web3 ver 1 support | [example](./examples/web3-v1) |

## Usage
Expand Down Expand Up @@ -101,11 +102,11 @@ That's it! Now, you can simply import typings, check out our examples for more d

## Targets 🎯

### Ethers.js v4
### Ethers.js v4 / v5

Use `ethers-v4` target to generate wrappers for [ethers.js](https://github.com/ethers-io/ethers.js/) lib.

### Truffle v4-v5
### Truffle v4 / v5

Truffle target is great when you use truffle contracts already. Check out
[truffle-typechain-example](https://github.com/ethereum-ts/truffle-typechain-example) for more details. It require
Expand Down
2 changes: 1 addition & 1 deletion examples/ethers-v4/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# TypeChain x Web3 v1 example
# TypeChain x Ethers-v4 example

## Running

Expand Down
Loading

0 comments on commit b0b2292

Please sign in to comment.