CCIP v1.5.1 Ownable2Step Contract API Reference

Ownable2Step

A minimal contract that implements 2-step ownership transfer and nothing more. It's made to be minimal to reduce the impact of the bytecode size on any contract that inherits from it.

Git Source

Events

OwnershipTransferRequested

event OwnershipTransferRequested(address indexed from, address indexed to);

Parameters

OwnershipTransferred

event OwnershipTransferred(address indexed from, address indexed to);

Parameters

Errors

CannotTransferToSelf

error CannotTransferToSelf();

MustBeProposedOwner

error MustBeProposedOwner();

OnlyCallableByOwner

error OnlyCallableByOwner();

OwnerCannotBeZero

error OwnerCannotBeZero();

State Variables

s_owner

The owner is the current owner of the contract.

address private s_owner;

s_pendingOwner

The pending owner is the address to which ownership may be transferred.

address private s_pendingOwner;

Functions

acceptOwnership

Allows an ownership transfer to be completed by the recipient.

function acceptOwnership() external override;

constructor

Initializes the contract with an owner and optionally a pending owner.

constructor(address newOwner, address pendingOwner);

Parameters

onlyOwner

Modifier that restricts function access to the contract owner.

modifier onlyOwner();

owner

Returns the current owner's address.

function owner() public view override returns (address);

Returns

transferOwnership

Allows an owner to begin transferring ownership to a new address.

function transferOwnership(address to) public override onlyOwner;

Parameters

_validateOwnership

Internal function to validate access control.

function _validateOwnership() internal view;