Struct odra_modules::access::Ownable

pub struct Ownable { /* private fields */ }

This module provides a straightforward access control feature that enables exclusive access to particular functions by an account, known as the owner. The account that initiates contract deployment is automatically assigned as the owner. However, ownership can be transferred later by using the transfer_ownership() function.

You can use this module as a standalone contract or integrate it into a custom module by adding it as a field.

When used in a custom module, the only_owner() function is available, allowing you to restrict function usage to the owner.

Implementations

impl Ownable

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.

impl Ownable

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

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

Trait Implementations

impl Clone for Ownable

fn clone(&self) -> Ownable

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl DynamicInstance for Ownable

fn instance(namespace: &[u8]) -> Self

impl Node for Ownable

const IS_LEAF: bool = false

const COUNT: u32 = 1u32

fn __keys() -> Vec<String>

impl OdraItem for Ownable

fn is_module() -> bool

impl StaticInstance for Ownable

fn instance<'a>(keys: &'a [&'a str]) -> (Self, &'a [&'a str])

Consumes keys required to create an instance, returns the instance with the remaining keys.