Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

openzeppelin_security

Fully qualified path: openzeppelin_security

Modules
initializable—
pausable—
reentrancyguard—

Re-exports:
InitializableComponent…
PausableComponent…
ReentrancyGuardComponent…

Modules

Modules
initializable—
pausable—
reentrancyguard—

initializable

Fully qualified path: openzeppelin_security::initializable

Modules
InitializableComponent…

Modules

Modules
InitializableComponent…

InitializableComponent

Initializable Component

The Initializable component provides a simple mechanism that executes logic once and only once. This can be useful for setting a contract’s initial state in scenarios where a constructor cannot be used.

Fully qualified path: openzeppelin_security::initializable::InitializableComponent

Modules
Errors—
__external_InitializableImpl—
__l1_handler_InitializableImpl—
__constructor_InitializableImpl—

Free functions
unsafe_new_component_state—

Structs
Storage—
ComponentState—

Enums
Event—

Traits
HasComponent—
InternalTrait—
UnsafeNewContractStateTraitForInitializableImpl—

Modules

Modules
Errors—
__external_InitializableImpl—
__l1_handler_InitializableImpl—
__constructor_InitializableImpl—

Errors

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::Errors

Constants
INITIALIZED—

Constants

Constants
INITIALIZED—

INITIALIZED

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::Errors::INITIALIZED

pub const INITIALIZED: felt252 =
    1979703840346465310352890977896418220597550248255657866222977538483556;

__external_InitializableImpl

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::__external_InitializableImpl

__l1_handler_InitializableImpl

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::__l1_handler_InitializableImpl

__constructor_InitializableImpl

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::__constructor_InitializableImpl

Free functions

Free functions
unsafe_new_component_state—

unsafe_new_component_state

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::unsafe_new_component_state

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

Structs

Structs
Storage—
ComponentState—

Storage

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::Storage

[storage]
pub struct Storage {
    pub Initializable_initialized: bool,
}

Members

Initializable_initialized

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::Storage::Initializable_initialized

pub Initializable_initialized: bool

ComponentState

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::ComponentState

pub struct ComponentState<TContractState> {}

Enums

Enums
Event—

Event

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::Event

pub enum Event {}

Traits

Traits
HasComponent—
InternalTrait—
UnsafeNewContractStateTraitForInitializableImpl—

HasComponent

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::HasComponent

pub trait HasComponent<TContractState>

Trait functions

get_component

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::HasComponent::get_component

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

get_component_mut

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::HasComponent::get_component_mut

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

get_contract

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::HasComponent::get_contract

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

get_contract_mut

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::HasComponent::get_contract_mut

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

emit

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::HasComponent::emit

fn emit<
    S, impl IntoImp: Into<S, openzeppelin_security::initializable::InitializableComponent::Event>,
>(
    ref self: ComponentState<TContractState>, event: S,
)

InternalTrait

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::InternalTrait

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

Trait functions

initialize

Ensures that the calling function can only be called once.

Requirements:

  • initialize was not previously called.

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::InternalTrait::initialize

fn initialize(ref self: ComponentState<TContractState>)

UnsafeNewContractStateTraitForInitializableImpl

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::UnsafeNewContractStateTraitForInitializableImpl

pub trait UnsafeNewContractStateTraitForInitializableImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: openzeppelin_security::initializable::InitializableComponent::UnsafeNewContractStateTraitForInitializableImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

pausable

Fully qualified path: openzeppelin_security::pausable

Modules
PausableComponent…

Modules

Modules
PausableComponent…

PausableComponent

Pausable Component

The Pausable component allows the using contract to implement an emergency stop mechanism. Only functions that call assert_paused or assert_not_paused will be affected by this mechanism.

Fully qualified path: openzeppelin_security::pausable::PausableComponent

Modules
Errors—
__external_PausableImpl—
__l1_handler_PausableImpl—
__constructor_PausableImpl—

Free functions
unsafe_new_component_state—

