Keyboard shortcuts

Press or to navigate between chapters

Press ? to show this help

Press Esc to hide this help

openzeppelin_introspection

Fully qualified path: openzeppelin_introspection

Modules

interface
src5

Modules

Modules

interface
src5

interface

Fully qualified path: openzeppelin_introspection::interface

Modules

Constants

Traits


Groups:

dispatchers

Modules

Modules

__external_ISRC5ForwardImpl

Fully qualified path: openzeppelin_introspection::interface::__external_ISRC5ForwardImpl

__l1_handler_ISRC5ForwardImpl

Fully qualified path: openzeppelin_introspection::interface::__l1_handler_ISRC5ForwardImpl

__constructor_ISRC5ForwardImpl

Fully qualified path: openzeppelin_introspection::interface::__constructor_ISRC5ForwardImpl

Constants

Constants

ISRC5_ID

Fully qualified path: openzeppelin_introspection::interface::ISRC5_ID

pub const ISRC5_ID: felt252 =
    1797054754729183305928171726271749999318198861813713898581160688510183841877;

Traits

Traits

ISRC5

Fully qualified path: openzeppelin_introspection::interface::ISRC5

pub trait ISRC5<TState>

Trait functions

supports_interface

Fully qualified path: openzeppelin_introspection::interface::ISRC5::supports_interface

fn supports_interface(self: @TState, interface_id: felt252) -> bool

UnsafeNewContractStateTraitForISRC5ForwardImpl

Fully qualified path: openzeppelin_introspection::interface::UnsafeNewContractStateTraitForISRC5ForwardImpl

pub trait UnsafeNewContractStateTraitForISRC5ForwardImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: openzeppelin_introspection::interface::UnsafeNewContractStateTraitForISRC5ForwardImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

src5

Fully qualified path: openzeppelin_introspection::src5

Modules

Modules

Modules

SRC5Component

SRC5 Component

The SRC5 component allows contracts to expose the interfaces they implement.

Fully qualified path: openzeppelin_introspection::src5::SRC5Component

Modules

Free functions

Structs

Enums

Event

Traits

Modules

Modules

Errors

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::Errors

Constants

Constants

Constants

INVALID_ID

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::Errors::INVALID_ID

pub const INVALID_ID: felt252 = 110753055131073245316502233535479834980;

__external_SRC5Impl

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::__external_SRC5Impl

__l1_handler_SRC5Impl

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::__l1_handler_SRC5Impl

__constructor_SRC5Impl

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::__constructor_SRC5Impl

Free functions

Free functions

unsafe_new_component_state

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::unsafe_new_component_state

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

Structs

Structs

Storage

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::Storage

[storage]
pub struct Storage {
    pub SRC5_supported_interfaces: Map<felt252, bool>,
}

Members

SRC5_supported_interfaces

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::Storage::SRC5_supported_interfaces

pub SRC5_supported_interfaces: Map<felt252, bool>

ComponentState

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::ComponentState

pub struct ComponentState<TContractState> {}

Enums

Enums

Event

Event

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::Event

pub enum Event {}

Traits

Traits

HasComponent

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::HasComponent

pub trait HasComponent<TContractState>

Trait functions

get_component

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::HasComponent::get_component

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

get_component_mut

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::HasComponent::get_component_mut

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

get_contract

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::HasComponent::get_contract

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

get_contract_mut

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::HasComponent::get_contract_mut

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

emit

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::HasComponent::emit

fn emit<S, impl IntoImp: Into<S, openzeppelin_introspection::src5::SRC5Component::Event>>(
    ref self: ComponentState<TContractState>, event: S,
)

InternalTrait

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::InternalTrait

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

Trait functions

register_interface

Registers the given interface as supported by the contract.

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::InternalTrait::register_interface

fn register_interface(ref self: ComponentState<TContractState>, interface_id: felt252)

deregister_interface

Deregisters the given interface as supported by the contract.

Requirements:

  • interface_id is not ISRC5_ID

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::InternalTrait::deregister_interface

fn deregister_interface(ref self: ComponentState<TContractState>, interface_id: felt252)

UnsafeNewContractStateTraitForSRC5Impl

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::UnsafeNewContractStateTraitForSRC5Impl

pub trait UnsafeNewContractStateTraitForSRC5Impl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: openzeppelin_introspection::src5::SRC5Component::UnsafeNewContractStateTraitForSRC5Impl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

dispatchers

Structs

Structs

ISRC5Dispatcher

Fully qualified path: openzeppelin_introspection::interface::ISRC5Dispatcher

Part of the group: dispatchers

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

Members

contract_address

Fully qualified path: openzeppelin_introspection::interface::ISRC5Dispatcher::contract_address

pub contract_address: ContractAddress

ISRC5LibraryDispatcher

Fully qualified path: openzeppelin_introspection::interface::ISRC5LibraryDispatcher

Part of the group: dispatchers

[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISRC5LibraryDispatcher {
    pub class_hash: ClassHash,
}

Members

class_hash

Fully qualified path: openzeppelin_introspection::interface::ISRC5LibraryDispatcher::class_hash

pub class_hash: ClassHash

ISRC5SafeLibraryDispatcher

Fully qualified path: openzeppelin_introspection::interface::ISRC5SafeLibraryDispatcher

Part of the group: dispatchers

[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISRC5SafeLibraryDispatcher {
    pub class_hash: ClassHash,
}

Members

class_hash

Fully qualified path: openzeppelin_introspection::interface::ISRC5SafeLibraryDispatcher::class_hash

pub class_hash: ClassHash

ISRC5SafeDispatcher

Fully qualified path: openzeppelin_introspection::interface::ISRC5SafeDispatcher

Part of the group: dispatchers

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

Members

contract_address

Fully qualified path: openzeppelin_introspection::interface::ISRC5SafeDispatcher::contract_address

pub contract_address: ContractAddress

Traits

Traits

ISRC5DispatcherTrait

Fully qualified path: openzeppelin_introspection::interface::ISRC5DispatcherTrait

Part of the group: dispatchers

pub trait ISRC5DispatcherTrait<T>

Trait functions

supports_interface

Fully qualified path: openzeppelin_introspection::interface::ISRC5DispatcherTrait::supports_interface

fn supports_interface(self: T, interface_id: felt252) -> bool

ISRC5SafeDispatcherTrait

Fully qualified path: openzeppelin_introspection::interface::ISRC5SafeDispatcherTrait

Part of the group: dispatchers

pub trait ISRC5SafeDispatcherTrait<T>

Trait functions

supports_interface

Fully qualified path: openzeppelin_introspection::interface::ISRC5SafeDispatcherTrait::supports_interface

fn supports_interface(self: T, interface_id: felt252) -> Result<bool, Array<felt252>>