Initializable.sol (2024)

The Solidity based Immutable Ecosystem

View Source: @openzeppelin\contracts-upgradeable\proxy\utils\Initializable.sol

↘ Derived Contracts: ActivateToken, ContextUpgradeable, CreatorToken, CustomToken, ERC165Upgradeable, ERC20Upgradeable, ERC721BurnableUpgradeable, ERC721EnumerableUpgradeable, ERC721Upgradeable, ERC721URIStorageUpgradeable, ImmutableEntity, ImmutableProduct, OwnableUpgradeable, ProductActivate, StringCommon

Initializable

This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed behind a proxy. Since proxied contracts do not make use of a constructor, it’s common to move constructor logic to an external initializer function, usually called initialize. It then becomes necessary to protect this initializer function so it can only be called once. The {initializer} modifier provided by this contract will have this effect. The initialization functions use a version number. Once a version number is used, it is consumed and cannot be reused. This mechanism prevents re-execution of each “step” but allows the creation of new initialization steps in case an upgrade adds a module that needs to be initialized. For example: [.hljs-theme-light.nopadding]

 contract MyToken is ERC20Upgradeable { function initialize() initializer public { __ERC20_init("MyToken", "MTK"); } } contract MyTokenV2 is MyToken, ERC20PermitUpgradeable { function initializeV2() reinitializer(2) public { __ERC20Permit_init("MyToken"); } }

TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as possible by providing the encoded function call as the _data argument to {ERC1967Proxy-constructor}. CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure that all initializers are idempotent. This is not verified automatically as constructors are by Solidity. [CAUTION] ==== Avoid leaving a contract uninitialized. An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke the {_disableInitializers} function in the constructor to automatically lock it when it is deployed: [.hljs-theme-light.nopadding]

 ///## Contract Members**Constants & Variables**```jsuint8 private _initialized;bool private _initializing;

Events

event Initialized(uint8 version);

Modifiers

• initializer
• reinitializer
• onlyInitializing

initializer

A modifier that defines a protected initializer function that can be invoked at most once. In its scope, onlyInitializing functions can be used to initialize parent contracts. Equivalent to reinitializer(1).

modifier initializer() internal

Arguments

| Name | Type | Description || ————- |————- | —–|

reinitializer

A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the contract hasn’t been initialized to a greater version before. In its scope, onlyInitializing functions can be used to initialize parent contracts. initializer is equivalent to reinitializer(1), so a reinitializer may be used after the original initialization step. This is essential to configure modules that are added through upgrades and that require initialization. Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in a contract, executing them in the right order is up to the developer or operator.

modifier reinitializer(uint8 version) internal

Arguments

onlyInitializing

Modifier to protect an initialization function so that it can only be invoked by functions with the {initializer} and {reinitializer} modifiers, directly or indirectly.

modifier onlyInitializing() internal

Arguments

| Name | Type | Description || ————- |————- | —–|

Functions

• _disableInitializers()
• _setInitializedVersion(uint8 version)

_disableInitializers

Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call. Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized to any version. It is recommended to use this to lock implementation contracts that are designed to be called through proxies.

function _disableInitializers() internal nonpayable

Arguments

| Name | Type | Description || ————- |————- | —–|

_setInitializedVersion

function _setInitializedVersion(uint8 version) private nonpayablereturns(bool)

Arguments

Contracts

• ActivateToken
• AddressUpgradeable
• ContextUpgradeable
• CreatorToken
• CustomToken
• ERC165Upgradeable
• ERC20Upgradeable
• ERC721BurnableUpgradeable
• ERC721EnumerableUpgradeable
• ERC721Upgradeable
• ERC721URIStorageUpgradeable
• IERC165Upgradeable
• IERC20MetadataUpgradeable
• IERC20Upgradeable
• IERC721EnumerableUpgradeable
• IERC721MetadataUpgradeable
• IERC721ReceiverUpgradeable
• IERC721Upgradeable
• ImmutableEntity
• ImmutableProduct
• Initializable
• Migrations
• OwnableUpgradeable
• ProductActivate
• StringCommon
• StringsUpgradeable