Struct odra_modules::access::OwnableHostRef

pub struct OwnableHostRef { /* private fields */ }

Ownable Host Ref.

Implementations

impl OwnableHostRef

pub fn init(&mut self)

Initializes the module setting the caller 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.

impl OwnableHostRef

pub fn try_init(&mut self) -> OdraResult<()>

Initializes the module setting the caller as the initial owner. Does not fail in case of error, returns odra::OdraResult instead.

pub fn try_transfer_ownership(&mut self, new_owner: &Address) -> OdraResult<()>

Transfers ownership of the module to new_owner. This function can only be accessed by the current owner of the module. Does not fail in case of error, returns odra::OdraResult instead.

pub fn try_renounce_ownership(&mut self) -> OdraResult<()>

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. Does not fail in case of error, returns odra::OdraResult instead.

pub fn try_get_owner(&self) -> OdraResult<Address>

Returns the address of the current owner. Does not fail in case of error, returns odra::OdraResult instead.

pub fn try_assert_owner(&self, address: &Address) -> OdraResult<()>

Reverts with Error::CallerNotTheOwner if the function called by any account other than the owner. Does not fail in case of error, returns odra::OdraResult instead.

pub fn try_get_optional_owner(&self) -> OdraResult<Option<Address>>

Returns the optional address of the current owner. Does not fail in case of error, returns odra::OdraResult instead.

pub fn try_unchecked_transfer_ownership( &mut self, new_owner: Option<Address>, ) -> OdraResult<()>

Unchecked version of the ownership transfer. It emits an event and sets the new owner. Does not fail in case of error, returns odra::OdraResult instead.

Trait Implementations

impl EntryPointsCallerProvider for OwnableHostRef

fn entry_points_caller(env: &HostEnv) -> EntryPointsCaller

Returns an EntryPointsCaller for the given host environment.

impl HasIdent for OwnableHostRef

fn ident() -> String

Returns the contract’s ident.

impl HostRef for OwnableHostRef

fn new(address: Address, env: HostEnv) -> Self

Creates a new host side reference to a contract.

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

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

fn address(&self) -> &Address

Returns the address of the contract.

fn env(&self) -> &HostEnv

Returns the host environment.

fn get_event<T>(&self, index: i32) -> Result<T, EventError>

where T: FromBytes + EventInstance,

Returns the n-th event emitted by the contract.

fn last_call(&self) -> ContractCallResult

Returns a detailed information about the last call of the contract.