Structs
Storage—
PausedEmitted when the pause is triggered by account .
UnpausedEmitted when the pause is lifted by account .
ComponentState—

Enums
Event—

Traits
HasComponent—
InternalTrait—
UnsafeNewContractStateTraitForPausableImpl—

Modules

Modules
Errors—
__external_PausableImpl—
__l1_handler_PausableImpl—
__constructor_PausableImpl—

Errors

Fully qualified path: openzeppelin_security::pausable::PausableComponent::Errors

Constants
PAUSED—
NOT_PAUSED—

Constants

Constants
PAUSED—
NOT_PAUSED—

PAUSED

Fully qualified path: openzeppelin_security::pausable::PausableComponent::Errors::PAUSED

pub const PAUSED: felt252 = 106844274641372497063992925961428624740;

NOT_PAUSED

Fully qualified path: openzeppelin_security::pausable::PausableComponent::Errors::NOT_PAUSED

pub const NOT_PAUSED: felt252 = 458892665349537003443705626993111344055808386404;

__external_PausableImpl

Fully qualified path: openzeppelin_security::pausable::PausableComponent::__external_PausableImpl

__l1_handler_PausableImpl

Fully qualified path: openzeppelin_security::pausable::PausableComponent::__l1_handler_PausableImpl

__constructor_PausableImpl

Fully qualified path: openzeppelin_security::pausable::PausableComponent::__constructor_PausableImpl

Free functions

Free functions
unsafe_new_component_state—

unsafe_new_component_state

Fully qualified path: openzeppelin_security::pausable::PausableComponent::unsafe_new_component_state

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

Structs

Structs
Storage—
PausedEmitted when the pause is triggered by account .
UnpausedEmitted when the pause is lifted by account .
ComponentState—

Storage

Fully qualified path: openzeppelin_security::pausable::PausableComponent::Storage

[storage]
pub struct Storage {
    pub Pausable_paused: bool,
}

Members

Pausable_paused

Fully qualified path: openzeppelin_security::pausable::PausableComponent::Storage::Pausable_paused

pub Pausable_paused: bool

Paused

Emitted when the pause is triggered by account.

Fully qualified path: openzeppelin_security::pausable::PausableComponent::Paused

