PPRADDZY

praddzy/openzeppelin-v5-safe-imports

Safe OpenZeppelin Contracts v5 Solidity import migration with optional AI follow-up.

codemodopenzeppelinsoliditymigration
Public
5 executions
Apply to Repository

Run locally

npx codemod @praddzy/openzeppelin-v5-safe-imports

OpenZeppelin v5 Safe Imports

Focused Codemod workflow for Solidity repositories upgrading toward OpenZeppelin Contracts v5.

It handles the import-path and allowlisted symbol changes that are mechanical, then leaves categorized OZ-V5-TODO[...] markers where local review is still required.

Run

Preview changes:

bash

Apply changes:

bash

Optional AI follow-up for unresolved TODOs:

bash

Coverage

  • Safe import moves:
    • @openzeppelin/contracts/security/ReentrancyGuard.sol -> @openzeppelin/contracts/utils/ReentrancyGuard.sol
    • @openzeppelin/contracts/security/Pausable.sol -> @openzeppelin/contracts/utils/Pausable.sol
    • draft ERC20 permit imports to their v5 paths
  • Upgradeable import moves for the same safe path changes
  • Allowlisted upgradeable symbol rewrites when the corresponding import rewrite is safe:
    • IERC20Upgradeable -> IERC20
    • IERC20MetadataUpgradeable -> IERC20Metadata
    • IERC20PermitUpgradeable -> IERC20Permit
    • AddressUpgradeable -> Address
    • SafeERC20Upgradeable -> SafeERC20

Manual Follow-Up

The workflow will keep explicit TODO markers for cases that need code-aware review:

  • ownable_constructor_initial_owner
  • ownable_initializer_initial_owner
  • token_hooks_update_migration
  • removed_module_usage
  • import_path_layout_review

Validate

bash

Registry

Check the registry before publishing:

bash

Publish when ready:

bash

Local Checks

bash

Optional repo-level evaluation:

bash

Ready to contribute?

Build your own codemod and share it with the community.

Publish a codemodJoin the community