API Reference

This section contains the complete API reference for the OpenZeppelin Foundry Upgrades library.

Core Libraries

Library for deploying and managing upgradeable contracts from Forge scripts or tests. Requires OpenZeppelin Contracts v5 or higher.

Library for managing upgradeable contracts from Forge scripts or tests. Only for upgrading existing deployments using OpenZeppelin Contracts v4.

Library for interacting with OpenZeppelin Defender from Forge scripts or tests.

Configuration options and structs used throughout the upgrade libraries.

Internal helper methods to validate/deploy implementations and perform upgrades.

Internal helper methods for Defender deployments.

Internal helper methods used by Upgrades and Defender libraries.

String manipulation utilities.

Version management utilities.

Interface for proxy admin contracts.

Interface for upgradeable beacon contracts.

Interface for upgradeable proxy contracts.