Skip to main content

UpgradeableBeacon

Git Source

Inherits: IBeacon, Ownable

This contract is used in conjunction with one or more instances of {BeaconProxy} to determine their implementation contract, which is where they will delegate all function calls. An owner is able to change the implementation the beacon points to, thus upgrading the proxies that use this beacon.

State Variables​

_implementation​

address private _implementation;

Functions​

constructor​

Sets the address of the initial implementation, and the initial owner who can upgrade the beacon.

constructor(address implementation_, address initialOwner) Ownable(initialOwner);

implementation​

Returns the current implementation address.

function implementation() public view virtual returns (address);

upgradeTo​

*Upgrades the beacon to a new implementation. Emits an Upgraded event. Requirements:

  • msg.sender must be the owner of the contract.
  • newImplementation must be a contract.*
function upgradeTo(address newImplementation) public virtual onlyOwner;

_setImplementation​

*Sets the implementation contract address for this beacon Requirements:

  • newImplementation must be a contract.*
function _setImplementation(address newImplementation) private;

Events​

Upgraded​

Emitted when the implementation returned by the beacon is changed.

event Upgraded(address indexed implementation);

Errors​

BeaconInvalidImplementation​

The implementation of the beacon is invalid.

error BeaconInvalidImplementation(address implementation);