axelar-gmp-sdk-solidity

Solidity API

IOwnable

IOwnable is an interface that abstracts the implementation of a contract with ownership control features. It’s commonly used in upgradable contracts and includes the functionality to get current owner, transfer ownership, and propose and accept ownership.

NotOwner

error NotOwner()

InvalidOwner

error InvalidOwner()

InvalidOwnerAddress

error InvalidOwnerAddress()

OwnershipTransferStarted

event OwnershipTransferStarted(address newOwner)

OwnershipTransferred

event OwnershipTransferred(address newOwner)

owner

function owner() external view returns (address)

Returns the current owner of the contract.

Return Values

Name	Type	Description
[0]	address	address The address of the current owner

pendingOwner

function pendingOwner() external view returns (address)

Returns the address of the pending owner of the contract.

Return Values

Name	Type	Description
[0]	address	address The address of the pending owner

transferOwnership

function transferOwnership(address newOwner) external

Transfers ownership of the contract to a new address

Parameters

Name	Type	Description
newOwner	address	The address to transfer ownership to

proposeOwnership

function proposeOwnership(address newOwner) external

Proposes to transfer the contract’s ownership to a new address. The new owner needs to accept the ownership explicitly.

Parameters

Name	Type	Description
newOwner	address	The address to transfer ownership to

acceptOwnership

function acceptOwnership() external

Transfers ownership to the pending owner.

Can only be called by the pending owner