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.

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 HasEntrypoints for Ownable

fn entrypoints() -> Vec<Entrypoint>

Returns the list of contract’s entrypoints.

impl HasEvents for Ownable

fn events() -> Vec<Event>

Returns a list of Events used by the contract.

fn event_schemas() -> BTreeMap<String, Schema>

Returns a map of event schemas used by the contract.

impl HasIdent for Ownable

fn ident() -> String

Returns the contract’s ident.

impl Module for Ownable

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

Creates a new instance of the module with the given contract environment.

fn env(&self) -> Rc<ContractEnv>

Returns the contract environment associated with the module.

impl SchemaCustomTypes for Ownable

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

Returns a vector of optional CustomTypes.

impl SchemaEntrypoints for Ownable

fn schema_entrypoints() -> Vec<Entrypoint>

Returns a vector of Entrypoints.

impl SchemaErrors for Ownable

fn schema_errors() -> Vec<UserError>

Returns a vector of UserErrors.

impl SchemaEvents for Ownable

fn schema_events() -> Vec<Event>

Returns a vector of Events.

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

Returns a vector of CustomTypes.