Struct OwnableContractRef

pub struct OwnableContractRef { /* private fields */ }

Ownable Contract Ref.

Implementations

impl OwnableContractRef

pub fn init(&mut self, owner: Address)

Initializes the module setting an owner as the initial owner.

pub fn transfer_ownership(&mut self, new_owner: &Address)

Transfers ownership of the module to new_owner. This function can only be accessed by the current owner of the module.

pub fn renounce_ownership(&mut self)

If the contract’s owner chooses to renounce their ownership, the contract will no longer have an owner. This means that any functions that can only be accessed by the owner will no longer be available.

The function can only be called by the current owner, and it will permanently remove the owner’s privileges.

pub fn get_owner(&self) -> Address

Returns the address of the current owner.

pub fn assert_owner(&self, address: &Address)

Reverts with Error::CallerNotTheOwner if the function called by any account other than the owner.

pub fn get_optional_owner(&self) -> Option<Address>

Returns the optional address of the current owner.

pub fn unchecked_transfer_ownership(&mut self, new_owner: Option<Address>)

Unchecked version of the ownership transfer. It emits an event and sets the new owner.

Trait Implementations

impl ContractRef for OwnableContractRef

fn new(env: Rc<ContractEnv>, address: Address) -> Self

Creates a new instance of the Contract Ref.

fn address(&self) -> &Address

Returns the address of the contract.

fn with_tokens(&self, tokens: U512) -> Self

Creates a new contract reference with attached tokens, based on the current instance.

impl SchemaErrors for OwnableContractRef

fn schema_errors() -> Vec<UserError>

Returns a vector of UserErrors.

impl SchemaEvents for OwnableContractRef

fn schema_events() -> Vec<Event>

Returns a vector of Events.

fn custom_types() -> Vec<Option<CustomType>>

Returns a vector of CustomTypes.