typechain - npm Package Compare versions

Comparing version 8.2.0 to 8.2.1

dist/codegen/createBarrelFiles.js

@@ -45,2 +45,5 @@ "use strict";
                 ].join('\n');
+            if (moduleSuffix) {
+                return `export * as ${namespaceIdentifier} from './${p}/index${moduleSuffix}';`;
+            }
             return `export * as ${namespaceIdentifier} from './${p}';`;
@@ -47,0 +50,0 @@ })

package.json

@@ -11,3 +11,3 @@ {
   ],
-  "version": "8.2.0",
+  "version": "8.2.1",
   "license": "MIT",
@@ -14,0 +14,0 @@ "repository": "https://github.com/ethereum-ts/Typechain",

README.md

@@ -43,3 +43,3 @@ <p align="center">
 
-You will also need to install a desired target for example `@typechain/ethers-v5`. [Learn more about targets](#targets-)
+You will also need to install a desired target for example `@typechain/ethers-v6`. [Learn more about targets](#targets-)
 
@@ -54,2 +54,3 @@ _Take note, that code generated by TypeChain requires TypeScript version 4.3 or newer._
 | [`@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 (⚠️ requires TS 4.0 >=) | [example](./examples/ethers-v5)                                                                                      |
+| [`@typechain/ethers-v6`](/packages/target-ethers-v6)                                                                                        | [![npm](https://img.shields.io/npm/v/@typechain/ethers-v6.svg)](https://www.npmjs.com/package/@typechain/ethers-v6)   | Ethers ver 6 support (⚠️ requires TS 4.0 >=) | [example](./examples/ethers-v6)                                                                                      |
 | [`@typechain/starknet.js`](/packages/target-starknet)                                                                                       | [![npm](https://img.shields.io/npm/v/@typechain/starknet.svg)](https://www.npmjs.com/package/@typechain/starknet)     | Starknet.js ver 3.9                          |                                                                                                                      |
@@ -77,3 +78,3 @@ | [`@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 --target=(ethers-v5|truffle-v4|truffle-v5|web3-v1|path-to-custom-target) [glob]
+typechain --target=(ethers-v5|ethers-v6|truffle-v4|truffle-v5|web3-v1|path-to-custom-target) [glob]
 ```
@@ -83,9 +84,9 @@
   `./abis/**/*.abi`, `./abis/?(Oasis.abi|OasisHelper.abi)`.
-- `--target` - ethers-v5, truffle-v4, truffle-v5, web3-v1 or path to your custom target. Typechain will try to load
-  package named: `@typechain/${target}`, so make sure that desired package is installed.
+- `--target` - ethers-v5, ethers-v6, truffle-v4, truffle-v5, web3-v1 or path to your custom target. Typechain will try
+  to load package named: `@typechain/${target}`, so make sure that desired package is installed.
 - `--out-dir` (optional) - put all generated files to a specific dir.
 - `--always-generate-overloads` (optional) - some targets won't generate unnecessary types for overloaded functions by
   default, this option forces to always generate them
-- `--discriminate-types` (optional) - ethers-v5 will add an artificial field `contractName` that helps discriminate
-  between contracts
+- `--discriminate-types` (optional) - ethers-v5 and ethers-v6 will add an artificial field `contractName` that helps
+  discriminate between contracts
 
@@ -97,3 +98,3 @@ TypeChain always will rewrite existing files. You should not commit them. Read more in FAQ section.
 ```
-typechain --target ethers-v5 --out-dir app/contracts './node_modules/neufund-contracts/build/contracts/*.json'
+typechain --target ethers-v6 --out-dir app/contracts './node_modules/neufund-contracts/build/contracts/*.json'
 ```
@@ -131,5 +132,5 @@
 
-### Ethers.js v5
+### Ethers.js v6
 
-Use `ethers-v5` target to generate wrappers for [ethers.js](https://github.com/ethers-io/ethers.js/) lib. To make it
+Use `ethers-v6` target to generate wrappers for [ethers.js](https://github.com/ethers-io/ethers.js/) lib. To make it
 work great with Hardhat, use [Hardhat plugin](https://github.com/ethereum-ts/TypeChain/tree/master/packages/hardhat).
@@ -139,2 +140,4 @@
 
+If you are using Ethers.js v5, use the `@typechain/ethers-v5` target.
+
 If you're using Ethers.js v4, you can find legacy `@typechain/ethers-v4` target on
@@ -141,0 +144,0 @@ [npm](https://www.npmjs.com/package/@typechain/ethers-v4) and commit

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

118162

increased by0.65%

Lines of code

1589

increased by0.19%

Number of lines in readme file

223

increased by1.36%

No dependency changes