Skip to content

Commit b0b2292

Browse files
authored
Merge pull request #252 from ethereum-ts/fork/ethers-v5-target
2 parents e41b8eb + 3538688 commit b0b2292

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+6747
-1012
lines changed

.circleci/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ jobs:
2929
- run: yarn test
3030
- run: yarn format # do it at the very end because test can generate types (which should be formatted)
3131
- run: yarn check-examples
32+
- run: yarn no-git-changes # ensure that committed types are up to date
3233

3334
workflows:
3435
version: 2

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,5 @@ examples/truffle-v4/types
1414
examples/truffle-v4/migrations
1515
examples/truffle-v5/types
1616
examples/truffle-v5/migrations
17+
examples/ethers-v4/types
18+
examples/ethers-v5/types

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,10 @@ You will also need to install a desired target for example `@typechain/ethers-v4
4242
| Package | Version | Description | Examples |
4343
| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | --------------------- | -------------------------------- |
4444
| [`typechain`](/packages/typechain) | [![npm](https://img.shields.io/npm/v/typechain.svg)](https://www.npmjs.com/package/typechain) | Core package | - |
45+
| [`@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) |
4546
| [`@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) |
46-
| [`@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) |
4747
| [`@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) |
48+
| [`@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) |
4849
| [`@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) |
4950

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

102103
## Targets 🎯
103104

104-
### Ethers.js v4
105+
### Ethers.js v4 / v5
105106

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

108-
### Truffle v4-v5
109+
### Truffle v4 / v5
109110

110111
Truffle target is great when you use truffle contracts already. Check out
111112
[truffle-typechain-example](https://github.com/ethereum-ts/truffle-typechain-example) for more details. It require

examples/ethers-v4/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# TypeChain x Web3 v1 example
1+
# TypeChain x Ethers-v4 example
22

33
## Running
44

0 commit comments

Comments
 (0)