Skip to content

Interfaces and libraries are not included in the @openzeppelin/contracts-upgradeable package #1200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
melonges wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Interfaces and libraries are not included in the @openzeppelin/contracts-upgradeable package #1200

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/modules/ROOT/pages/writing-upgradeable.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,8 @@ contract ERC20Upgradeable is Initializable, ContextUpgradeable, IERC20Upgradeabl

Whether using OpenZeppelin Contracts or another smart contract library, always make sure that the package is set up to handle upgradeable contracts.

WARNING: Interfaces and libraries are not included in the `@openzeppelin/contracts-upgradeable` package. They should be imported from the main `@openzeppelin/contracts` package. For example, use `IERC20` from `@openzeppelin/contracts/token/ERC20/IERC20.sol` instead of `IERC20Upgradeable`. This is because interfaces and libraries do not have state variables or constructors that would require special handling for upgrades. See the https://docs.openzeppelin.com/contracts/5.x/upgradeable[OpenZeppelin Contracts 5.x documentation] for more details.

Learn more about OpenZeppelin Contracts Upgradeable in xref:contracts::upgradeable.adoc[Contracts: Using with Upgrades].

[[avoid-initial-values-in-field-declarations]]
Expand Down Expand Up @@ -239,12 +241,12 @@ If you would like the `ERC20` instance to be upgradeable, the easiest way to ach
pragma solidity ^0.6.0;

import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
import "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";

contract MyContract is Initializable {
IERC20Upgradeable public token;
IERC20 public token;

function initialize(IERC20Upgradeable _token) public initializer {
function initialize(IERC20 _token) public initializer {
token = _token;
}
}
Expand Down