access_control

Fully qualified path: access_control

Modules

Re-exports:

• Structs

• Traits

• Modules

Groups:

dispatchers

• Structs

• Traits

Modules

Modules

access_control

Fully qualified path: access_control::access_control

Modules

Groups:

dispatchers

• Structs

• Traits

Modules

Modules

access_control_component

Fully qualified path: access_control::access_control::access_control_component

Modules

Free functions

Structs

Enums

Traits

Impls

Modules

Modules

__external_AccessControl

Fully qualified path: access_control::access_control::access_control_component::__external_AccessControl

__l1_handler_AccessControl

Fully qualified path: access_control::access_control::access_control_component::__l1_handler_AccessControl

__constructor_AccessControl

Fully qualified path: access_control::access_control::access_control_component::__constructor_AccessControl

Free functions

Free functions

unsafe_new_component_state

Fully qualified path: access_control::access_control::access_control_component::unsafe_new_component_state

pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>

Structs

Structs

Storage

Fully qualified path: access_control::access_control::access_control_component::Storage

    [storage]
pub struct Storage { /* private fields */ }

AdminChanged

Fully qualified path: access_control::access_control::access_control_component::AdminChanged

    [derive(Copy, Drop, starknet::Event, PartialEq)]
pub struct AdminChanged { /* private fields */ }

NewPendingAdmin

Fully qualified path: access_control::access_control::access_control_component::NewPendingAdmin

    [derive(Copy, Drop, starknet::Event, PartialEq)]
pub struct NewPendingAdmin { /* private fields */ }

RoleGranted

Fully qualified path: access_control::access_control::access_control_component::RoleGranted

    [derive(Copy, Drop, starknet::Event, PartialEq)]
pub struct RoleGranted { /* private fields */ }

RoleRevoked

Fully qualified path: access_control::access_control::access_control_component::RoleRevoked

    [derive(Copy, Drop, starknet::Event, PartialEq)]
pub struct RoleRevoked { /* private fields */ }

ComponentState

Fully qualified path: access_control::access_control::access_control_component::ComponentState

pub struct ComponentState<TContractState> {}

Enums

Enums

Event

Fully qualified path: access_control::access_control::access_control_component::Event

pub enum Event {
    AdminChanged: AdminChanged,
    NewPendingAdmin: NewPendingAdmin,
    RoleGranted: RoleGranted,
    RoleRevoked: RoleRevoked,
}

Variants

AdminChanged

Fully qualified path: access_control::access_control::access_control_component::Event::AdminChanged

AdminChanged: AdminChanged

NewPendingAdmin

Fully qualified path: access_control::access_control::access_control_component::Event::NewPendingAdmin

NewPendingAdmin: NewPendingAdmin

RoleGranted

Fully qualified path: access_control::access_control::access_control_component::Event::RoleGranted

RoleGranted: RoleGranted

RoleRevoked

Fully qualified path: access_control::access_control::access_control_component::Event::RoleRevoked

RoleRevoked: RoleRevoked

Traits

Traits

HasComponent

Fully qualified path: access_control::access_control::access_control_component::HasComponent

pub trait HasComponent<TContractState>

Trait functions

get_component

Fully qualified path: access_control::access_control::access_control_component::HasComponent::get_component

fn get_component(self: @TContractState) -> @ComponentState<TContractState>

get_component_mut

Fully qualified path: access_control::access_control::access_control_component::HasComponent::get_component_mut

fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>

get_contract

Fully qualified path: access_control::access_control::access_control_component::HasComponent::get_contract

fn get_contract(self: @ComponentState<TContractState>) -> @TContractState

get_contract_mut

Fully qualified path: access_control::access_control::access_control_component::HasComponent::get_contract_mut

fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState

emit

Fully qualified path: access_control::access_control::access_control_component::HasComponent::emit

fn emit<S, impl IntoImp: Into<S, access_control::access_control::access_control_component::Event>>(
    ref self: ComponentState<TContractState>, event: S,
)

AccessControlHelpersTrait

Fully qualified path: access_control::access_control::access_control_component::AccessControlHelpersTrait

pub trait AccessControlHelpersTrait<TContractState, +HasComponent<TContractState>>

Trait functions

initializer

Fully qualified path: access_control::access_control::access_control_component::AccessControlHelpersTrait::initializer

fn initializer(
    ref self: ComponentState<TContractState>, admin: ContractAddress, roles: Option<u128>,
)

assert_has_role

Fully qualified path: access_control::access_control::access_control_component::AccessControlHelpersTrait::assert_has_role

fn assert_has_role(self: @ComponentState<TContractState>, role: u128)

assert_admin

Fully qualified path: access_control::access_control::access_control_component::AccessControlHelpersTrait::assert_admin

fn assert_admin(self: @ComponentState<TContractState>)

set_admin_helper

Fully qualified path: access_control::access_control::access_control_component::AccessControlHelpersTrait::set_admin_helper

fn set_admin_helper(ref self: ComponentState<TContractState>, new_admin: ContractAddress)

set_pending_admin_helper

Fully qualified path: access_control::access_control::access_control_component::AccessControlHelpersTrait::set_pending_admin_helper