[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct Paused {
    pub account: ContractAddress,
}

Members

account

Fully qualified path: openzeppelin_security::pausable::PausableComponent::Paused::account

pub account: ContractAddress

Unpaused

Emitted when the pause is lifted by account.

Fully qualified path: openzeppelin_security::pausable::PausableComponent::Unpaused

[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct Unpaused {
    pub account: ContractAddress,
}

Members

account

Fully qualified path: openzeppelin_security::pausable::PausableComponent::Unpaused::account

pub account: ContractAddress

ComponentState

Fully qualified path: openzeppelin_security::pausable::PausableComponent::ComponentState

pub struct ComponentState<TContractState> {}

Enums

Enums
Event—

Event

Fully qualified path: openzeppelin_security::pausable::PausableComponent::Event

pub enum Event {
    Paused: Paused,
    Unpaused: Unpaused,
}

Variants

Paused

Fully qualified path: openzeppelin_security::pausable::PausableComponent::Event::Paused

Paused: Paused

Unpaused

Fully qualified path: openzeppelin_security::pausable::PausableComponent::Event::Unpaused

Unpaused: Unpaused

Traits

Traits
HasComponent—
InternalTrait—
UnsafeNewContractStateTraitForPausableImpl—

HasComponent

Fully qualified path: openzeppelin_security::pausable::PausableComponent::HasComponent

pub trait HasComponent<TContractState>

Trait functions

get_component

Fully qualified path: openzeppelin_security::pausable::PausableComponent::HasComponent::get_component

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

get_component_mut

Fully qualified path: openzeppelin_security::pausable::PausableComponent::HasComponent::get_component_mut

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

get_contract

Fully qualified path: openzeppelin_security::pausable::PausableComponent::HasComponent::get_contract

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

get_contract_mut

Fully qualified path: openzeppelin_security::pausable::PausableComponent::HasComponent::get_contract_mut

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

emit

Fully qualified path: openzeppelin_security::pausable::PausableComponent::HasComponent::emit

fn emit<S, impl IntoImp: Into<S, openzeppelin_security::pausable::PausableComponent::Event>>(
    ref self: ComponentState<TContractState>, event: S,
)

InternalTrait

Fully qualified path: openzeppelin_security::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: openzeppelin_security::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: openzeppelin_security::pausable::PausableComponent::InternalTrait::assert_paused

fn assert_paused(self: @ComponentState<TContractState>)

pause

Triggers a stopped state.

Requirements:

  • The contract is not paused.

Emits a Paused event.

Fully qualified path: openzeppelin_security::pausable::PausableComponent::InternalTrait::pause

fn pause(ref self: ComponentState<TContractState>)

unpause

Lifts the pause on the contract.

Requirements:

  • The contract is paused.

Emits an Unpaused event.

Fully qualified path: openzeppelin_security::pausable::PausableComponent::InternalTrait::unpause

fn unpause(ref self: ComponentState<TContractState>)

UnsafeNewContractStateTraitForPausableImpl

Fully qualified path: openzeppelin_security::pausable::PausableComponent::UnsafeNewContractStateTraitForPausableImpl

pub trait UnsafeNewContractStateTraitForPausableImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: openzeppelin_security::pausable::PausableComponent::UnsafeNewContractStateTraitForPausableImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

reentrancyguard

Fully qualified path: openzeppelin_security::reentrancyguard

Modules
ReentrancyGuardComponent…

Modules

Modules
ReentrancyGuardComponent…

ReentrancyGuardComponent

ReentrancyGuard Component

The ReentrancyGuard component helps prevent nested (reentrant) calls to a function.

Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent

Modules
Errors—

Free functions
unsafe_new_component_state—

Structs
Storage—
ComponentState—

Enums
Event—

Traits
HasComponent—
InternalTrait—

Modules

Modules
Errors—

Errors

Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::Errors

Constants
REENTRANT_CALL—

Constants

Constants
REENTRANT_CALL—

REENTRANT_CALL

Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::Errors::REENTRANT_CALL

pub const REENTRANT_CALL: felt252 =
    145581270279722262409219780158987462040688757148004254037992015513052605548;

Free functions

Free functions
unsafe_new_component_state—

unsafe_new_component_state

Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::unsafe_new_component_state

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

Structs

Structs
Storage—
ComponentState—

Storage

Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::Storage

[storage]
pub struct Storage {
    pub ReentrancyGuard_entered: bool,
}

Members

ReentrancyGuard_entered

Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::Storage::ReentrancyGuard_entered

pub ReentrancyGuard_entered: bool

ComponentState

Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::ComponentState

pub struct ComponentState<TContractState> {}

Enums

Enums
Event—

Event

Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::Event

pub enum Event {}

Traits

Traits
HasComponent—
InternalTrait—

HasComponent

Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::HasComponent

pub trait HasComponent<TContractState>

Trait functions

get_component

Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::HasComponent::get_component

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

get_component_mut

Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::HasComponent::get_component_mut

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

get_contract

Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::HasComponent::get_contract

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

get_contract_mut

Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::HasComponent::get_contract_mut

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

emit

Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::HasComponent::emit

fn emit<
    S,
    impl IntoImp: Into<S, openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::Event>,
>(
    ref self: ComponentState<TContractState>, event: S,
)

InternalTrait

Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::InternalTrait

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

Trait functions

start

Prevents a contract’s function from calling itself or another protected function, directly or indirectly.

Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::InternalTrait::start

fn start(ref self: ComponentState<TContractState>)

end

Removes the reentrant guard.

Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::InternalTrait::end

fn end(ref self: ComponentState<TContractState>)