ethers-v5-to-v6

Name: ethersjs-v5-to-v6-migration codemod
Availability: InStock

Automated codemod for migrating ethers.js v5 codebases to v6.

What it does

This codemod automates ~90% of the deterministic migration patterns from ethers.js v5 to v6:

Import paths: @ethersproject/* sub-packages → unified "ethers" package
Namespace flattening: ethers.providers.X, ethers.utils.X, ethers.constants.X → ethers.X
BigNumber → bigint: BigNumber.from() → BigInt(), chained arithmetic
Contract patterns: callStatic.X → X.staticCall(), estimateGas.X → X.estimateGas()
Provider/Signer renames: Web3Provider → BrowserProvider, Signer → AbstractSigner
Utility functions: arrayify → getBytes, splitSignature → Signature.from(), etc.
Constants: ethers.constants.AddressZero → ethers.ZeroAddress, numeric constants → bigint literals

Usage

bash

Or run the migration script directly:

bash

What's NOT automated

These patterns require type information or semantic understanding and should be handled by an AI agent or manually:

Variable BigNumber arithmetic: balance.mul(2) → balance * 2 (need to verify balance is bigint)
Removed APIs: commify(), poll(), checkProperties(), deepCopy()
feeData.lastBaseFeePerGas → alternative approach
Error code type changes (numeric → string)
provider.getNetwork().chainId type change (number → bigint)

Testing

bash

Case Study

See CASE_STUDY.md for the full migration analysis of Uniswap v3-periphery.

1 import { ethers, Signer } from "ethers";
2
3 const provider = new ethers.providers.JsonRpcProvider(url);
4 const web3 = new ethers.providers.Web3Provider(window.ethereum);
5 const signer: ethers.Signer = provider.getSigner();
6
7 // sendTransaction on provider
8 const tx = await provider.sendTransaction(signedTx);
9
10 // getGasPrice
11 const gasPrice = await provider.getGasPrice();
12
13 const network = await provider.getNetwork();
14

Registry

Ready to contribute?

ethersjs-v5-to-v6-migration

Run locally