Struct odra_modules::access::AccessControl

pub struct AccessControl { /* private fields */ }

This contract module enables the implementation of role-based access control mechanisms for children modules.

Roles are identified by their 32-bytes identifier, which should be unique and exposed in the external API.

Roles can be used to represent a set of permissions, and the hasRole function is used to restrict access to a function call.

Roles can be granted and revoked dynamically using the grant_role() and revoke_role() functions, respectively. Each role has an associated admin role, and only accounts that have the role’s admin role can call grant_role and revoke_role.

By default, the admin role for all roles is DEFAULT_ADMIN_ROLE, which means that only accounts with this role can grant or revoke other roles.

More complex role relationships can be established using the set_admin_role() function.

Implementations

impl AccessControl

pub fn has_role(&self, role: &Role, address: &Address) -> bool

Returns true if account has been granted role.

pub fn get_role_admin(&self, role: &Role) -> Role

Returns the admin role that controls role.

The admin role may be changed using set_admin_role().

pub fn grant_role(&mut self, role: &Role, address: &Address)

Grants role to address.

If the role has been already granted - nothing happens, otherwise RoleGranted event is emitted.

The caller must have role’s admin role.

pub fn revoke_role(&mut self, role: &Role, address: &Address)

Grants role to address.

If the role has been already revoked - nothing happens, otherwise RoleRevoked event is emitted.

The caller must have role’s admin role.

pub fn renounce_role(&mut self, role: &Role, address: &Address)

The function is used to remove a role from the account that initiated the call.

One common way of managing roles is by using grant_role() and revoke_role(). The purpose of revokeRole is to provide a mechanism for revoking privileges from an account in case it gets compromised.

If the account had previously been granted the role, the function will trigger a RoleRevoked event.

Note that only address is authorized to call this function.

impl AccessControl

pub fn check_role(&self, role: &Role, address: &Address)

Ensures address has role. If not, reverts with Error::MissingRole.

pub fn set_admin_role(&mut self, role: &Role, admin_role: &Role)

Sets admin_role as role’s admin role.

Emits a RoleAdminChanged event.

pub fn unchecked_grant_role(&mut self, role: &Role, address: &Address)

Grants role to address.

Internal function without access restriction. This function should be used to setup the initial access control.

May emit a RoleGranted event.

pub fn unchecked_revoke_role(&mut self, role: &Role, address: &Address)

Revokes role from address.

Internal function without access restriction. This function should be used to setup the initial access control.

May emit a RoleRevoked event.

Trait Implementations

impl HasEntrypoints for AccessControl

fn entrypoints() -> Vec<Entrypoint>

Returns the list of contract’s entrypoints.

impl HasEvents for AccessControl

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 AccessControl

fn ident() -> String

Returns the contract’s ident.

impl Module for AccessControl

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 AccessControl

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

Returns a vector of optional CustomTypes.

impl SchemaEntrypoints for AccessControl

fn schema_entrypoints() -> Vec<Entrypoint>

Returns a vector of Entrypoints.

impl SchemaErrors for AccessControl

fn schema_errors() -> Vec<UserError>

Returns a vector of UserErrors.

impl SchemaEvents for AccessControl

fn schema_events() -> Vec<Event>

Returns a vector of Events.

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

Returns a vector of CustomTypes.