fn set_pending_admin_helper(ref self: ComponentState<TContractState>, new_admin: ContractAddress)

grant_role_helper

Fully qualified path: access_control::access_control::access_control_component::AccessControlHelpersTrait::grant_role_helper

fn grant_role_helper(ref self: ComponentState<TContractState>, role: u128, account: ContractAddress)

revoke_role_helper

Fully qualified path: access_control::access_control::access_control_component::AccessControlHelpersTrait::revoke_role_helper

fn revoke_role_helper(
    ref self: ComponentState<TContractState>, role: u128, account: ContractAddress,
)

UnsafeNewContractStateTraitForAccessControl

Fully qualified path: access_control::access_control::access_control_component::UnsafeNewContractStateTraitForAccessControl

pub trait UnsafeNewContractStateTraitForAccessControl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: access_control::access_control::access_control_component::UnsafeNewContractStateTraitForAccessControl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

Impls

Impls

AccessControlPublic

Fully qualified path: access_control::access_control::access_control_component::AccessControlPublic

pub impl AccessControlPublic<
    TContractState, +HasComponent<TContractState>,
> of IAccessControl<ComponentState<TContractState>>;

Impl functions

get_roles

Fully qualified path: access_control::access_control::access_control_component::AccessControlPublic::get_roles

fn get_roles(self: @ComponentState<TContractState>, account: ContractAddress) -> u128

has_role

Fully qualified path: access_control::access_control::access_control_component::AccessControlPublic::has_role

fn has_role(self: @ComponentState<TContractState>, role: u128, account: ContractAddress) -> bool

get_admin

Fully qualified path: access_control::access_control::access_control_component::AccessControlPublic::get_admin

fn get_admin(self: @ComponentState<TContractState>) -> ContractAddress

get_pending_admin

Fully qualified path: access_control::access_control::access_control_component::AccessControlPublic::get_pending_admin

fn get_pending_admin(self: @ComponentState<TContractState>) -> ContractAddress

grant_role

Fully qualified path: access_control::access_control::access_control_component::AccessControlPublic::grant_role

fn grant_role(ref self: ComponentState<TContractState>, role: u128, account: ContractAddress)

revoke_role

Fully qualified path: access_control::access_control::access_control_component::AccessControlPublic::revoke_role

fn revoke_role(ref self: ComponentState<TContractState>, role: u128, account: ContractAddress)

renounce_role

Fully qualified path: access_control::access_control::access_control_component::AccessControlPublic::renounce_role

fn renounce_role(ref self: ComponentState<TContractState>, role: u128)

set_pending_admin

Fully qualified path: access_control::access_control::access_control_component::AccessControlPublic::set_pending_admin

fn set_pending_admin(ref self: ComponentState<TContractState>, new_admin: ContractAddress)

accept_admin

Fully qualified path: access_control::access_control::access_control_component::AccessControlPublic::accept_admin

fn accept_admin(ref self: ComponentState<TContractState>)

dispatchers

• Structs

• Traits

Structs

Structs

IAccessControlDispatcher

Fully qualified path: access_control::access_control::IAccessControlDispatcher

Part of the group: dispatchers

[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IAccessControlDispatcher {
    pub contract_address: ContractAddress,
}

Members

contract_address

Fully qualified path: access_control::access_control::IAccessControlDispatcher::contract_address

pub contract_address: ContractAddress

Traits

Traits

IAccessControlDispatcherTrait

Fully qualified path: access_control::access_control::IAccessControlDispatcherTrait

Part of the group: dispatchers

pub trait IAccessControlDispatcherTrait<T>

Trait functions

get_roles

Fully qualified path: access_control::access_control::IAccessControlDispatcherTrait::get_roles

fn get_roles(self: T, account: ContractAddress) -> u128

has_role

Fully qualified path: access_control::access_control::IAccessControlDispatcherTrait::has_role

fn has_role(self: T, role: u128, account: ContractAddress) -> bool

get_admin

Fully qualified path: access_control::access_control::IAccessControlDispatcherTrait::get_admin

fn get_admin(self: T) -> ContractAddress

get_pending_admin

Fully qualified path: access_control::access_control::IAccessControlDispatcherTrait::get_pending_admin

fn get_pending_admin(self: T) -> ContractAddress

grant_role

Fully qualified path: access_control::access_control::IAccessControlDispatcherTrait::grant_role

fn grant_role(self: T, role: u128, account: ContractAddress)

revoke_role

Fully qualified path: access_control::access_control::IAccessControlDispatcherTrait::revoke_role

fn revoke_role(self: T, role: u128, account: ContractAddress)

renounce_role

Fully qualified path: access_control::access_control::IAccessControlDispatcherTrait::renounce_role

fn renounce_role(self: T, role: u128)

set_pending_admin

Fully qualified path: access_control::access_control::IAccessControlDispatcherTrait::set_pending_admin

fn set_pending_admin(self: T, new_admin: ContractAddress)

accept_admin

Fully qualified path: access_control::access_control::IAccessControlDispatcherTrait::accept_admin

fn accept_admin(self: T)