starkware_utils
Fully qualified path: starkware_utils
Modules
Modules
Modules
components
Fully qualified path: starkware_utils::components
Modules
Modules
Modules
deposit
Fully qualified path: starkware_utils::components::deposit
Modules
Re-exports:
Modules
Modules
events
Fully qualified path: starkware_utils::components::deposit::events
Structs
Structs
Structs
AssetRegistered
Fully qualified path: starkware_utils::components::deposit::events::AssetRegistered
[derive(Debug, Drop, PartialEq, starknet::Event)]
pub struct AssetRegistered {
pub asset_id: felt252,
pub token_address: ContractAddress,
pub quantum: u64,
}
Members
asset_id
Fully qualified path: starkware_utils::components::deposit::events::AssetRegistered::asset_id
pub asset_id: felt252
token_address
Fully qualified path: starkware_utils::components::deposit::events::AssetRegistered::token_address
pub token_address: ContractAddress
quantum
Fully qualified path: starkware_utils::components::deposit::events::AssetRegistered::quantum
pub quantum: u64
Deposit
Fully qualified path: starkware_utils::components::deposit::events::Deposit
[derive(Debug, Drop, PartialEq, starknet::Event)]
pub struct Deposit {
pub beneficiary: u32,
pub depositing_address: ContractAddress,
pub asset_id: felt252,
pub quantized_amount: u128,
pub unquantized_amount: u128,
pub deposit_request_hash: felt252,
}
Members
beneficiary
Fully qualified path: starkware_utils::components::deposit::events::Deposit::beneficiary
pub beneficiary: u32
depositing_address
Fully qualified path: starkware_utils::components::deposit::events::Deposit::depositing_address
pub depositing_address: ContractAddress
asset_id
Fully qualified path: starkware_utils::components::deposit::events::Deposit::asset_id
pub asset_id: felt252
quantized_amount
Fully qualified path: starkware_utils::components::deposit::events::Deposit::quantized_amount
pub quantized_amount: u128
unquantized_amount
Fully qualified path: starkware_utils::components::deposit::events::Deposit::unquantized_amount
pub unquantized_amount: u128
deposit_request_hash
Fully qualified path: starkware_utils::components::deposit::events::Deposit::deposit_request_hash
pub deposit_request_hash: felt252
DepositProcessed
Fully qualified path: starkware_utils::components::deposit::events::DepositProcessed
[derive(Debug, Drop, PartialEq, starknet::Event)]
pub struct DepositProcessed {
pub beneficiary: u32,
pub depositing_address: ContractAddress,
pub asset_id: felt252,
pub quantized_amount: u128,
pub unquantized_amount: u128,
pub deposit_request_hash: felt252,
}
Members
beneficiary
Fully qualified path: starkware_utils::components::deposit::events::DepositProcessed::beneficiary
pub beneficiary: u32
depositing_address
Fully qualified path: starkware_utils::components::deposit::events::DepositProcessed::depositing_address
pub depositing_address: ContractAddress
asset_id
Fully qualified path: starkware_utils::components::deposit::events::DepositProcessed::asset_id
pub asset_id: felt252
quantized_amount
Fully qualified path: starkware_utils::components::deposit::events::DepositProcessed::quantized_amount
pub quantized_amount: u128
unquantized_amount
Fully qualified path: starkware_utils::components::deposit::events::DepositProcessed::unquantized_amount
pub unquantized_amount: u128
deposit_request_hash
Fully qualified path: starkware_utils::components::deposit::events::DepositProcessed::deposit_request_hash
pub deposit_request_hash: felt252
DepositCanceled
Fully qualified path: starkware_utils::components::deposit::events::DepositCanceled
[derive(Debug, Drop, PartialEq, starknet::Event)]
pub struct DepositCanceled {
pub beneficiary: u32,
pub depositing_address: ContractAddress,
pub asset_id: felt252,
pub quantized_amount: u128,
pub unquantized_amount: u128,
pub deposit_request_hash: felt252,
}
Members
beneficiary
Fully qualified path: starkware_utils::components::deposit::events::DepositCanceled::beneficiary
pub beneficiary: u32
depositing_address
Fully qualified path: starkware_utils::components::deposit::events::DepositCanceled::depositing_address
pub depositing_address: ContractAddress
asset_id
Fully qualified path: starkware_utils::components::deposit::events::DepositCanceled::asset_id
pub asset_id: felt252
quantized_amount
Fully qualified path: starkware_utils::components::deposit::events::DepositCanceled::quantized_amount
pub quantized_amount: u128
unquantized_amount
Fully qualified path: starkware_utils::components::deposit::events::DepositCanceled::unquantized_amount
pub unquantized_amount: u128
deposit_request_hash
Fully qualified path: starkware_utils::components::deposit::events::DepositCanceled::deposit_request_hash
pub deposit_request_hash: felt252
interface
Fully qualified path: starkware_utils::components::deposit::interface
Modules
| __external_IDepositForwardImpl | — |
| __l1_handler_IDepositForwardImpl | — |
| __constructor_IDepositForwardImpl | — |
Enums
Traits
Groups:
dispatchers
| IDepositDispatcher | — |
| IDepositLibraryDispatcher | — |
| IDepositSafeLibraryDispatcher | — |
| IDepositSafeDispatcher | — |
Modules
Modules
| __external_IDepositForwardImpl | — |
| __l1_handler_IDepositForwardImpl | — |
| __constructor_IDepositForwardImpl | — |
__external_IDepositForwardImpl
Fully qualified path: starkware_utils::components::deposit::interface::__external_IDepositForwardImpl
__l1_handler_IDepositForwardImpl
Fully qualified path: starkware_utils::components::deposit::interface::__l1_handler_IDepositForwardImpl
__constructor_IDepositForwardImpl
Fully qualified path: starkware_utils::components::deposit::interface::__constructor_IDepositForwardImpl
Enums
Enums
DepositStatus
Fully qualified path: starkware_utils::components::deposit::interface::DepositStatus
pub enum DepositStatus {
NOT_REGISTERED,
PROCESSED,
CANCELED,
PENDING: Timestamp,
}
Variants
NOT_REGISTERED
Fully qualified path: starkware_utils::components::deposit::interface::DepositStatus::NOT_REGISTERED
NOT_REGISTERED
PROCESSED
Fully qualified path: starkware_utils::components::deposit::interface::DepositStatus::PROCESSED
PROCESSED
CANCELED
Fully qualified path: starkware_utils::components::deposit::interface::DepositStatus::CANCELED
CANCELED
PENDING
Fully qualified path: starkware_utils::components::deposit::interface::DepositStatus::PENDING
PENDING: Timestamp
Traits
Traits
IDeposit
Fully qualified path: starkware_utils::components::deposit::interface::IDeposit
pub trait IDeposit<TContractState>
Trait functions
deposit
Fully qualified path: starkware_utils::components::deposit::interface::IDeposit::deposit
fn deposit(
ref self: TContractState,
beneficiary: u32,
asset_id: felt252,
quantized_amount: u128,
salt: felt252,
)
cancel_deposit
Fully qualified path: starkware_utils::components::deposit::interface::IDeposit::cancel_deposit
fn cancel_deposit(
ref self: TContractState,
beneficiary: u32,
asset_id: felt252,
quantized_amount: u128,
salt: felt252,
)
get_deposit_status
Fully qualified path: starkware_utils::components::deposit::interface::IDeposit::get_deposit_status
fn get_deposit_status(self: @TContractState, deposit_hash: felt252) -> DepositStatus
get_asset_info
Fully qualified path: starkware_utils::components::deposit::interface::IDeposit::get_asset_info
fn get_asset_info(self: @TContractState, asset_id: felt252) -> (ContractAddress, u64)
get_cancel_delay
Fully qualified path: starkware_utils::components::deposit::interface::IDeposit::get_cancel_delay
fn get_cancel_delay(self: @TContractState) -> TimeDelta
UnsafeNewContractStateTraitForIDepositForwardImpl
Fully qualified path: starkware_utils::components::deposit::interface::UnsafeNewContractStateTraitForIDepositForwardImpl
pub trait UnsafeNewContractStateTraitForIDepositForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: starkware_utils::components::deposit::interface::UnsafeNewContractStateTraitForIDepositForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
deposit
Fully qualified path: starkware_utils::components::deposit::deposit
Modules
Modules
Modules
Deposit
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit
Modules
Free functions
Structs
Enums
Traits
Modules
Modules
__external_DepositImpl
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::__external_DepositImpl
__l1_handler_DepositImpl
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::__l1_handler_DepositImpl
__constructor_DepositImpl
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::__constructor_DepositImpl
Free functions
Free functions
deposit_hash
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::deposit_hash
pub fn deposit_hash(
depositor: ContractAddress,
beneficiary: u32,
asset_id: felt252,
quantized_amount: u128,
salt: felt252,
) -> felt252
unsafe_new_component_state
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
Storage
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::Storage
[storage]
pub struct Storage { /* private fields */ }
ComponentState
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::Event
pub enum Event {
AssetRegistered: AssetRegistered,
Deposit: Deposit,
DepositCanceled: DepositCanceled,
DepositProcessed: DepositProcessed,
}
Variants
AssetRegistered
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::Event::AssetRegistered
AssetRegistered: AssetRegistered
Deposit
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::Event::Deposit
Deposit: Deposit
DepositCanceled
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::Event::DepositCanceled
DepositCanceled: DepositCanceled
DepositProcessed
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::Event::DepositProcessed
DepositProcessed: DepositProcessed
Traits
Traits
HasComponent
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::HasComponent::emit
fn emit<S, impl IntoImp: Into<S, starkware_utils::components::deposit::deposit::Deposit::Event>>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::InternalTrait
pub trait InternalTrait<TContractState, +HasComponent<TContractState>, +Drop<TContractState>>
Trait functions
initialize
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::InternalTrait::initialize
fn initialize(ref self: ComponentState<TContractState>, cancel_delay: TimeDelta)
register_token
Each asset_id can be registered only once.
Same token_address and quantum can be shared by different asset_id.
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::InternalTrait::register_token
fn register_token(
ref self: ComponentState<TContractState>,
asset_id: felt252,
token_address: ContractAddress,
quantum: u64,
)
process_deposit
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::InternalTrait::process_deposit
fn process_deposit(
ref self: ComponentState<TContractState>,
depositor: ContractAddress,
beneficiary: u32,
asset_id: felt252,
quantized_amount: u128,
salt: felt252,
)
UnsafeNewContractStateTraitForDepositImpl
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::UnsafeNewContractStateTraitForDepositImpl
pub trait UnsafeNewContractStateTraitForDepositImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: starkware_utils::components::deposit::deposit::Deposit::UnsafeNewContractStateTraitForDepositImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
nonce
Fully qualified path: starkware_utils::components::nonce
Modules
Re-exports:
Modules
Modules
interface
Fully qualified path: starkware_utils::components::nonce::interface
Modules
Traits
Groups:
dispatchers
Modules
Modules
__external_INonceForwardImpl
Fully qualified path: starkware_utils::components::nonce::interface::__external_INonceForwardImpl
__l1_handler_INonceForwardImpl
Fully qualified path: starkware_utils::components::nonce::interface::__l1_handler_INonceForwardImpl
__constructor_INonceForwardImpl
Fully qualified path: starkware_utils::components::nonce::interface::__constructor_INonceForwardImpl
Traits
Traits
INonce
Fully qualified path: starkware_utils::components::nonce::interface::INonce
pub trait INonce<TContractState>
Trait functions
nonce
Fully qualified path: starkware_utils::components::nonce::interface::INonce::nonce
fn nonce(self: @TContractState) -> u64
UnsafeNewContractStateTraitForINonceForwardImpl
Fully qualified path: starkware_utils::components::nonce::interface::UnsafeNewContractStateTraitForINonceForwardImpl
pub trait UnsafeNewContractStateTraitForINonceForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: starkware_utils::components::nonce::interface::UnsafeNewContractStateTraitForINonceForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
nonce
Fully qualified path: starkware_utils::components::nonce::nonce
Modules
Modules
Modules
NonceComponent
Nonce Component
The Nonce component provides a simple mechanism for handling incremental nonce. It is commonly used to prevent replay attacks when contracts accept signatures as input.
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent
Modules
Free functions
Structs
Enums
Traits
Modules
Modules
__external_NonceImpl
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::__external_NonceImpl
__l1_handler_NonceImpl
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::__l1_handler_NonceImpl
__constructor_NonceImpl
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::__constructor_NonceImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
Storage
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::Storage
[storage]
pub struct Storage { /* private fields */ }
ComponentState
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::Event
pub enum Event {}
Traits
Traits
HasComponent
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::HasComponent::emit
fn emit<S, impl IntoImp: Into<S, starkware_utils::components::nonce::nonce::NonceComponent::Event>>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::InternalTrait
pub trait InternalTrait<TContractState, +HasComponent<TContractState>>
Trait functions
use_next_nonce
Consumes a nonce, returns the current value, and increments nonce.
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::InternalTrait::use_next_nonce
fn use_next_nonce(ref self: ComponentState<TContractState>) -> u64
use_checked_nonce
Consumes a nonce, returns the current value, and increments nonce. Panics if the nonce is not the expected value.
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::InternalTrait::use_checked_nonce
fn use_checked_nonce(ref self: ComponentState<TContractState>, nonce: u64) -> u64
UnsafeNewContractStateTraitForNonceImpl
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::UnsafeNewContractStateTraitForNonceImpl
pub trait UnsafeNewContractStateTraitForNonceImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: starkware_utils::components::nonce::nonce::NonceComponent::UnsafeNewContractStateTraitForNonceImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
pausable
Fully qualified path: starkware_utils::components::pausable
Modules
Re-exports:
Modules
Modules
interface
Fully qualified path: starkware_utils::components::pausable::interface
Modules
| __external_IPausableForwardImpl | — |
| __l1_handler_IPausableForwardImpl | — |
| __constructor_IPausableForwardImpl | — |
Traits
Groups:
dispatchers
| IPausableDispatcher | — |
| IPausableLibraryDispatcher | — |
| IPausableSafeLibraryDispatcher | — |
| IPausableSafeDispatcher | — |
Modules
Modules
| __external_IPausableForwardImpl | — |
| __l1_handler_IPausableForwardImpl | — |
| __constructor_IPausableForwardImpl | — |
__external_IPausableForwardImpl
Fully qualified path: starkware_utils::components::pausable::interface::__external_IPausableForwardImpl
__l1_handler_IPausableForwardImpl
Fully qualified path: starkware_utils::components::pausable::interface::__l1_handler_IPausableForwardImpl
__constructor_IPausableForwardImpl
Fully qualified path: starkware_utils::components::pausable::interface::__constructor_IPausableForwardImpl
Traits
Traits
IPausable
Fully qualified path: starkware_utils::components::pausable::interface::IPausable
pub trait IPausable<TState>
Trait functions
is_paused
Fully qualified path: starkware_utils::components::pausable::interface::IPausable::is_paused
fn is_paused(self: @TState) -> bool
pause
Fully qualified path: starkware_utils::components::pausable::interface::IPausable::pause
fn pause(ref self: TState)
unpause
Fully qualified path: starkware_utils::components::pausable::interface::IPausable::unpause
fn unpause(ref self: TState)
UnsafeNewContractStateTraitForIPausableForwardImpl
Fully qualified path: starkware_utils::components::pausable::interface::UnsafeNewContractStateTraitForIPausableForwardImpl
pub trait UnsafeNewContractStateTraitForIPausableForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: starkware_utils::components::pausable::interface::UnsafeNewContractStateTraitForIPausableForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
pausable
Fully qualified path: starkware_utils::components::pausable::pausable
Modules
Modules
Modules
PausableComponent
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent
Modules
Free functions
Structs
| Storage | — |
| Paused | Emitted when paused, where account triggered the action. |
| Unpaused | Emitted when un-paused, where account triggered the action. |
| ComponentState | — |
Enums
Traits
Modules
Modules
Errors
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::Errors
Constants
Constants
Constants
PAUSED
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::Errors::PAUSED
pub const PAUSED: felt252 = 88241534616900;
NOT_PAUSED
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::Errors::NOT_PAUSED
pub const NOT_PAUSED: felt252 = 369807958111918889321796;
__external_PausableImpl
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::__external_PausableImpl
__l1_handler_PausableImpl
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::__l1_handler_PausableImpl
__constructor_PausableImpl
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::__constructor_PausableImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| Paused | Emitted when paused, where account triggered the action. |
| Unpaused | Emitted when un-paused, where account triggered the action. |
| ComponentState | — |
Storage
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::Storage
[storage]
pub struct Storage {
pub paused: bool,
}
Members
paused
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::Storage::paused
pub paused: bool
Paused
Emitted when paused, where account triggered the action.
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::Paused
[derive(Drop, PartialEq, starknet::Event)]
pub struct Paused {
pub account: ContractAddress,
}
Members
account
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::Paused::account
pub account: ContractAddress
Unpaused
Emitted when un-paused, where account triggered the action.
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::Unpaused
[derive(Drop, PartialEq, starknet::Event)]
pub struct Unpaused {
pub account: ContractAddress,
}
Members
account
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::Unpaused::account
pub account: ContractAddress
ComponentState
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::Event
pub enum Event {
Paused: Paused,
Unpaused: Unpaused,
}
Variants
Paused
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::Event::Paused
Paused: Paused
Unpaused
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::Event::Unpaused
Unpaused: Unpaused
Traits
Traits
HasComponent
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::HasComponent::emit
fn emit<
S,
impl IntoImp: Into<
S, starkware_utils::components::pausable::pausable::PausableComponent::Event,
>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::InternalTrait
pub trait InternalTrait<TContractState, +HasComponent<TContractState>>
Trait functions
assert_not_paused
Makes a function only callable when the contract is not paused.
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::InternalTrait::assert_not_paused
fn assert_not_paused(self: @ComponentState<TContractState>)
assert_paused
Makes a function only callable when the contract is paused.
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::InternalTrait::assert_paused
fn assert_paused(self: @ComponentState<TContractState>)
UnsafeNewContractStateTraitForPausableImpl
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::UnsafeNewContractStateTraitForPausableImpl
pub trait UnsafeNewContractStateTraitForPausableImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: starkware_utils::components::pausable::pausable::PausableComponent::UnsafeNewContractStateTraitForPausableImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
replaceability
Fully qualified path: starkware_utils::components::replaceability
Modules
Re-exports:
Modules
Modules
interface
Fully qualified path: starkware_utils::components::replaceability::interface
Modules
Structs
| EICData | Holds EIC data…. |
| ImplementationData | Holds implementation data…. |
Traits
| IEICInitializable | — |
| IReplaceable | — |
| UnsafeNewContractStateTraitForIEICInitializableForwardImpl | — |
| UnsafeNewContractStateTraitForIReplaceableForwardImpl | — |
Groups:
dispatchers
| IEICInitializableDispatcherTrait | — |
| IEICInitializableSafeDispatcherTrait | — |
| IReplaceableDispatcherTrait | — |
| IReplaceableSafeDispatcherTrait | — |
Modules
Modules
__external_IEICInitializableForwardImpl
Fully qualified path: starkware_utils::components::replaceability::interface::__external_IEICInitializableForwardImpl
__l1_handler_IEICInitializableForwardImpl
Fully qualified path: starkware_utils::components::replaceability::interface::__l1_handler_IEICInitializableForwardImpl
__constructor_IEICInitializableForwardImpl
Fully qualified path: starkware_utils::components::replaceability::interface::__constructor_IEICInitializableForwardImpl
__external_IReplaceableForwardImpl
Fully qualified path: starkware_utils::components::replaceability::interface::__external_IReplaceableForwardImpl
__l1_handler_IReplaceableForwardImpl
Fully qualified path: starkware_utils::components::replaceability::interface::__l1_handler_IReplaceableForwardImpl
__constructor_IReplaceableForwardImpl
Fully qualified path: starkware_utils::components::replaceability::interface::__constructor_IReplaceableForwardImpl
Structs
Structs
| EICData | Holds EIC data…. |
| ImplementationData | Holds implementation data…. |
EICData
Holds EIC data.
- eic_hash is the EIC class hash.
- eic_init_data is a span of the EIC init args.
Fully qualified path: starkware_utils::components::replaceability::interface::EICData
[derive(Copy, Drop, Serde, PartialEq)]
pub struct EICData {
pub eic_hash: ClassHash,
pub eic_init_data: Span<felt252>,
}
Members
eic_hash
Fully qualified path: starkware_utils::components::replaceability::interface::EICData::eic_hash
pub eic_hash: ClassHash
eic_init_data
Fully qualified path: starkware_utils::components::replaceability::interface::EICData::eic_init_data
pub eic_init_data: Span<felt252>
ImplementationData
Holds implementation data.
- impl_hash is the implementation class hash.
- eic_data is the EIC data when applicable, and empty otherwise.
- final indicates whether the implementation is finalized.
Fully qualified path: starkware_utils::components::replaceability::interface::ImplementationData
[derive(Copy, Drop, Serde, PartialEq)]
pub struct ImplementationData {
pub impl_hash: ClassHash,
pub eic_data: Option<EICData>,
pub final: bool,
}
Members
impl_hash
Fully qualified path: starkware_utils::components::replaceability::interface::ImplementationData::impl_hash
pub impl_hash: ClassHash
eic_data
Fully qualified path: starkware_utils::components::replaceability::interface::ImplementationData::eic_data
pub eic_data: Option<EICData>
final
Fully qualified path: starkware_utils::components::replaceability::interface::ImplementationData::final
pub final: bool
Traits
Traits
| IEICInitializable | — |
| IReplaceable | — |
| UnsafeNewContractStateTraitForIEICInitializableForwardImpl | — |
| UnsafeNewContractStateTraitForIReplaceableForwardImpl | — |
IEICInitializable
Fully qualified path: starkware_utils::components::replaceability::interface::IEICInitializable
pub trait IEICInitializable<TContractState>
Trait functions
eic_initialize
Fully qualified path: starkware_utils::components::replaceability::interface::IEICInitializable::eic_initialize
fn eic_initialize(ref self: TContractState, eic_init_data: Span<felt252>)
IReplaceable
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceable
pub trait IReplaceable<TContractState>
Trait functions
get_upgrade_delay
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceable::get_upgrade_delay
fn get_upgrade_delay(self: @TContractState) -> u64
get_impl_activation_time
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceable::get_impl_activation_time
fn get_impl_activation_time(self: @TContractState, implementation_data: ImplementationData) -> u64
add_new_implementation
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceable::add_new_implementation
fn add_new_implementation(ref self: TContractState, implementation_data: ImplementationData)
remove_implementation
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceable::remove_implementation
fn remove_implementation(ref self: TContractState, implementation_data: ImplementationData)
replace_to
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceable::replace_to
fn replace_to(ref self: TContractState, implementation_data: ImplementationData)
UnsafeNewContractStateTraitForIEICInitializableForwardImpl
Fully qualified path: starkware_utils::components::replaceability::interface::UnsafeNewContractStateTraitForIEICInitializableForwardImpl
pub trait UnsafeNewContractStateTraitForIEICInitializableForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: starkware_utils::components::replaceability::interface::UnsafeNewContractStateTraitForIEICInitializableForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIReplaceableForwardImpl
Fully qualified path: starkware_utils::components::replaceability::interface::UnsafeNewContractStateTraitForIReplaceableForwardImpl
pub trait UnsafeNewContractStateTraitForIReplaceableForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: starkware_utils::components::replaceability::interface::UnsafeNewContractStateTraitForIReplaceableForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
replaceability
Fully qualified path: starkware_utils::components::replaceability::replaceability
Modules
Modules
Modules
ReplaceabilityComponent
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent
Modules
Free functions
Structs
Enums
Traits
Impls
Modules
Modules
__external_ReplaceabilityImpl
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::__external_ReplaceabilityImpl
__l1_handler_ReplaceabilityImpl
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::__l1_handler_ReplaceabilityImpl
__constructor_ReplaceabilityImpl
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::__constructor_ReplaceabilityImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
Storage
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::Storage
[storage]
pub struct Storage { /* private fields */ }
ComponentState
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::Event
pub enum Event {
ImplementationAdded: ImplementationAdded,
ImplementationRemoved: ImplementationRemoved,
ImplementationReplaced: ImplementationReplaced,
ImplementationFinalized: ImplementationFinalized,
}
Variants
ImplementationAdded
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::Event::ImplementationAdded
ImplementationAdded: ImplementationAdded
ImplementationRemoved
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::Event::ImplementationRemoved
ImplementationRemoved: ImplementationRemoved
ImplementationReplaced
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::Event::ImplementationReplaced
ImplementationReplaced: ImplementationReplaced
ImplementationFinalized
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::Event::ImplementationFinalized
ImplementationFinalized: ImplementationFinalized
Traits
Traits
HasComponent
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::HasComponent::emit
fn emit<
S,
impl IntoImp: Into<
S,
starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::Event,
>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalReplaceabilityTrait
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::InternalReplaceabilityTrait
pub trait InternalReplaceabilityTrait<
TContractState, +HasComponent<TContractState>, +Drop<TContractState>,
>
Trait functions
initialize
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::InternalReplaceabilityTrait::initialize
fn initialize(ref self: ComponentState<TContractState>, upgrade_delay: u64)
UnsafeNewContractStateTraitForReplaceabilityImpl
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::UnsafeNewContractStateTraitForReplaceabilityImpl
pub trait UnsafeNewContractStateTraitForReplaceabilityImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::UnsafeNewContractStateTraitForReplaceabilityImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
Impls
Impls
Replaceability
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::Replaceability
pub impl Replaceability<
TContractState,
+HasComponent<TContractState>,
impl Roles: HasComponent<TContractState>,
+AccessControlComponent::HasComponent<TContractState>,
+SRC5Component::HasComponent<TContractState>,
+Drop<TContractState>,
> of IReplaceable<ComponentState<TContractState>>;
Impl functions
get_upgrade_delay
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::Replaceability::get_upgrade_delay
fn get_upgrade_delay(self: @ComponentState<TContractState>) -> u64
get_impl_activation_time
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::Replaceability::get_impl_activation_time
fn get_impl_activation_time(
self: @ComponentState<TContractState>, implementation_data: ImplementationData,
) -> u64
add_new_implementation
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::Replaceability::add_new_implementation
fn add_new_implementation(
ref self: ComponentState<TContractState>, implementation_data: ImplementationData,
)
remove_implementation
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::Replaceability::remove_implementation
fn remove_implementation(
ref self: ComponentState<TContractState>, implementation_data: ImplementationData,
)
replace_to
Fully qualified path: starkware_utils::components::replaceability::replaceability::ReplaceabilityComponent::Replaceability::replace_to
fn replace_to(ref self: ComponentState<TContractState>, implementation_data: ImplementationData)
request_approvals
Fully qualified path: starkware_utils::components::request_approvals
Modules
Re-exports:
Modules
Modules
interface
Fully qualified path: starkware_utils::components::request_approvals::interface
Modules
| __external_IRequestApprovalsForwardImpl | — |
| __l1_handler_IRequestApprovalsForwardImpl | — |
| __constructor_IRequestApprovalsForwardImpl | — |
Enums
Traits
Groups:
dispatchers
| IRequestApprovalsDispatcher | — |
| IRequestApprovalsLibraryDispatcher | — |
| IRequestApprovalsSafeLibraryDispatcher | — |
| IRequestApprovalsSafeDispatcher | — |
Modules
Modules
| __external_IRequestApprovalsForwardImpl | — |
| __l1_handler_IRequestApprovalsForwardImpl | — |
| __constructor_IRequestApprovalsForwardImpl | — |
__external_IRequestApprovalsForwardImpl
Fully qualified path: starkware_utils::components::request_approvals::interface::__external_IRequestApprovalsForwardImpl
__l1_handler_IRequestApprovalsForwardImpl
Fully qualified path: starkware_utils::components::request_approvals::interface::__l1_handler_IRequestApprovalsForwardImpl
__constructor_IRequestApprovalsForwardImpl
Fully qualified path: starkware_utils::components::request_approvals::interface::__constructor_IRequestApprovalsForwardImpl
Enums
Enums
RequestStatus
Fully qualified path: starkware_utils::components::request_approvals::interface::RequestStatus
pub enum RequestStatus {
NOT_REGISTERED,
PROCESSED,
PENDING,
}
Variants
NOT_REGISTERED
Fully qualified path: starkware_utils::components::request_approvals::interface::RequestStatus::NOT_REGISTERED
NOT_REGISTERED
PROCESSED
Fully qualified path: starkware_utils::components::request_approvals::interface::RequestStatus::PROCESSED
PROCESSED
PENDING
Fully qualified path: starkware_utils::components::request_approvals::interface::RequestStatus::PENDING
PENDING
Traits
Traits
IRequestApprovals
Fully qualified path: starkware_utils::components::request_approvals::interface::IRequestApprovals
pub trait IRequestApprovals<TContractState>
Trait functions
get_request_status
Returns the status of a request.
Fully qualified path: starkware_utils::components::request_approvals::interface::IRequestApprovals::get_request_status
fn get_request_status(self: @TContractState, request_hash: felt252) -> RequestStatus
UnsafeNewContractStateTraitForIRequestApprovalsForwardImpl
Fully qualified path: starkware_utils::components::request_approvals::interface::UnsafeNewContractStateTraitForIRequestApprovalsForwardImpl
pub trait UnsafeNewContractStateTraitForIRequestApprovalsForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: starkware_utils::components::request_approvals::interface::UnsafeNewContractStateTraitForIRequestApprovalsForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
request_approvals
Fully qualified path: starkware_utils::components::request_approvals::request_approvals
Modules
Modules
Modules
RequestApprovalsComponent
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent
Modules
| __external_RequestApprovalsImpl | — |
| __l1_handler_RequestApprovalsImpl | — |
| __constructor_RequestApprovalsImpl | — |
Free functions
Structs
Enums
Traits
Modules
Modules
| __external_RequestApprovalsImpl | — |
| __l1_handler_RequestApprovalsImpl | — |
| __constructor_RequestApprovalsImpl | — |
__external_RequestApprovalsImpl
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::__external_RequestApprovalsImpl
__l1_handler_RequestApprovalsImpl
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::__l1_handler_RequestApprovalsImpl
__constructor_RequestApprovalsImpl
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::__constructor_RequestApprovalsImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
Storage
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::Storage
[storage]
pub struct Storage { /* private fields */ }
ComponentState
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::Event
pub enum Event {}
Traits
Traits
HasComponent
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::HasComponent::emit
fn emit<
S,
impl IntoImp: Into<
S,
starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::Event,
>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::InternalTrait
pub trait InternalTrait<TContractState, +HasComponent<TContractState>>
Trait functions
register_approval
Registers an approval for a request. If the owner_account is non-zero, the caller must be the owner_account. The approval is signed with the public key. The signature is verified with the hash of the request. The request is stored with a status of PENDING.
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::InternalTrait::register_approval
fn register_approval<T, +OffchainMessageHash<T>, +Drop<T>>(
ref self: ComponentState<TContractState>,
owner_account: Option<ContractAddress>,
public_key: felt252,
signature: Span<felt252>,
args: T,
) -> felt252
consume_approved_request
Consumes an approved request. Marks the request with status DONE.
Validations: The request must be registered with PENDING state.
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::InternalTrait::consume_approved_request
fn consume_approved_request<T, +OffchainMessageHash<T>, +Drop<T>>(
ref self: ComponentState<TContractState>, args: T, public_key: felt252,
) -> felt252
UnsafeNewContractStateTraitForRequestApprovalsImpl
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::UnsafeNewContractStateTraitForRequestApprovalsImpl
pub trait UnsafeNewContractStateTraitForRequestApprovalsImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: starkware_utils::components::request_approvals::request_approvals::RequestApprovalsComponent::UnsafeNewContractStateTraitForRequestApprovalsImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
roles
Fully qualified path: starkware_utils::components::roles
Modules
Re-exports:
Modules
Modules
interface
Fully qualified path: starkware_utils::components::roles::interface
Modules
Constants
| APP_GOVERNOR | — |
| APP_ROLE_ADMIN | — |
| GOVERNANCE_ADMIN | — |
| OPERATOR | — |
| TOKEN_ADMIN | — |
| UPGRADE_GOVERNOR | — |
| SECURITY_ADMIN | — |
| SECURITY_AGENT | — |
Type aliases
Traits
| IRoles | — |
| IMinimalRoles | — |
| UnsafeNewContractStateTraitForIRolesForwardImpl | — |
| UnsafeNewContractStateTraitForIMinimalRolesForwardImpl | — |
Groups:
dispatchers
| IRolesDispatcherTrait | — |
| IRolesSafeDispatcherTrait | — |
| IMinimalRolesDispatcherTrait | — |
| IMinimalRolesSafeDispatcherTrait | — |
Modules
Modules
__external_IRolesForwardImpl
Fully qualified path: starkware_utils::components::roles::interface::__external_IRolesForwardImpl
__l1_handler_IRolesForwardImpl
Fully qualified path: starkware_utils::components::roles::interface::__l1_handler_IRolesForwardImpl
__constructor_IRolesForwardImpl
Fully qualified path: starkware_utils::components::roles::interface::__constructor_IRolesForwardImpl
__external_IMinimalRolesForwardImpl
Fully qualified path: starkware_utils::components::roles::interface::__external_IMinimalRolesForwardImpl
__l1_handler_IMinimalRolesForwardImpl
Fully qualified path: starkware_utils::components::roles::interface::__l1_handler_IMinimalRolesForwardImpl
__constructor_IMinimalRolesForwardImpl
Fully qualified path: starkware_utils::components::roles::interface::__constructor_IMinimalRolesForwardImpl
Constants
Constants
| APP_GOVERNOR | — |
| APP_ROLE_ADMIN | — |
| GOVERNANCE_ADMIN | — |
| OPERATOR | — |
| TOKEN_ADMIN | — |
| UPGRADE_GOVERNOR | — |
| SECURITY_ADMIN | — |
| SECURITY_AGENT | — |
APP_GOVERNOR
Fully qualified path: starkware_utils::components::roles::interface::APP_GOVERNOR
pub const APP_GOVERNOR: felt252 =
372658703421202264242181762742335711812443249690089615707571962600461721704;
APP_ROLE_ADMIN
Fully qualified path: starkware_utils::components::roles::interface::APP_ROLE_ADMIN
pub const APP_ROLE_ADMIN: felt252 =
1763460991315895633316329146706412950670706354561043417663623424241752141465;
GOVERNANCE_ADMIN
Fully qualified path: starkware_utils::components::roles::interface::GOVERNANCE_ADMIN
pub const GOVERNANCE_ADMIN: felt252 =
1556789761824654631941645422192241267775035395971414146468438977535375841350;
OPERATOR
Fully qualified path: starkware_utils::components::roles::interface::OPERATOR
pub const OPERATOR: felt252 =
1015684931961133208114587987562990764923262568616000027565309658679808585127;
TOKEN_ADMIN
Fully qualified path: starkware_utils::components::roles::interface::TOKEN_ADMIN
pub const TOKEN_ADMIN: felt252 =
524465291734395767699654754658819213761588301338933870358418583916878633534;
UPGRADE_GOVERNOR
Fully qualified path: starkware_utils::components::roles::interface::UPGRADE_GOVERNOR
pub const UPGRADE_GOVERNOR: felt252 =
1049344231851077699969150983216091689562714419835904805842696142089018589736;
SECURITY_ADMIN
Fully qualified path: starkware_utils::components::roles::interface::SECURITY_ADMIN
pub const SECURITY_ADMIN: felt252 =
1095121239723352770772166591718737686966204345253119027477952598736384210611;
SECURITY_AGENT
Fully qualified path: starkware_utils::components::roles::interface::SECURITY_AGENT
pub const SECURITY_AGENT: felt252 =
1566446075833267426703401035392730548387206636780968074041221475590432398230;
Type aliases
Type aliases
RoleId
Fully qualified path: starkware_utils::components::roles::interface::RoleId
pub type RoleId = felt252;
Traits
Traits
| IRoles | — |
| IMinimalRoles | — |
| UnsafeNewContractStateTraitForIRolesForwardImpl | — |
| UnsafeNewContractStateTraitForIMinimalRolesForwardImpl | — |
IRoles
Fully qualified path: starkware_utils::components::roles::interface::IRoles
pub trait IRoles<TContractState>
Trait functions
is_app_governor
Fully qualified path: starkware_utils::components::roles::interface::IRoles::is_app_governor
fn is_app_governor(self: @TContractState, account: ContractAddress) -> bool
is_app_role_admin
Fully qualified path: starkware_utils::components::roles::interface::IRoles::is_app_role_admin
fn is_app_role_admin(self: @TContractState, account: ContractAddress) -> bool
is_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IRoles::is_governance_admin
fn is_governance_admin(self: @TContractState, account: ContractAddress) -> bool
is_operator
Fully qualified path: starkware_utils::components::roles::interface::IRoles::is_operator
fn is_operator(self: @TContractState, account: ContractAddress) -> bool
is_token_admin
Fully qualified path: starkware_utils::components::roles::interface::IRoles::is_token_admin
fn is_token_admin(self: @TContractState, account: ContractAddress) -> bool
is_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IRoles::is_upgrade_governor
fn is_upgrade_governor(self: @TContractState, account: ContractAddress) -> bool
is_security_admin
Fully qualified path: starkware_utils::components::roles::interface::IRoles::is_security_admin
fn is_security_admin(self: @TContractState, account: ContractAddress) -> bool
is_security_agent
Fully qualified path: starkware_utils::components::roles::interface::IRoles::is_security_agent
fn is_security_agent(self: @TContractState, account: ContractAddress) -> bool
register_app_governor
Fully qualified path: starkware_utils::components::roles::interface::IRoles::register_app_governor
fn register_app_governor(ref self: TContractState, account: ContractAddress)
remove_app_governor
Fully qualified path: starkware_utils::components::roles::interface::IRoles::remove_app_governor
fn remove_app_governor(ref self: TContractState, account: ContractAddress)
register_app_role_admin
Fully qualified path: starkware_utils::components::roles::interface::IRoles::register_app_role_admin
fn register_app_role_admin(ref self: TContractState, account: ContractAddress)
remove_app_role_admin
Fully qualified path: starkware_utils::components::roles::interface::IRoles::remove_app_role_admin
fn remove_app_role_admin(ref self: TContractState, account: ContractAddress)
register_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IRoles::register_governance_admin
fn register_governance_admin(ref self: TContractState, account: ContractAddress)
remove_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IRoles::remove_governance_admin
fn remove_governance_admin(ref self: TContractState, account: ContractAddress)
register_operator
Fully qualified path: starkware_utils::components::roles::interface::IRoles::register_operator
fn register_operator(ref self: TContractState, account: ContractAddress)
remove_operator
Fully qualified path: starkware_utils::components::roles::interface::IRoles::remove_operator
fn remove_operator(ref self: TContractState, account: ContractAddress)
register_token_admin
Fully qualified path: starkware_utils::components::roles::interface::IRoles::register_token_admin
fn register_token_admin(ref self: TContractState, account: ContractAddress)
remove_token_admin
Fully qualified path: starkware_utils::components::roles::interface::IRoles::remove_token_admin
fn remove_token_admin(ref self: TContractState, account: ContractAddress)
register_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IRoles::register_upgrade_governor
fn register_upgrade_governor(ref self: TContractState, account: ContractAddress)
remove_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IRoles::remove_upgrade_governor
fn remove_upgrade_governor(ref self: TContractState, account: ContractAddress)
renounce
Fully qualified path: starkware_utils::components::roles::interface::IRoles::renounce
fn renounce(ref self: TContractState, role: felt252)
register_security_admin
Fully qualified path: starkware_utils::components::roles::interface::IRoles::register_security_admin
fn register_security_admin(ref self: TContractState, account: ContractAddress)
remove_security_admin
Fully qualified path: starkware_utils::components::roles::interface::IRoles::remove_security_admin
fn remove_security_admin(ref self: TContractState, account: ContractAddress)
register_security_agent
Fully qualified path: starkware_utils::components::roles::interface::IRoles::register_security_agent
fn register_security_agent(ref self: TContractState, account: ContractAddress)
remove_security_agent
Fully qualified path: starkware_utils::components::roles::interface::IRoles::remove_security_agent
fn remove_security_agent(ref self: TContractState, account: ContractAddress)
IMinimalRoles
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRoles
pub trait IMinimalRoles<TContractState>
Trait functions
is_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRoles::is_governance_admin
fn is_governance_admin(self: @TContractState, account: ContractAddress) -> bool
is_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRoles::is_upgrade_governor
fn is_upgrade_governor(self: @TContractState, account: ContractAddress) -> bool
register_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRoles::register_governance_admin
fn register_governance_admin(ref self: TContractState, account: ContractAddress)
remove_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRoles::remove_governance_admin
fn remove_governance_admin(ref self: TContractState, account: ContractAddress)
register_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRoles::register_upgrade_governor
fn register_upgrade_governor(ref self: TContractState, account: ContractAddress)
remove_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRoles::remove_upgrade_governor
fn remove_upgrade_governor(ref self: TContractState, account: ContractAddress)
renounce
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRoles::renounce
fn renounce(ref self: TContractState, role: felt252)
UnsafeNewContractStateTraitForIRolesForwardImpl
Fully qualified path: starkware_utils::components::roles::interface::UnsafeNewContractStateTraitForIRolesForwardImpl
pub trait UnsafeNewContractStateTraitForIRolesForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: starkware_utils::components::roles::interface::UnsafeNewContractStateTraitForIRolesForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIMinimalRolesForwardImpl
Fully qualified path: starkware_utils::components::roles::interface::UnsafeNewContractStateTraitForIMinimalRolesForwardImpl
pub trait UnsafeNewContractStateTraitForIMinimalRolesForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: starkware_utils::components::roles::interface::UnsafeNewContractStateTraitForIMinimalRolesForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
roles
Fully qualified path: starkware_utils::components::roles::roles
Modules
Modules
Modules
RolesComponent
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent
Modules
Free functions
Structs
Enums
Traits
Impls
Modules
Modules
__external_RolesImpl
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::__external_RolesImpl
__l1_handler_RolesImpl
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::__l1_handler_RolesImpl
__constructor_RolesImpl
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::__constructor_RolesImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
Storage
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Storage
[storage]
pub struct Storage {}
ComponentState
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Event
pub enum Event {
AppGovernorAdded: AppGovernorAdded,
AppGovernorRemoved: AppGovernorRemoved,
AppRoleAdminAdded: AppRoleAdminAdded,
AppRoleAdminRemoved: AppRoleAdminRemoved,
GovernanceAdminAdded: GovernanceAdminAdded,
GovernanceAdminRemoved: GovernanceAdminRemoved,
OperatorAdded: OperatorAdded,
OperatorRemoved: OperatorRemoved,
SecurityAdminAdded: SecurityAdminAdded,
SecurityAdminRemoved: SecurityAdminRemoved,
SecurityAgentAdded: SecurityAgentAdded,
SecurityAgentRemoved: SecurityAgentRemoved,
TokenAdminAdded: TokenAdminAdded,
TokenAdminRemoved: TokenAdminRemoved,
UpgradeGovernorAdded: UpgradeGovernorAdded,
UpgradeGovernorRemoved: UpgradeGovernorRemoved,
}
Variants
AppGovernorAdded
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Event::AppGovernorAdded
AppGovernorAdded: AppGovernorAdded
AppGovernorRemoved
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Event::AppGovernorRemoved
AppGovernorRemoved: AppGovernorRemoved
AppRoleAdminAdded
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Event::AppRoleAdminAdded
AppRoleAdminAdded: AppRoleAdminAdded
AppRoleAdminRemoved
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Event::AppRoleAdminRemoved
AppRoleAdminRemoved: AppRoleAdminRemoved
GovernanceAdminAdded
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Event::GovernanceAdminAdded
GovernanceAdminAdded: GovernanceAdminAdded
GovernanceAdminRemoved
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Event::GovernanceAdminRemoved
GovernanceAdminRemoved: GovernanceAdminRemoved
OperatorAdded
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Event::OperatorAdded
OperatorAdded: OperatorAdded
OperatorRemoved
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Event::OperatorRemoved
OperatorRemoved: OperatorRemoved
SecurityAdminAdded
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Event::SecurityAdminAdded
SecurityAdminAdded: SecurityAdminAdded
SecurityAdminRemoved
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Event::SecurityAdminRemoved
SecurityAdminRemoved: SecurityAdminRemoved
SecurityAgentAdded
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Event::SecurityAgentAdded
SecurityAgentAdded: SecurityAgentAdded
SecurityAgentRemoved
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Event::SecurityAgentRemoved
SecurityAgentRemoved: SecurityAgentRemoved
TokenAdminAdded
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Event::TokenAdminAdded
TokenAdminAdded: TokenAdminAdded
TokenAdminRemoved
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Event::TokenAdminRemoved
TokenAdminRemoved: TokenAdminRemoved
UpgradeGovernorAdded
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Event::UpgradeGovernorAdded
UpgradeGovernorAdded: UpgradeGovernorAdded
UpgradeGovernorRemoved
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Event::UpgradeGovernorRemoved
UpgradeGovernorRemoved: UpgradeGovernorRemoved
Traits
Traits
HasComponent
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::HasComponent::emit
fn emit<S, impl IntoImp: Into<S, starkware_utils::components::roles::roles::RolesComponent::Event>>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::InternalTrait
pub trait InternalTrait<TContractState, +HasComponent<TContractState>, +Drop<TContractState>, impl Access: HasComponent<TContractState>, impl HasComponent<TContractState>: HasComponent<TContractState>>
Trait functions
_grant_role_and_emit
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::InternalTrait::_grant_role_and_emit
fn _grant_role_and_emit(
ref self: ComponentState<TContractState>, role: felt252, account: ContractAddress, event: Event,
)
_revoke_role_and_emit
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::InternalTrait::_revoke_role_and_emit
fn _revoke_role_and_emit(
ref self: ComponentState<TContractState>, role: felt252, account: ContractAddress, event: Event,
)
initialize
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::InternalTrait::initialize
fn initialize(ref self: ComponentState<TContractState>, governance_admin: ContractAddress)
only_app_governor
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::InternalTrait::only_app_governor
fn only_app_governor(self: @ComponentState<TContractState>)
only_operator
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::InternalTrait::only_operator
fn only_operator(self: @ComponentState<TContractState>)
only_token_admin
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::InternalTrait::only_token_admin
fn only_token_admin(self: @ComponentState<TContractState>)
only_upgrade_governor
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::InternalTrait::only_upgrade_governor
fn only_upgrade_governor(self: @ComponentState<TContractState>)
only_security_admin
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::InternalTrait::only_security_admin
fn only_security_admin(self: @ComponentState<TContractState>)
only_security_agent
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::InternalTrait::only_security_agent
fn only_security_agent(self: @ComponentState<TContractState>)
UnsafeNewContractStateTraitForRolesImpl
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::UnsafeNewContractStateTraitForRolesImpl
pub trait UnsafeNewContractStateTraitForRolesImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::UnsafeNewContractStateTraitForRolesImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
Impls
Impls
Roles
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles
pub impl Roles<
TContractState,
+HasComponent<TContractState>,
+Drop<TContractState>,
impl Access: HasComponent<TContractState>,
+SRC5Component::HasComponent<TContractState>,
> of IRoles<ComponentState<TContractState>>;
Impl functions
is_app_governor
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::is_app_governor
fn is_app_governor(self: @ComponentState<TContractState>, account: ContractAddress) -> bool
is_app_role_admin
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::is_app_role_admin
fn is_app_role_admin(self: @ComponentState<TContractState>, account: ContractAddress) -> bool
is_governance_admin
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::is_governance_admin
fn is_governance_admin(self: @ComponentState<TContractState>, account: ContractAddress) -> bool
is_operator
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::is_operator
fn is_operator(self: @ComponentState<TContractState>, account: ContractAddress) -> bool
is_security_admin
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::is_security_admin
fn is_security_admin(self: @ComponentState<TContractState>, account: ContractAddress) -> bool
is_security_agent
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::is_security_agent
fn is_security_agent(self: @ComponentState<TContractState>, account: ContractAddress) -> bool
is_token_admin
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::is_token_admin
fn is_token_admin(self: @ComponentState<TContractState>, account: ContractAddress) -> bool
is_upgrade_governor
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::is_upgrade_governor
fn is_upgrade_governor(self: @ComponentState<TContractState>, account: ContractAddress) -> bool
register_app_governor
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::register_app_governor
fn register_app_governor(ref self: ComponentState<TContractState>, account: ContractAddress)
remove_app_governor
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::remove_app_governor
fn remove_app_governor(ref self: ComponentState<TContractState>, account: ContractAddress)
register_app_role_admin
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::register_app_role_admin
fn register_app_role_admin(ref self: ComponentState<TContractState>, account: ContractAddress)
remove_app_role_admin
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::remove_app_role_admin
fn remove_app_role_admin(ref self: ComponentState<TContractState>, account: ContractAddress)
register_security_admin
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::register_security_admin
fn register_security_admin(ref self: ComponentState<TContractState>, account: ContractAddress)
remove_security_admin
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::remove_security_admin
fn remove_security_admin(ref self: ComponentState<TContractState>, account: ContractAddress)
register_security_agent
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::register_security_agent
fn register_security_agent(ref self: ComponentState<TContractState>, account: ContractAddress)
remove_security_agent
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::remove_security_agent
fn remove_security_agent(ref self: ComponentState<TContractState>, account: ContractAddress)
register_governance_admin
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::register_governance_admin
fn register_governance_admin(ref self: ComponentState<TContractState>, account: ContractAddress)
remove_governance_admin
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::remove_governance_admin
fn remove_governance_admin(ref self: ComponentState<TContractState>, account: ContractAddress)
register_operator
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::register_operator
fn register_operator(ref self: ComponentState<TContractState>, account: ContractAddress)
remove_operator
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::remove_operator
fn remove_operator(ref self: ComponentState<TContractState>, account: ContractAddress)
register_token_admin
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::register_token_admin
fn register_token_admin(ref self: ComponentState<TContractState>, account: ContractAddress)
remove_token_admin
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::remove_token_admin
fn remove_token_admin(ref self: ComponentState<TContractState>, account: ContractAddress)
register_upgrade_governor
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::register_upgrade_governor
fn register_upgrade_governor(ref self: ComponentState<TContractState>, account: ContractAddress)
remove_upgrade_governor
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::remove_upgrade_governor
fn remove_upgrade_governor(ref self: ComponentState<TContractState>, account: ContractAddress)
renounce
Fully qualified path: starkware_utils::components::roles::roles::RolesComponent::Roles::renounce
fn renounce(ref self: ComponentState<TContractState>, role: felt252)
constants
Fully qualified path: starkware_utils::constants
Constants
Free functions
Constants
Constants
MAX_U8
Fully qualified path: starkware_utils::constants::MAX_U8
pub const MAX_U8: u8 = Bounded::<u8>::MAX;
MAX_U16
Fully qualified path: starkware_utils::constants::MAX_U16
pub const MAX_U16: u16 = Bounded::<u16>::MAX;
MAX_U32
Fully qualified path: starkware_utils::constants::MAX_U32
pub const MAX_U32: u32 = Bounded::<u32>::MAX;
MAX_U64
Fully qualified path: starkware_utils::constants::MAX_U64
pub const MAX_U64: u64 = Bounded::<u64>::MAX;
MAX_U128
Fully qualified path: starkware_utils::constants::MAX_U128
pub const MAX_U128: u128 = Bounded::<u128>::MAX;
MAX_U256
Fully qualified path: starkware_utils::constants::MAX_U256
pub const MAX_U256: u256 = Bounded::<u256>::MAX;
TWO_POW_8
Fully qualified path: starkware_utils::constants::TWO_POW_8
pub const TWO_POW_8: u16 = 2_u16.pow(8); // = 256
TWO_POW_16
Fully qualified path: starkware_utils::constants::TWO_POW_16
pub const TWO_POW_16: u32 = 2_u32.pow(16); // = 65536
TWO_POW_32
Fully qualified path: starkware_utils::constants::TWO_POW_32
pub const TWO_POW_32: u64 = 2_u64.pow(32); // = 4294967296
TWO_POW_40
Fully qualified path: starkware_utils::constants::TWO_POW_40
pub const TWO_POW_40: u64 = 2_u64.pow(40); // = 1099511627776
TWO_POW_64
Fully qualified path: starkware_utils::constants::TWO_POW_64
pub const TWO_POW_64: u128 = 2_u128.pow(64); // = 18446744073709551616
TWO_POW_128
Fully qualified path: starkware_utils::constants::TWO_POW_128
pub const TWO_POW_128: u256 = 2_u256.pow(128);
;
TEN_POW_3
Fully qualified path: starkware_utils::constants::TEN_POW_3
pub const TEN_POW_3: u16 = 10_u16.pow(3); // = 1000
TEN_POW_6
Fully qualified path: starkware_utils::constants::TEN_POW_6
pub const TEN_POW_6: u32 = 10_u32.pow(6); // = 1000000
TEN_POW_9
Fully qualified path: starkware_utils::constants::TEN_POW_9
pub const TEN_POW_9: u32 = 10_u32.pow(9); // = 1000000000
TEN_POW_12
Fully qualified path: starkware_utils::constants::TEN_POW_12
pub const TEN_POW_12: u64 = 10_u64.pow(12); // = 1000000000000
TEN_POW_15
Fully qualified path: starkware_utils::constants::TEN_POW_15
pub const TEN_POW_15: u64 = 10_u64.pow(15); // = 1000000000000000
TEN_POW_18
Fully qualified path: starkware_utils::constants::TEN_POW_18
pub const TEN_POW_18: u64 = 10_u64.pow(18); // = 1000000000000000000
MINUTE
Fully qualified path: starkware_utils::constants::MINUTE
pub const MINUTE: u64 = 60;
HOUR
Fully qualified path: starkware_utils::constants::HOUR
pub const HOUR: u64 = 60 * MINUTE; // = 3600
DAY
Fully qualified path: starkware_utils::constants::DAY
pub const DAY: u64 = 24 * HOUR; // = 86400
WEEK
Fully qualified path: starkware_utils::constants::WEEK
pub const WEEK: u64 = 7 * DAY; // = 604800
Free functions
Free functions
NAME
Fully qualified path: starkware_utils::constants::NAME
pub fn NAME() -> ByteArray
SYMBOL
Fully qualified path: starkware_utils::constants::SYMBOL
pub fn SYMBOL() -> ByteArray
errors
Fully qualified path: starkware_utils::errors
Free functions
Traits
Free functions
Free functions
assert_with_byte_array
Fully qualified path: starkware_utils::errors::assert_with_byte_array
pub fn assert_with_byte_array(condition: bool, err: ByteArray)
Traits
Traits
Describable
Fully qualified path: starkware_utils::errors::Describable
pub trait Describable<T>
Trait functions
describe
Fully qualified path: starkware_utils::errors::Describable::describe
fn describe(self: @T) -> ByteArray
OptionAuxTrait
Fully qualified path: starkware_utils::errors::OptionAuxTrait
pub trait OptionAuxTrait<T>
Trait functions
expect_with_err
Fully qualified path: starkware_utils::errors::OptionAuxTrait::expect_with_err
fn expect_with_err<TError, +Describable<TError>, +Drop<TError>>(self: Option<T>, err: TError) -> T
interfaces
Fully qualified path: starkware_utils::interfaces
Modules
Modules
Modules
identity
Fully qualified path: starkware_utils::interfaces::identity
Modules
| __external_IdentityForwardImpl | — |
| __l1_handler_IdentityForwardImpl | — |
| __constructor_IdentityForwardImpl | — |
Traits
Groups:
dispatchers
| IdentityDispatcher | — |
| IdentityLibraryDispatcher | — |
| IdentitySafeLibraryDispatcher | — |
| IdentitySafeDispatcher | — |
Modules
Modules
| __external_IdentityForwardImpl | — |
| __l1_handler_IdentityForwardImpl | — |
| __constructor_IdentityForwardImpl | — |
__external_IdentityForwardImpl
Fully qualified path: starkware_utils::interfaces::identity::__external_IdentityForwardImpl
__l1_handler_IdentityForwardImpl
Fully qualified path: starkware_utils::interfaces::identity::__l1_handler_IdentityForwardImpl
__constructor_IdentityForwardImpl
Fully qualified path: starkware_utils::interfaces::identity::__constructor_IdentityForwardImpl
Traits
Traits
Identity
Fully qualified path: starkware_utils::interfaces::identity::Identity
pub trait Identity<TContractState>
Trait functions
identify
Fully qualified path: starkware_utils::interfaces::identity::Identity::identify
fn identify(self: @TContractState) -> felt252
version
Fully qualified path: starkware_utils::interfaces::identity::Identity::version
fn version(self: @TContractState) -> felt252
UnsafeNewContractStateTraitForIdentityForwardImpl
Fully qualified path: starkware_utils::interfaces::identity::UnsafeNewContractStateTraitForIdentityForwardImpl
pub trait UnsafeNewContractStateTraitForIdentityForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: starkware_utils::interfaces::identity::UnsafeNewContractStateTraitForIdentityForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
mintable_token
Fully qualified path: starkware_utils::interfaces::mintable_token
Modules
| __external_IMintableTokenForwardImpl | — |
| __l1_handler_IMintableTokenForwardImpl | — |
| __constructor_IMintableTokenForwardImpl | — |
Traits
Groups:
dispatchers
| IMintableTokenDispatcher | — |
| IMintableTokenLibraryDispatcher | — |
| IMintableTokenSafeLibraryDispatcher | — |
| IMintableTokenSafeDispatcher | — |
Modules
Modules
| __external_IMintableTokenForwardImpl | — |
| __l1_handler_IMintableTokenForwardImpl | — |
| __constructor_IMintableTokenForwardImpl | — |
__external_IMintableTokenForwardImpl
Fully qualified path: starkware_utils::interfaces::mintable_token::__external_IMintableTokenForwardImpl
__l1_handler_IMintableTokenForwardImpl
Fully qualified path: starkware_utils::interfaces::mintable_token::__l1_handler_IMintableTokenForwardImpl
__constructor_IMintableTokenForwardImpl
Fully qualified path: starkware_utils::interfaces::mintable_token::__constructor_IMintableTokenForwardImpl
Traits
Traits
IMintableToken
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableToken
pub trait IMintableToken<TContractState>
Trait functions
permissioned_mint
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableToken::permissioned_mint
fn permissioned_mint(ref self: TContractState, account: ContractAddress, amount: u256)
permissioned_burn
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableToken::permissioned_burn
fn permissioned_burn(ref self: TContractState, account: ContractAddress, amount: u256)
is_permitted_minter
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableToken::is_permitted_minter
fn is_permitted_minter(self: @TContractState, account: ContractAddress) -> bool
UnsafeNewContractStateTraitForIMintableTokenForwardImpl
Fully qualified path: starkware_utils::interfaces::mintable_token::UnsafeNewContractStateTraitForIMintableTokenForwardImpl
pub trait UnsafeNewContractStateTraitForIMintableTokenForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: starkware_utils::interfaces::mintable_token::UnsafeNewContractStateTraitForIMintableTokenForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
iterable_map
Fully qualified path: starkware_utils::iterable_map
Structs
| IterableMap | A Map like struct that represents a map in a contract storage that can also be iterated over. Another thing that IterableMap is different from Map in that it returns Option , so values… |
Traits
| IterableMapTrait | Trait for the interface of a iterable map. |
Impls
Structs
Structs
| IterableMap | A Map like struct that represents a map in a contract storage that can also be iterated over. Another thing that IterableMap is different from Map in that it returns Option , so values… |
IterableMap
A Map like struct that represents a map in a contract storage that can also be iterated over. Another thing that IterableMap is different from Map in that it returns Option, so values that weren’t written into it will return Option::None.
Fully qualified path: starkware_utils::iterable_map::IterableMap
[starknet::storage_node]
[allow(starknet::invalid_storage_member_types)]
pub struct IterableMap<K, V> { /* private fields */ }
Traits
Traits
| IterableMapTrait | Trait for the interface of a iterable map. |
IterableMapTrait
Trait for the interface of a iterable map.
Fully qualified path: starkware_utils::iterable_map::IterableMapTrait
pub trait IterableMapTrait<T>
Trait functions
len
Fully qualified path: starkware_utils::iterable_map::IterableMapTrait::len
fn len(self: T) -> u64
Trait types
Key
Fully qualified path: starkware_utils::iterable_map::IterableMapTrait::Key
type Key;
Impls
Impls
IterableMapIteratorImpl
Fully qualified path: starkware_utils::iterable_map::IterableMapIteratorImpl
pub impl IterableMapIteratorImpl<
K, V, +Drop<K>, +Store<K>, +Hash<K, HashState>, +Copy<K>, +Store<Option<V>>,
> of Iterator<MapIterator<K, V>>;
Impl functions
next
Fully qualified path: starkware_utils::iterable_map::IterableMapIteratorImpl::next
fn next(ref self: MapIterator<K, V>) -> Option<(K, V)>
Impl types
Item
Fully qualified path: starkware_utils::iterable_map::IterableMapIteratorImpl::Item
type Item = (K, V);
IterableMapIteratorMutImpl
Fully qualified path: starkware_utils::iterable_map::IterableMapIteratorMutImpl
pub impl IterableMapIteratorMutImpl<
K, V, +Drop<K>, +Store<K>, +Hash<K, HashState>, +Copy<K>, +Store<Option<V>>,
> of Iterator<MapIteratorMut<K, V>>;
Impl functions
next
Fully qualified path: starkware_utils::iterable_map::IterableMapIteratorMutImpl::next
fn next(ref self: MapIteratorMut<K, V>) -> Option<(K, V)>
Impl types
Item
Fully qualified path: starkware_utils::iterable_map::IterableMapIteratorMutImpl::Item
type Item = (K, V);
math
Fully qualified path: starkware_utils::math
Modules
Modules
Modules
abs
Fully qualified path: starkware_utils::math::abs
Free functions
| wide_abs_diff | Returns ` |
Traits
Free functions
Free functions
| wide_abs_diff | Returns ` |
wide_abs_diff
Returns |a - b|.
Fully qualified path: starkware_utils::math::abs::wide_abs_diff
pub fn wide_abs_diff<
T,
impl TAbs: AbsDiff<T>,
+PartialOrd<T>,
+Drop<T>,
+Drop<TAbs::Mid>,
+Copy<T>,
+Into<T, TAbs::Mid>,
+Sub<TAbs::Mid>,
+TryInto<TAbs::Mid, TAbs::Target>,
>(
a: T, b: T,
) -> Target
Traits
Traits
AbsDiff
Fully qualified path: starkware_utils::math::abs::AbsDiff
pub trait AbsDiff<T>
Trait types
Mid
The type of the result of subtraction.
Fully qualified path: starkware_utils::math::abs::AbsDiff::Mid
type Mid;
Target
Fully qualified path: starkware_utils::math::abs::AbsDiff::Target
type Target;
Abs
Fully qualified path: starkware_utils::math::abs::Abs
pub trait Abs<T, S>
Trait functions
abs
Returns the absolute value of a number.
Fully qualified path: starkware_utils::math::abs::Abs::abs
fn abs(self: T) -> S
fraction
Fully qualified path: starkware_utils::math::fraction
Structs
Traits
Impls
Structs
Structs
Fraction
Fully qualified path: starkware_utils::math::fraction::Fraction
[derive(Copy, Drop, Hash, Serde)]
pub struct Fraction { /* private fields */ }
Traits
Traits
FractionTrait
Fully qualified path: starkware_utils::math::fraction::FractionTrait
pub trait FractionTrait
Trait functions
new
Fully qualified path: starkware_utils::math::fraction::FractionTrait::new
fn new(numerator: i128, denominator: u128) -> Fraction
numerator
Fully qualified path: starkware_utils::math::fraction::FractionTrait::numerator
fn numerator(self: @Fraction) -> i128
denominator
Fully qualified path: starkware_utils::math::fraction::FractionTrait::denominator
fn denominator(self: @Fraction) -> u128
Impls
Impls
FractionlImpl
Fully qualified path: starkware_utils::math::fraction::FractionlImpl
pub impl FractionlImpl of FractionTrait;
Impl functions
new
Fully qualified path: starkware_utils::math::fraction::FractionlImpl::new
fn new(numerator: i128, denominator: u128) -> Fraction
numerator
Fully qualified path: starkware_utils::math::fraction::FractionlImpl::numerator
fn numerator(self: @Fraction) -> i128
denominator
Fully qualified path: starkware_utils::math::fraction::FractionlImpl::denominator
fn denominator(self: @Fraction) -> u128
utils
Fully qualified path: starkware_utils::math::utils
Free functions
| have_same_sign | — |
| u256_from_u32_array | Converts an array of 8 u32 values into a single u256 value. This function treats the input array as a sequence of 32-bit words,… |
| u256_reverse_endian | — |
| mul_wide_and_div | — |
| mul_wide_and_ceil_div | — |
| ceil_of_division | — |
| mul_wide_and_floor_div | — |
| floor_of_division | — |
Traits
Free functions
Free functions
| have_same_sign | — |
| u256_from_u32_array | Converts an array of 8 u32 values into a single u256 value. This function treats the input array as a sequence of 32-bit words,… |
| u256_reverse_endian | — |
| mul_wide_and_div | — |
| mul_wide_and_ceil_div | — |
| ceil_of_division | — |
| mul_wide_and_floor_div | — |
| floor_of_division | — |
have_same_sign
Fully qualified path: starkware_utils::math::utils::have_same_sign
pub fn have_same_sign(x: i64, y: i64) -> bool
u256_from_u32_array
Converts an array of 8 u32 values into a single u256 value.
This function treats the input array as a sequence of 32-bit words,
where the first element of the array represents the most significant
32 bits and the last element represents the least significant 32 bits.
The resulting u256 value is constructed by combining these words
in big-endian order.
Arguments
arr- An array of 8u32values to be converted into au256.
Returns
- A
u256value representing the combined value of the input array.
Example
let arr: [u32; 8] = [0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8];
let result: u256 = u256_from_u32_array(arr);
// `result` will now hold the value:
// 0x00000001_00000002_00000003_00000004_00000005_00000006_00000007_00000008
Fully qualified path: starkware_utils::math::utils::u256_from_u32_array
pub fn u256_from_u32_array(arr: [u32; 8]) -> u256
u256_reverse_endian
Fully qualified path: starkware_utils::math::utils::u256_reverse_endian
pub fn u256_reverse_endian(input: u256) -> u256
mul_wide_and_div
Fully qualified path: starkware_utils::math::utils::mul_wide_and_div
pub fn mul_wide_and_div<
T,
impl TWide: WideMul<T, T>,
+Into<T, TWide::Target>,
+Zero<T>,
+Div<TWide::Target>,
+TryInto<TWide::Target, T>,
+Drop<T>,
+Drop<TWide::Target>,
>(
lhs: T, rhs: T, div: T,
) -> Option<T>
mul_wide_and_ceil_div
Fully qualified path: starkware_utils::math::utils::mul_wide_and_ceil_div
pub fn mul_wide_and_ceil_div<
T,
impl TWide: WideMul<T, T>,
+Into<T, TWide::Target>,
+Zero<T>,
+Div<TWide::Target>,
+Sub<TWide::Target>,
+Add<TWide::Target>,
+One<TWide::Target>,
+Copy<TWide::Target>,
+TryInto<TWide::Target, T>,
+Drop<T>,
+Drop<TWide::Target>,
>(
lhs: T, rhs: T, div: T,
) -> Option<T>
ceil_of_division
Fully qualified path: starkware_utils::math::utils::ceil_of_division
pub fn ceil_of_division<T, +Sub<T>, +Add<T>, +One<T>, +Div<T>, +Copy<T>, +Drop<T>>(
dividend: T, divisor: T,
) -> T
mul_wide_and_floor_div
Fully qualified path: starkware_utils::math::utils::mul_wide_and_floor_div
pub fn mul_wide_and_floor_div<
T,
impl TWide: WideMul<T, T>,
+Into<T, TWide::Target>,
+SameSign<TWide::Target, TWide::Target>,
+DivRem<TWide::Target>,
+Sub<TWide::Target>,
+One<TWide::Target>,
+Zero<TWide::Target>,
+Copy<TWide::Target>,
+TryInto<TWide::Target, T>,
+TryInto<TWide::Target, NonZero<TWide::Target>>,
+Drop<T>,
+Drop<TWide::Target>,
>(
lhs: T, rhs: T, div: T,
) -> Option<T>
floor_of_division
Fully qualified path: starkware_utils::math::utils::floor_of_division
pub fn floor_of_division<
T,
+Sub<T>,
+One<T>,
+Zero<T>,
+DivRem<T>,
+Copy<T>,
+Drop<T>,
+SameSign<T, T>,
+TryInto<T, NonZero<T>>,
>(
dividend: T, divisor: T,
) -> Option<T>
Traits
Traits
SameSign
Fully qualified path: starkware_utils::math::utils::SameSign
pub trait SameSign<T, S>
Trait functions
same_sign
Fully qualified path: starkware_utils::math::utils::SameSign::same_sign
fn same_sign(self: T, other: S) -> bool
message_hash
Fully qualified path: starkware_utils::message_hash
Constants
Traits
| OffchainMessageHash | Trait for calculating the hash of a message given the public_key |
Constants
Constants
REVISION
Fully qualified path: starkware_utils::message_hash::REVISION
pub const REVISION: felt252 = 1;
STARKNET_MESSAGE
Fully qualified path: starkware_utils::message_hash::STARKNET_MESSAGE
pub const STARKNET_MESSAGE: felt252 = 110930206544689809660069706067448260453;
Traits
Traits
| OffchainMessageHash | Trait for calculating the hash of a message given the public_key |
OffchainMessageHash
Trait for calculating the hash of a message given the public_key
Fully qualified path: starkware_utils::message_hash::OffchainMessageHash
pub trait OffchainMessageHash<T>
Trait functions
get_message_hash
Fully qualified path: starkware_utils::message_hash::OffchainMessageHash::get_message_hash
fn get_message_hash(self: @T, public_key: felt252) -> felt252
trace
Fully qualified path: starkware_utils::trace
Modules
Modules
Modules
errors
Fully qualified path: starkware_utils::trace::errors
Enums
Enums
Enums
TraceErrors
Fully qualified path: starkware_utils::trace::errors::TraceErrors
pub enum TraceErrors {
UNORDERED_INSERTION,
EMPTY_TRACE,
INDEX_OUT_OF_BOUNDS,
PENULTIMATE_NOT_EXIST,
}
Variants
UNORDERED_INSERTION
Fully qualified path: starkware_utils::trace::errors::TraceErrors::UNORDERED_INSERTION
UNORDERED_INSERTION
EMPTY_TRACE
Fully qualified path: starkware_utils::trace::errors::TraceErrors::EMPTY_TRACE
EMPTY_TRACE
INDEX_OUT_OF_BOUNDS
Fully qualified path: starkware_utils::trace::errors::TraceErrors::INDEX_OUT_OF_BOUNDS
INDEX_OUT_OF_BOUNDS
PENULTIMATE_NOT_EXIST
Fully qualified path: starkware_utils::trace::errors::TraceErrors::PENULTIMATE_NOT_EXIST
PENULTIMATE_NOT_EXIST
trace
Fully qualified path: starkware_utils::trace::trace
Structs
| Trace | Trace struct, for checkpointing values as they change at different points in time, and later looking up past values by block timestamp. |
Traits
Impls
Structs
Structs
| Trace | Trace struct, for checkpointing values as they change at different points in time, and later looking up past values by block timestamp. |
Trace
Trace struct, for checkpointing values as they change at different points in
time, and later looking up past values by block timestamp.
Fully qualified path: starkware_utils::trace::trace::Trace
[starknet::storage_node]
pub struct Trace { /* private fields */ }
Traits
Traits
TraceTrait
Fully qualified path: starkware_utils::trace::trace::TraceTrait
pub trait TraceTrait
Trait functions
latest
Retrieves the most recent checkpoint from the trace structure.
Returns
A tuple containing:
u64: Timestamp/key of the latest checkpointu128: Value stored in the latest checkpoint
Panics
If the trace structure is empty (no checkpoints exist)
Note
This will return the last inserted checkpoint that maintains the structure’s invariant of non-decreasing keys.
Fully qualified path: starkware_utils::trace::trace::TraceTrait::latest
fn latest(self: StoragePath<Trace>) -> Result<(u64, u128), TraceErrors>
penultimate
Retrieves the penultimate checkpoint from the trace structure. Penultimate checkpoint is the second last checkpoint in the trace.
Fully qualified path: starkware_utils::trace::trace::TraceTrait::penultimate
fn penultimate(self: StoragePath<Trace>) -> Result<(u64, u128), TraceErrors>
length
Returns the total number of checkpoints.
Fully qualified path: starkware_utils::trace::trace::TraceTrait::length
fn length(self: StoragePath<Trace>) -> u64
at
Returns the checkpoint at the given position.
Returns
A tuple containing:
u64: Timestamp/key of the checkpointu128: Value stored in the checkpoint
Panics
If the position is out of bounds.
Fully qualified path: starkware_utils::trace::trace::TraceTrait::at
fn at(self: StoragePath<Trace>, pos: u64) -> (u64, u128)
is_empty
Returns true is the trace is empty.
Fully qualified path: starkware_utils::trace::trace::TraceTrait::is_empty
fn is_empty(self: StoragePath<Trace>) -> bool
MutableTraceTrait
Fully qualified path: starkware_utils::trace::trace::MutableTraceTrait
pub trait MutableTraceTrait
Trait functions
insert
Inserts a (key, value) pair into a Trace so that it is stored as the checkpoint,
either by inserting a new checkpoint, or by updating the last one.
Fully qualified path: starkware_utils::trace::trace::MutableTraceTrait::insert
fn insert(self: StoragePath<Mutable<Trace>>, key: u64, value: u128)
latest
Retrieves the most recent checkpoint from the trace structure.
Returns
A tuple containing:
u64: Timestamp/key of the latest checkpointu128: Value stored in the latest checkpoint
Panics
If the trace structure is empty (no checkpoints exist)
Note
This will return the last inserted checkpoint that maintains the structure’s invariant of non-decreasing keys.
Fully qualified path: starkware_utils::trace::trace::MutableTraceTrait::latest
fn latest(self: StoragePath<Mutable<Trace>>) -> Result<(u64, u128), TraceErrors>
penultimate
Retrieves the penultimate checkpoint from the trace structure. Penultimate checkpoint is the second last checkpoint in the trace.
Fully qualified path: starkware_utils::trace::trace::MutableTraceTrait::penultimate
fn penultimate(self: StoragePath<Mutable<Trace>>) -> Result<(u64, u128), TraceErrors>
length
Returns the total number of checkpoints.
Fully qualified path: starkware_utils::trace::trace::MutableTraceTrait::length
fn length(self: StoragePath<Mutable<Trace>>) -> u64
is_empty
Returns true is the trace is empty.
Fully qualified path: starkware_utils::trace::trace::MutableTraceTrait::is_empty
fn is_empty(self: StoragePath<Mutable<Trace>>) -> bool
Impls
Impls
CheckpointIntoPair
Fully qualified path: starkware_utils::trace::trace::CheckpointIntoPair
pub impl CheckpointIntoPair of Into<Checkpoint, (u64, u128)>;
Impl functions
into
Fully qualified path: starkware_utils::trace::trace::CheckpointIntoPair::into
fn into(self: Checkpoint) -> (u64, u128)
TraceImpl
Fully qualified path: starkware_utils::trace::trace::TraceImpl
pub impl TraceImpl of TraceTrait;
Impl functions
latest
Retrieves the most recent checkpoint from the trace structure.
Returns
A tuple containing:
u64: Timestamp/key of the latest checkpointu128: Value stored in the latest checkpoint
Panics
If the trace structure is empty (no checkpoints exist)
Note
This will return the last inserted checkpoint that maintains the structure’s invariant of non-decreasing keys.
Fully qualified path: starkware_utils::trace::trace::TraceImpl::latest
fn latest(self: StoragePath<Trace>) -> Result<(u64, u128), TraceErrors>
penultimate
Retrieves the penultimate checkpoint from the trace structure. Penultimate checkpoint is the second last checkpoint in the trace.
Fully qualified path: starkware_utils::trace::trace::TraceImpl::penultimate
fn penultimate(self: StoragePath<Trace>) -> Result<(u64, u128), TraceErrors>
length
Returns the total number of checkpoints.
Fully qualified path: starkware_utils::trace::trace::TraceImpl::length
fn length(self: StoragePath<Trace>) -> u64
at
Returns the checkpoint at the given position.
Returns
A tuple containing:
u64: Timestamp/key of the checkpointu128: Value stored in the checkpoint
Panics
If the position is out of bounds.
Fully qualified path: starkware_utils::trace::trace::TraceImpl::at
fn at(self: StoragePath<Trace>, pos: u64) -> (u64, u128)
is_empty
Returns true is the trace is empty.
Fully qualified path: starkware_utils::trace::trace::TraceImpl::is_empty
fn is_empty(self: StoragePath<Trace>) -> bool
MutableTraceImpl
Fully qualified path: starkware_utils::trace::trace::MutableTraceImpl
pub impl MutableTraceImpl of MutableTraceTrait;
Impl functions
insert
Inserts a (key, value) pair into a Trace so that it is stored as the checkpoint,
either by inserting a new checkpoint, or by updating the last one.
Fully qualified path: starkware_utils::trace::trace::MutableTraceImpl::insert
fn insert(self: StoragePath<Mutable<Trace>>, key: u64, value: u128)
latest
Retrieves the most recent checkpoint from the trace structure.
Returns
A tuple containing:
u64: Timestamp/key of the latest checkpointu128: Value stored in the latest checkpoint
Panics
If the trace structure is empty (no checkpoints exist)
Note
This will return the last inserted checkpoint that maintains the structure’s invariant of non-decreasing keys.
Fully qualified path: starkware_utils::trace::trace::MutableTraceImpl::latest
fn latest(self: StoragePath<Mutable<Trace>>) -> Result<(u64, u128), TraceErrors>
penultimate
Retrieves the penultimate checkpoint from the trace structure. Penultimate checkpoint is the second last checkpoint in the trace.
Fully qualified path: starkware_utils::trace::trace::MutableTraceImpl::penultimate
fn penultimate(self: StoragePath<Mutable<Trace>>) -> Result<(u64, u128), TraceErrors>
length
Returns the total number of checkpoints.
Fully qualified path: starkware_utils::trace::trace::MutableTraceImpl::length
fn length(self: StoragePath<Mutable<Trace>>) -> u64
is_empty
Returns true is the trace is empty.
Fully qualified path: starkware_utils::trace::trace::MutableTraceImpl::is_empty
fn is_empty(self: StoragePath<Mutable<Trace>>) -> bool
types
Fully qualified path: starkware_utils::types
Modules
| time | — |
Type aliases
Modules
Modules
| time | — |
time
Fully qualified path: starkware_utils::types::time
Modules
| time | — |
Modules
Modules
| time | — |
time
Fully qualified path: starkware_utils::types::time::time
Structs
Type aliases
Traits
| Time | — |
Impls
Structs
Structs
TimeDelta
Fully qualified path: starkware_utils::types::time::time::TimeDelta
[derive(Debug, PartialEq, Drop, Serde, Copy, starknet::Store)]
pub struct TimeDelta {
pub seconds: u64,
}
Members
seconds
Fully qualified path: starkware_utils::types::time::time::TimeDelta::seconds
pub seconds: u64
Timestamp
Fully qualified path: starkware_utils::types::time::time::Timestamp
[derive(Debug, PartialEq, Drop, Hash, Serde, Copy, starknet::Store)]
pub struct Timestamp {
pub seconds: u64,
}
Members
seconds
Fully qualified path: starkware_utils::types::time::time::Timestamp::seconds
pub seconds: u64
Type aliases
Type aliases
Seconds
Fully qualified path: starkware_utils::types::time::time::Seconds
pub type Seconds = u64;
Traits
Traits
| Time | — |
Time
Fully qualified path: starkware_utils::types::time::time::Time
pub trait Time
Trait functions
seconds
Fully qualified path: starkware_utils::types::time::time::Time::seconds
fn seconds(count: u64) -> TimeDelta
days
Fully qualified path: starkware_utils::types::time::time::Time::days
fn days(count: u64) -> TimeDelta
weeks
Fully qualified path: starkware_utils::types::time::time::Time::weeks
fn weeks(count: u64) -> TimeDelta
now
Fully qualified path: starkware_utils::types::time::time::Time::now
fn now() -> Timestamp
add
Fully qualified path: starkware_utils::types::time::time::Time::add
fn add(self: Timestamp, delta: TimeDelta) -> Timestamp
sub
Fully qualified path: starkware_utils::types::time::time::Time::sub
fn sub(self: Timestamp, other: Timestamp) -> TimeDelta
div
Fully qualified path: starkware_utils::types::time::time::Time::div
fn div(self: TimeDelta, divider: u64) -> TimeDelta
Impls
Impls
TimeImpl
Fully qualified path: starkware_utils::types::time::time::TimeImpl
pub impl TimeImpl of Time;
Impl functions
seconds
Fully qualified path: starkware_utils::types::time::time::TimeImpl::seconds
fn seconds(count: u64) -> TimeDelta
days
Fully qualified path: starkware_utils::types::time::time::TimeImpl::days
fn days(count: u64) -> TimeDelta
weeks
Fully qualified path: starkware_utils::types::time::time::TimeImpl::weeks
fn weeks(count: u64) -> TimeDelta
now
Fully qualified path: starkware_utils::types::time::time::TimeImpl::now
fn now() -> Timestamp
add
Fully qualified path: starkware_utils::types::time::time::TimeImpl::add
fn add(self: Timestamp, delta: TimeDelta) -> Timestamp
sub
Fully qualified path: starkware_utils::types::time::time::TimeImpl::sub
fn sub(self: Timestamp, other: Timestamp) -> TimeDelta
div
Fully qualified path: starkware_utils::types::time::time::TimeImpl::div
fn div(self: TimeDelta, divider: u64) -> TimeDelta
Type aliases
Type aliases
Signature
Fully qualified path: starkware_utils::types::Signature
pub type Signature = Span<felt252>;
PublicKey
Fully qualified path: starkware_utils::types::PublicKey
pub type PublicKey = felt252;
HashType
Fully qualified path: starkware_utils::types::HashType
pub type HashType = felt252;
utils
Fully qualified path: starkware_utils::utils
Free functions
Traits
Impls
Free functions
Free functions
validate_stark_signature
Fully qualified path: starkware_utils::utils::validate_stark_signature
pub fn validate_stark_signature(public_key: felt252, msg_hash: felt252, signature: Span<felt252>)
validate_expiration
Fully qualified path: starkware_utils::utils::validate_expiration
pub fn validate_expiration(expiration: Timestamp, err: felt252)
validate_ratio
Fully qualified path: starkware_utils::utils::validate_ratio
pub fn validate_ratio<N, D, +Into<N, i128>, +Drop<N>, +Into<D, u128>, +Drop<D>>(
n1: i128, d1: u128, n2: i128, d2: u128, err: ByteArray,
)
Traits
Traits
AddToStorage
Fully qualified path: starkware_utils::utils::AddToStorage
pub trait AddToStorage<T>
Trait functions
add_and_write
Fully qualified path: starkware_utils::utils::AddToStorage::add_and_write
fn add_and_write(self: T, value: Self::Value) -> AddToStorage<T>Value
Trait types
Value
Fully qualified path: starkware_utils::utils::AddToStorage::Value
type Value;
SubFromStorage
Fully qualified path: starkware_utils::utils::SubFromStorage
pub trait SubFromStorage<T>
Trait functions
sub_and_write
Fully qualified path: starkware_utils::utils::SubFromStorage::sub_and_write
fn sub_and_write(self: T, value: Self::Value) -> SubFromStorage<T>Value
Trait types
Value
Fully qualified path: starkware_utils::utils::SubFromStorage::Value
type Value;
Impls
Impls
StoragePointerAddToStorageImpl
Fully qualified path: starkware_utils::utils::StoragePointerAddToStorageImpl
pub impl StoragePointerAddToStorageImpl<
TValue, +Drop<TValue>, +Add<TValue>, +Copy<TValue>, +Store<TValue>,
> of AddToStorage<StoragePointer<Mutable<TValue>>>;
Impl functions
add_and_write
Fully qualified path: starkware_utils::utils::StoragePointerAddToStorageImpl::add_and_write
fn add_and_write(self: StoragePointer<Mutable<TValue>>, value: TValue) -> TValue
Impl types
Value
Fully qualified path: starkware_utils::utils::StoragePointerAddToStorageImpl::Value
type Value = TValue;
StoragePathSubFromStorageImpl
Fully qualified path: starkware_utils::utils::StoragePathSubFromStorageImpl
pub impl StoragePathSubFromStorageImpl<
TValue, +Drop<TValue>, +Sub<TValue>, +Copy<TValue>, +Store<TValue>,
> of SubFromStorage<StoragePointer<Mutable<TValue>>>;
Impl functions
sub_and_write
Fully qualified path: starkware_utils::utils::StoragePathSubFromStorageImpl::sub_and_write
fn sub_and_write(self: StoragePointer<Mutable<TValue>>, value: TValue) -> TValue
Impl types
Value
Fully qualified path: starkware_utils::utils::StoragePathSubFromStorageImpl::Value
type Value = TValue;
dispatchers
Structs
Structs
IDepositDispatcher
Fully qualified path: starkware_utils::components::deposit::interface::IDepositDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IDepositDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::components::deposit::interface::IDepositDispatcher::contract_address
pub contract_address: ContractAddress
IDepositLibraryDispatcher
Fully qualified path: starkware_utils::components::deposit::interface::IDepositLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IDepositLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::components::deposit::interface::IDepositLibraryDispatcher::class_hash
pub class_hash: ClassHash
IDepositSafeLibraryDispatcher
Fully qualified path: starkware_utils::components::deposit::interface::IDepositSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IDepositSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::components::deposit::interface::IDepositSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IDepositSafeDispatcher
Fully qualified path: starkware_utils::components::deposit::interface::IDepositSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IDepositSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::components::deposit::interface::IDepositSafeDispatcher::contract_address
pub contract_address: ContractAddress
INonceDispatcher
Fully qualified path: starkware_utils::components::nonce::interface::INonceDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct INonceDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::components::nonce::interface::INonceDispatcher::contract_address
pub contract_address: ContractAddress
INonceLibraryDispatcher
Fully qualified path: starkware_utils::components::nonce::interface::INonceLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct INonceLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::components::nonce::interface::INonceLibraryDispatcher::class_hash
pub class_hash: ClassHash
INonceSafeLibraryDispatcher
Fully qualified path: starkware_utils::components::nonce::interface::INonceSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct INonceSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::components::nonce::interface::INonceSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
INonceSafeDispatcher
Fully qualified path: starkware_utils::components::nonce::interface::INonceSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct INonceSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::components::nonce::interface::INonceSafeDispatcher::contract_address
pub contract_address: ContractAddress
IPausableDispatcher
Fully qualified path: starkware_utils::components::pausable::interface::IPausableDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IPausableDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::components::pausable::interface::IPausableDispatcher::contract_address
pub contract_address: ContractAddress
IPausableLibraryDispatcher
Fully qualified path: starkware_utils::components::pausable::interface::IPausableLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IPausableLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::components::pausable::interface::IPausableLibraryDispatcher::class_hash
pub class_hash: ClassHash
IPausableSafeLibraryDispatcher
Fully qualified path: starkware_utils::components::pausable::interface::IPausableSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IPausableSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::components::pausable::interface::IPausableSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IPausableSafeDispatcher
Fully qualified path: starkware_utils::components::pausable::interface::IPausableSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IPausableSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::components::pausable::interface::IPausableSafeDispatcher::contract_address
pub contract_address: ContractAddress
IEICInitializableDispatcher
Fully qualified path: starkware_utils::components::replaceability::interface::IEICInitializableDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IEICInitializableDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::components::replaceability::interface::IEICInitializableDispatcher::contract_address
pub contract_address: ContractAddress
IEICInitializableLibraryDispatcher
Fully qualified path: starkware_utils::components::replaceability::interface::IEICInitializableLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IEICInitializableLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::components::replaceability::interface::IEICInitializableLibraryDispatcher::class_hash
pub class_hash: ClassHash
IEICInitializableSafeLibraryDispatcher
Fully qualified path: starkware_utils::components::replaceability::interface::IEICInitializableSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IEICInitializableSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::components::replaceability::interface::IEICInitializableSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IEICInitializableSafeDispatcher
Fully qualified path: starkware_utils::components::replaceability::interface::IEICInitializableSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IEICInitializableSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::components::replaceability::interface::IEICInitializableSafeDispatcher::contract_address
pub contract_address: ContractAddress
IReplaceableDispatcher
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IReplaceableDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableDispatcher::contract_address
pub contract_address: ContractAddress
IReplaceableLibraryDispatcher
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IReplaceableLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableLibraryDispatcher::class_hash
pub class_hash: ClassHash
IReplaceableSafeLibraryDispatcher
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IReplaceableSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IReplaceableSafeDispatcher
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IReplaceableSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableSafeDispatcher::contract_address
pub contract_address: ContractAddress
IRequestApprovalsDispatcher
Fully qualified path: starkware_utils::components::request_approvals::interface::IRequestApprovalsDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IRequestApprovalsDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::components::request_approvals::interface::IRequestApprovalsDispatcher::contract_address
pub contract_address: ContractAddress
IRequestApprovalsLibraryDispatcher
Fully qualified path: starkware_utils::components::request_approvals::interface::IRequestApprovalsLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IRequestApprovalsLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::components::request_approvals::interface::IRequestApprovalsLibraryDispatcher::class_hash
pub class_hash: ClassHash
IRequestApprovalsSafeLibraryDispatcher
Fully qualified path: starkware_utils::components::request_approvals::interface::IRequestApprovalsSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IRequestApprovalsSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::components::request_approvals::interface::IRequestApprovalsSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IRequestApprovalsSafeDispatcher
Fully qualified path: starkware_utils::components::request_approvals::interface::IRequestApprovalsSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IRequestApprovalsSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::components::request_approvals::interface::IRequestApprovalsSafeDispatcher::contract_address
pub contract_address: ContractAddress
IRolesDispatcher
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IRolesDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcher::contract_address
pub contract_address: ContractAddress
IRolesLibraryDispatcher
Fully qualified path: starkware_utils::components::roles::interface::IRolesLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IRolesLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::components::roles::interface::IRolesLibraryDispatcher::class_hash
pub class_hash: ClassHash
IRolesSafeLibraryDispatcher
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IRolesSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IRolesSafeDispatcher
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IRolesSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcher::contract_address
pub contract_address: ContractAddress
IMinimalRolesDispatcher
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IMinimalRolesDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesDispatcher::contract_address
pub contract_address: ContractAddress
IMinimalRolesLibraryDispatcher
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IMinimalRolesLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesLibraryDispatcher::class_hash
pub class_hash: ClassHash
IMinimalRolesSafeLibraryDispatcher
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IMinimalRolesSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IMinimalRolesSafeDispatcher
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IMinimalRolesSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesSafeDispatcher::contract_address
pub contract_address: ContractAddress
IdentityDispatcher
Fully qualified path: starkware_utils::interfaces::identity::IdentityDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IdentityDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::interfaces::identity::IdentityDispatcher::contract_address
pub contract_address: ContractAddress
IdentityLibraryDispatcher
Fully qualified path: starkware_utils::interfaces::identity::IdentityLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IdentityLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::interfaces::identity::IdentityLibraryDispatcher::class_hash
pub class_hash: ClassHash
IdentitySafeLibraryDispatcher
Fully qualified path: starkware_utils::interfaces::identity::IdentitySafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IdentitySafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::interfaces::identity::IdentitySafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IdentitySafeDispatcher
Fully qualified path: starkware_utils::interfaces::identity::IdentitySafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IdentitySafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::interfaces::identity::IdentitySafeDispatcher::contract_address
pub contract_address: ContractAddress
IMintableTokenDispatcher
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableTokenDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IMintableTokenDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableTokenDispatcher::contract_address
pub contract_address: ContractAddress
IMintableTokenLibraryDispatcher
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableTokenLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IMintableTokenLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableTokenLibraryDispatcher::class_hash
pub class_hash: ClassHash
IMintableTokenSafeLibraryDispatcher
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableTokenSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IMintableTokenSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableTokenSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IMintableTokenSafeDispatcher
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableTokenSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IMintableTokenSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableTokenSafeDispatcher::contract_address
pub contract_address: ContractAddress
Traits
Traits
IDepositDispatcherTrait
Fully qualified path: starkware_utils::components::deposit::interface::IDepositDispatcherTrait
Part of the group: dispatchers
pub trait IDepositDispatcherTrait<T>
Trait functions
deposit
Fully qualified path: starkware_utils::components::deposit::interface::IDepositDispatcherTrait::deposit
fn deposit(self: T, beneficiary: u32, asset_id: felt252, quantized_amount: u128, salt: felt252)
cancel_deposit
Fully qualified path: starkware_utils::components::deposit::interface::IDepositDispatcherTrait::cancel_deposit
fn cancel_deposit(
self: T, beneficiary: u32, asset_id: felt252, quantized_amount: u128, salt: felt252,
)
get_deposit_status
Fully qualified path: starkware_utils::components::deposit::interface::IDepositDispatcherTrait::get_deposit_status
fn get_deposit_status(self: T, deposit_hash: felt252) -> DepositStatus
get_asset_info
Fully qualified path: starkware_utils::components::deposit::interface::IDepositDispatcherTrait::get_asset_info
fn get_asset_info(self: T, asset_id: felt252) -> (ContractAddress, u64)
get_cancel_delay
Fully qualified path: starkware_utils::components::deposit::interface::IDepositDispatcherTrait::get_cancel_delay
fn get_cancel_delay(self: T) -> TimeDelta
IDepositSafeDispatcherTrait
Fully qualified path: starkware_utils::components::deposit::interface::IDepositSafeDispatcherTrait
Part of the group: dispatchers
pub trait IDepositSafeDispatcherTrait<T>
Trait functions
deposit
Fully qualified path: starkware_utils::components::deposit::interface::IDepositSafeDispatcherTrait::deposit
fn deposit(
self: T, beneficiary: u32, asset_id: felt252, quantized_amount: u128, salt: felt252,
) -> Result<(), Array<felt252>>
cancel_deposit
Fully qualified path: starkware_utils::components::deposit::interface::IDepositSafeDispatcherTrait::cancel_deposit
fn cancel_deposit(
self: T, beneficiary: u32, asset_id: felt252, quantized_amount: u128, salt: felt252,
) -> Result<(), Array<felt252>>
get_deposit_status
Fully qualified path: starkware_utils::components::deposit::interface::IDepositSafeDispatcherTrait::get_deposit_status
fn get_deposit_status(self: T, deposit_hash: felt252) -> Result<DepositStatus, Array<felt252>>
get_asset_info
Fully qualified path: starkware_utils::components::deposit::interface::IDepositSafeDispatcherTrait::get_asset_info
fn get_asset_info(self: T, asset_id: felt252) -> Result<(ContractAddress, u64), Array<felt252>>
get_cancel_delay
Fully qualified path: starkware_utils::components::deposit::interface::IDepositSafeDispatcherTrait::get_cancel_delay
fn get_cancel_delay(self: T) -> Result<TimeDelta, Array<felt252>>
INonceDispatcherTrait
Fully qualified path: starkware_utils::components::nonce::interface::INonceDispatcherTrait
Part of the group: dispatchers
pub trait INonceDispatcherTrait<T>
Trait functions
nonce
Fully qualified path: starkware_utils::components::nonce::interface::INonceDispatcherTrait::nonce
fn nonce(self: T) -> u64
INonceSafeDispatcherTrait
Fully qualified path: starkware_utils::components::nonce::interface::INonceSafeDispatcherTrait
Part of the group: dispatchers
pub trait INonceSafeDispatcherTrait<T>
Trait functions
nonce
Fully qualified path: starkware_utils::components::nonce::interface::INonceSafeDispatcherTrait::nonce
fn nonce(self: T) -> Result<u64, Array<felt252>>
IPausableDispatcherTrait
Fully qualified path: starkware_utils::components::pausable::interface::IPausableDispatcherTrait
Part of the group: dispatchers
pub trait IPausableDispatcherTrait<T>
Trait functions
is_paused
Fully qualified path: starkware_utils::components::pausable::interface::IPausableDispatcherTrait::is_paused
fn is_paused(self: T) -> bool
pause
Fully qualified path: starkware_utils::components::pausable::interface::IPausableDispatcherTrait::pause
fn pause(self: T)
unpause
Fully qualified path: starkware_utils::components::pausable::interface::IPausableDispatcherTrait::unpause
fn unpause(self: T)
IPausableSafeDispatcherTrait
Fully qualified path: starkware_utils::components::pausable::interface::IPausableSafeDispatcherTrait
Part of the group: dispatchers
pub trait IPausableSafeDispatcherTrait<T>
Trait functions
is_paused
Fully qualified path: starkware_utils::components::pausable::interface::IPausableSafeDispatcherTrait::is_paused
fn is_paused(self: T) -> Result<bool, Array<felt252>>
pause
Fully qualified path: starkware_utils::components::pausable::interface::IPausableSafeDispatcherTrait::pause
fn pause(self: T) -> Result<(), Array<felt252>>
unpause
Fully qualified path: starkware_utils::components::pausable::interface::IPausableSafeDispatcherTrait::unpause
fn unpause(self: T) -> Result<(), Array<felt252>>
IEICInitializableDispatcherTrait
Fully qualified path: starkware_utils::components::replaceability::interface::IEICInitializableDispatcherTrait
Part of the group: dispatchers
pub trait IEICInitializableDispatcherTrait<T>
Trait functions
eic_initialize
Fully qualified path: starkware_utils::components::replaceability::interface::IEICInitializableDispatcherTrait::eic_initialize
fn eic_initialize(self: T, eic_init_data: Span<felt252>)
IEICInitializableSafeDispatcherTrait
Fully qualified path: starkware_utils::components::replaceability::interface::IEICInitializableSafeDispatcherTrait
Part of the group: dispatchers
pub trait IEICInitializableSafeDispatcherTrait<T>
Trait functions
eic_initialize
Fully qualified path: starkware_utils::components::replaceability::interface::IEICInitializableSafeDispatcherTrait::eic_initialize
fn eic_initialize(self: T, eic_init_data: Span<felt252>) -> Result<(), Array<felt252>>
IReplaceableDispatcherTrait
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableDispatcherTrait
Part of the group: dispatchers
pub trait IReplaceableDispatcherTrait<T>
Trait functions
get_upgrade_delay
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableDispatcherTrait::get_upgrade_delay
fn get_upgrade_delay(self: T) -> u64
get_impl_activation_time
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableDispatcherTrait::get_impl_activation_time
fn get_impl_activation_time(self: T, implementation_data: ImplementationData) -> u64
add_new_implementation
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableDispatcherTrait::add_new_implementation
fn add_new_implementation(self: T, implementation_data: ImplementationData)
remove_implementation
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableDispatcherTrait::remove_implementation
fn remove_implementation(self: T, implementation_data: ImplementationData)
replace_to
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableDispatcherTrait::replace_to
fn replace_to(self: T, implementation_data: ImplementationData)
IReplaceableSafeDispatcherTrait
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableSafeDispatcherTrait
Part of the group: dispatchers
pub trait IReplaceableSafeDispatcherTrait<T>
Trait functions
get_upgrade_delay
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableSafeDispatcherTrait::get_upgrade_delay
fn get_upgrade_delay(self: T) -> Result<u64, Array<felt252>>
get_impl_activation_time
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableSafeDispatcherTrait::get_impl_activation_time
fn get_impl_activation_time(
self: T, implementation_data: ImplementationData,
) -> Result<u64, Array<felt252>>
add_new_implementation
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableSafeDispatcherTrait::add_new_implementation
fn add_new_implementation(
self: T, implementation_data: ImplementationData,
) -> Result<(), Array<felt252>>
remove_implementation
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableSafeDispatcherTrait::remove_implementation
fn remove_implementation(
self: T, implementation_data: ImplementationData,
) -> Result<(), Array<felt252>>
replace_to
Fully qualified path: starkware_utils::components::replaceability::interface::IReplaceableSafeDispatcherTrait::replace_to
fn replace_to(self: T, implementation_data: ImplementationData) -> Result<(), Array<felt252>>
IRequestApprovalsDispatcherTrait
Fully qualified path: starkware_utils::components::request_approvals::interface::IRequestApprovalsDispatcherTrait
Part of the group: dispatchers
pub trait IRequestApprovalsDispatcherTrait<T>
Trait functions
get_request_status
Returns the status of a request.
Fully qualified path: starkware_utils::components::request_approvals::interface::IRequestApprovalsDispatcherTrait::get_request_status
fn get_request_status(self: T, request_hash: felt252) -> RequestStatus
IRequestApprovalsSafeDispatcherTrait
Fully qualified path: starkware_utils::components::request_approvals::interface::IRequestApprovalsSafeDispatcherTrait
Part of the group: dispatchers
pub trait IRequestApprovalsSafeDispatcherTrait<T>
Trait functions
get_request_status
Returns the status of a request.
Fully qualified path: starkware_utils::components::request_approvals::interface::IRequestApprovalsSafeDispatcherTrait::get_request_status
fn get_request_status(self: T, request_hash: felt252) -> Result<RequestStatus, Array<felt252>>
IRolesDispatcherTrait
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait
Part of the group: dispatchers
pub trait IRolesDispatcherTrait<T>
Trait functions
is_app_governor
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::is_app_governor
fn is_app_governor(self: T, account: ContractAddress) -> bool
is_app_role_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::is_app_role_admin
fn is_app_role_admin(self: T, account: ContractAddress) -> bool
is_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::is_governance_admin
fn is_governance_admin(self: T, account: ContractAddress) -> bool
is_operator
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::is_operator
fn is_operator(self: T, account: ContractAddress) -> bool
is_token_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::is_token_admin
fn is_token_admin(self: T, account: ContractAddress) -> bool
is_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::is_upgrade_governor
fn is_upgrade_governor(self: T, account: ContractAddress) -> bool
is_security_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::is_security_admin
fn is_security_admin(self: T, account: ContractAddress) -> bool
is_security_agent
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::is_security_agent
fn is_security_agent(self: T, account: ContractAddress) -> bool
register_app_governor
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::register_app_governor
fn register_app_governor(self: T, account: ContractAddress)
remove_app_governor
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::remove_app_governor
fn remove_app_governor(self: T, account: ContractAddress)
register_app_role_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::register_app_role_admin
fn register_app_role_admin(self: T, account: ContractAddress)
remove_app_role_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::remove_app_role_admin
fn remove_app_role_admin(self: T, account: ContractAddress)
register_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::register_governance_admin
fn register_governance_admin(self: T, account: ContractAddress)
remove_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::remove_governance_admin
fn remove_governance_admin(self: T, account: ContractAddress)
register_operator
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::register_operator
fn register_operator(self: T, account: ContractAddress)
remove_operator
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::remove_operator
fn remove_operator(self: T, account: ContractAddress)
register_token_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::register_token_admin
fn register_token_admin(self: T, account: ContractAddress)
remove_token_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::remove_token_admin
fn remove_token_admin(self: T, account: ContractAddress)
register_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::register_upgrade_governor
fn register_upgrade_governor(self: T, account: ContractAddress)
remove_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::remove_upgrade_governor
fn remove_upgrade_governor(self: T, account: ContractAddress)
renounce
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::renounce
fn renounce(self: T, role: felt252)
register_security_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::register_security_admin
fn register_security_admin(self: T, account: ContractAddress)
remove_security_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::remove_security_admin
fn remove_security_admin(self: T, account: ContractAddress)
register_security_agent
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::register_security_agent
fn register_security_agent(self: T, account: ContractAddress)
remove_security_agent
Fully qualified path: starkware_utils::components::roles::interface::IRolesDispatcherTrait::remove_security_agent
fn remove_security_agent(self: T, account: ContractAddress)
IRolesSafeDispatcherTrait
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait
Part of the group: dispatchers
pub trait IRolesSafeDispatcherTrait<T>
Trait functions
is_app_governor
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::is_app_governor
fn is_app_governor(self: T, account: ContractAddress) -> Result<bool, Array<felt252>>
is_app_role_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::is_app_role_admin
fn is_app_role_admin(self: T, account: ContractAddress) -> Result<bool, Array<felt252>>
is_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::is_governance_admin
fn is_governance_admin(self: T, account: ContractAddress) -> Result<bool, Array<felt252>>
is_operator
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::is_operator
fn is_operator(self: T, account: ContractAddress) -> Result<bool, Array<felt252>>
is_token_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::is_token_admin
fn is_token_admin(self: T, account: ContractAddress) -> Result<bool, Array<felt252>>
is_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::is_upgrade_governor
fn is_upgrade_governor(self: T, account: ContractAddress) -> Result<bool, Array<felt252>>
is_security_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::is_security_admin
fn is_security_admin(self: T, account: ContractAddress) -> Result<bool, Array<felt252>>
is_security_agent
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::is_security_agent
fn is_security_agent(self: T, account: ContractAddress) -> Result<bool, Array<felt252>>
register_app_governor
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::register_app_governor
fn register_app_governor(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
remove_app_governor
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::remove_app_governor
fn remove_app_governor(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
register_app_role_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::register_app_role_admin
fn register_app_role_admin(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
remove_app_role_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::remove_app_role_admin
fn remove_app_role_admin(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
register_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::register_governance_admin
fn register_governance_admin(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
remove_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::remove_governance_admin
fn remove_governance_admin(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
register_operator
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::register_operator
fn register_operator(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
remove_operator
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::remove_operator
fn remove_operator(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
register_token_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::register_token_admin
fn register_token_admin(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
remove_token_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::remove_token_admin
fn remove_token_admin(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
register_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::register_upgrade_governor
fn register_upgrade_governor(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
remove_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::remove_upgrade_governor
fn remove_upgrade_governor(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
renounce
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::renounce
fn renounce(self: T, role: felt252) -> Result<(), Array<felt252>>
register_security_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::register_security_admin
fn register_security_admin(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
remove_security_admin
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::remove_security_admin
fn remove_security_admin(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
register_security_agent
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::register_security_agent
fn register_security_agent(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
remove_security_agent
Fully qualified path: starkware_utils::components::roles::interface::IRolesSafeDispatcherTrait::remove_security_agent
fn remove_security_agent(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
IMinimalRolesDispatcherTrait
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesDispatcherTrait
Part of the group: dispatchers
pub trait IMinimalRolesDispatcherTrait<T>
Trait functions
is_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesDispatcherTrait::is_governance_admin
fn is_governance_admin(self: T, account: ContractAddress) -> bool
is_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesDispatcherTrait::is_upgrade_governor
fn is_upgrade_governor(self: T, account: ContractAddress) -> bool
register_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesDispatcherTrait::register_governance_admin
fn register_governance_admin(self: T, account: ContractAddress)
remove_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesDispatcherTrait::remove_governance_admin
fn remove_governance_admin(self: T, account: ContractAddress)
register_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesDispatcherTrait::register_upgrade_governor
fn register_upgrade_governor(self: T, account: ContractAddress)
remove_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesDispatcherTrait::remove_upgrade_governor
fn remove_upgrade_governor(self: T, account: ContractAddress)
renounce
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesDispatcherTrait::renounce
fn renounce(self: T, role: felt252)
IMinimalRolesSafeDispatcherTrait
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesSafeDispatcherTrait
Part of the group: dispatchers
pub trait IMinimalRolesSafeDispatcherTrait<T>
Trait functions
is_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesSafeDispatcherTrait::is_governance_admin
fn is_governance_admin(self: T, account: ContractAddress) -> Result<bool, Array<felt252>>
is_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesSafeDispatcherTrait::is_upgrade_governor
fn is_upgrade_governor(self: T, account: ContractAddress) -> Result<bool, Array<felt252>>
register_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesSafeDispatcherTrait::register_governance_admin
fn register_governance_admin(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
remove_governance_admin
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesSafeDispatcherTrait::remove_governance_admin
fn remove_governance_admin(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
register_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesSafeDispatcherTrait::register_upgrade_governor
fn register_upgrade_governor(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
remove_upgrade_governor
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesSafeDispatcherTrait::remove_upgrade_governor
fn remove_upgrade_governor(self: T, account: ContractAddress) -> Result<(), Array<felt252>>
renounce
Fully qualified path: starkware_utils::components::roles::interface::IMinimalRolesSafeDispatcherTrait::renounce
fn renounce(self: T, role: felt252) -> Result<(), Array<felt252>>
IdentityDispatcherTrait
Fully qualified path: starkware_utils::interfaces::identity::IdentityDispatcherTrait
Part of the group: dispatchers
pub trait IdentityDispatcherTrait<T>
Trait functions
identify
Fully qualified path: starkware_utils::interfaces::identity::IdentityDispatcherTrait::identify
fn identify(self: T) -> felt252
version
Fully qualified path: starkware_utils::interfaces::identity::IdentityDispatcherTrait::version
fn version(self: T) -> felt252
IdentitySafeDispatcherTrait
Fully qualified path: starkware_utils::interfaces::identity::IdentitySafeDispatcherTrait
Part of the group: dispatchers
pub trait IdentitySafeDispatcherTrait<T>
Trait functions
identify
Fully qualified path: starkware_utils::interfaces::identity::IdentitySafeDispatcherTrait::identify
fn identify(self: T) -> Result<felt252, Array<felt252>>
version
Fully qualified path: starkware_utils::interfaces::identity::IdentitySafeDispatcherTrait::version
fn version(self: T) -> Result<felt252, Array<felt252>>
IMintableTokenDispatcherTrait
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableTokenDispatcherTrait
Part of the group: dispatchers
pub trait IMintableTokenDispatcherTrait<T>
Trait functions
permissioned_mint
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableTokenDispatcherTrait::permissioned_mint
fn permissioned_mint(self: T, account: ContractAddress, amount: u256)
permissioned_burn
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableTokenDispatcherTrait::permissioned_burn
fn permissioned_burn(self: T, account: ContractAddress, amount: u256)
is_permitted_minter
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableTokenDispatcherTrait::is_permitted_minter
fn is_permitted_minter(self: T, account: ContractAddress) -> bool
IMintableTokenSafeDispatcherTrait
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableTokenSafeDispatcherTrait
Part of the group: dispatchers
pub trait IMintableTokenSafeDispatcherTrait<T>
Trait functions
permissioned_mint
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableTokenSafeDispatcherTrait::permissioned_mint
fn permissioned_mint(self: T, account: ContractAddress, amount: u256) -> Result<(), Array<felt252>>
permissioned_burn
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableTokenSafeDispatcherTrait::permissioned_burn
fn permissioned_burn(self: T, account: ContractAddress, amount: u256) -> Result<(), Array<felt252>>
is_permitted_minter
Fully qualified path: starkware_utils::interfaces::mintable_token::IMintableTokenSafeDispatcherTrait::is_permitted_minter
fn is_permitted_minter(self: T, account: ContractAddress) -> Result<bool, Array<felt252>>