Proxy Admin

This is an auxiliary contract meant to be assigned as the admin of a {TransparentUpgradeableProxy}. For an explanation of why you would want to use this see the documentation for {TransparentUpgradeableProxy}.

Methods

changeProxyAdmin

function changeProxyAdmin(contract TransparentUpgradeableProxy proxy, address newAdmin) external nonpayable

Changes the admin of proxy to newAdmin. Requirements: - This contract must be the current admin of proxy.

Parameters

NameTypeDescription

proxy

contract TransparentUpgradeableProxy

undefined

newAdmin

address

undefined

getProxyAdmin

function getProxyAdmin(contract TransparentUpgradeableProxy proxy) external view returns (address)

Returns the current admin of proxy. Requirements: - This contract must be the admin of proxy.

Parameters

NameTypeDescription

proxy

contract TransparentUpgradeableProxy

undefined

Returns

NameTypeDescription

_0

address

undefined

getProxyImplementation

function getProxyImplementation(contract TransparentUpgradeableProxy proxy) external view returns (address)

Returns the current implementation of proxy. Requirements: - This contract must be the admin of proxy.

Parameters

NameTypeDescription

proxy

contract TransparentUpgradeableProxy

undefined

Returns

NameTypeDescription

_0

address

undefined

owner

function owner() external view returns (address)

Returns the address of the current owner.

Returns

NameTypeDescription

_0

address

undefined

renounceOwnership

function renounceOwnership() external nonpayable

Leaves the contract without owner. It will not be possible to call onlyOwner functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.

transferOwnership

function transferOwnership(address newOwner) external nonpayable

Transfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.

Parameters

NameTypeDescription

newOwner

address

undefined

upgrade

function upgrade(contract TransparentUpgradeableProxy proxy, address implementation) external nonpayable

Upgrades proxy to implementation. See {TransparentUpgradeableProxy-upgradeTo}. Requirements: - This contract must be the admin of proxy.

Parameters

NameTypeDescription

proxy

contract TransparentUpgradeableProxy

undefined

implementation

address

undefined

upgradeAndCall

function upgradeAndCall(contract TransparentUpgradeableProxy proxy, address implementation, bytes data) external payable

Upgrades proxy to implementation and calls a function on the new implementation. See {TransparentUpgradeableProxy-upgradeToAndCall}. Requirements: - This contract must be the admin of proxy.

Parameters

NameTypeDescription

proxy

contract TransparentUpgradeableProxy

undefined

implementation

address

undefined

data

bytes

undefined

Events

OwnershipTransferred

event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)

Parameters

NameTypeDescription

previousOwner indexed

address

undefined

newOwner indexed

address

undefined

Last updated