openzeppelin
Fully qualified path: openzeppelin
Modules
Re-exports:
Modules
Modules
openzeppelin_access
Fully qualified path: openzeppelin_access
Modules
Modules
Modules
accesscontrol
Fully qualified path: openzeppelin_access::accesscontrol
Modules
Re-exports:
Modules
Modules
accesscontrol
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol
Modules
Modules
Modules
AccessControlComponent
AccessControl Component
The AccessControl component enables role-based access control mechanisms. This is a lightweight implementation that doesn’t support on-chain enumeration of role members, though role membership can be tracked off-chain through contract events.
Roles can be granted and revoked dynamically via grant_role and revoke_role. Each role
has an associated admin role that controls who can grant and revoke it. By default, all roles
use DEFAULT_ADMIN_ROLE as their admin role.
Accounts can also renounce roles they have been granted by using renounce_role.
More complex role hierarchies can be created using set_role_admin.
WARNING: The DEFAULT_ADMIN_ROLE is its own admin, meaning it can grant and revoke itself.
Extra precautions should be taken to secure accounts with this role.
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent
Modules
Constants
Free functions
Structs
| Storage | — |
| RoleGranted | Emitted when account is granted role . sender is the account that originated the contract call, an account with the admin role or the deployer address if _grant_role… |
| RoleGrantedWithDelay | Emitted when account is granted role with a delay. sender is the account that originated the contract call, an account with the admin role or the deployer address if _grant_role_with_delay… |
| RoleRevoked | Emitted when role is revoked for account . sender is the account that originated the contract call:… |
| RoleAdminChanged | Emitted when new_admin_role is set as role ’s admin role, replacing previous_admin_role DEFAULT_ADMIN_ROLE is the starting admin for all roles, despite RoleAdminChanged… |
| ComponentState | — |
Enums
Traits
Modules
Modules
Errors
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::Errors
Constants
Constants
Constants
INVALID_CALLER
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::Errors::INVALID_CALLER
pub const INVALID_CALLER: felt252 =
119051191745757350281208028839101815176267233062108463203342334778046508134;
MISSING_ROLE
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::Errors::MISSING_ROLE
pub const MISSING_ROLE: felt252 = 25210060730641651003830129571497095168425182341590117;
INVALID_DELAY
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::Errors::INVALID_DELAY
pub const INVALID_DELAY: felt252 =
7202958984691914763075227381218870070086808991015795868594737127472;
ALREADY_EFFECTIVE
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::Errors::ALREADY_EFFECTIVE
pub const ALREADY_EFFECTIVE: felt252 = 517454436563142884656566846503664730090624682370817168340581;
__external_AccessControlImpl
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::__external_AccessControlImpl
__l1_handler_AccessControlImpl
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::__l1_handler_AccessControlImpl
__constructor_AccessControlImpl
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::__constructor_AccessControlImpl
__external_AccessControlCamelImpl
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::__external_AccessControlCamelImpl
__l1_handler_AccessControlCamelImpl
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::__l1_handler_AccessControlCamelImpl
__constructor_AccessControlCamelImpl
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::__constructor_AccessControlCamelImpl
__external_AccessControlWithDelayImpl
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::__external_AccessControlWithDelayImpl
__l1_handler_AccessControlWithDelayImpl
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::__l1_handler_AccessControlWithDelayImpl
__constructor_AccessControlWithDelayImpl
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::__constructor_AccessControlWithDelayImpl
__external_AccessControlMixinImpl
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::__external_AccessControlMixinImpl
__l1_handler_AccessControlMixinImpl
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::__l1_handler_AccessControlMixinImpl
__constructor_AccessControlMixinImpl
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::__constructor_AccessControlMixinImpl
Constants
Constants
DEFAULT_ADMIN_ROLE
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::DEFAULT_ADMIN_ROLE
pub const DEFAULT_ADMIN_ROLE: felt252 = 0;
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| RoleGranted | Emitted when account is granted role . sender is the account that originated the contract call, an account with the admin role or the deployer address if _grant_role… |
| RoleGrantedWithDelay | Emitted when account is granted role with a delay. sender is the account that originated the contract call, an account with the admin role or the deployer address if _grant_role_with_delay… |
| RoleRevoked | Emitted when role is revoked for account . sender is the account that originated the contract call:… |
| RoleAdminChanged | Emitted when new_admin_role is set as role ’s admin role, replacing previous_admin_role DEFAULT_ADMIN_ROLE is the starting admin for all roles, despite RoleAdminChanged… |
| ComponentState | — |
Storage
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::Storage
[storage]
pub struct Storage {
pub AccessControl_role_admin: Map<felt252, felt252>,
pub AccessControl_role_member: Map<(felt252, ContractAddress), AccountRoleInfo>,
}
Members
AccessControl_role_admin
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::Storage::AccessControl_role_admin
pub AccessControl_role_admin: Map<felt252, felt252>
AccessControl_role_member
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::Storage::AccessControl_role_member
pub AccessControl_role_member: Map<(felt252, ContractAddress), AccountRoleInfo>
RoleGranted
Emitted when account is granted role.
sender is the account that originated the contract call, an account with the admin role
or the deployer address if _grant_role is called from the constructor.
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::RoleGranted
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct RoleGranted {
pub role: felt252,
pub account: ContractAddress,
pub sender: ContractAddress,
}
Members
role
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::RoleGranted::role
pub role: felt252
account
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::RoleGranted::account
pub account: ContractAddress
sender
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::RoleGranted::sender
pub sender: ContractAddress
RoleGrantedWithDelay
Emitted when account is granted role with a delay.
sender is the account that originated the contract call, an account with the admin role
or the deployer address if _grant_role_with_delay is called from the constructor.
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::RoleGrantedWithDelay
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct RoleGrantedWithDelay {
pub role: felt252,
pub account: ContractAddress,
pub sender: ContractAddress,
pub delay: u64,
}
Members
role
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::RoleGrantedWithDelay::role
pub role: felt252
account
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::RoleGrantedWithDelay::account
pub account: ContractAddress
sender
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::RoleGrantedWithDelay::sender
pub sender: ContractAddress
delay
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::RoleGrantedWithDelay::delay
pub delay: u64
RoleRevoked
Emitted when role is revoked for account.
sender is the account that originated the contract call:
- If using
revoke_role, it is the admin role bearer. - If using
renounce_role, it is the role bearer (i.e.account).
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::RoleRevoked
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct RoleRevoked {
pub role: felt252,
pub account: ContractAddress,
pub sender: ContractAddress,
}
Members
role
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::RoleRevoked::role
pub role: felt252
account
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::RoleRevoked::account
pub account: ContractAddress
sender
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::RoleRevoked::sender
pub sender: ContractAddress
RoleAdminChanged
Emitted when new_admin_role is set as role’s admin role, replacing previous_admin_role
DEFAULT_ADMIN_ROLE is the starting admin for all roles, despite
RoleAdminChanged not being emitted signaling this.
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::RoleAdminChanged
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct RoleAdminChanged {
pub role: felt252,
pub previous_admin_role: felt252,
pub new_admin_role: felt252,
}
Members
role
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::RoleAdminChanged::role
pub role: felt252
previous_admin_role
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::RoleAdminChanged::previous_admin_role
pub previous_admin_role: felt252
new_admin_role
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::RoleAdminChanged::new_admin_role
pub new_admin_role: felt252
ComponentState
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::Event
pub enum Event {
RoleGranted: RoleGranted,
RoleGrantedWithDelay: RoleGrantedWithDelay,
RoleRevoked: RoleRevoked,
RoleAdminChanged: RoleAdminChanged,
}
Variants
RoleGranted
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::Event::RoleGranted
RoleGranted: RoleGranted
RoleGrantedWithDelay
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::Event::RoleGrantedWithDelay
RoleGrantedWithDelay: RoleGrantedWithDelay
RoleRevoked
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::Event::RoleRevoked
RoleRevoked: RoleRevoked
RoleAdminChanged
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::Event::RoleAdminChanged
RoleAdminChanged: RoleAdminChanged
Traits
Traits
HasComponent
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::HasComponent::emit
fn emit<
S,
impl IntoImp: Into<
S, openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::Event,
>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::InternalTrait
pub trait InternalTrait<
TContractState,
+HasComponent<TContractState>,
impl SRC5: HasComponent<TContractState>,
+Drop<TContractState>,
>
Trait functions
initializer
Initializes the contract by registering the IAccessControl interface ID.
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::InternalTrait::initializer
fn initializer(ref self: ComponentState<TContractState>)
assert_only_role
Validates that the caller can act as the given role. Otherwise it panics.
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::InternalTrait::assert_only_role
fn assert_only_role(self: @ComponentState<TContractState>, role: felt252)
is_role_effective
Returns whether the account can act as the given role.
The account can act as the role if it is active and the effective_from time is before
or equal to the current time.
NOTE: If the effective_from timepoint is 0, the role is effective immediately.
This is backwards compatible with implementations that didn’t use delays but
a single boolean flag.
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::InternalTrait::is_role_effective
fn is_role_effective(
self: @ComponentState<TContractState>, role: felt252, account: ContractAddress,
) -> bool
resolve_role_status
Returns the account’s status for the given role.
The possible statuses are:
NotGranted: the role has not been granted to the account.Delayed: The role has been granted to the account but is not yet active due to a time delay.Effective: the role has been granted to the account and is currently active.
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::InternalTrait::resolve_role_status
fn resolve_role_status(
self: @ComponentState<TContractState>, role: felt252, account: ContractAddress,
) -> RoleStatus
is_role_granted
Returns whether the account has the given role granted.
NOTE: The account may not be able to act as the role yet, if a delay was set and has not
passed yet. Use is_role_effective to check if the account can act as the role.
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::InternalTrait::is_role_granted
fn is_role_granted(
self: @ComponentState<TContractState>, role: felt252, account: ContractAddress,
) -> bool
set_role_admin
Sets admin_role as role’s admin role.
Internal function without access restriction.
Emits a RoleAdminChanged event.
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::InternalTrait::set_role_admin
fn set_role_admin(ref self: ComponentState<TContractState>, role: felt252, admin_role: felt252)
_grant_role
Attempts to grant role to account. The function does nothing if role is already
effective for account. If role has been granted to account, but is not yet active
due to a time delay, the delay is removed and role becomes effective immediately.
Internal function without access restriction.
May emit a RoleGranted event.
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::InternalTrait::_grant_role
fn _grant_role(ref self: ComponentState<TContractState>, role: felt252, account: ContractAddress)
_grant_role_with_delay
Attempts to grant role to account with the specified activation delay.
The role will become effective after the given delay has passed. If the role is already
active (Effective) for the account, the function will panic. If the role has been
granted but is not yet active (being in the Delayed state), the existing delay will be
overwritten with the new delay.
Internal function without access restriction.
Requirements:
- delay must be greater than 0.
- the
rolemust not be already effective foraccount.
May emit a RoleGrantedWithDelay event.
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::InternalTrait::_grant_role_with_delay
fn _grant_role_with_delay(
ref self: ComponentState<TContractState>, role: felt252, account: ContractAddress, delay: u64,
)
_revoke_role
Attempts to revoke role from account.
Internal function without access restriction.
May emit a RoleRevoked event.
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::InternalTrait::_revoke_role
fn _revoke_role(ref self: ComponentState<TContractState>, role: felt252, account: ContractAddress)
UnsafeNewContractStateTraitForAccessControlImpl
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::UnsafeNewContractStateTraitForAccessControlImpl
pub trait UnsafeNewContractStateTraitForAccessControlImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::UnsafeNewContractStateTraitForAccessControlImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForAccessControlCamelImpl
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::UnsafeNewContractStateTraitForAccessControlCamelImpl
pub trait UnsafeNewContractStateTraitForAccessControlCamelImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::UnsafeNewContractStateTraitForAccessControlCamelImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForAccessControlWithDelayImpl
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::UnsafeNewContractStateTraitForAccessControlWithDelayImpl
pub trait UnsafeNewContractStateTraitForAccessControlWithDelayImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::UnsafeNewContractStateTraitForAccessControlWithDelayImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForAccessControlMixinImpl
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::UnsafeNewContractStateTraitForAccessControlMixinImpl
pub trait UnsafeNewContractStateTraitForAccessControlMixinImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_access::accesscontrol::accesscontrol::AccessControlComponent::UnsafeNewContractStateTraitForAccessControlMixinImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
account_role_info
Fully qualified path: openzeppelin_access::accesscontrol::account_role_info
Structs
| AccountRoleInfo | Information about whether a role is active for an account or not. |
Structs
Structs
| AccountRoleInfo | Information about whether a role is active for an account or not. |
AccountRoleInfo
Information about whether a role is active for an account or not.
Fully qualified path: openzeppelin_access::accesscontrol::account_role_info::AccountRoleInfo
[derive(Copy, Drop, Serde, PartialEq, Debug)]
pub struct AccountRoleInfo {
pub effective_from: u64,
pub is_granted: bool,
}
Members
effective_from
Fully qualified path: openzeppelin_access::accesscontrol::account_role_info::AccountRoleInfo::effective_from
pub effective_from: u64
is_granted
Fully qualified path: openzeppelin_access::accesscontrol::account_role_info::AccountRoleInfo::is_granted
pub is_granted: bool
extensions
Fully qualified path: openzeppelin_access::accesscontrol::extensions
Modules
Re-exports:
| DefaultConfig | Implementation of the default ERC20Component ImmutableConfig. See https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-107.md#defaultconfig-implementation… |
Modules
Modules
accesscontrol_default_admin_rules
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules
Modules
Impls
| DefaultConfig | Implementation of the default ERC20Component ImmutableConfig. See https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-107.md#defaultconfig-implementation… |
Modules
Modules
AccessControlDefaultAdminRulesComponent
AccessControlDefaultAdminRules Component
Extension of AccessControl that allows specifying special rules to manage
the DEFAULT_ADMIN_ROLE holder, which is a sensitive role with special permissions
over other roles that may potentially have privileged rights in the system.
If a specific role doesn’t have an admin role assigned, the holder of the
DEFAULT_ADMIN_ROLE will have the ability to grant it and revoke it.
This contract implements the following risk mitigations on top of {AccessControl}:
- Only one account holds the
DEFAULT_ADMIN_ROLEsince deployment until it’s potentially renounced. - Enforces a 2-step process to transfer the
DEFAULT_ADMIN_ROLEto another account. - Enforces a configurable delay between the two steps, with the ability to cancel before the transfer is accepted.
- The delay can be changed by scheduling, see
change_default_admin_delay. - It is not possible to use another role to manage the
DEFAULT_ADMIN_ROLE.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent
Modules
Constants
Free functions
Structs
| Storage | — |
| DefaultAdminTransferScheduled | Emitted when a default_admin transfer is started. Sets new_admin as the next address to become the default_admin by calling accept_default_admin_transfer only after accept_schedule `… |
| DefaultAdminTransferCanceled | Emitted when a pending_default_admin is reset if it was never accepted, regardless of its schedule. |
| DefaultAdminDelayChangeScheduled | Emitted when a default_admin_delay change is started. Sets new_delay as the next delay to be applied between default admins transfers after effect_schedule has passed. |
| DefaultAdminDelayChangeCanceled | Emitted when a pending_default_admin_delay is reset if its schedule didn’t pass. |
| ComponentState | — |
Enums
Traits
| ImmutableConfig | Constants expected to be defined at the contract level used to configure the component behavior…. |
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForAccessControlDefaultAdminRulesImpl | — |
| UnsafeNewContractStateTraitForAccessControlImpl | — |
| UnsafeNewContractStateTraitForAccessControlCamelImpl | — |
| UnsafeNewContractStateTraitForAccessControlWithDelayImpl | — |
| UnsafeNewContractStateTraitForAccessControlMixinImpl | — |
Modules
Modules
Errors
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Errors
Constants
| INVALID_CALLER | AccessControl errors |
| MISSING_ROLE | — |
| INVALID_GRANT_ROLE_DELAY | — |
| ALREADY_EFFECTIVE | — |
| INVALID_DEFAULT_ADMIN | DefaultAdminRules extension errors |
| ADMIN_TRANSFER_DELAY_TOO_HIGH | — |
| ONLY_NEW_DEFAULT_ADMIN | — |
| ENFORCED_DEFAULT_ADMIN_RULES | — |
| ENFORCED_DEFAULT_ADMIN_DELAY | — |
Constants
Constants
| INVALID_CALLER | AccessControl errors |
| MISSING_ROLE | — |
| INVALID_GRANT_ROLE_DELAY | — |
| ALREADY_EFFECTIVE | — |
| INVALID_DEFAULT_ADMIN | DefaultAdminRules extension errors |
| ADMIN_TRANSFER_DELAY_TOO_HIGH | — |
| ONLY_NEW_DEFAULT_ADMIN | — |
| ENFORCED_DEFAULT_ADMIN_RULES | — |
| ENFORCED_DEFAULT_ADMIN_DELAY | — |
INVALID_CALLER
AccessControl errors
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Errors::INVALID_CALLER
pub const INVALID_CALLER: felt252 =
119051191745757350281208028839101815176267233062108463203342334778046508134;
MISSING_ROLE
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Errors::MISSING_ROLE
pub const MISSING_ROLE: felt252 = 25210060730641651003830129571497095168425182341590117;
INVALID_GRANT_ROLE_DELAY
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Errors::INVALID_GRANT_ROLE_DELAY
pub const INVALID_GRANT_ROLE_DELAY: felt252 =
7202958984691914763075227381218870070086808991015795868594737127472;
ALREADY_EFFECTIVE
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Errors::ALREADY_EFFECTIVE
pub const ALREADY_EFFECTIVE: felt252 = 517454436563142884656566846503664730090624682370817168340581;
INVALID_DEFAULT_ADMIN
DefaultAdminRules extension errors
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Errors::INVALID_DEFAULT_ADMIN
pub const INVALID_DEFAULT_ADMIN: felt252 = 107320248484662281824505193580524149612429867575662;
ADMIN_TRANSFER_DELAY_TOO_HIGH
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Errors::ADMIN_TRANSFER_DELAY_TOO_HIGH
pub const ADMIN_TRANSFER_DELAY_TOO_HIGH: felt252 =
1762972771950605937378764940229157014459606997690752055041091223250792;
ONLY_NEW_DEFAULT_ADMIN
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Errors::ONLY_NEW_DEFAULT_ADMIN
pub const ONLY_NEW_DEFAULT_ADMIN: felt252 =
548214979085969159257434433750054553192310537025363096826600515677152612;
ENFORCED_DEFAULT_ADMIN_RULES
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Errors::ENFORCED_DEFAULT_ADMIN_RULES
pub const ENFORCED_DEFAULT_ADMIN_RULES: felt252 =
7202949342972851343017453202681816323330072953697918535706869982564;
ENFORCED_DEFAULT_ADMIN_DELAY
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Errors::ENFORCED_DEFAULT_ADMIN_DELAY
pub const ENFORCED_DEFAULT_ADMIN_DELAY: felt252 =
7202949342972851343017453202681816038108683094977223637649821230436;
__external_AccessControlDefaultAdminRulesImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::__external_AccessControlDefaultAdminRulesImpl
__l1_handler_AccessControlDefaultAdminRulesImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::__l1_handler_AccessControlDefaultAdminRulesImpl
__constructor_AccessControlDefaultAdminRulesImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::__constructor_AccessControlDefaultAdminRulesImpl
__external_AccessControlImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::__external_AccessControlImpl
__l1_handler_AccessControlImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::__l1_handler_AccessControlImpl
__constructor_AccessControlImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::__constructor_AccessControlImpl
__external_AccessControlCamelImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::__external_AccessControlCamelImpl
__l1_handler_AccessControlCamelImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::__l1_handler_AccessControlCamelImpl
__constructor_AccessControlCamelImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::__constructor_AccessControlCamelImpl
__external_AccessControlWithDelayImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::__external_AccessControlWithDelayImpl
__l1_handler_AccessControlWithDelayImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::__l1_handler_AccessControlWithDelayImpl
__constructor_AccessControlWithDelayImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::__constructor_AccessControlWithDelayImpl
__external_AccessControlMixinImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::__external_AccessControlMixinImpl
__l1_handler_AccessControlMixinImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::__l1_handler_AccessControlMixinImpl
__constructor_AccessControlMixinImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::__constructor_AccessControlMixinImpl
Constants
Constants
DEFAULT_ADMIN_ROLE
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::DEFAULT_ADMIN_ROLE
pub const DEFAULT_ADMIN_ROLE: felt252 = 0;
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| DefaultAdminTransferScheduled | Emitted when a default_admin transfer is started. Sets new_admin as the next address to become the default_admin by calling accept_default_admin_transfer only after accept_schedule `… |
| DefaultAdminTransferCanceled | Emitted when a pending_default_admin is reset if it was never accepted, regardless of its schedule. |
| DefaultAdminDelayChangeScheduled | Emitted when a default_admin_delay change is started. Sets new_delay as the next delay to be applied between default admins transfers after effect_schedule has passed. |
| DefaultAdminDelayChangeCanceled | Emitted when a pending_default_admin_delay is reset if its schedule didn’t pass. |
| ComponentState | — |
Storage
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Storage
[storage]
pub struct Storage {
pub AccessControl_role_admin: Map<felt252, felt252>,
pub AccessControl_role_member: Map<(felt252, ContractAddress), AccountRoleInfo>,
pub AccessControl_pending_default_admin: ContractAddress,
pub AccessControl_pending_default_admin_schedule: u64,
pub AccessControl_current_delay: u64,
pub AccessControl_current_default_admin: ContractAddress,
pub AccessControl_pending_delay: PendingDelay,
}
Members
AccessControl_role_admin
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Storage::AccessControl_role_admin
pub AccessControl_role_admin: Map<felt252, felt252>
AccessControl_role_member
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Storage::AccessControl_role_member
pub AccessControl_role_member: Map<(felt252, ContractAddress), AccountRoleInfo>
AccessControl_pending_default_admin
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Storage::AccessControl_pending_default_admin
pub AccessControl_pending_default_admin: ContractAddress
AccessControl_pending_default_admin_schedule
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Storage::AccessControl_pending_default_admin_schedule
pub AccessControl_pending_default_admin_schedule: u64
AccessControl_current_delay
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Storage::AccessControl_current_delay
pub AccessControl_current_delay: u64
AccessControl_current_default_admin
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Storage::AccessControl_current_default_admin
pub AccessControl_current_default_admin: ContractAddress
AccessControl_pending_delay
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Storage::AccessControl_pending_delay
pub AccessControl_pending_delay: PendingDelay
DefaultAdminTransferScheduled
Emitted when a default_admin transfer is started.
Sets new_admin as the next address to become the default_admin by calling
accept_default_admin_transfer only after accept_schedule` passes.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::DefaultAdminTransferScheduled
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct DefaultAdminTransferScheduled {
pub new_admin: ContractAddress,
pub accept_schedule: u64,
}
Members
new_admin
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::DefaultAdminTransferScheduled::new_admin
pub new_admin: ContractAddress
accept_schedule
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::DefaultAdminTransferScheduled::accept_schedule
pub accept_schedule: u64
DefaultAdminTransferCanceled
Emitted when a pending_default_admin is reset if it was never
accepted, regardless of its schedule.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::DefaultAdminTransferCanceled
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct DefaultAdminTransferCanceled {}
DefaultAdminDelayChangeScheduled
Emitted when a default_admin_delay change is started.
Sets new_delay as the next delay to be applied between default admins transfers
after effect_schedule has passed.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::DefaultAdminDelayChangeScheduled
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct DefaultAdminDelayChangeScheduled {
pub new_delay: u64,
pub effect_schedule: u64,
}
Members
new_delay
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::DefaultAdminDelayChangeScheduled::new_delay
pub new_delay: u64
effect_schedule
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::DefaultAdminDelayChangeScheduled::effect_schedule
pub effect_schedule: u64
DefaultAdminDelayChangeCanceled
Emitted when a pending_default_admin_delay is reset if its schedule didn’t pass.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::DefaultAdminDelayChangeCanceled
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct DefaultAdminDelayChangeCanceled {}
ComponentState
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Event
pub enum Event {
RoleGranted: RoleGranted,
RoleGrantedWithDelay: RoleGrantedWithDelay,
RoleRevoked: RoleRevoked,
RoleAdminChanged: RoleAdminChanged,
DefaultAdminTransferScheduled: DefaultAdminTransferScheduled,
DefaultAdminTransferCanceled: DefaultAdminTransferCanceled,
DefaultAdminDelayChangeScheduled: DefaultAdminDelayChangeScheduled,
DefaultAdminDelayChangeCanceled: DefaultAdminDelayChangeCanceled,
}
Variants
RoleGranted
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Event::RoleGranted
RoleGranted: RoleGranted
RoleGrantedWithDelay
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Event::RoleGrantedWithDelay
RoleGrantedWithDelay: RoleGrantedWithDelay
RoleRevoked
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Event::RoleRevoked
RoleRevoked: RoleRevoked
RoleAdminChanged
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Event::RoleAdminChanged
RoleAdminChanged: RoleAdminChanged
DefaultAdminTransferScheduled
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Event::DefaultAdminTransferScheduled
DefaultAdminTransferScheduled: DefaultAdminTransferScheduled
DefaultAdminTransferCanceled
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Event::DefaultAdminTransferCanceled
DefaultAdminTransferCanceled: DefaultAdminTransferCanceled
DefaultAdminDelayChangeScheduled
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Event::DefaultAdminDelayChangeScheduled
DefaultAdminDelayChangeScheduled: DefaultAdminDelayChangeScheduled
DefaultAdminDelayChangeCanceled
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Event::DefaultAdminDelayChangeCanceled
DefaultAdminDelayChangeCanceled: DefaultAdminDelayChangeCanceled
Traits
Traits
| ImmutableConfig | Constants expected to be defined at the contract level used to configure the component behavior…. |
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForAccessControlDefaultAdminRulesImpl | — |
| UnsafeNewContractStateTraitForAccessControlImpl | — |
| UnsafeNewContractStateTraitForAccessControlCamelImpl | — |
| UnsafeNewContractStateTraitForAccessControlWithDelayImpl | — |
| UnsafeNewContractStateTraitForAccessControlMixinImpl | — |
ImmutableConfig
Constants expected to be defined at the contract level used to configure the component behavior.
DEFAULT_ADMIN_DELAY_INCREASE_WAIT: Returns the maximum number of seconds to wait for a delay increase.MAXIMUM_DEFAULT_ADMIN_TRANSFER_DELAY: Returns the maximum number of seconds for a transfer delay.
IMPORTANT:
When overriding DEFAULT_ADMIN_DELAY_INCREASE_WAIT, choose a value that provides a safe
buffer.
If set too low, a mistakenly high new delay (e.g., entering milliseconds instead of seconds)
could be activated almost instantly, leaving no opportunity for manual correction.
The maximum time you have to recover from an accidental delay increase is controlled by
MAXIMUM_DEFAULT_ADMIN_TRANSFER_DELAY. See the delay_change_wait function for details on
how these constants interact.
If MAXIMUM_DEFAULT_ADMIN_TRANSFER_DELAY is set too high, you might be unable to recover
from an accidental increase for an extended period. Too low, and it unnecessarily restricts
how much security delay you can impose for admin transfers. As a best practice, consider
setting it in the 30-60 day range for a good balance between security and recoverability.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::ImmutableConfig
pub trait ImmutableConfig
Trait constants
DEFAULT_ADMIN_DELAY_INCREASE_WAIT
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::ImmutableConfig::DEFAULT_ADMIN_DELAY_INCREASE_WAIT
const DEFAULT_ADMIN_DELAY_INCREASE_WAIT: u64;
MAXIMUM_DEFAULT_ADMIN_TRANSFER_DELAY
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::ImmutableConfig::MAXIMUM_DEFAULT_ADMIN_TRANSFER_DELAY
const MAXIMUM_DEFAULT_ADMIN_TRANSFER_DELAY: u64;
HasComponent
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::HasComponent::emit
fn emit<
S,
impl IntoImp: Into<
S,
openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::Event,
>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::InternalTrait
pub trait InternalTrait<
TContractState,
+HasComponent<TContractState>,
impl Immutable: ImmutableConfig,
impl SRC5: HasComponent<TContractState>,
+Drop<TContractState>,
>
Trait functions
initializer
Initializes the contract by registering the IAccessControl interface ID and setting the initial delay and default admin.
Requirements:
- initial_default_admin must not be the zero address.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::InternalTrait::initializer
fn initializer(
ref self: ComponentState<TContractState>,
initial_admin_transfer_delay: u64,
initial_default_admin: ContractAddress,
)
assert_only_role
Validates that the caller can act as the given role. Otherwise it panics.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::InternalTrait::assert_only_role
fn assert_only_role(self: @ComponentState<TContractState>, role: felt252)
is_role_effective
Returns whether the account can act as the given role.
The account can act as the role if it is active and the effective_from time is before
or equal to the current time.
NOTE: If the effective_from timepoint is 0, the role is effective immediately.
This is backwards compatible with implementations that didn’t use delays but
a single boolean flag.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::InternalTrait::is_role_effective
fn is_role_effective(
self: @ComponentState<TContractState>, role: felt252, account: ContractAddress,
) -> bool
resolve_role_status
Returns the account’s status for the given role.
The possible statuses are:
NotGranted: the role has not been granted to the account.Delayed: The role has been granted to the account but is not yet active due to a time delay.Effective: the role has been granted to the account and is currently active.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::InternalTrait::resolve_role_status
fn resolve_role_status(
self: @ComponentState<TContractState>, role: felt252, account: ContractAddress,
) -> RoleStatus
is_role_granted
Returns whether the account has the given role granted.
NOTE: The account may not be able to act as the role yet, if a delay was set and has not
passed yet. Use is_role_effective to check if the account can act as the role.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::InternalTrait::is_role_granted
fn is_role_granted(
self: @ComponentState<TContractState>, role: felt252, account: ContractAddress,
) -> bool
set_role_admin
Sets admin_role as role’s admin role.
Internal function without access restriction.
Requirements:
rolemust not beDEFAULT_ADMIN_ROLE.
Emits a RoleAdminChanged event.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::InternalTrait::set_role_admin
fn set_role_admin(ref self: ComponentState<TContractState>, role: felt252, admin_role: felt252)
_grant_role
Attempts to grant role to account. The function does nothing if role is already
effective for account. If role has been granted to account, but is not yet active
due to a time delay, the delay is removed and role becomes effective immediately.
Internal function without access restriction.
For DEFAULT_ADMIN_ROLE, it only allows granting if there isn’t already a
default_admin
or if the role has been previously renounced.
NOTE: Exposing this function through another mechanism may make the DEFAULT_ADMIN_ROLE
assignable again. Make sure to guarantee this is the expected behavior in your
implementation.
May emit a RoleGranted event.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::InternalTrait::_grant_role
fn _grant_role(ref self: ComponentState<TContractState>, role: felt252, account: ContractAddress)
_grant_role_with_delay
Attempts to grant role to account with the specified activation delay.
The role will become effective after the given delay has passed. If the role is already
active (Effective) for the account, the function will panic. If the role has been
granted but is not yet active (being in the Delayed state), the existing delay will be
overwritten with the new delay.
Internal function without access restriction.
Requirements:
- delay must be greater than 0.
- the
rolemust not be already effective foraccount. rolemust not beDEFAULT_ADMIN_ROLE.
May emit a RoleGrantedWithDelay event.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::InternalTrait::_grant_role_with_delay
fn _grant_role_with_delay(
ref self: ComponentState<TContractState>, role: felt252, account: ContractAddress, delay: u64,
)
_revoke_role
Attempts to revoke role from account.
Internal function without access restriction.
May emit a RoleRevoked event.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::InternalTrait::_revoke_role
fn _revoke_role(ref self: ComponentState<TContractState>, role: felt252, account: ContractAddress)
set_pending_default_admin
Setter of the tuple for pending admin and its schedule.
May emit a DefaultAdminTransferCanceled event.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::InternalTrait::set_pending_default_admin
fn set_pending_default_admin(
ref self: ComponentState<TContractState>, new_admin: ContractAddress, new_schedule: u64,
)
set_pending_delay
Setter of the tuple for pending delay and its schedule.
May emit a DefaultAdminDelayChangeCanceled event.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::InternalTrait::set_pending_delay
fn set_pending_delay(ref self: ComponentState<TContractState>, new_delay: u64, new_schedule: u64)
delay_change_wait
Returns the amount of seconds to wait after the new_delay will
become the new default_admin_delay.
The value returned guarantees that if the delay is reduced, it will go into effect after a wait that honors the previously set delay.
See default_admin_delay_increase_wait.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::InternalTrait::delay_change_wait
fn delay_change_wait(self: @ComponentState<TContractState>, new_delay: u64) -> u64
UnsafeNewContractStateTraitForAccessControlDefaultAdminRulesImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::UnsafeNewContractStateTraitForAccessControlDefaultAdminRulesImpl
pub trait UnsafeNewContractStateTraitForAccessControlDefaultAdminRulesImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::UnsafeNewContractStateTraitForAccessControlDefaultAdminRulesImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForAccessControlImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::UnsafeNewContractStateTraitForAccessControlImpl
pub trait UnsafeNewContractStateTraitForAccessControlImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::UnsafeNewContractStateTraitForAccessControlImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForAccessControlCamelImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::UnsafeNewContractStateTraitForAccessControlCamelImpl
pub trait UnsafeNewContractStateTraitForAccessControlCamelImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::UnsafeNewContractStateTraitForAccessControlCamelImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForAccessControlWithDelayImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::UnsafeNewContractStateTraitForAccessControlWithDelayImpl
pub trait UnsafeNewContractStateTraitForAccessControlWithDelayImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::UnsafeNewContractStateTraitForAccessControlWithDelayImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForAccessControlMixinImpl
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::UnsafeNewContractStateTraitForAccessControlMixinImpl
pub trait UnsafeNewContractStateTraitForAccessControlMixinImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesComponent::UnsafeNewContractStateTraitForAccessControlMixinImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
Impls
Impls
| DefaultConfig | Implementation of the default ERC20Component ImmutableConfig. See https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-107.md#defaultconfig-implementation… |
DefaultConfig
Implementation of the default ERC20Component ImmutableConfig.
See https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-107.md#defaultconfig-implementation
The default delay increase wait is set to 5 days. The maximum transfer delay is set to 30 days.
NOTE: You cannot set a transfer delay to a value greater than this
MAXIMUM_DEFAULT_ADMIN_TRANSFER_DELAY.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::DefaultConfig
pub impl DefaultConfig of ImmutableConfig;
Impl constants
DEFAULT_ADMIN_DELAY_INCREASE_WAIT
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::DefaultConfig::DEFAULT_ADMIN_DELAY_INCREASE_WAIT
const DEFAULT_ADMIN_DELAY_INCREASE_WAIT: u64 = 5 * 24 * 60 * 60;
MAXIMUM_DEFAULT_ADMIN_TRANSFER_DELAY
Fully qualified path: openzeppelin_access::accesscontrol::extensions::accesscontrol_default_admin_rules::DefaultConfig::MAXIMUM_DEFAULT_ADMIN_TRANSFER_DELAY
const MAXIMUM_DEFAULT_ADMIN_TRANSFER_DELAY: u64 = 30 * 24 * 60 * 60;
pending_delay
Fully qualified path: openzeppelin_access::accesscontrol::extensions::pending_delay
Structs
| PendingDelay | Information about a scheduledpending delay. |
Structs
Structs
| PendingDelay | Information about a scheduledpending delay. |
PendingDelay
Information about a scheduledpending delay.
Fully qualified path: openzeppelin_access::accesscontrol::extensions::pending_delay::PendingDelay
[derive(Copy, Drop, Serde, PartialEq, Debug)]
pub struct PendingDelay {
pub delay: u64,
pub schedule: u64,
}
Members
delay
Fully qualified path: openzeppelin_access::accesscontrol::extensions::pending_delay::PendingDelay::delay
pub delay: u64
schedule
Fully qualified path: openzeppelin_access::accesscontrol::extensions::pending_delay::PendingDelay::schedule
pub schedule: u64
ownable
Fully qualified path: openzeppelin_access::ownable
Modules
Re-exports:
Modules
Modules
ownable
Fully qualified path: openzeppelin_access::ownable::ownable
Modules
Modules
Modules
OwnableComponent
Ownable Component
The Ownable component provides a basic access control mechanism, where there is an account (an owner) that can be granted exclusive access to specific functions.
The initial owner can be set by using the initializer function in
construction time. This can later be changed with transfer_ownership.
The component also offers functionality for a two-step ownership transfer where the new owner first has to accept their ownership to finalize the transfer.
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent
Modules
Free functions
Structs
| Storage | — |
| OwnershipTransferred | Emitted when new_owner is set as owner of the contract. new_owner can be set to zero only if the ownership is renounced. |
| OwnershipTransferStarted | Emitted when transfer_ownership is called on a contract that implements IOwnableTwoStep . previous_owner is the address of the current owner. new_owner is the address of the pending owner. |
| ComponentState | — |
Enums
Traits
Modules
Modules
Errors
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::Errors
Constants
Constants
Constants
NOT_OWNER
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::Errors::NOT_OWNER
pub const NOT_OWNER: felt252 = 6453775547044262656980513251389146108192067417835201906;
NOT_PENDING_OWNER
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::Errors::NOT_PENDING_OWNER
pub const NOT_PENDING_OWNER: felt252 =
119051145825490371705017055488349666845855619325153144982018027625445746034;
ZERO_ADDRESS_OWNER
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::Errors::ZERO_ADDRESS_OWNER
pub const ZERO_ADDRESS_OWNER: felt252 =
2113561387378558640007916056212955719375468717479393106901732231050099;
__external_OwnableImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__external_OwnableImpl
__l1_handler_OwnableImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__l1_handler_OwnableImpl
__constructor_OwnableImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__constructor_OwnableImpl
__external_OwnableTwoStepImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__external_OwnableTwoStepImpl
__l1_handler_OwnableTwoStepImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__l1_handler_OwnableTwoStepImpl
__constructor_OwnableTwoStepImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__constructor_OwnableTwoStepImpl
__external_OwnableCamelOnlyImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__external_OwnableCamelOnlyImpl
__l1_handler_OwnableCamelOnlyImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__l1_handler_OwnableCamelOnlyImpl
__constructor_OwnableCamelOnlyImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__constructor_OwnableCamelOnlyImpl
__external_OwnableTwoStepCamelOnlyImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__external_OwnableTwoStepCamelOnlyImpl
__l1_handler_OwnableTwoStepCamelOnlyImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__l1_handler_OwnableTwoStepCamelOnlyImpl
__constructor_OwnableTwoStepCamelOnlyImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__constructor_OwnableTwoStepCamelOnlyImpl
__external_OwnableMixinImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__external_OwnableMixinImpl
__l1_handler_OwnableMixinImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__l1_handler_OwnableMixinImpl
__constructor_OwnableMixinImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__constructor_OwnableMixinImpl
__external_OwnableTwoStepMixinImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__external_OwnableTwoStepMixinImpl
__l1_handler_OwnableTwoStepMixinImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__l1_handler_OwnableTwoStepMixinImpl
__constructor_OwnableTwoStepMixinImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::__constructor_OwnableTwoStepMixinImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| OwnershipTransferred | Emitted when new_owner is set as owner of the contract. new_owner can be set to zero only if the ownership is renounced. |
| OwnershipTransferStarted | Emitted when transfer_ownership is called on a contract that implements IOwnableTwoStep . previous_owner is the address of the current owner. new_owner is the address of the pending owner. |
| ComponentState | — |
Storage
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::Storage
[storage]
pub struct Storage {
pub Ownable_owner: ContractAddress,
pub Ownable_pending_owner: ContractAddress,
}
Members
Ownable_owner
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::Storage::Ownable_owner
pub Ownable_owner: ContractAddress
Ownable_pending_owner
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::Storage::Ownable_pending_owner
pub Ownable_pending_owner: ContractAddress
OwnershipTransferred
Emitted when new_owner is set as owner of the contract.
new_owner can be set to zero only if the ownership is renounced.
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::OwnershipTransferred
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct OwnershipTransferred {
pub previous_owner: ContractAddress,
pub new_owner: ContractAddress,
}
Members
previous_owner
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::OwnershipTransferred::previous_owner
pub previous_owner: ContractAddress
new_owner
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::OwnershipTransferred::new_owner
pub new_owner: ContractAddress
OwnershipTransferStarted
Emitted when transfer_ownership is called on a contract that implements IOwnableTwoStep.
previous_owner is the address of the current owner.
new_owner is the address of the pending owner.
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::OwnershipTransferStarted
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct OwnershipTransferStarted {
pub previous_owner: ContractAddress,
pub new_owner: ContractAddress,
}
Members
previous_owner
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::OwnershipTransferStarted::previous_owner
pub previous_owner: ContractAddress
new_owner
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::OwnershipTransferStarted::new_owner
pub new_owner: ContractAddress
ComponentState
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::Event
pub enum Event {
OwnershipTransferred: OwnershipTransferred,
OwnershipTransferStarted: OwnershipTransferStarted,
}
Variants
OwnershipTransferred
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::Event::OwnershipTransferred
OwnershipTransferred: OwnershipTransferred
OwnershipTransferStarted
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::Event::OwnershipTransferStarted
OwnershipTransferStarted: OwnershipTransferStarted
Traits
Traits
HasComponent
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::HasComponent::emit
fn emit<S, impl IntoImp: Into<S, openzeppelin_access::ownable::ownable::OwnableComponent::Event>>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::InternalTrait
pub trait InternalTrait<TContractState, +HasComponent<TContractState>>
Trait functions
initializer
Sets the contract’s initial owner.
Requirements:
owneris not the zero address.
This function should be called at construction time.
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::InternalTrait::initializer
fn initializer(ref self: ComponentState<TContractState>, owner: ContractAddress)
assert_only_owner
Panics if called by any account other than the owner. Use this to restrict access to certain functions to the owner.
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::InternalTrait::assert_only_owner
fn assert_only_owner(self: @ComponentState<TContractState>)
_transfer_ownership
Transfers ownership of the contract to a new address and resets the pending owner to the zero address.
Internal function without access restriction.
Emits an OwnershipTransferred event.
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::InternalTrait::_transfer_ownership
fn _transfer_ownership(ref self: ComponentState<TContractState>, new_owner: ContractAddress)
_propose_owner
Sets a new pending owner.
Internal function without access restriction.
Emits an OwnershipTransferStarted event.
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::InternalTrait::_propose_owner
fn _propose_owner(ref self: ComponentState<TContractState>, new_owner: ContractAddress)
UnsafeNewContractStateTraitForOwnableImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::UnsafeNewContractStateTraitForOwnableImpl
pub trait UnsafeNewContractStateTraitForOwnableImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::UnsafeNewContractStateTraitForOwnableImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForOwnableTwoStepImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::UnsafeNewContractStateTraitForOwnableTwoStepImpl
pub trait UnsafeNewContractStateTraitForOwnableTwoStepImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::UnsafeNewContractStateTraitForOwnableTwoStepImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForOwnableCamelOnlyImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::UnsafeNewContractStateTraitForOwnableCamelOnlyImpl
pub trait UnsafeNewContractStateTraitForOwnableCamelOnlyImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::UnsafeNewContractStateTraitForOwnableCamelOnlyImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForOwnableTwoStepCamelOnlyImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::UnsafeNewContractStateTraitForOwnableTwoStepCamelOnlyImpl
pub trait UnsafeNewContractStateTraitForOwnableTwoStepCamelOnlyImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::UnsafeNewContractStateTraitForOwnableTwoStepCamelOnlyImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForOwnableMixinImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::UnsafeNewContractStateTraitForOwnableMixinImpl
pub trait UnsafeNewContractStateTraitForOwnableMixinImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::UnsafeNewContractStateTraitForOwnableMixinImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForOwnableTwoStepMixinImpl
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::UnsafeNewContractStateTraitForOwnableTwoStepMixinImpl
pub trait UnsafeNewContractStateTraitForOwnableTwoStepMixinImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_access::ownable::ownable::OwnableComponent::UnsafeNewContractStateTraitForOwnableTwoStepMixinImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
openzeppelin_account
Fully qualified path: openzeppelin_account
Modules
Re-exports:
Modules
Modules
account
Fully qualified path: openzeppelin_account::account
Modules
Modules
Modules
AccountComponent
Account Component
The Account component enables contracts to behave as accounts.
Fully qualified path: openzeppelin_account::account::AccountComponent
Modules
Free functions
Structs
Enums
Traits
Modules
Modules
Errors
Fully qualified path: openzeppelin_account::account::AccountComponent::Errors
Constants
Constants
Constants
INVALID_CALLER
Fully qualified path: openzeppelin_account::account::AccountComponent::Errors::INVALID_CALLER
pub const INVALID_CALLER: felt252 = 6262948757243068301173483364169975331325598907448976754;
INVALID_SIGNATURE
Fully qualified path: openzeppelin_account::account::AccountComponent::Errors::INVALID_SIGNATURE
pub const INVALID_SIGNATURE: felt252 =
105074844097198521391540583873086336848321434922596230638170725;
INVALID_TX_VERSION
Fully qualified path: openzeppelin_account::account::AccountComponent::Errors::INVALID_TX_VERSION
pub const INVALID_TX_VERSION: felt252 =
26899160088882821476234389471510102233170292334138446031203430254;
UNAUTHORIZED
Fully qualified path: openzeppelin_account::account::AccountComponent::Errors::UNAUTHORIZED
pub const UNAUTHORIZED: felt252 = 95565013996018498247890117593540195050286445389156;
__external_SRC6Impl
Fully qualified path: openzeppelin_account::account::AccountComponent::__external_SRC6Impl
__l1_handler_SRC6Impl
Fully qualified path: openzeppelin_account::account::AccountComponent::__l1_handler_SRC6Impl
__constructor_SRC6Impl
Fully qualified path: openzeppelin_account::account::AccountComponent::__constructor_SRC6Impl
__external_DeclarerImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__external_DeclarerImpl
__l1_handler_DeclarerImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__l1_handler_DeclarerImpl
__constructor_DeclarerImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__constructor_DeclarerImpl
__external_DeployableImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__external_DeployableImpl
__l1_handler_DeployableImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__l1_handler_DeployableImpl
__constructor_DeployableImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__constructor_DeployableImpl
__external_PublicKeyImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__external_PublicKeyImpl
__l1_handler_PublicKeyImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__l1_handler_PublicKeyImpl
__constructor_PublicKeyImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__constructor_PublicKeyImpl
__external_SRC6CamelOnlyImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__external_SRC6CamelOnlyImpl
__l1_handler_SRC6CamelOnlyImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__l1_handler_SRC6CamelOnlyImpl
__constructor_SRC6CamelOnlyImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__constructor_SRC6CamelOnlyImpl
__external_PublicKeyCamelImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__external_PublicKeyCamelImpl
__l1_handler_PublicKeyCamelImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__l1_handler_PublicKeyCamelImpl
__constructor_PublicKeyCamelImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__constructor_PublicKeyCamelImpl
__external_AccountMixinImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__external_AccountMixinImpl
__l1_handler_AccountMixinImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__l1_handler_AccountMixinImpl
__constructor_AccountMixinImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::__constructor_AccountMixinImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_account::account::AccountComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
Storage
Fully qualified path: openzeppelin_account::account::AccountComponent::Storage
[storage]
pub struct Storage {
pub Account_public_key: felt252,
}
Members
Account_public_key
Fully qualified path: openzeppelin_account::account::AccountComponent::Storage::Account_public_key
pub Account_public_key: felt252
OwnerAdded
Fully qualified path: openzeppelin_account::account::AccountComponent::OwnerAdded
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct OwnerAdded {
pub new_owner_guid: felt252,
}
Members
new_owner_guid
Fully qualified path: openzeppelin_account::account::AccountComponent::OwnerAdded::new_owner_guid
pub new_owner_guid: felt252
OwnerRemoved
Fully qualified path: openzeppelin_account::account::AccountComponent::OwnerRemoved
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct OwnerRemoved {
pub removed_owner_guid: felt252,
}
Members
removed_owner_guid
Fully qualified path: openzeppelin_account::account::AccountComponent::OwnerRemoved::removed_owner_guid
pub removed_owner_guid: felt252
ComponentState
Fully qualified path: openzeppelin_account::account::AccountComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_account::account::AccountComponent::Event
pub enum Event {
OwnerAdded: OwnerAdded,
OwnerRemoved: OwnerRemoved,
}
Variants
OwnerAdded
Fully qualified path: openzeppelin_account::account::AccountComponent::Event::OwnerAdded
OwnerAdded: OwnerAdded
OwnerRemoved
Fully qualified path: openzeppelin_account::account::AccountComponent::Event::OwnerRemoved
OwnerRemoved: OwnerRemoved
Traits
Traits
HasComponent
Fully qualified path: openzeppelin_account::account::AccountComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_account::account::AccountComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_account::account::AccountComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_account::account::AccountComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_account::account::AccountComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_account::account::AccountComponent::HasComponent::emit
fn emit<S, impl IntoImp: Into<S, openzeppelin_account::account::AccountComponent::Event>>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_account::account::AccountComponent::InternalTrait
pub trait InternalTrait<
TContractState,
+HasComponent<TContractState>,
impl SRC5: HasComponent<TContractState>,
+Drop<TContractState>,
>
Trait functions
initializer
Initializes the account with the given public key, and registers the ISRC6 interface ID.
Emits an OwnerAdded event.
Fully qualified path: openzeppelin_account::account::AccountComponent::InternalTrait::initializer
fn initializer(ref self: ComponentState<TContractState>, public_key: felt252)
assert_only_self
Validates that the caller is the account itself. Otherwise it reverts.
Fully qualified path: openzeppelin_account::account::AccountComponent::InternalTrait::assert_only_self
fn assert_only_self(self: @ComponentState<TContractState>)
assert_valid_new_owner
Validates that new_owner accepted the ownership of the contract.
WARNING: This function assumes that current_owner is the current owner of the
contract, and does not validate this assumption.
Requirements:
- The signature must be valid for the new owner.
Fully qualified path: openzeppelin_account::account::AccountComponent::InternalTrait::assert_valid_new_owner
fn assert_valid_new_owner(
self: @ComponentState<TContractState>,
current_owner: felt252,
new_owner: felt252,
signature: Span<felt252>,
)
validate_transaction
Validates the signature for the current transaction.
Returns the short string VALID if valid, otherwise it reverts.
Fully qualified path: openzeppelin_account::account::AccountComponent::InternalTrait::validate_transaction
fn validate_transaction(self: @ComponentState<TContractState>) -> felt252
_set_public_key
Sets the public key without validating the caller.
The usage of this method outside the set_public_key function is discouraged.
Emits an OwnerAdded event.
Fully qualified path: openzeppelin_account::account::AccountComponent::InternalTrait::_set_public_key
fn _set_public_key(ref self: ComponentState<TContractState>, new_public_key: felt252)
_is_valid_signature
Returns whether the given signature is valid for the given hash using the account’s current public key.
Fully qualified path: openzeppelin_account::account::AccountComponent::InternalTrait::_is_valid_signature
fn _is_valid_signature(
self: @ComponentState<TContractState>, hash: felt252, signature: Span<felt252>,
) -> bool
UnsafeNewContractStateTraitForSRC6Impl
Fully qualified path: openzeppelin_account::account::AccountComponent::UnsafeNewContractStateTraitForSRC6Impl
pub trait UnsafeNewContractStateTraitForSRC6Impl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_account::account::AccountComponent::UnsafeNewContractStateTraitForSRC6Impl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForDeclarerImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::UnsafeNewContractStateTraitForDeclarerImpl
pub trait UnsafeNewContractStateTraitForDeclarerImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_account::account::AccountComponent::UnsafeNewContractStateTraitForDeclarerImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForDeployableImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::UnsafeNewContractStateTraitForDeployableImpl
pub trait UnsafeNewContractStateTraitForDeployableImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_account::account::AccountComponent::UnsafeNewContractStateTraitForDeployableImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForPublicKeyImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::UnsafeNewContractStateTraitForPublicKeyImpl
pub trait UnsafeNewContractStateTraitForPublicKeyImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_account::account::AccountComponent::UnsafeNewContractStateTraitForPublicKeyImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForSRC6CamelOnlyImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::UnsafeNewContractStateTraitForSRC6CamelOnlyImpl
pub trait UnsafeNewContractStateTraitForSRC6CamelOnlyImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_account::account::AccountComponent::UnsafeNewContractStateTraitForSRC6CamelOnlyImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForPublicKeyCamelImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::UnsafeNewContractStateTraitForPublicKeyCamelImpl
pub trait UnsafeNewContractStateTraitForPublicKeyCamelImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_account::account::AccountComponent::UnsafeNewContractStateTraitForPublicKeyCamelImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForAccountMixinImpl
Fully qualified path: openzeppelin_account::account::AccountComponent::UnsafeNewContractStateTraitForAccountMixinImpl
pub trait UnsafeNewContractStateTraitForAccountMixinImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_account::account::AccountComponent::UnsafeNewContractStateTraitForAccountMixinImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
eth_account
Fully qualified path: openzeppelin_account::eth_account
Modules
Modules
Modules
EthAccountComponent
EthAccount Component
The EthAccount component enables contracts to behave as accounts signing with Ethereum keys.
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent
Modules
Free functions
Structs
Enums
Traits
Modules
Modules
Errors
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::Errors
Constants
Constants
Constants
INVALID_CALLER
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::Errors::INVALID_CALLER
pub const INVALID_CALLER: felt252 = 111609425190703942063128945407568851162756752710068754602288498;
INVALID_SIGNATURE
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::Errors::INVALID_SIGNATURE
pub const INVALID_SIGNATURE: felt252 =
1872495434060281228044599952954990650829421195675704593774326882595429;
INVALID_TX_VERSION
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::Errors::INVALID_TX_VERSION
pub const INVALID_TX_VERSION: felt252 =
479358831119431994379417587956477606612331826092985369960038669776154478;
UNAUTHORIZED
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::Errors::UNAUTHORIZED
pub const UNAUTHORIZED: felt252 = 1703024676371825287828505636715884912155634219360997500260;
__external_SRC6Impl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__external_SRC6Impl
__l1_handler_SRC6Impl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__l1_handler_SRC6Impl
__constructor_SRC6Impl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__constructor_SRC6Impl
__external_DeclarerImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__external_DeclarerImpl
__l1_handler_DeclarerImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__l1_handler_DeclarerImpl
__constructor_DeclarerImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__constructor_DeclarerImpl
__external_DeployableImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__external_DeployableImpl
__l1_handler_DeployableImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__l1_handler_DeployableImpl
__constructor_DeployableImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__constructor_DeployableImpl
__external_PublicKeyImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__external_PublicKeyImpl
__l1_handler_PublicKeyImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__l1_handler_PublicKeyImpl
__constructor_PublicKeyImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__constructor_PublicKeyImpl
__external_SRC6CamelOnlyImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__external_SRC6CamelOnlyImpl
__l1_handler_SRC6CamelOnlyImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__l1_handler_SRC6CamelOnlyImpl
__constructor_SRC6CamelOnlyImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__constructor_SRC6CamelOnlyImpl
__external_PublicKeyCamelImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__external_PublicKeyCamelImpl
__l1_handler_PublicKeyCamelImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__l1_handler_PublicKeyCamelImpl
__constructor_PublicKeyCamelImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__constructor_PublicKeyCamelImpl
__external_EthAccountMixinImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__external_EthAccountMixinImpl
__l1_handler_EthAccountMixinImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__l1_handler_EthAccountMixinImpl
__constructor_EthAccountMixinImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::__constructor_EthAccountMixinImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
Storage
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::Storage
[storage]
pub struct Storage {
pub EthAccount_public_key: Secp256k1Point,
}
Members
EthAccount_public_key
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::Storage::EthAccount_public_key
pub EthAccount_public_key: Secp256k1Point
OwnerAdded
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::OwnerAdded
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct OwnerAdded {
pub new_owner_guid: felt252,
}
Members
new_owner_guid
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::OwnerAdded::new_owner_guid
pub new_owner_guid: felt252
OwnerRemoved
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::OwnerRemoved
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct OwnerRemoved {
pub removed_owner_guid: felt252,
}
Members
removed_owner_guid
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::OwnerRemoved::removed_owner_guid
pub removed_owner_guid: felt252
ComponentState
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::Event
pub enum Event {
OwnerAdded: OwnerAdded,
OwnerRemoved: OwnerRemoved,
}
Variants
OwnerAdded
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::Event::OwnerAdded
OwnerAdded: OwnerAdded
OwnerRemoved
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::Event::OwnerRemoved
OwnerRemoved: OwnerRemoved
Traits
Traits
HasComponent
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::HasComponent::emit
fn emit<S, impl IntoImp: Into<S, openzeppelin_account::eth_account::EthAccountComponent::Event>>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::InternalTrait
pub trait InternalTrait<
TContractState,
+HasComponent<TContractState>,
impl SRC5: HasComponent<TContractState>,
+Drop<TContractState>,
>
Trait functions
initializer
Initializes the account with the given public key, and registers the ISRC6 interface ID.
Emits an OwnerAdded event.
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::InternalTrait::initializer
fn initializer(ref self: ComponentState<TContractState>, public_key: Secp256k1Point)
assert_only_self
Validates that the caller is the account itself. Otherwise it reverts.
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::InternalTrait::assert_only_self
fn assert_only_self(self: @ComponentState<TContractState>)
assert_valid_new_owner
Validates that new_owner accepted the ownership of the contract.
WARNING: This function assumes that current_owner is the current owner of the
contract, and does not validate this assumption.
Requirements:
- The signature must be valid for the
new_owner.
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::InternalTrait::assert_valid_new_owner
fn assert_valid_new_owner(
self: @ComponentState<TContractState>,
current_owner: Secp256k1Point,
new_owner: Secp256k1Point,
signature: Span<felt252>,
)
validate_transaction
Validates the signature for the current transaction.
Returns the short string VALID if valid, otherwise it reverts.
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::InternalTrait::validate_transaction
fn validate_transaction(self: @ComponentState<TContractState>) -> felt252
_set_public_key
Sets the public key without validating the caller.
The usage of this method outside the set_public_key function is discouraged.
Emits an OwnerAdded event.
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::InternalTrait::_set_public_key
fn _set_public_key(ref self: ComponentState<TContractState>, new_public_key: Secp256k1Point)
_is_valid_signature
Returns whether the given signature is valid for the given hash using the account’s current public key.
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::InternalTrait::_is_valid_signature
fn _is_valid_signature(
self: @ComponentState<TContractState>, hash: felt252, signature: Span<felt252>,
) -> bool
UnsafeNewContractStateTraitForSRC6Impl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::UnsafeNewContractStateTraitForSRC6Impl
pub trait UnsafeNewContractStateTraitForSRC6Impl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::UnsafeNewContractStateTraitForSRC6Impl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForDeclarerImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::UnsafeNewContractStateTraitForDeclarerImpl
pub trait UnsafeNewContractStateTraitForDeclarerImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::UnsafeNewContractStateTraitForDeclarerImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForDeployableImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::UnsafeNewContractStateTraitForDeployableImpl
pub trait UnsafeNewContractStateTraitForDeployableImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::UnsafeNewContractStateTraitForDeployableImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForPublicKeyImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::UnsafeNewContractStateTraitForPublicKeyImpl
pub trait UnsafeNewContractStateTraitForPublicKeyImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::UnsafeNewContractStateTraitForPublicKeyImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForSRC6CamelOnlyImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::UnsafeNewContractStateTraitForSRC6CamelOnlyImpl
pub trait UnsafeNewContractStateTraitForSRC6CamelOnlyImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::UnsafeNewContractStateTraitForSRC6CamelOnlyImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForPublicKeyCamelImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::UnsafeNewContractStateTraitForPublicKeyCamelImpl
pub trait UnsafeNewContractStateTraitForPublicKeyCamelImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::UnsafeNewContractStateTraitForPublicKeyCamelImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForEthAccountMixinImpl
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::UnsafeNewContractStateTraitForEthAccountMixinImpl
pub trait UnsafeNewContractStateTraitForEthAccountMixinImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_account::eth_account::EthAccountComponent::UnsafeNewContractStateTraitForEthAccountMixinImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
extensions
Fully qualified path: openzeppelin_account::extensions
Modules
| src9 | — |
Re-exports:
Modules
Modules
| src9 | — |
src9
Fully qualified path: openzeppelin_account::extensions::src9
Modules
Re-exports:
Modules
Modules
snip12_utils
Fully qualified path: openzeppelin_account::extensions::src9::snip12_utils
Constants
Impls
Constants
Constants
OUTSIDE_EXECUTION_TYPE_HASH
Fully qualified path: openzeppelin_account::extensions::src9::snip12_utils::OUTSIDE_EXECUTION_TYPE_HASH
pub const OUTSIDE_EXECUTION_TYPE_HASH: felt252 =
1389993921274322046375090584689199791730207455988644802284406561556793335567;
CALL_TYPE_HASH
Fully qualified path: openzeppelin_account::extensions::src9::snip12_utils::CALL_TYPE_HASH
pub const CALL_TYPE_HASH: felt252 =
1532494794213978114698445795943389740361164528080484821528531616582786100393;
Impls
Impls
CallStructHash
Fully qualified path: openzeppelin_account::extensions::src9::snip12_utils::CallStructHash
pub impl CallStructHash of StructHash<Call>;
Impl functions
hash_struct
Fully qualified path: openzeppelin_account::extensions::src9::snip12_utils::CallStructHash::hash_struct
fn hash_struct(self: @Call) -> felt252
OutsideExecutionStructHash
Fully qualified path: openzeppelin_account::extensions::src9::snip12_utils::OutsideExecutionStructHash
pub impl OutsideExecutionStructHash of StructHash<OutsideExecution>;
Impl functions
hash_struct
Fully qualified path: openzeppelin_account::extensions::src9::snip12_utils::OutsideExecutionStructHash::hash_struct
fn hash_struct(self: @OutsideExecution) -> felt252
src9
Fully qualified path: openzeppelin_account::extensions::src9::src9
Modules
Modules
Modules
SRC9Component
SRC9 Component (Outside Execution)
The SRC9 component allows a protocol to submit transactions on behalf of a user account, as long as they provide the relevant signatures.
This component is designed to be account agnostic, as long as the contract implements the ISRC6 interface.
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component
Modules
| Errors | — |
| __external_OutsideExecutionV2Impl | — |
| __l1_handler_OutsideExecutionV2Impl | — |
| __constructor_OutsideExecutionV2Impl | — |
Free functions
Structs
Enums
Traits
Impls
Modules
Modules
| Errors | — |
| __external_OutsideExecutionV2Impl | — |
| __l1_handler_OutsideExecutionV2Impl | — |
| __constructor_OutsideExecutionV2Impl | — |
Errors
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::Errors
Constants
Constants
Constants
INVALID_CALLER
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::Errors::INVALID_CALLER
pub const INVALID_CALLER: felt252 = 475680751081174049698716115999338770025514034546;
INVALID_AFTER
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::Errors::INVALID_AFTER
pub const INVALID_AFTER: felt252 = 133892228332280848098431280661449449936853217964070993327842674;
INVALID_BEFORE
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::Errors::INVALID_BEFORE
pub const INVALID_BEFORE: felt252 =
34276410453063897113198408529895793025711350725551390250446582373;
DUPLICATED_NONCE
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::Errors::DUPLICATED_NONCE
pub const DUPLICATED_NONCE: felt252 = 31174213702855815911140334579741639588446766470423397;
INVALID_SIGNATURE
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::Errors::INVALID_SIGNATURE
pub const INVALID_SIGNATURE: felt252 = 7980598707931090565390095200801962697615335207267037797;
__external_OutsideExecutionV2Impl
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::__external_OutsideExecutionV2Impl
__l1_handler_OutsideExecutionV2Impl
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::__l1_handler_OutsideExecutionV2Impl
__constructor_OutsideExecutionV2Impl
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::__constructor_OutsideExecutionV2Impl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
Storage
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::Storage
[storage]
pub struct Storage {
pub SRC9_nonces: Map<felt252, bool>,
}
Members
SRC9_nonces
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::Storage::SRC9_nonces
pub SRC9_nonces: Map<felt252, bool>
ComponentState
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::Event
pub enum Event {}
Traits
Traits
HasComponent
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::HasComponent::emit
fn emit<
S, impl IntoImp: Into<S, openzeppelin_account::extensions::src9::src9::SRC9Component::Event>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::InternalTrait
pub trait InternalTrait<
TContractState,
+HasComponent<TContractState>,
impl SRC5: HasComponent<TContractState>,
+Drop<TContractState>,
>
Trait functions
initializer
Initializes the account by registering the ISRC9_V2 interface ID.
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::InternalTrait::initializer
fn initializer(ref self: ComponentState<TContractState>)
UnsafeNewContractStateTraitForOutsideExecutionV2Impl
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::UnsafeNewContractStateTraitForOutsideExecutionV2Impl
pub trait UnsafeNewContractStateTraitForOutsideExecutionV2Impl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::UnsafeNewContractStateTraitForOutsideExecutionV2Impl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
Impls
Impls
SNIP12MetadataImpl
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::SNIP12MetadataImpl
pub impl SNIP12MetadataImpl of SNIP12Metadata;
Impl functions
name
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::SNIP12MetadataImpl::name
fn name() -> felt252
version
Fully qualified path: openzeppelin_account::extensions::src9::src9::SRC9Component::SNIP12MetadataImpl::version
fn version() -> felt252
utils
Fully qualified path: openzeppelin_account::utils
Modules
Constants
Free functions
| is_tx_version_valid | If the transaction is a simulation (version >= QUERY_OFFSET ), it must be greater than or equal to QUERY_OFFSET + MIN_TRANSACTION_VERSION to be considered valid…. |
Re-exports:
| is_valid_eth_signature | This function assumes the s component of the signature to be positive for efficiency reasons. It is not recommended to use it other than for… |
| is_valid_p256_signature | This function assumes the s component of the signature to be positive for efficiency reasons. It is not recommended to use it other than for… |
| is_valid_stark_signature | This function assumes the s component of the signature to be positive for efficiency reasons. It is not recommended to use it other than for… |
Modules
Modules
secp256_point
Fully qualified path: openzeppelin_account::utils::secp256_point
signature
Fully qualified path: openzeppelin_account::utils::signature
Free functions
| is_valid_stark_signature | This function assumes the s component of the signature to be positive for efficiency reasons. It is not recommended to use it other than for… |
| is_valid_eth_signature | This function assumes the s component of the signature to be positive for efficiency reasons. It is not recommended to use it other than for… |
| is_valid_p256_signature | This function assumes the s component of the signature to be positive for efficiency reasons. It is not recommended to use it other than for… |
Structs
| Secp256Signature | A signature format compatible with the family of secp256 curves. |
Free functions
Free functions
| is_valid_stark_signature | This function assumes the s component of the signature to be positive for efficiency reasons. It is not recommended to use it other than for… |
| is_valid_eth_signature | This function assumes the s component of the signature to be positive for efficiency reasons. It is not recommended to use it other than for… |
| is_valid_p256_signature | This function assumes the s component of the signature to be positive for efficiency reasons. It is not recommended to use it other than for… |
is_valid_stark_signature
This function assumes the s component of the signature to be positive
for efficiency reasons. It is not recommended to use it other than for
validating account signatures over transaction hashes since otherwise
it’s not protected against signature malleability.
See https://github.com/OpenZeppelin/cairo-contracts/issues/889.
Fully qualified path: openzeppelin_account::utils::signature::is_valid_stark_signature
pub fn is_valid_stark_signature(
msg_hash: felt252, public_key: felt252, signature: Span<felt252>,
) -> bool
is_valid_eth_signature
This function assumes the s component of the signature to be positive
for efficiency reasons. It is not recommended to use it other than for
validating account signatures over transaction hashes since otherwise
it’s not protected against signature malleability.
See https://github.com/OpenZeppelin/cairo-contracts/issues/889.
Fully qualified path: openzeppelin_account::utils::signature::is_valid_eth_signature
pub fn is_valid_eth_signature(
msg_hash: felt252, public_key: Secp256k1Point, signature: Span<felt252>,
) -> bool
is_valid_p256_signature
This function assumes the s component of the signature to be positive
for efficiency reasons. It is not recommended to use it other than for
validating account signatures over transaction hashes since otherwise
it’s not protected against signature malleability.
See https://github.com/OpenZeppelin/cairo-contracts/issues/889.
Fully qualified path: openzeppelin_account::utils::signature::is_valid_p256_signature
pub fn is_valid_p256_signature(
msg_hash: felt252, public_key: Secp256r1Point, signature: Span<felt252>,
) -> bool
Structs
Structs
| Secp256Signature | A signature format compatible with the family of secp256 curves. |
Secp256Signature
A signature format compatible with the family of secp256 curves.
Fully qualified path: openzeppelin_account::utils::signature::Secp256Signature
[derive(Copy, Drop, Serde)]
pub struct Secp256Signature {
pub r: u256,
pub s: u256,
}
Members
r
Fully qualified path: openzeppelin_account::utils::signature::Secp256Signature::r
pub r: u256
s
Fully qualified path: openzeppelin_account::utils::signature::Secp256Signature::s
pub s: u256
Constants
Constants
MIN_TRANSACTION_VERSION
Fully qualified path: openzeppelin_account::utils::MIN_TRANSACTION_VERSION
pub const MIN_TRANSACTION_VERSION: u256 = 1;
QUERY_OFFSET
Fully qualified path: openzeppelin_account::utils::QUERY_OFFSET
pub const QUERY_OFFSET: u256 = 340282366920938463463374607431768211456;
QUERY_VERSION
Fully qualified path: openzeppelin_account::utils::QUERY_VERSION
pub const QUERY_VERSION: u256 = 340282366920938463463374607431768211457;
Free functions
Free functions
| is_tx_version_valid | If the transaction is a simulation (version >= QUERY_OFFSET ), it must be greater than or equal to QUERY_OFFSET + MIN_TRANSACTION_VERSION to be considered valid…. |
is_tx_version_valid
If the transaction is a simulation (version >= QUERY_OFFSET), it must be
greater than or equal to QUERY_OFFSET + MIN_TRANSACTION_VERSION to be considered valid.
Otherwise, it must be greater than or equal to MIN_TRANSACTION_VERSION.
Fully qualified path: openzeppelin_account::utils::is_tx_version_valid
pub fn is_tx_version_valid() -> bool
openzeppelin_finance
Fully qualified path: openzeppelin_finance
Modules
Modules
Modules
vesting
Fully qualified path: openzeppelin_finance::vesting
Modules
Re-exports:
| LinearVestingSchedule | Defines the logic for calculating the vested amount, incorporating a cliff period. It returns 0 before the cliff ends. After the cliff period, the vested amount returned… |
Modules
Modules
vesting
Fully qualified path: openzeppelin_finance::vesting::vesting
Modules
Modules
Modules
VestingComponent
Vesting Component
A component for the controlled release of ERC-20 tokens to a designated beneficiary according
to a predefined vesting schedule. The implementing contract is required to implement Ownable
component, so that the owner of the contract is the vesting beneficiary. It also means that
ownership rights to the contract and to the vesting allocation can be assigned and transferred.
Vesting schedule is specified through the VestingScheduleTrait implementation.
This trait can be used to implement any custom vesting schedules.
Any assets transferred to this contract will follow the vesting schedule as if they were locked from the beginning. Consequently, if the vesting has already started, any amount of tokens sent to this contract may be immediately releasable.
By setting the duration to 0, one can configure this contract to behave like an asset timelock that holds tokens for a beneficiary until a specified time.
NOTE:
- A separate contract with a Vesting component must be deployed for each beneficiary.
- Can be used to vest multiple tokens to a single beneficiary, provided that the core vesting parameters (start, duration, and cliff_duration) are identical.
- When using this contract with any token whose balance is adjusted automatically (i.e. a rebase token), make sure to account for the supply/balance adjustment in the vesting schedule to ensure the vested amount is as intended.
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent
Modules
Free functions
Structs
| Storage | — |
| AmountReleased | Emitted when vested tokens are released to the beneficiary. |
| ComponentState | — |
Enums
Traits
| VestingScheduleTrait | A trait that defines the logic for calculating the vested amount based on a given timestamp. |
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForVestingImpl | — |
Modules
Modules
Errors
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::Errors
Constants
Constants
Constants
INVALID_CLIFF_DURATION
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::Errors::INVALID_CLIFF_DURATION
pub const INVALID_CLIFF_DURATION: felt252 =
152649036605431360944181758425092134271167152285113331730761582230553325422;
TOKEN_TRANSFER_FAILED
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::Errors::TOKEN_TRANSFER_FAILED
pub const TOKEN_TRANSFER_FAILED: felt252 =
596285299239966253688226075830058395828406538886580424138896439941817700;
__external_VestingImpl
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::__external_VestingImpl
__l1_handler_VestingImpl
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::__l1_handler_VestingImpl
__constructor_VestingImpl
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::__constructor_VestingImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| AmountReleased | Emitted when vested tokens are released to the beneficiary. |
| ComponentState | — |
Storage
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::Storage
[storage]
pub struct Storage {
pub Vesting_start: u64,
pub Vesting_duration: u64,
pub Vesting_cliff: u64,
pub Vesting_released: Map<ContractAddress, u256>,
}
Members
Vesting_start
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::Storage::Vesting_start
pub Vesting_start: u64
Vesting_duration
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::Storage::Vesting_duration
pub Vesting_duration: u64
Vesting_cliff
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::Storage::Vesting_cliff
pub Vesting_cliff: u64
Vesting_released
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::Storage::Vesting_released
pub Vesting_released: Map<ContractAddress, u256>
AmountReleased
Emitted when vested tokens are released to the beneficiary.
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::AmountReleased
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct AmountReleased {
pub token: ContractAddress,
pub amount: u256,
}
Members
token
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::AmountReleased::token
pub token: ContractAddress
amount
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::AmountReleased::amount
pub amount: u256
ComponentState
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::Event
pub enum Event {
AmountReleased: AmountReleased,
}
Variants
AmountReleased
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::Event::AmountReleased
AmountReleased: AmountReleased
Traits
Traits
| VestingScheduleTrait | A trait that defines the logic for calculating the vested amount based on a given timestamp. |
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForVestingImpl | — |
VestingScheduleTrait
A trait that defines the logic for calculating the vested amount based on a given timestamp.
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::VestingScheduleTrait
pub trait VestingScheduleTrait<TContractState>
Trait functions
calculate_vested_amount
Calculates and returns the vested amount at a given timestamp based on the core
vesting parameters.
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::VestingScheduleTrait::calculate_vested_amount
fn calculate_vested_amount(
self: @ComponentState<TContractState>,
token: ContractAddress,
total_allocation: u256,
timestamp: u64,
start: u64,
duration: u64,
cliff: u64,
) -> u256
HasComponent
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::HasComponent::emit
fn emit<S, impl IntoImp: Into<S, openzeppelin_finance::vesting::vesting::VestingComponent::Event>>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::InternalTrait
pub trait InternalTrait<
TContractState,
+HasComponent<TContractState>,
impl VestingSchedule: VestingScheduleTrait<TContractState>,
>
Trait functions
initializer
Initializes the component by setting the vesting start, duration and
cliff_duration.
Requirements:
cliff_durationmust be less than or equal toduration.
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::InternalTrait::initializer
fn initializer(
ref self: ComponentState<TContractState>, start: u64, duration: u64, cliff_duration: u64,
)
resolve_vested_amount
Returns the vested amount that’s calculated using the VestingScheduleTrait
implementation.
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::InternalTrait::resolve_vested_amount
fn resolve_vested_amount(
self: @ComponentState<TContractState>, token: ContractAddress, timestamp: u64,
) -> u256
UnsafeNewContractStateTraitForVestingImpl
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::UnsafeNewContractStateTraitForVestingImpl
pub trait UnsafeNewContractStateTraitForVestingImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_finance::vesting::vesting::VestingComponent::UnsafeNewContractStateTraitForVestingImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
openzeppelin_governance
Fully qualified path: openzeppelin_governance
Modules
Modules
Modules
governor
Fully qualified path: openzeppelin_governance::governor
Modules
Re-exports:
| ProposalCore | Proposal state. |
| DefaultConfig | Implementation of the default Governor ImmutableConfig. See https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-107.md#defaultconfig-implementation The DEFAULT_PARAMS… |
Modules
Modules
extensions
Fully qualified path: openzeppelin_governance::governor::extensions
Modules
| governor_core_execution | — |
| governor_counting_simple | — |
| governor_settings | — |
| governor_timelock_execution | — |
| governor_votes | — |
| governor_votes_quorum_fraction | — |
Re-exports:
| GovernorCoreExecutionComponent | … |
| GovernorCountingSimpleComponent | … |
| GovernorSettingsComponent | … |
| GovernorTimelockExecutionComponent | … |
| GovernorVotesComponent | … |
| GovernorVotesQuorumFractionComponent | … |
Modules
Modules
| governor_core_execution | — |
| governor_counting_simple | — |
| governor_settings | — |
| governor_timelock_execution | — |
| governor_votes | — |
| governor_votes_quorum_fraction | — |
governor_core_execution
Fully qualified path: openzeppelin_governance::governor::extensions::governor_core_execution
Modules
Modules
Modules
GovernorCoreExecutionComponent
GovernorCoreExecution Component
Extension of GovernorComponent providing an execution mechanism directly through the Governor itself. For a timelocked execution mechanism, see GovernorTimelockExecutionComponent.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_core_execution::GovernorCoreExecutionComponent
Free functions
Structs
Enums
Traits
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_governance::governor::extensions::governor_core_execution::GovernorCoreExecutionComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
Storage
Fully qualified path: openzeppelin_governance::governor::extensions::governor_core_execution::GovernorCoreExecutionComponent::Storage
[storage]
pub struct Storage {}
ComponentState
Fully qualified path: openzeppelin_governance::governor::extensions::governor_core_execution::GovernorCoreExecutionComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_governance::governor::extensions::governor_core_execution::GovernorCoreExecutionComponent::Event
pub enum Event {}
Traits
Traits
HasComponent
Fully qualified path: openzeppelin_governance::governor::extensions::governor_core_execution::GovernorCoreExecutionComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_governance::governor::extensions::governor_core_execution::GovernorCoreExecutionComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_governance::governor::extensions::governor_core_execution::GovernorCoreExecutionComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_governance::governor::extensions::governor_core_execution::GovernorCoreExecutionComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_governance::governor::extensions::governor_core_execution::GovernorCoreExecutionComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_governance::governor::extensions::governor_core_execution::GovernorCoreExecutionComponent::HasComponent::emit
fn emit<
S,
impl IntoImp: Into<
S,
openzeppelin_governance::governor::extensions::governor_core_execution::GovernorCoreExecutionComponent::Event,
>,
>(
ref self: ComponentState<TContractState>, event: S,
)
governor_counting_simple
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple
Modules
Modules
Modules
GovernorCountingSimpleComponent
GovernorCountingSimple Component
Extension of GovernorComponent for simple vote counting with three options.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent
Modules
Free functions
Structs
Enums
Traits
Modules
Modules
Errors
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::Errors
Constants
Constants
Constants
ALREADY_CAST_VOTE
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::Errors::ALREADY_CAST_VOTE
pub const ALREADY_CAST_VOTE: felt252 = 22262504451487240676400251763458170647653;
INVALID_VOTE_TYPE
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::Errors::INVALID_VOTE_TYPE
pub const INVALID_VOTE_TYPE: felt252 = 24987442531777145766172188403588409159781;
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
Storage
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::Storage
[storage]
pub struct Storage {
pub Governor_proposals_votes: Map<felt252, ProposalVote>,
}
Members
Governor_proposals_votes
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::Storage::Governor_proposals_votes
pub Governor_proposals_votes: Map<felt252, ProposalVote>
ProposalVote
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::ProposalVote
[starknet::storage_node]
pub struct ProposalVote {
pub against_votes: u256,
pub for_votes: u256,
pub abstain_votes: u256,
pub has_voted: Map<ContractAddress, bool>,
}
Members
against_votes
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::ProposalVote::against_votes
pub against_votes: u256
for_votes
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::ProposalVote::for_votes
pub for_votes: u256
abstain_votes
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::ProposalVote::abstain_votes
pub abstain_votes: u256
has_voted
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::ProposalVote::has_voted
pub has_voted: Map<ContractAddress, bool>
ComponentState
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
VoteType
Supported vote types.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::VoteType
pub enum VoteType {
Against,
For,
Abstain,
}
Variants
Against
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::VoteType::Against
Against
For
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::VoteType::For
For
Abstain
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::VoteType::Abstain
Abstain
Event
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::Event
pub enum Event {}
Traits
Traits
HasComponent
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::HasComponent::emit
fn emit<
S,
impl IntoImp: Into<
S,
openzeppelin_governance::governor::extensions::governor_counting_simple::GovernorCountingSimpleComponent::Event,
>,
>(
ref self: ComponentState<TContractState>, event: S,
)
governor_settings
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings
Modules
Modules
Modules
GovernorSettingsComponent
GovernorSettings Component
Extension of GovernorComponent for settings that are updatable through governance.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent
Modules
| Errors | — |
| __external_GovernorSettingsAdminImpl | — |
| __l1_handler_GovernorSettingsAdminImpl | — |
| __constructor_GovernorSettingsAdminImpl | — |
Free functions
Structs
| Storage | — |
| VotingDelayUpdated | Emitted when Governor_voting_delay is updated. |
| VotingPeriodUpdated | Emitted when Governor_voting_period is updated. |
| ProposalThresholdUpdated | Emitted when Governor_proposal_threshold is updated. |
| ComponentState | — |
Enums
Traits
Modules
Modules
| Errors | — |
| __external_GovernorSettingsAdminImpl | — |
| __l1_handler_GovernorSettingsAdminImpl | — |
| __constructor_GovernorSettingsAdminImpl | — |
Errors
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::Errors
Constants
Constants
Constants
INVALID_VOTING_PERIOD
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::Errors::INVALID_VOTING_PERIOD
pub const INVALID_VOTING_PERIOD: felt252 = 107320248484662281825934412318490016555160658603876;
__external_GovernorSettingsAdminImpl
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::__external_GovernorSettingsAdminImpl
__l1_handler_GovernorSettingsAdminImpl
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::__l1_handler_GovernorSettingsAdminImpl
__constructor_GovernorSettingsAdminImpl
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::__constructor_GovernorSettingsAdminImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| VotingDelayUpdated | Emitted when Governor_voting_delay is updated. |
| VotingPeriodUpdated | Emitted when Governor_voting_period is updated. |
| ProposalThresholdUpdated | Emitted when Governor_proposal_threshold is updated. |
| ComponentState | — |
Storage
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::Storage
[storage]
pub struct Storage {
pub Governor_voting_delay: u64,
pub Governor_voting_period: u64,
pub Governor_proposal_threshold: u256,
}
Members
Governor_voting_delay
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::Storage::Governor_voting_delay
pub Governor_voting_delay: u64
Governor_voting_period
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::Storage::Governor_voting_period
pub Governor_voting_period: u64
Governor_proposal_threshold
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::Storage::Governor_proposal_threshold
pub Governor_proposal_threshold: u256
VotingDelayUpdated
Emitted when Governor_voting_delay is updated.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::VotingDelayUpdated
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct VotingDelayUpdated {
pub old_voting_delay: u64,
pub new_voting_delay: u64,
}
Members
old_voting_delay
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::VotingDelayUpdated::old_voting_delay
pub old_voting_delay: u64
new_voting_delay
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::VotingDelayUpdated::new_voting_delay
pub new_voting_delay: u64
VotingPeriodUpdated
Emitted when Governor_voting_period is updated.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::VotingPeriodUpdated
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct VotingPeriodUpdated {
pub old_voting_period: u64,
pub new_voting_period: u64,
}
Members
old_voting_period
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::VotingPeriodUpdated::old_voting_period
pub old_voting_period: u64
new_voting_period
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::VotingPeriodUpdated::new_voting_period
pub new_voting_period: u64
ProposalThresholdUpdated
Emitted when Governor_proposal_threshold is updated.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::ProposalThresholdUpdated
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct ProposalThresholdUpdated {
pub old_proposal_threshold: u256,
pub new_proposal_threshold: u256,
}
Members
old_proposal_threshold
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::ProposalThresholdUpdated::old_proposal_threshold
pub old_proposal_threshold: u256
new_proposal_threshold
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::ProposalThresholdUpdated::new_proposal_threshold
pub new_proposal_threshold: u256
ComponentState
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::Event
pub enum Event {
VotingDelayUpdated: VotingDelayUpdated,
VotingPeriodUpdated: VotingPeriodUpdated,
ProposalThresholdUpdated: ProposalThresholdUpdated,
}
Variants
VotingDelayUpdated
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::Event::VotingDelayUpdated
VotingDelayUpdated: VotingDelayUpdated
VotingPeriodUpdated
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::Event::VotingPeriodUpdated
VotingPeriodUpdated: VotingPeriodUpdated
ProposalThresholdUpdated
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::Event::ProposalThresholdUpdated
ProposalThresholdUpdated: ProposalThresholdUpdated
Traits
Traits
HasComponent
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::HasComponent::emit
fn emit<
S,
impl IntoImp: Into<
S,
openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::Event,
>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::InternalTrait
pub trait InternalTrait<TContractState, +HasComponent<TContractState>, impl GovernorCountingTrait<TContractState>: GovernorCountingTrait<TContractState>, impl GovernorExecutionTrait<TContractState>: GovernorExecutionTrait<TContractState>, impl GovernorVotesTrait<TContractState>: GovernorVotesTrait<TContractState>, impl HasComponent<TContractState>: HasComponent<TContractState>, impl Governor: HasComponent<TContractState>, +Drop<TContractState>>
Trait functions
initializer
Initializes the component by setting the default values.
Requirements:
new_voting_periodmust be greater than 0.
Emits a VotingDelayUpdated, VotingPeriodUpdated, and ProposalThresholdUpdated
event.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::InternalTrait::initializer
fn initializer(
ref self: ComponentState<TContractState>,
new_voting_delay: u64,
new_voting_period: u64,
new_proposal_threshold: u256,
)
assert_only_governance
Wrapper for Governor::assert_only_governance.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::InternalTrait::assert_only_governance
fn assert_only_governance(self: @ComponentState<TContractState>)
_set_voting_delay
Internal function to update the voting delay.
NOTE: This function does not emit an event if the new voting delay is the same as the old one.
May emit a VotingDelayUpdated event.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::InternalTrait::_set_voting_delay
fn _set_voting_delay(ref self: ComponentState<TContractState>, new_voting_delay: u64)
_set_voting_period
Internal function to update the voting period.
Requirements:
new_voting_periodmust be greater than 0.
NOTE: This function does not emit an event if the new voting period is the same as the old one.
May emit a VotingPeriodUpdated event.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::InternalTrait::_set_voting_period
fn _set_voting_period(ref self: ComponentState<TContractState>, new_voting_period: u64)
_set_proposal_threshold
Internal function to update the proposal threshold.
NOTE: This function does not emit an event if the new proposal threshold is the same as the old one.
May emit a ProposalThresholdUpdated event.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::InternalTrait::_set_proposal_threshold
fn _set_proposal_threshold(ref self: ComponentState<TContractState>, new_proposal_threshold: u256)
UnsafeNewContractStateTraitForGovernorSettingsAdminImpl
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::UnsafeNewContractStateTraitForGovernorSettingsAdminImpl
pub trait UnsafeNewContractStateTraitForGovernorSettingsAdminImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_governance::governor::extensions::governor_settings::GovernorSettingsComponent::UnsafeNewContractStateTraitForGovernorSettingsAdminImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
governor_timelock_execution
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution
Modules
Modules
Modules
GovernorTimelockExecutionComponent
GovernorTimelockExecution Component
Extension of GovernorComponent that binds the execution process to an instance of a contract implementing TimelockControllerComponent. This adds a delay, enforced by the TimelockController to all successful proposals (in addition to the voting duration).
NOTE: The Governor needs the PROPOSER, EXECUTOR, and CANCELLER roles to work properly.
Using this model means the proposal will be operated by the TimelockController and not by the
Governor. Thus, the assets and permissions must be attached to the TimelockController. Any asset
sent to the Governor will be inaccessible from a proposal, unless executed via
Governor::relay.
WARNING: Setting up the TimelockController to have additional proposers or cancellers besides the governor is very risky, as it grants them the ability to: 1) execute operations as the timelock, and thus possibly performing operations or accessing funds that are expected to only be accessible through a vote, and 2) block governance proposals that have been approved by the voters, effectively executing a Denial of Service attack.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent
Modules
Free functions
Structs
| Storage | — |
| TimelockUpdated | Emitted when the timelock controller used for proposal execution is modified. |
| ComponentState | — |
Enums
Traits
Modules
Modules
Errors
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::Errors
Constants
Constants
Constants
INVALID_TIMELOCK_CONTROLLER
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::Errors::INVALID_TIMELOCK_CONTROLLER
pub const INVALID_TIMELOCK_CONTROLLER: felt252 =
30207964442802130652131156886795978221456167704787259247460902258;
__external_TimelockedImpl
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::__external_TimelockedImpl
__l1_handler_TimelockedImpl
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::__l1_handler_TimelockedImpl
__constructor_TimelockedImpl
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::__constructor_TimelockedImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| TimelockUpdated | Emitted when the timelock controller used for proposal execution is modified. |
| ComponentState | — |
Storage
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::Storage
[storage]
pub struct Storage {
pub Governor_timelock_controller: ContractAddress,
pub Governor_timelock_ids: Map<felt252, felt252>,
}
Members
Governor_timelock_controller
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::Storage::Governor_timelock_controller
pub Governor_timelock_controller: ContractAddress
Governor_timelock_ids
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::Storage::Governor_timelock_ids
pub Governor_timelock_ids: Map<felt252, felt252>
TimelockUpdated
Emitted when the timelock controller used for proposal execution is modified.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::TimelockUpdated
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct TimelockUpdated {
pub old_timelock: ContractAddress,
pub new_timelock: ContractAddress,
}
Members
old_timelock
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::TimelockUpdated::old_timelock
pub old_timelock: ContractAddress
new_timelock
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::TimelockUpdated::new_timelock
pub new_timelock: ContractAddress
ComponentState
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::Event
pub enum Event {
TimelockUpdated: TimelockUpdated,
}
Variants
TimelockUpdated
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::Event::TimelockUpdated
TimelockUpdated: TimelockUpdated
Traits
Traits
HasComponent
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::HasComponent::emit
fn emit<
S,
impl IntoImp: Into<
S,
openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::Event,
>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::InternalTrait
pub trait InternalTrait<TContractState, +HasComponent<TContractState>, impl GovernorSettingsTrait<TContractState>: GovernorSettingsTrait<TContractState>, impl GovernorCountingTrait<TContractState>: GovernorCountingTrait<TContractState>, impl GovernorVotesTrait<TContractState>: GovernorVotesTrait<TContractState>, impl HasComponent<TContractState>: HasComponent<TContractState>, impl Governor: HasComponent<TContractState>, +Drop<TContractState>>
Trait functions
initializer
Initializes the component by setting the timelock contract address.
Requirements:
timelock_controllermust not be zero.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::InternalTrait::initializer
fn initializer(ref self: ComponentState<TContractState>, timelock_controller: ContractAddress)
assert_only_governance
Wrapper for Governor::assert_only_governance.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::InternalTrait::assert_only_governance
fn assert_only_governance(self: @ComponentState<TContractState>)
timelock_salt
Computes the TimelockController operation salt as the XOR of
the governor address and description_hash. In the case of overflow, it is
reduced modulo P.
It is computed with the governor address itself to avoid collisions across governor instances using the same timelock.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::InternalTrait::timelock_salt
fn timelock_salt(self: @ComponentState<TContractState>, description_hash: felt252) -> felt252
get_timelock_dispatcher
Returns the timelock contract address wrapped in a ITimelockDispatcher.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::InternalTrait::get_timelock_dispatcher
fn get_timelock_dispatcher(self: @ComponentState<TContractState>) -> ITimelockDispatcher
_update_timelock
Updates the timelock contract address.
Emits a TimelockUpdated event.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::InternalTrait::_update_timelock
fn _update_timelock(ref self: ComponentState<TContractState>, new_timelock: ContractAddress)
UnsafeNewContractStateTraitForTimelockedImpl
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::UnsafeNewContractStateTraitForTimelockedImpl
pub trait UnsafeNewContractStateTraitForTimelockedImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_governance::governor::extensions::governor_timelock_execution::GovernorTimelockExecutionComponent::UnsafeNewContractStateTraitForTimelockedImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
governor_votes
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes
Modules
Modules
Modules
GovernorVotesComponent
GovernorVotes Component
Extension of GovernorComponent for voting weight extraction from a token with the Votes extension.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent
Modules
Free functions
Structs
Enums
Traits
Modules
Modules
Errors
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::Errors
Constants
Constants
Constants
INVALID_TOKEN
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::Errors::INVALID_TOKEN
pub const INVALID_TOKEN: felt252 = 1637577033762547024931860539240840025294464366;
__external_VotesTokenImpl
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::__external_VotesTokenImpl
__l1_handler_VotesTokenImpl
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::__l1_handler_VotesTokenImpl
__constructor_VotesTokenImpl
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::__constructor_VotesTokenImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
Storage
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::Storage
[storage]
pub struct Storage {
pub Governor_token: ContractAddress,
}
Members
Governor_token
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::Storage::Governor_token
pub Governor_token: ContractAddress
ComponentState
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::Event
pub enum Event {}
Traits
Traits
HasComponent
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::HasComponent::emit
fn emit<
S,
impl IntoImp: Into<
S,
openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::Event,
>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::InternalTrait
pub trait InternalTrait<TContractState, +HasComponent<TContractState>, impl HasComponent<TContractState>: HasComponent<TContractState>, impl GovernorVotesTrait<TContractState>: GovernorVotesTrait<TContractState>, +Drop<TContractState>>
Trait functions
initializer
Initializes the component by setting the votes token.
Requirements:
votes_tokenmust not be zero.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::InternalTrait::initializer
fn initializer(ref self: ComponentState<TContractState>, votes_token: ContractAddress)
UnsafeNewContractStateTraitForVotesTokenImpl
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::UnsafeNewContractStateTraitForVotesTokenImpl
pub trait UnsafeNewContractStateTraitForVotesTokenImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes::GovernorVotesComponent::UnsafeNewContractStateTraitForVotesTokenImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
governor_votes_quorum_fraction
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction
Modules
Modules
Modules
GovernorVotesQuorumFractionComponent
GovernorVotesQuorumFraction Component
Extension of GovernorComponent for voting weight extraction from a token with the Votes extension and a quorum expressed as a fraction of the total supply.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent
Modules
| Errors | — |
| __external_QuorumFractionImpl | — |
| __l1_handler_QuorumFractionImpl | — |
| __constructor_QuorumFractionImpl | — |
Free functions
Structs
| Storage | — |
| QuorumNumeratorUpdated | Emitted when the quorum numerator is updated. |
| ComponentState | — |
Enums
Traits
Modules
Modules
| Errors | — |
| __external_QuorumFractionImpl | — |
| __l1_handler_QuorumFractionImpl | — |
| __constructor_QuorumFractionImpl | — |
Errors
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::Errors
Constants
Constants
Constants
INVALID_QUORUM_FRACTION
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::Errors::INVALID_QUORUM_FRACTION
pub const INVALID_QUORUM_FRACTION: felt252 =
7033339804690827301718597462522552828128581913957461870;
INVALID_TOKEN
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::Errors::INVALID_TOKEN
pub const INVALID_TOKEN: felt252 = 1637577033762547024931860539240840025294464366;
__external_QuorumFractionImpl
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::__external_QuorumFractionImpl
__l1_handler_QuorumFractionImpl
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::__l1_handler_QuorumFractionImpl
__constructor_QuorumFractionImpl
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::__constructor_QuorumFractionImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| QuorumNumeratorUpdated | Emitted when the quorum numerator is updated. |
| ComponentState | — |
Storage
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::Storage
[storage]
pub struct Storage {
pub Governor_token: ContractAddress,
pub Governor_quorum_numerator_history: Trace,
}
Members
Governor_token
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::Storage::Governor_token
pub Governor_token: ContractAddress
Governor_quorum_numerator_history
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::Storage::Governor_quorum_numerator_history
pub Governor_quorum_numerator_history: Trace
QuorumNumeratorUpdated
Emitted when the quorum numerator is updated.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::QuorumNumeratorUpdated
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct QuorumNumeratorUpdated {
pub old_quorum_numerator: u256,
pub new_quorum_numerator: u256,
}
Members
old_quorum_numerator
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::QuorumNumeratorUpdated::old_quorum_numerator
pub old_quorum_numerator: u256
new_quorum_numerator
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::QuorumNumeratorUpdated::new_quorum_numerator
pub new_quorum_numerator: u256
ComponentState
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::Event
pub enum Event {
QuorumNumeratorUpdated: QuorumNumeratorUpdated,
}
Variants
QuorumNumeratorUpdated
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::Event::QuorumNumeratorUpdated
QuorumNumeratorUpdated: QuorumNumeratorUpdated
Traits
Traits
HasComponent
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::HasComponent::emit
fn emit<
S,
impl IntoImp: Into<
S,
openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::Event,
>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::InternalTrait
pub trait InternalTrait<TContractState, +HasComponent<TContractState>, impl GovernorVotesTrait<TContractState>: GovernorVotesTrait<TContractState>, impl Governor: HasComponent<TContractState>, +Drop<TContractState>>
Trait functions
initializer
Initializes the component by setting the votes token and the initial quorum numerator value.
Requirements:
votes_tokenmust not be zero.quorum_numeratormust be less thanquorum_denominator.
Emits a QuorumNumeratorUpdated event.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::InternalTrait::initializer
fn initializer(
ref self: ComponentState<TContractState>, votes_token: ContractAddress, quorum_numerator: u256,
)
update_quorum_numerator
Updates the quorum numerator.
NOTE: This function does not emit an event if the new quorum numerator is the same as the old one.
Requirements:
new_quorum_numeratormust be less thanquorum_denominator.
May emit a QuorumNumeratorUpdated event.
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::InternalTrait::update_quorum_numerator
fn update_quorum_numerator(ref self: ComponentState<TContractState>, new_quorum_numerator: u256)
UnsafeNewContractStateTraitForQuorumFractionImpl
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::UnsafeNewContractStateTraitForQuorumFractionImpl
pub trait UnsafeNewContractStateTraitForQuorumFractionImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_governance::governor::extensions::governor_votes_quorum_fraction::GovernorVotesQuorumFractionComponent::UnsafeNewContractStateTraitForQuorumFractionImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
governor
Fully qualified path: openzeppelin_governance::governor::governor
Modules
Impls
| DefaultConfig | Implementation of the default Governor ImmutableConfig. See https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-107.md#defaultconfig-implementation The DEFAULT_PARAMS… |
Modules
Modules
GovernorComponent
Governor Component
Core of the governance system.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent
Modules
Free functions
Structs
| Storage | — |
| ProposalCreated | Emitted when call is scheduled as part of operation id . |
| ProposalQueued | Emitted when a proposal is queued. |
| ProposalExecuted | Emitted when a proposal is executed. |
| ProposalCanceled | Emitted when a proposal is canceled. |
| VoteCast | Emitted when a vote is cast without params. |
| VoteCastWithParams | Emitted when a vote is cast with params. NOTE: support values should be seen as buckets. Their interpretation depends on the voting module used. params… |
| ComponentState | — |
Enums
Traits
| ImmutableConfig | Constants expected to be defined at the contract level used to configure the component behavior…. |
| GovernorSettingsTrait | — |
| GovernorQuorumTrait | — |
| GovernorCountingTrait | — |
| GovernorVotesTrait | — |
| GovernorExecutionTrait | — |
| HasComponent | — |
| InternalTrait | — |
| InternalExtendedTrait | — |
| UnsafeNewContractStateTraitForGovernorImpl | — |
Modules
Modules
Errors
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Errors
Constants
| EXECUTOR_ONLY | — |
| PROPOSER_ONLY | — |
| NONEXISTENT_PROPOSAL | — |
| EXISTENT_PROPOSAL | — |
| RESTRICTED_PROPOSER | — |
| INSUFFICIENT_PROPOSER_VOTES | — |
| UNEXPECTED_PROPOSAL_STATE | — |
| QUEUE_NOT_IMPLEMENTED | — |
| INVALID_SIGNATURE | — |
Constants
Constants
| EXECUTOR_ONLY | — |
| PROPOSER_ONLY | — |
| NONEXISTENT_PROPOSAL | — |
| EXISTENT_PROPOSAL | — |
| RESTRICTED_PROPOSER | — |
| INSUFFICIENT_PROPOSER_VOTES | — |
| UNEXPECTED_PROPOSAL_STATE | — |
| QUEUE_NOT_IMPLEMENTED | — |
| INVALID_SIGNATURE | — |
EXECUTOR_ONLY
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Errors::EXECUTOR_ONLY
pub const EXECUTOR_ONLY: felt252 = 5504003985851522690581493869689;
PROPOSER_ONLY
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Errors::PROPOSER_ONLY
pub const PROPOSER_ONLY: felt252 = 6373669013987707420509201132665;
NONEXISTENT_PROPOSAL
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Errors::NONEXISTENT_PROPOSAL
pub const NONEXISTENT_PROPOSAL: felt252 = 447786279721322827064110475097525489609471123820;
EXISTENT_PROPOSAL
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Errors::EXISTENT_PROPOSAL
pub const EXISTENT_PROPOSAL: felt252 = 23639538209908052828444086322521472983404;
RESTRICTED_PROPOSER
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Errors::RESTRICTED_PROPOSER
pub const RESTRICTED_PROPOSER: felt252 = 1837498734415321675983055626448671942234039666;
INSUFFICIENT_PROPOSER_VOTES
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Errors::INSUFFICIENT_PROPOSER_VOTES
pub const INSUFFICIENT_PROPOSER_VOTES: felt252 = 6396781404174968618341064636014939040146803;
UNEXPECTED_PROPOSAL_STATE
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Errors::UNEXPECTED_PROPOSAL_STATE
pub const UNEXPECTED_PROPOSAL_STATE: felt252 =
536260558599490853407724593562672133152449371803561509352549;
QUEUE_NOT_IMPLEMENTED
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Errors::QUEUE_NOT_IMPLEMENTED
pub const QUEUE_NOT_IMPLEMENTED: felt252 = 119051847145803658975802206826363178663641491989860;
INVALID_SIGNATURE
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Errors::INVALID_SIGNATURE
pub const INVALID_SIGNATURE: felt252 = 24987442531777145766116412176803132961381;
__external_GovernorImpl
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::__external_GovernorImpl
__l1_handler_GovernorImpl
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::__l1_handler_GovernorImpl
__constructor_GovernorImpl
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::__constructor_GovernorImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| ProposalCreated | Emitted when call is scheduled as part of operation id . |
| ProposalQueued | Emitted when a proposal is queued. |
| ProposalExecuted | Emitted when a proposal is executed. |
| ProposalCanceled | Emitted when a proposal is canceled. |
| VoteCast | Emitted when a vote is cast without params. |
| VoteCastWithParams | Emitted when a vote is cast with params. NOTE: support values should be seen as buckets. Their interpretation depends on the voting module used. params… |
| ComponentState | — |
Storage
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Storage
[storage]
pub struct Storage {
pub Governor_proposals: Map<felt252, ProposalCore>,
pub Governor_nonces: Map<ContractAddress, felt252>,
}
Members
Governor_proposals
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Storage::Governor_proposals
pub Governor_proposals: Map<felt252, ProposalCore>
Governor_nonces
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Storage::Governor_nonces
pub Governor_nonces: Map<ContractAddress, felt252>
ProposalCreated
Emitted when call is scheduled as part of operation id.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ProposalCreated
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct ProposalCreated {
pub proposal_id: felt252,
pub proposer: ContractAddress,
pub calls: Span<Call>,
pub signatures: Span<Span<felt252>>,
pub vote_start: u64,
pub vote_end: u64,
pub description: ByteArray,
}
Members
proposal_id
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ProposalCreated::proposal_id
pub proposal_id: felt252
proposer
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ProposalCreated::proposer
pub proposer: ContractAddress
calls
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ProposalCreated::calls
pub calls: Span<Call>
signatures
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ProposalCreated::signatures
pub signatures: Span<Span<felt252>>
vote_start
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ProposalCreated::vote_start
pub vote_start: u64
vote_end
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ProposalCreated::vote_end
pub vote_end: u64
description
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ProposalCreated::description
pub description: ByteArray
ProposalQueued
Emitted when a proposal is queued.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ProposalQueued
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct ProposalQueued {
pub proposal_id: felt252,
pub eta_seconds: u64,
}
Members
proposal_id
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ProposalQueued::proposal_id
pub proposal_id: felt252
eta_seconds
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ProposalQueued::eta_seconds
pub eta_seconds: u64
ProposalExecuted
Emitted when a proposal is executed.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ProposalExecuted
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct ProposalExecuted {
pub proposal_id: felt252,
}
Members
proposal_id
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ProposalExecuted::proposal_id
pub proposal_id: felt252
ProposalCanceled
Emitted when a proposal is canceled.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ProposalCanceled
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct ProposalCanceled {
pub proposal_id: felt252,
}
Members
proposal_id
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ProposalCanceled::proposal_id
pub proposal_id: felt252
VoteCast
Emitted when a vote is cast without params.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::VoteCast
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct VoteCast {
pub voter: ContractAddress,
pub proposal_id: felt252,
pub support: u8,
pub weight: u256,
pub reason: ByteArray,
}
Members
voter
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::VoteCast::voter
pub voter: ContractAddress
proposal_id
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::VoteCast::proposal_id
pub proposal_id: felt252
support
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::VoteCast::support
pub support: u8
weight
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::VoteCast::weight
pub weight: u256
reason
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::VoteCast::reason
pub reason: ByteArray
VoteCastWithParams
Emitted when a vote is cast with params.
NOTE: support values should be seen as buckets. Their interpretation depends on the voting
module used. params are additional encoded parameters. Their interpretation also
depends on the voting module used.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::VoteCastWithParams
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct VoteCastWithParams {
pub voter: ContractAddress,
pub proposal_id: felt252,
pub support: u8,
pub weight: u256,
pub reason: ByteArray,
pub params: Span<felt252>,
}
Members
voter
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::VoteCastWithParams::voter
pub voter: ContractAddress
proposal_id
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::VoteCastWithParams::proposal_id
pub proposal_id: felt252
support
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::VoteCastWithParams::support
pub support: u8
weight
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::VoteCastWithParams::weight
pub weight: u256
reason
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::VoteCastWithParams::reason
pub reason: ByteArray
params
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::VoteCastWithParams::params
pub params: Span<felt252>
ComponentState
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Event
pub enum Event {
ProposalCreated: ProposalCreated,
ProposalQueued: ProposalQueued,
ProposalExecuted: ProposalExecuted,
ProposalCanceled: ProposalCanceled,
VoteCast: VoteCast,
VoteCastWithParams: VoteCastWithParams,
}
Variants
ProposalCreated
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Event::ProposalCreated
ProposalCreated: ProposalCreated
ProposalQueued
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Event::ProposalQueued
ProposalQueued: ProposalQueued
ProposalExecuted
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Event::ProposalExecuted
ProposalExecuted: ProposalExecuted
ProposalCanceled
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Event::ProposalCanceled
ProposalCanceled: ProposalCanceled
VoteCast
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Event::VoteCast
VoteCast: VoteCast
VoteCastWithParams
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::Event::VoteCastWithParams
VoteCastWithParams: VoteCastWithParams
Traits
Traits
| ImmutableConfig | Constants expected to be defined at the contract level used to configure the component behavior…. |
| GovernorSettingsTrait | — |
| GovernorQuorumTrait | — |
| GovernorCountingTrait | — |
| GovernorVotesTrait | — |
| GovernorExecutionTrait | — |
| HasComponent | — |
| InternalTrait | — |
| InternalExtendedTrait | — |
| UnsafeNewContractStateTraitForGovernorImpl | — |
ImmutableConfig
Constants expected to be defined at the contract level used to configure the component behavior.
DEFAULT_PARAMS: Default additional encoded parameters used by cast_vote methods that don’t include them.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ImmutableConfig
pub trait ImmutableConfig
Trait functions
DEFAULT_PARAMS
Defined as a function since constant Span is not supported.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::ImmutableConfig::DEFAULT_PARAMS
fn DEFAULT_PARAMS() -> Span<felt252>
GovernorSettingsTrait
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorSettingsTrait
pub trait GovernorSettingsTrait<TContractState>
Trait functions
voting_delay
See interface::IGovernor::voting_delay.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorSettingsTrait::voting_delay
fn voting_delay(self: @ComponentState<TContractState>) -> u64
voting_period
See interface::IGovernor::voting_period.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorSettingsTrait::voting_period
fn voting_period(self: @ComponentState<TContractState>) -> u64
proposal_threshold
See interface::IGovernor::proposal_threshold.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorSettingsTrait::proposal_threshold
fn proposal_threshold(self: @ComponentState<TContractState>) -> u256
GovernorQuorumTrait
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorQuorumTrait
pub trait GovernorQuorumTrait<TContractState>
Trait functions
quorum
See interface::IGovernor::quorum.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorQuorumTrait::quorum
fn quorum(self: @ComponentState<TContractState>, timepoint: u64) -> u256
GovernorCountingTrait
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorCountingTrait
pub trait GovernorCountingTrait<TContractState>
Trait functions
counting_mode
See interface::IGovernor::COUNTING_MODE.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorCountingTrait::counting_mode
fn counting_mode(self: @ComponentState<TContractState>) -> ByteArray
count_vote
Register a vote for proposal_id by account with a given support,
voting weight and voting params.
NOTE: Support is generic and can represent various things depending on the voting system used.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorCountingTrait::count_vote
fn count_vote(
ref self: ComponentState<TContractState>,
proposal_id: felt252,
account: ContractAddress,
support: u8,
total_weight: u256,
params: Span<felt252>,
) -> u256
has_voted
See interface::IGovernor::has_voted.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorCountingTrait::has_voted
fn has_voted(
self: @ComponentState<TContractState>, proposal_id: felt252, account: ContractAddress,
) -> bool
quorum_reached
Returns whether amount of votes already cast passes the threshold limit.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorCountingTrait::quorum_reached
fn quorum_reached(self: @ComponentState<TContractState>, proposal_id: felt252) -> bool
vote_succeeded
Returns whether the proposal is successful or not.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorCountingTrait::vote_succeeded
fn vote_succeeded(self: @ComponentState<TContractState>, proposal_id: felt252) -> bool
GovernorVotesTrait
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorVotesTrait
pub trait GovernorVotesTrait<TContractState>
Trait functions
clock
See ERC6372Clock::clock.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorVotesTrait::clock
fn clock(self: @ComponentState<TContractState>) -> u64
CLOCK_MODE
See ERC6372Clock::CLOCK_MODE.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorVotesTrait::CLOCK_MODE
fn CLOCK_MODE(self: @ComponentState<TContractState>) -> ByteArray
get_votes
See interface::IGovernor::get_votes.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorVotesTrait::get_votes
fn get_votes(
self: @ComponentState<TContractState>,
account: ContractAddress,
timepoint: u64,
params: Span<felt252>,
) -> u256
GovernorExecutionTrait
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorExecutionTrait
pub trait GovernorExecutionTrait<TContractState>
Trait functions
state
See interface::IGovernor::state.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorExecutionTrait::state
fn state(self: @ComponentState<TContractState>, proposal_id: felt252) -> ProposalState
executor
Address through which the governor executes action. Should be used to specify whether the module execute actions through another contract such as a timelock.
NOTE: MUST be the governor itself, or an instance of TimelockController with the governor as the only proposer, canceller, and executor.
WARNING: When the executor is not the governor itself (i.e. a timelock), it can call
functions that are restricted with the assert_only_governance guard, and also
potentially execute transactions on behalf of the governor. Because of this, this module
is designed to work with the TimelockController as the unique potential external
executor.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorExecutionTrait::executor
fn executor(self: @ComponentState<TContractState>) -> ContractAddress
execute_operations
Execution mechanism. Can be used to modify the way execution is performed (for example adding a vault/timelock).
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorExecutionTrait::execute_operations
fn execute_operations(
ref self: ComponentState<TContractState>,
proposal_id: felt252,
calls: Span<Call>,
description_hash: felt252,
)
queue_operations
Queuing mechanism. Can be used to modify the way queuing is performed (for example adding a vault/timelock).
Requirements:
- Must return a timestamp that describes the expected ETA for execution. If the returned
value is 0, the core will consider queueing did not succeed, and the public
queuefunction will revert.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorExecutionTrait::queue_operations
fn queue_operations(
ref self: ComponentState<TContractState>,
proposal_id: felt252,
calls: Span<Call>,
description_hash: felt252,
) -> u64
proposal_needs_queuing
See interface::IGovernor::proposal_needs_queuing.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorExecutionTrait::proposal_needs_queuing
fn proposal_needs_queuing(self: @ComponentState<TContractState>, proposal_id: felt252) -> bool
cancel_operations
Cancel mechanism. Can be used to modify the way canceling is performed (for example adding a vault/timelock).
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::GovernorExecutionTrait::cancel_operations
fn cancel_operations(
ref self: ComponentState<TContractState>, proposal_id: felt252, description_hash: felt252,
)
HasComponent
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::HasComponent::emit
fn emit<
S, impl IntoImp: Into<S, openzeppelin_governance::governor::governor::GovernorComponent::Event>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalTrait
pub trait InternalTrait<
TContractState,
+HasComponent<TContractState>,
impl SRC5: HasComponent<TContractState>,
+Drop<TContractState>,
>
Trait functions
initializer
Initializes the contract by registering the supported interface id.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalTrait::initializer
fn initializer(ref self: ComponentState<TContractState>)
get_proposal
Returns the proposal object given its id.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalTrait::get_proposal
fn get_proposal(self: @ComponentState<TContractState>, proposal_id: felt252) -> ProposalCore
is_valid_description_for_proposer
Checks if the proposer is authorized to submit a proposal with the given description.
If the proposal description ends with #proposer=0x???, where 0x??? is an address
written as a hex string (case insensitive), then the submission of this proposal will
only be authorized to said address.
This is used for frontrunning protection. By adding this pattern at the end of their proposal, one can ensure that no other address can submit the same proposal. An attacker would have to either remove or change that part, which would result in a different proposal id.
NOTE: In Starknet, the Sequencer ensures the order of transactions, but frontrunning can still be achieved by nodes, and potentially other actors in the future with sequencer decentralization.
If the description does not match this pattern, it is unrestricted and anyone can submit it. This includes:
- If the
0x???part is not a valid hex string. - If the
0x???part is a valid hex string, but does not contain exactly 64 hex digits. - If it ends with the expected suffix followed by newlines or other whitespace.
- If it ends with some other similar suffix, e.g.
#other=abc. - If it does not end with any such suffix.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalTrait::is_valid_description_for_proposer
fn is_valid_description_for_proposer(
self: @ComponentState<TContractState>, proposer: ContractAddress, description: @ByteArray,
) -> bool
_hash_proposal
Returns a hash of the proposal using the Pedersen hashing algorithm.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalTrait::_hash_proposal
fn _hash_proposal(
self: @ComponentState<TContractState>, calls: Span<Call>, description_hash: felt252,
) -> felt252
_proposal_snapshot
Timepoint used to retrieve user’s votes and quorum. If using block number, the snapshot is performed at the end of this block. Hence, voting for this proposal starts at the beginning of the following block.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalTrait::_proposal_snapshot
fn _proposal_snapshot(self: @ComponentState<TContractState>, proposal_id: felt252) -> u64
_proposal_deadline
Timepoint at which votes close. If using block number, votes close at the end of this block, so it is possible to cast a vote during this block.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalTrait::_proposal_deadline
fn _proposal_deadline(self: @ComponentState<TContractState>, proposal_id: felt252) -> u64
_proposal_proposer
The account that created a proposal.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalTrait::_proposal_proposer
fn _proposal_proposer(
self: @ComponentState<TContractState>, proposal_id: felt252,
) -> ContractAddress
_proposal_eta
The time when a queued proposal becomes executable (“ETA”). Unlike proposal_snapshot
and proposal_deadline, this doesn’t use the governor clock, and instead relies on the
executor’s clock which may be different. In most cases this will be a timestamp.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalTrait::_proposal_eta
fn _proposal_eta(self: @ComponentState<TContractState>, proposal_id: felt252) -> u64
InternalExtendedTrait
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalExtendedTrait
pub trait InternalExtendedTrait<TContractState, +HasComponent<TContractState>, impl HasComponent<TContractState>: HasComponent<TContractState>, +GovernorCountingTrait<TContractState>, +GovernorExecutionTrait<TContractState>, impl GovernorSettings: GovernorSettingsTrait<TContractState>, impl GovernorVotes: GovernorVotesTrait<TContractState>, +Drop<TContractState>>
Trait functions
assert_only_governance
Asserts that the caller is the governance executor.
WARNING: When the executor is not the governor itself (i.e. a timelock), it can call functions that are restricted with this modifier, and also potentially execute transactions on behalf of the governor. Because of this, this module is designed to work with the TimelockController as the unique potential external executor. The timelock MUST have the governor as the only proposer, canceller, and executor.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalExtendedTrait::assert_only_governance
fn assert_only_governance(self: @ComponentState<TContractState>)
validate_state
Validates that the proposal is in one of the expected states.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalExtendedTrait::validate_state
fn validate_state(
self: @ComponentState<TContractState>,
proposal_id: felt252,
allowed_states: Span<ProposalState>,
)
use_nonce
Consumes a nonce, returns the current value, and increments nonce.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalExtendedTrait::use_nonce
fn use_nonce(ref self: ComponentState<TContractState>, voter: ContractAddress) -> felt252
_get_votes
Internal wrapper for GovernorVotesTrait::get_votes.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalExtendedTrait::_get_votes
fn _get_votes(
self: @ComponentState<TContractState>,
account: ContractAddress,
timepoint: u64,
params: Span<felt252>,
) -> u256
_proposal_threshold
Internal wrapper for GovernorProposeTrait::proposal_threshold.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalExtendedTrait::_proposal_threshold
fn _proposal_threshold(self: @ComponentState<TContractState>) -> u256
_state
Returns the state of a proposal, given its id.
Requirements:
- The proposal must exist.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalExtendedTrait::_state
fn _state(self: @ComponentState<TContractState>, proposal_id: felt252) -> ProposalState
_propose
Internal propose mechanism. Returns the proposal id.
Requirements:
- The proposal must not already exist.
Emits a ProposalCreated event.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalExtendedTrait::_propose
fn _propose(
ref self: ComponentState<TContractState>,
calls: Span<Call>,
description: @ByteArray,
proposer: ContractAddress,
) -> felt252
_cancel
Internal cancel mechanism with minimal restrictions. A proposal can be cancelled in any state other than Canceled or Executed.
NOTE: Once cancelled, a proposal can’t be re-submitted.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalExtendedTrait::_cancel
fn _cancel(
ref self: ComponentState<TContractState>, proposal_id: felt252, description_hash: felt252,
)
_count_vote
Internal wrapper for GovernorCountingTrait::count_vote.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalExtendedTrait::_count_vote
fn _count_vote(
ref self: ComponentState<TContractState>,
proposal_id: felt252,
account: ContractAddress,
support: u8,
total_weight: u256,
params: Span<felt252>,
) -> u256
_cast_vote
Internal vote-casting mechanism.
Checks that the vote is pending and that it has not been cast yet.
This function retrieves the voting weight using get_votes and then calls
the _count_vote internal function.
Emits either:
VoteCastevent if no params are provided.VoteCastWithParamsevent otherwise.
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::InternalExtendedTrait::_cast_vote
fn _cast_vote(
ref self: ComponentState<TContractState>,
proposal_id: felt252,
voter: ContractAddress,
support: u8,
reason: ByteArray,
params: Span<felt252>,
) -> u256
UnsafeNewContractStateTraitForGovernorImpl
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::UnsafeNewContractStateTraitForGovernorImpl
pub trait UnsafeNewContractStateTraitForGovernorImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_governance::governor::governor::GovernorComponent::UnsafeNewContractStateTraitForGovernorImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
Impls
Impls
| DefaultConfig | Implementation of the default Governor ImmutableConfig. See https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-107.md#defaultconfig-implementation The DEFAULT_PARAMS… |
DefaultConfig
Implementation of the default Governor ImmutableConfig.
See https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-107.md#defaultconfig-implementation
The DEFAULT_PARAMS is set to an empty span of felts.
Fully qualified path: openzeppelin_governance::governor::governor::DefaultConfig
pub impl DefaultConfig of ImmutableConfig;
Impl functions
DEFAULT_PARAMS
Fully qualified path: openzeppelin_governance::governor::governor::DefaultConfig::DEFAULT_PARAMS
fn DEFAULT_PARAMS() -> Span<felt252>
proposal_core
Fully qualified path: openzeppelin_governance::governor::proposal_core
Structs
| ProposalCore | Proposal state. |
Structs
Structs
| ProposalCore | Proposal state. |
ProposalCore
Proposal state.
Fully qualified path: openzeppelin_governance::governor::proposal_core::ProposalCore
[derive(Copy, Drop, Serde, PartialEq, Debug)]
pub struct ProposalCore {
pub proposer: ContractAddress,
pub vote_start: u64,
pub vote_duration: u64,
pub executed: bool,
pub canceled: bool,
pub eta_seconds: u64,
}
Members
proposer
Fully qualified path: openzeppelin_governance::governor::proposal_core::ProposalCore::proposer
pub proposer: ContractAddress
vote_start
Fully qualified path: openzeppelin_governance::governor::proposal_core::ProposalCore::vote_start
pub vote_start: u64
vote_duration
Fully qualified path: openzeppelin_governance::governor::proposal_core::ProposalCore::vote_duration
pub vote_duration: u64
executed
Fully qualified path: openzeppelin_governance::governor::proposal_core::ProposalCore::executed
pub executed: bool
canceled
Fully qualified path: openzeppelin_governance::governor::proposal_core::ProposalCore::canceled
pub canceled: bool
eta_seconds
Fully qualified path: openzeppelin_governance::governor::proposal_core::ProposalCore::eta_seconds
pub eta_seconds: u64
vote
Fully qualified path: openzeppelin_governance::governor::vote
Constants
Structs
Constants
Constants
VOTE_TYPE_HASH
Fully qualified path: openzeppelin_governance::governor::vote::VOTE_TYPE_HASH
pub const VOTE_TYPE_HASH: felt252 =
725086074905528818286057064447115658319371078818069988727085961453449186177;
VOTE_WITH_REASON_AND_PARAMS_TYPE_HASH
Fully qualified path: openzeppelin_governance::governor::vote::VOTE_WITH_REASON_AND_PARAMS_TYPE_HASH
pub const VOTE_WITH_REASON_AND_PARAMS_TYPE_HASH: felt252 =
884836110813927721873221814866501037558610336142253565359524245175899322699;
Structs
Structs
Vote
Fully qualified path: openzeppelin_governance::governor::vote::Vote
[derive(Copy, Drop, Hash)]
pub struct Vote {
pub verifying_contract: ContractAddress,
pub nonce: felt252,
pub proposal_id: felt252,
pub support: u8,
pub voter: ContractAddress,
}
Members
verifying_contract
Fully qualified path: openzeppelin_governance::governor::vote::Vote::verifying_contract
pub verifying_contract: ContractAddress
nonce
Fully qualified path: openzeppelin_governance::governor::vote::Vote::nonce
pub nonce: felt252
proposal_id
Fully qualified path: openzeppelin_governance::governor::vote::Vote::proposal_id
pub proposal_id: felt252
support
Fully qualified path: openzeppelin_governance::governor::vote::Vote::support
pub support: u8
voter
Fully qualified path: openzeppelin_governance::governor::vote::Vote::voter
pub voter: ContractAddress
VoteWithReasonAndParams
Fully qualified path: openzeppelin_governance::governor::vote::VoteWithReasonAndParams
[derive(Copy, Drop)]
pub struct VoteWithReasonAndParams {
pub verifying_contract: ContractAddress,
pub nonce: felt252,
pub proposal_id: felt252,
pub support: u8,
pub voter: ContractAddress,
pub reason_hash: felt252,
pub params: Span<felt252>,
}
Members
verifying_contract
Fully qualified path: openzeppelin_governance::governor::vote::VoteWithReasonAndParams::verifying_contract
pub verifying_contract: ContractAddress
nonce
Fully qualified path: openzeppelin_governance::governor::vote::VoteWithReasonAndParams::nonce
pub nonce: felt252
proposal_id
Fully qualified path: openzeppelin_governance::governor::vote::VoteWithReasonAndParams::proposal_id
pub proposal_id: felt252
support
Fully qualified path: openzeppelin_governance::governor::vote::VoteWithReasonAndParams::support
pub support: u8
voter
Fully qualified path: openzeppelin_governance::governor::vote::VoteWithReasonAndParams::voter
pub voter: ContractAddress
reason_hash
Fully qualified path: openzeppelin_governance::governor::vote::VoteWithReasonAndParams::reason_hash
pub reason_hash: felt252
params
Fully qualified path: openzeppelin_governance::governor::vote::VoteWithReasonAndParams::params
pub params: Span<felt252>
multisig
Fully qualified path: openzeppelin_governance::multisig
Modules
Re-exports:
Modules
Modules
multisig
Fully qualified path: openzeppelin_governance::multisig::multisig
Modules
Modules
Modules
MultisigComponent
Multisig Component
Component that implements a multi-signature mechanism to enhance the security and governance of smart contract transactions. It requires multiple registered signers to collectively approve and execute transactions, ensuring that no single signer can perform critical actions unilaterally.
By default, this component is self-administered, meaning modifications to signers or quorum must be performed by the contract itself through the multisig approval process. Only registered signers can submit, confirm, revoke, or execute transactions. A common use case is to secure important operations by requiring multiple approvals, such as in fund management or protocol governance.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent
Modules
Free functions
Structs
| Storage | — |
| SignerAdded | Emitted when a new signer is added. |
| SignerRemoved | Emitted when a signer is removed. |
| QuorumUpdated | Emitted when the quorum value is updated. |
| TransactionSubmitted | Emitted when a new transaction is submitted by a signer . |
| TransactionConfirmed | Emitted when a transaction is confirmed by a signer . |
| ConfirmationRevoked | Emitted when a signer revokes his confirmation. |
| TransactionExecuted | Emitted when a transaction is executed. |
| CallSalt | Emitted when a new transaction is submitted with non-zero salt. |
| ComponentState | — |
Enums
Traits
Modules
Modules
Errors
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Errors
Constants
Constants
Constants
UNAUTHORIZED
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Errors::UNAUTHORIZED
pub const UNAUTHORIZED: felt252 = 28980735133710228569237587213461474776215379414508900;
NOT_A_SIGNER
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Errors::NOT_A_SIGNER
pub const NOT_A_SIGNER: felt252 = 28980735133710228569237585048363487446986659776587122;
ALREADY_A_SIGNER
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Errors::ALREADY_A_SIGNER
pub const ALREADY_A_SIGNER: felt252 =
124471309613323618845560282141163823132043530618172507669030258;
ALREADY_CONFIRMED
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Errors::ALREADY_CONFIRMED
pub const ALREADY_CONFIRMED: felt252 =
31864655261010846424463432228137938721803143880836789374926284132;
HAS_NOT_CONFIRMED
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Errors::HAS_NOT_CONFIRMED
pub const HAS_NOT_CONFIRMED: felt252 =
31864655261010846424463434595496793058698599549259553196380874084;
TX_ALREADY_EXISTS
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Errors::TX_ALREADY_EXISTS
pub const TX_ALREADY_EXISTS: felt252 =
31864655261010846424463438709027797572833375938559821179128083571;
TX_NOT_FOUND
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Errors::TX_NOT_FOUND
pub const TX_NOT_FOUND: felt252 = 28980735133710228569237586915758639845424376204062308;
TX_NOT_CONFIRMED
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Errors::TX_NOT_CONFIRMED
pub const TX_NOT_CONFIRMED: felt252 =
124471309613323618845560307457140865165540135695436916542236004;
TX_ALREADY_EXECUTED
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Errors::TX_ALREADY_EXECUTED
pub const TX_ALREADY_EXECUTED: felt252 =
2088282047185606831273635919234845741733208125509456440790871335789924;
ZERO_ADDRESS_SIGNER
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Errors::ZERO_ADDRESS_SIGNER
pub const ZERO_ADDRESS_SIGNER: felt252 =
2088282047185606831273636051412104868533519736479712600171427759285618;
ZERO_QUORUM
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Errors::ZERO_QUORUM
pub const ZERO_QUORUM: felt252 =
8157351746818776684662640047258508745439585914141865884190243102768;
QUORUM_TOO_HIGH
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Errors::QUORUM_TOO_HIGH
pub const QUORUM_TOO_HIGH: felt252 =
124471309613323618845560303455482616354973463089364470377837171;
__external_MultisigImpl
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::__external_MultisigImpl
__l1_handler_MultisigImpl
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::__l1_handler_MultisigImpl
__constructor_MultisigImpl
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::__constructor_MultisigImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| SignerAdded | Emitted when a new signer is added. |
| SignerRemoved | Emitted when a signer is removed. |
| QuorumUpdated | Emitted when the quorum value is updated. |
| TransactionSubmitted | Emitted when a new transaction is submitted by a signer . |
| TransactionConfirmed | Emitted when a transaction is confirmed by a signer . |
| ConfirmationRevoked | Emitted when a signer revokes his confirmation. |
| TransactionExecuted | Emitted when a transaction is executed. |
| CallSalt | Emitted when a new transaction is submitted with non-zero salt. |
| ComponentState | — |
Storage
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Storage
[storage]
pub struct Storage {
pub Multisig_signers_info: SignersInfo,
pub Multisig_is_signer: Map<ContractAddress, bool>,
pub Multisig_signers_by_index: Map<u32, ContractAddress>,
pub Multisig_signers_indices: Map<ContractAddress, u32>,
pub Multisig_tx_info: Map<felt252, TxInfo>,
pub Multisig_tx_confirmed_by: Map<(felt252, ContractAddress), bool>,
}
Members
Multisig_signers_info
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Storage::Multisig_signers_info
pub Multisig_signers_info: SignersInfo
Multisig_is_signer
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Storage::Multisig_is_signer
pub Multisig_is_signer: Map<ContractAddress, bool>
Multisig_signers_by_index
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Storage::Multisig_signers_by_index
pub Multisig_signers_by_index: Map<u32, ContractAddress>
Multisig_signers_indices
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Storage::Multisig_signers_indices
pub Multisig_signers_indices: Map<ContractAddress, u32>
Multisig_tx_info
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Storage::Multisig_tx_info
pub Multisig_tx_info: Map<felt252, TxInfo>
Multisig_tx_confirmed_by
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Storage::Multisig_tx_confirmed_by
pub Multisig_tx_confirmed_by: Map<(felt252, ContractAddress), bool>
SignerAdded
Emitted when a new signer is added.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::SignerAdded
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct SignerAdded {
pub signer: ContractAddress,
}
Members
signer
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::SignerAdded::signer
pub signer: ContractAddress
SignerRemoved
Emitted when a signer is removed.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::SignerRemoved
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct SignerRemoved {
pub signer: ContractAddress,
}
Members
signer
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::SignerRemoved::signer
pub signer: ContractAddress
QuorumUpdated
Emitted when the quorum value is updated.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::QuorumUpdated
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct QuorumUpdated {
pub old_quorum: u32,
pub new_quorum: u32,
}
Members
old_quorum
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::QuorumUpdated::old_quorum
pub old_quorum: u32
new_quorum
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::QuorumUpdated::new_quorum
pub new_quorum: u32
TransactionSubmitted
Emitted when a new transaction is submitted by a signer.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::TransactionSubmitted
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct TransactionSubmitted {
pub id: felt252,
pub signer: ContractAddress,
}
Members
id
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::TransactionSubmitted::id
pub id: felt252
signer
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::TransactionSubmitted::signer
pub signer: ContractAddress
TransactionConfirmed
Emitted when a transaction is confirmed by a signer.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::TransactionConfirmed
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct TransactionConfirmed {
pub id: felt252,
pub signer: ContractAddress,
}
Members
id
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::TransactionConfirmed::id
pub id: felt252
signer
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::TransactionConfirmed::signer
pub signer: ContractAddress
ConfirmationRevoked
Emitted when a signer revokes his confirmation.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::ConfirmationRevoked
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct ConfirmationRevoked {
pub id: felt252,
pub signer: ContractAddress,
}
Members
id
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::ConfirmationRevoked::id
pub id: felt252
signer
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::ConfirmationRevoked::signer
pub signer: ContractAddress
TransactionExecuted
Emitted when a transaction is executed.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::TransactionExecuted
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct TransactionExecuted {
pub id: felt252,
}
Members
id
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::TransactionExecuted::id
pub id: felt252
CallSalt
Emitted when a new transaction is submitted with non-zero salt.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::CallSalt
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct CallSalt {
pub id: felt252,
pub salt: felt252,
}
Members
id
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::CallSalt::id
pub id: felt252
salt
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::CallSalt::salt
pub salt: felt252
ComponentState
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Event
pub enum Event {
SignerAdded: SignerAdded,
SignerRemoved: SignerRemoved,
QuorumUpdated: QuorumUpdated,
TransactionSubmitted: TransactionSubmitted,
TransactionConfirmed: TransactionConfirmed,
TransactionExecuted: TransactionExecuted,
ConfirmationRevoked: ConfirmationRevoked,
CallSalt: CallSalt,
}
Variants
SignerAdded
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Event::SignerAdded
SignerAdded: SignerAdded
SignerRemoved
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Event::SignerRemoved
SignerRemoved: SignerRemoved
QuorumUpdated
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Event::QuorumUpdated
QuorumUpdated: QuorumUpdated
TransactionSubmitted
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Event::TransactionSubmitted
TransactionSubmitted: TransactionSubmitted
TransactionConfirmed
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Event::TransactionConfirmed
TransactionConfirmed: TransactionConfirmed
TransactionExecuted
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Event::TransactionExecuted
TransactionExecuted: TransactionExecuted
ConfirmationRevoked
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Event::ConfirmationRevoked
ConfirmationRevoked: ConfirmationRevoked
CallSalt
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::Event::CallSalt
CallSalt: CallSalt
Traits
Traits
HasComponent
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::HasComponent::emit
fn emit<
S, impl IntoImp: Into<S, openzeppelin_governance::multisig::multisig::MultisigComponent::Event>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::InternalTrait
pub trait InternalTrait<TContractState, +HasComponent<TContractState>, +Drop<TContractState>>
Trait functions
initializer
Initializes the Multisig component with the initial quorum and signers.
This function must be called during contract initialization to set up the initial state.
Requirements:
quorummust be non-zero and less than or equal to the number ofsigners.
Emits a SignerAdded event for each signer added.
Emits a QuorumUpdated event.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::InternalTrait::initializer
fn initializer(
ref self: ComponentState<TContractState>, quorum: u32, signers: Span<ContractAddress>,
)
resolve_tx_state
Resolves and returns the current state of the transaction with the given id.
The possible states are:
NotFound: the transaction does not exist.Pending: the transaction exists but hasn’t reached the required confirmations.Confirmed: the transaction has reached the required confirmations but hasn’t been executed.Executed: the transaction has been executed.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::InternalTrait::resolve_tx_state
fn resolve_tx_state(self: @ComponentState<TContractState>, id: felt252) -> TransactionState
assert_one_of_signers
Asserts that the caller is one of the registered signers.
Requirements:
- The
callermust be a registered signer.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::InternalTrait::assert_one_of_signers
fn assert_one_of_signers(self: @ComponentState<TContractState>, caller: ContractAddress)
assert_tx_exists
Asserts that a transaction with the given id exists.
Requirements:
- The transaction with the given
idmust have been submitted.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::InternalTrait::assert_tx_exists
fn assert_tx_exists(self: @ComponentState<TContractState>, id: felt252)
assert_only_self
Asserts that the caller is the contract itself.
Requirements:
- The caller must be the contract’s own address.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::InternalTrait::assert_only_self
fn assert_only_self(self: @ComponentState<TContractState>)
_add_signers
Adds new signers and updates the quorum.
Requirements:
- Each signer address must be non-zero.
new_quorummust be non-zero and less than or equal to the total number of signers after addition.
Emits a SignerAdded event for each new signer added.
Emits a QuorumUpdated event if the quorum changes.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::InternalTrait::_add_signers
fn _add_signers(
ref self: ComponentState<TContractState>,
new_quorum: u32,
signers_to_add: Span<ContractAddress>,
)
_remove_signers
Removes existing signers and updates the quorum.
Requirements:
new_quorummust be non-zero and less than or equal to the total number of signers after removal.
Emits a SignerRemoved event for each signer removed.
Emits a QuorumUpdated event if the quorum changes.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::InternalTrait::_remove_signers
fn _remove_signers(
ref self: ComponentState<TContractState>,
new_quorum: u32,
signers_to_remove: Span<ContractAddress>,
)
_replace_signer
Replaces an existing signer with a new signer.
Requirements:
signer_to_removemust be an existing signer.signer_to_addmust not be an existing signer.signer_to_addmust be a non-zero address.
Emits a SignerRemoved event for the removed signer.
Emits a SignerAdded event for the new signer.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::InternalTrait::_replace_signer
fn _replace_signer(
ref self: ComponentState<TContractState>,
signer_to_remove: ContractAddress,
signer_to_add: ContractAddress,
)
_change_quorum
Updates the quorum value to new_quorum if it differs from the current quorum.
Requirements:
new_quorummust be non-zero.new_quorummust be less than or equal to the total number of signers.
Emits a QuorumUpdated event if the quorum changes.
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::InternalTrait::_change_quorum
fn _change_quorum(ref self: ComponentState<TContractState>, new_quorum: u32)
UnsafeNewContractStateTraitForMultisigImpl
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::UnsafeNewContractStateTraitForMultisigImpl
pub trait UnsafeNewContractStateTraitForMultisigImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_governance::multisig::multisig::MultisigComponent::UnsafeNewContractStateTraitForMultisigImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
storage_utils
Fully qualified path: openzeppelin_governance::multisig::storage_utils
Structs
| TxInfo | Helper struct for MultisigComponent that optimizes how transaction-related information is stored, including the transaction’s execution status and the block it was submitted in. |
| SignersInfo | Helper struct for MultisigComponent that optimizes how the quorum value and the total number of signers are stored. |
Impls
| TxInfoStorePacking | Packs a TxInfo entity into a u128 value. The packing is done as follows:… |
| SignersInfoStorePackingV2 | Packs a SignersInfo entity into a u128 value. The packing is done as follows:… |
Structs
Structs
| TxInfo | Helper struct for MultisigComponent that optimizes how transaction-related information is stored, including the transaction’s execution status and the block it was submitted in. |
| SignersInfo | Helper struct for MultisigComponent that optimizes how the quorum value and the total number of signers are stored. |
TxInfo
Helper struct for MultisigComponent that optimizes how transaction-related information
is stored, including the transaction’s execution status and the block it was submitted in.
Fully qualified path: openzeppelin_governance::multisig::storage_utils::TxInfo
[derive(Drop)]
pub struct TxInfo {
pub is_executed: bool,
pub submitted_block: u64,
}
Members
is_executed
Fully qualified path: openzeppelin_governance::multisig::storage_utils::TxInfo::is_executed
pub is_executed: bool
submitted_block
Fully qualified path: openzeppelin_governance::multisig::storage_utils::TxInfo::submitted_block
pub submitted_block: u64
SignersInfo
Helper struct for MultisigComponent that optimizes how the quorum
value and the total number of signers are stored.
Fully qualified path: openzeppelin_governance::multisig::storage_utils::SignersInfo
[derive(Drop)]
pub struct SignersInfo {
pub quorum: u32,
pub signers_count: u32,
}
Members
quorum
Fully qualified path: openzeppelin_governance::multisig::storage_utils::SignersInfo::quorum
pub quorum: u32
signers_count
Fully qualified path: openzeppelin_governance::multisig::storage_utils::SignersInfo::signers_count
pub signers_count: u32
Impls
Impls
| TxInfoStorePacking | Packs a TxInfo entity into a u128 value. The packing is done as follows:… |
| SignersInfoStorePackingV2 | Packs a SignersInfo entity into a u128 value. The packing is done as follows:… |
TxInfoStorePacking
Packs a TxInfo entity into a u128 value.
The packing is done as follows:
- The boolean
is_executedis stored as a single bit at the highest bit position (index 127). - The
submitted_blockvalue occupies 64 bits in the range 63..126.
Fully qualified path: openzeppelin_governance::multisig::storage_utils::TxInfoStorePacking
pub impl TxInfoStorePacking of StorePacking<TxInfo, u128>;
Impl functions
pack
Fully qualified path: openzeppelin_governance::multisig::storage_utils::TxInfoStorePacking::pack
fn pack(value: TxInfo) -> u128
unpack
Fully qualified path: openzeppelin_governance::multisig::storage_utils::TxInfoStorePacking::unpack
fn unpack(value: u128) -> TxInfo
SignersInfoStorePackingV2
Packs a SignersInfo entity into a u128 value.
The packing is done as follows:
quorumvalue occupies 32 bits in bit range 64..95.signers_countvalue occupies the highest 32 bits in bit range 96..127.- The 63rd bit indicates the packing version: 0 for V1 (legacy) and 1 for V2 (current).
WARNING: A bug in the original StorePacking trait for SignersInfo multiplied the quorum
value by 0xffffffff instead of 0x100000000. This affected only the case where signers_count
was 0xffffffff, resulting in an off-by-one quorum value and a signers_count of 0 after
unpacking. The issue is resolved in V2 of StorePacking. For backward compatibility, V2 can
still correctly unpack values from both V1 and V2 by checking the 63rd bit (0 for V1, 1 for V2).
Fully qualified path: openzeppelin_governance::multisig::storage_utils::SignersInfoStorePackingV2
pub impl SignersInfoStorePackingV2 of StorePacking<SignersInfo, u128>;
Impl functions
pack
Fully qualified path: openzeppelin_governance::multisig::storage_utils::SignersInfoStorePackingV2::pack
fn pack(value: SignersInfo) -> u128
unpack
Fully qualified path: openzeppelin_governance::multisig::storage_utils::SignersInfoStorePackingV2::unpack
fn unpack(value: u128) -> SignersInfo
timelock
Fully qualified path: openzeppelin_governance::timelock
Modules
Re-exports:
Modules
Modules
timelock_controller
Fully qualified path: openzeppelin_governance::timelock::timelock_controller
Modules
Modules
Modules
TimelockControllerComponent
TimelockController Component
Component that acts as a timelocked controller. When set as the owner of an Ownable smart
contract, it enforces a timelock on all only_owner maintenance operations. This gives time for
users of the controlled contract to exit before a potentially dangerous maintenance operation is
applied.
By default, this component is self administered, meaning administration tasks have to go through the timelock process. The proposer role is in charge of proposing operations. A common use case is to position the timelock controller as the owner of a smart contract, with a multi-sig or a DAO as the sole proposer.
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent
Modules
| Errors | — |
| __external_TimelockImpl | — |
| __l1_handler_TimelockImpl | — |
| __constructor_TimelockImpl | — |
| __external_TimelockMixinImpl | — |
| __l1_handler_TimelockMixinImpl | — |
| __constructor_TimelockMixinImpl | — |
Constants
Free functions
Structs
| Storage | — |
| CallScheduled | Emitted when call is scheduled as part of operation id . |
| CallExecuted | Emitted when call is performed as part of operation id . |
| CallSalt | Emitted when a new proposal is scheduled with non-zero salt. |
| CallCancelled | Emitted when operation id is cancelled. |
| MinDelayChanged | Emitted when the minimum delay for future operations is modified. |
| ComponentState | — |
Enums
Traits
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForTimelockImpl | — |
| UnsafeNewContractStateTraitForTimelockMixinImpl | — |
Modules
Modules
| Errors | — |
| __external_TimelockImpl | — |
| __l1_handler_TimelockImpl | — |
| __constructor_TimelockImpl | — |
| __external_TimelockMixinImpl | — |
| __l1_handler_TimelockMixinImpl | — |
| __constructor_TimelockMixinImpl | — |
Errors
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Errors
Constants
| INVALID_OPERATION_LEN | — |
| INSUFFICIENT_DELAY | — |
| EXPECTED_UNSET_OPERATION | — |
| EXPECTED_PENDING_OPERATION | — |
| EXPECTED_READY_OPERATION | — |
| UNEXECUTED_PREDECESSOR | — |
| UNAUTHORIZED_CALLER | — |
Constants
Constants
| INVALID_OPERATION_LEN | — |
| INSUFFICIENT_DELAY | — |
| EXPECTED_UNSET_OPERATION | — |
| EXPECTED_PENDING_OPERATION | — |
| EXPECTED_READY_OPERATION | — |
| UNEXECUTED_PREDECESSOR | — |
| UNAUTHORIZED_CALLER | — |
INVALID_OPERATION_LEN
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Errors::INVALID_OPERATION_LEN
pub const INVALID_OPERATION_LEN: felt252 =
149142786123133088059548017970228936285844585618085628618567453910126847342;
INSUFFICIENT_DELAY
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Errors::INSUFFICIENT_DELAY
pub const INSUFFICIENT_DELAY: felt252 =
8889602787681406024667502520690189257282797298883326216109860610425;
EXPECTED_UNSET_OPERATION
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Errors::EXPECTED_UNSET_OPERATION
pub const EXPECTED_UNSET_OPERATION: felt252 =
34725010889380492283857430373592962417870439180718862108563894128;
EXPECTED_PENDING_OPERATION
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Errors::EXPECTED_PENDING_OPERATION
pub const EXPECTED_PENDING_OPERATION: felt252 =
2275738313646439942314880556963788385017557102123813133454626827300720;
EXPECTED_READY_OPERATION
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Errors::EXPECTED_READY_OPERATION
pub const EXPECTED_READY_OPERATION: felt252 =
34725010889380492283857430373592962417870439180500136256239333232;
UNEXECUTED_PREDECESSOR
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Errors::UNEXECUTED_PREDECESSOR
pub const UNEXECUTED_PREDECESSOR: felt252 =
582589008293488625232609399723160697451040620433093421953529306198273906;
UNAUTHORIZED_CALLER
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Errors::UNAUTHORIZED_CALLER
pub const UNAUTHORIZED_CALLER: felt252 =
2275738313646439942314880912899505822360497764644535609168103673193842;
__external_TimelockImpl
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::__external_TimelockImpl
__l1_handler_TimelockImpl
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::__l1_handler_TimelockImpl
__constructor_TimelockImpl
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::__constructor_TimelockImpl
__external_TimelockMixinImpl
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::__external_TimelockMixinImpl
__l1_handler_TimelockMixinImpl
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::__l1_handler_TimelockMixinImpl
__constructor_TimelockMixinImpl
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::__constructor_TimelockMixinImpl
Constants
Constants
PROPOSER_ROLE
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::PROPOSER_ROLE
pub const PROPOSER_ROLE: felt252 =
273237946050858345628590045737694107205410417995850951630048913656897445057;
EXECUTOR_ROLE
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::EXECUTOR_ROLE
pub const EXECUTOR_ROLE: felt252 =
300468863893292893306738894280854375441360493536472852170483816561360936547;
CANCELLER_ROLE
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::CANCELLER_ROLE
pub const CANCELLER_ROLE: felt252 =
629414745181218075209380536283997517164293846052958011745239685582828271491;
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| CallScheduled | Emitted when call is scheduled as part of operation id . |
| CallExecuted | Emitted when call is performed as part of operation id . |
| CallSalt | Emitted when a new proposal is scheduled with non-zero salt. |
| CallCancelled | Emitted when operation id is cancelled. |
| MinDelayChanged | Emitted when the minimum delay for future operations is modified. |
| ComponentState | — |
Storage
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Storage
[storage]
pub struct Storage {
pub TimelockController_timestamps: Map<felt252, u64>,
pub TimelockController_min_delay: u64,
}
Members
TimelockController_timestamps
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Storage::TimelockController_timestamps
pub TimelockController_timestamps: Map<felt252, u64>
TimelockController_min_delay
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Storage::TimelockController_min_delay
pub TimelockController_min_delay: u64
CallScheduled
Emitted when call is scheduled as part of operation id.
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::CallScheduled
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct CallScheduled {
pub id: felt252,
pub index: felt252,
pub call: Call,
pub predecessor: felt252,
pub delay: u64,
}
Members
id
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::CallScheduled::id
pub id: felt252
index
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::CallScheduled::index
pub index: felt252
call
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::CallScheduled::call
pub call: Call
predecessor
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::CallScheduled::predecessor
pub predecessor: felt252
delay
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::CallScheduled::delay
pub delay: u64
CallExecuted
Emitted when call is performed as part of operation id.
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::CallExecuted
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct CallExecuted {
pub id: felt252,
pub index: felt252,
pub call: Call,
}
Members
id
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::CallExecuted::id
pub id: felt252
index
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::CallExecuted::index
pub index: felt252
call
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::CallExecuted::call
pub call: Call
CallSalt
Emitted when a new proposal is scheduled with non-zero salt.
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::CallSalt
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct CallSalt {
pub id: felt252,
pub salt: felt252,
}
Members
id
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::CallSalt::id
pub id: felt252
salt
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::CallSalt::salt
pub salt: felt252
CallCancelled
Emitted when operation id is cancelled.
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::CallCancelled
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct CallCancelled {
pub id: felt252,
}
Members
id
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::CallCancelled::id
pub id: felt252
MinDelayChanged
Emitted when the minimum delay for future operations is modified.
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::MinDelayChanged
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct MinDelayChanged {
pub old_duration: u64,
pub new_duration: u64,
}
Members
old_duration
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::MinDelayChanged::old_duration
pub old_duration: u64
new_duration
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::MinDelayChanged::new_duration
pub new_duration: u64
ComponentState
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Event
pub enum Event {
CallScheduled: CallScheduled,
CallExecuted: CallExecuted,
CallSalt: CallSalt,
CallCancelled: CallCancelled,
MinDelayChanged: MinDelayChanged,
}
Variants
CallScheduled
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Event::CallScheduled
CallScheduled: CallScheduled
CallExecuted
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Event::CallExecuted
CallExecuted: CallExecuted
CallSalt
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Event::CallSalt
CallSalt: CallSalt
CallCancelled
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Event::CallCancelled
CallCancelled: CallCancelled
MinDelayChanged
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Event::MinDelayChanged
MinDelayChanged: MinDelayChanged
Traits
Traits
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForTimelockImpl | — |
| UnsafeNewContractStateTraitForTimelockMixinImpl | — |
HasComponent
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::HasComponent::emit
fn emit<
S,
impl IntoImp: Into<
S,
openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::Event,
>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::InternalTrait
pub trait InternalTrait<
TContractState,
+HasComponent<TContractState>,
impl SRC5: HasComponent<TContractState>,
impl AccessControl: HasComponent<TContractState>,
+Drop<TContractState>,
>
Trait functions
initializer
Initializes the contract by registering support for SRC5 and AccessControl.
This function also configures the contract with the following parameters:
min_delay: initial minimum delay in seconds for operations.proposers: accounts to be granted proposer and canceller roles.executors: accounts to be granted executor role.admin: optional account to be granted admin role; disable with zero address.
WARNING: The optional admin can aid with initial configuration of roles after deployment without being subject to delay, but this role should be subsequently renounced in favor of administration through timelocked proposals.
Emits two RoleGranted events for each account in proposers with PROPOSER_ROLE
and CANCELLER_ROLE roles.
Emits a RoleGranted event for each account in executors with EXECUTOR_ROLE role.
May emit a RoleGranted event for admin with DEFAULT_ADMIN_ROLE role (if admin is
not zero).
Emits MinDelayChanged event.
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::InternalTrait::initializer
fn initializer(
ref self: ComponentState<TContractState>,
min_delay: u64,
proposers: Span<ContractAddress>,
executors: Span<ContractAddress>,
admin: ContractAddress,
)
assert_only_role
Validates that the caller has the given role.
Otherwise it panics.
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::InternalTrait::assert_only_role
fn assert_only_role(self: @ComponentState<TContractState>, role: felt252)
assert_only_role_or_open_role
Validates that the caller has the given role.
If role is granted to the zero address, then this is considered an open role which
allows anyone to be the caller.
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::InternalTrait::assert_only_role_or_open_role
fn assert_only_role_or_open_role(self: @ComponentState<TContractState>, role: felt252)
assert_only_self
Validates that the caller is the timelock contract itself. Otherwise it panics.
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::InternalTrait::assert_only_self
fn assert_only_self(self: @ComponentState<TContractState>)
_before_call
Private function that checks before execution of an operation’s calls.
Requirements:
idmust be in theReadyOperationState.predecessormust either be zero or be in theDoneOperationState.
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::InternalTrait::_before_call
fn _before_call(self: @ComponentState<TContractState>, id: felt252, predecessor: felt252)
_after_call
Private function that checks after execution of an operation’s calls
and sets the OperationState of id to Done.
Requirements:
idmust be in theReadyOperationState.
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::InternalTrait::_after_call
fn _after_call(ref self: ComponentState<TContractState>, id: felt252)
_schedule
Private function that schedules an operation that is to become valid after a given
delay.
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::InternalTrait::_schedule
fn _schedule(ref self: ComponentState<TContractState>, id: felt252, delay: u64)
_execute
Private function that executes an operation’s calls.
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::InternalTrait::_execute
fn _execute(ref self: ComponentState<TContractState>, call: Call)
UnsafeNewContractStateTraitForTimelockImpl
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::UnsafeNewContractStateTraitForTimelockImpl
pub trait UnsafeNewContractStateTraitForTimelockImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::UnsafeNewContractStateTraitForTimelockImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForTimelockMixinImpl
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::UnsafeNewContractStateTraitForTimelockMixinImpl
pub trait UnsafeNewContractStateTraitForTimelockMixinImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_governance::timelock::timelock_controller::TimelockControllerComponent::UnsafeNewContractStateTraitForTimelockMixinImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
utils
Fully qualified path: openzeppelin_governance::utils
Modules
Modules
Modules
call_impls
Fully qualified path: openzeppelin_governance::utils::call_impls
Impls
Impls
Impls
HashCallImpl
Fully qualified path: openzeppelin_governance::utils::call_impls::HashCallImpl
pub impl HashCallImpl<S, +HashStateTrait<S>, +Drop<S>> of Hash<Call, S, + HashStateTrait<S>>;
Impl functions
update_state
Fully qualified path: openzeppelin_governance::utils::call_impls::HashCallImpl::update_state
fn update_state(mut state: S, value: Call) -> S
HashCallsImpl
Fully qualified path: openzeppelin_governance::utils::call_impls::HashCallsImpl
pub impl HashCallsImpl<S, +HashStateTrait<S>, +Drop<S>> of Hash<Span<Call>, S, + HashStateTrait<S>>;
Impl functions
update_state
Fully qualified path: openzeppelin_governance::utils::call_impls::HashCallsImpl::update_state
fn update_state(mut state: S, value: Span<Call>) -> S
CallPartialEq
Fully qualified path: openzeppelin_governance::utils::call_impls::CallPartialEq
pub impl CallPartialEq of PartialEq<Call>;
Impl functions
eq
Fully qualified path: openzeppelin_governance::utils::call_impls::CallPartialEq::eq
fn eq(lhs: @Call, rhs: @Call) -> bool
ne
Fully qualified path: openzeppelin_governance::utils::call_impls::CallPartialEq::ne
fn ne(lhs: @Call, rhs: @Call) -> bool
votes
Fully qualified path: openzeppelin_governance::votes
Modules
Re-exports:
Modules
Modules
delegation
Fully qualified path: openzeppelin_governance::votes::delegation
Constants
Structs
Constants
Constants
DELEGATION_TYPE_HASH
Fully qualified path: openzeppelin_governance::votes::delegation::DELEGATION_TYPE_HASH
pub const DELEGATION_TYPE_HASH: felt252 =
1166593738448701488539025986910998635615644239754284995914066903868502076751;
Structs
Structs
Delegation
Fully qualified path: openzeppelin_governance::votes::delegation::Delegation
[derive(Copy, Drop, Hash)]
pub struct Delegation {
pub verifying_contract: ContractAddress,
pub delegatee: ContractAddress,
pub nonce: felt252,
pub expiry: u64,
}
Members
verifying_contract
Fully qualified path: openzeppelin_governance::votes::delegation::Delegation::verifying_contract
pub verifying_contract: ContractAddress
delegatee
Fully qualified path: openzeppelin_governance::votes::delegation::Delegation::delegatee
pub delegatee: ContractAddress
nonce
Fully qualified path: openzeppelin_governance::votes::delegation::Delegation::nonce
pub nonce: felt252
expiry
Fully qualified path: openzeppelin_governance::votes::delegation::Delegation::expiry
pub expiry: u64
votes
Fully qualified path: openzeppelin_governance::votes::votes
Modules
Modules
Modules
VotesComponent
Votes Component
The Votes component provides a flexible system for tracking and delegating voting power. It is currently implemented for ERC20 and ERC721 tokens. An account can delegate their voting power to a representative, that will pool delegated voting units from different delegators and can then use it to vote in decisions. Voting power must be delegated to be counted, and an account must delegate to itself if it wishes to vote directly without a trusted representative.
When integrating the Votes component, the ´VotingUnitsTrait´ must be implemented to get the voting units for a given account as a function of the implementing contract. For simplicity, this module already provides two implementations for ERC20 and ERC721 tokens, which will work out of the box if the respective components are integrated.
NOTE: ERC20 and ERC721 tokens implementing this component must call ´transfer_voting_units´ whenever a transfer, mint, or burn operation is performed. Hooks can be leveraged for this purpose, as shown in the following ERC20 example:
See the documentation (https://docs.openzeppelin.com/contracts-cairo/3.0.0/governance.html#usage_2) for examples and more details.
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent
Modules
Free functions
Structs
| Storage | — |
| DelegateChanged | Emitted when delegator delegates their votes from from_delegate to to_delegate . |
| DelegateVotesChanged | Emitted when delegate votes are updated from previous_votes to new_votes . |
| ComponentState | — |
Enums
Traits
| VotingUnitsTrait | A trait that must be implemented when integrating {VotesComponent} into a contract. It offers a mechanism to retrieve the number of voting units for a given account at the current time. |
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForVotesImpl | — |
Modules
Modules
Errors
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::Errors
Constants
Constants
Constants
FUTURE_LOOKUP
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::Errors::FUTURE_LOOKUP
pub const FUTURE_LOOKUP: felt252 = 493458728554737271343947431258143419428107941232;
EXPIRED_SIGNATURE
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::Errors::EXPIRED_SIGNATURE
pub const EXPIRED_SIGNATURE: felt252 = 2119389101068337925958216489287083020391074280737212822117;
INVALID_SIGNATURE
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::Errors::INVALID_SIGNATURE
pub const INVALID_SIGNATURE: felt252 = 2119389101068337927306084668060731060221641785975082676837;
__external_VotesImpl
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::__external_VotesImpl
__l1_handler_VotesImpl
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::__l1_handler_VotesImpl
__constructor_VotesImpl
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::__constructor_VotesImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| DelegateChanged | Emitted when delegator delegates their votes from from_delegate to to_delegate . |
| DelegateVotesChanged | Emitted when delegate votes are updated from previous_votes to new_votes . |
| ComponentState | — |
Storage
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::Storage
[storage]
pub struct Storage {
pub Votes_delegatee: Map<ContractAddress, ContractAddress>,
pub Votes_delegate_checkpoints: Map<ContractAddress, Trace>,
pub Votes_total_checkpoints: Trace,
}
Members
Votes_delegatee
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::Storage::Votes_delegatee
pub Votes_delegatee: Map<ContractAddress, ContractAddress>
Votes_delegate_checkpoints
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::Storage::Votes_delegate_checkpoints
pub Votes_delegate_checkpoints: Map<ContractAddress, Trace>
Votes_total_checkpoints
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::Storage::Votes_total_checkpoints
pub Votes_total_checkpoints: Trace
DelegateChanged
Emitted when delegator delegates their votes from from_delegate to to_delegate.
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::DelegateChanged
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct DelegateChanged {
pub delegator: ContractAddress,
pub from_delegate: ContractAddress,
pub to_delegate: ContractAddress,
}
Members
delegator
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::DelegateChanged::delegator
pub delegator: ContractAddress
from_delegate
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::DelegateChanged::from_delegate
pub from_delegate: ContractAddress
to_delegate
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::DelegateChanged::to_delegate
pub to_delegate: ContractAddress
DelegateVotesChanged
Emitted when delegate votes are updated from previous_votes to new_votes.
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::DelegateVotesChanged
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct DelegateVotesChanged {
pub delegate: ContractAddress,
pub previous_votes: u256,
pub new_votes: u256,
}
Members
delegate
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::DelegateVotesChanged::delegate
pub delegate: ContractAddress
previous_votes
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::DelegateVotesChanged::previous_votes
pub previous_votes: u256
new_votes
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::DelegateVotesChanged::new_votes
pub new_votes: u256
ComponentState
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::Event
pub enum Event {
DelegateChanged: DelegateChanged,
DelegateVotesChanged: DelegateVotesChanged,
}
Variants
DelegateChanged
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::Event::DelegateChanged
DelegateChanged: DelegateChanged
DelegateVotesChanged
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::Event::DelegateVotesChanged
DelegateVotesChanged: DelegateVotesChanged
Traits
Traits
| VotingUnitsTrait | A trait that must be implemented when integrating {VotesComponent} into a contract. It offers a mechanism to retrieve the number of voting units for a given account at the current time. |
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForVotesImpl | — |
VotingUnitsTrait
A trait that must be implemented when integrating {VotesComponent} into a contract. It offers a mechanism to retrieve the number of voting units for a given account at the current time.
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::VotingUnitsTrait
pub trait VotingUnitsTrait<TState>
Trait functions
get_voting_units
Returns the number of voting units for a given account. For ERC20, this is typically the token balance. For ERC721, this is typically the number of tokens owned.
WARNING: While any formula can be used as a measure of voting units, the internal vote
accounting of the contract may be compromised if voting units are transferred in any
external flow by following a different formula. For example, when implementing the hook
for ERC20, the number of voting units transferred should match the formula given by the
get_voting_units implementation.
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::VotingUnitsTrait::get_voting_units
fn get_voting_units(self: @TState, account: ContractAddress) -> u256
HasComponent
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::HasComponent::emit
fn emit<S, impl IntoImp: Into<S, openzeppelin_governance::votes::votes::VotesComponent::Event>>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::InternalTrait
pub trait InternalTrait<TContractState, +HasComponent<TContractState>, +VotingUnitsTrait<ComponentState<TContractState>>, impl Clock: ERC6372Clock, impl HasComponent<TContractState>: HasComponent<TContractState>, +SNIP12Metadata, +Drop<TContractState>>
Trait functions
get_total_supply
Returns the current total supply of votes.
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::InternalTrait::get_total_supply
fn get_total_supply(self: @ComponentState<TContractState>) -> u256
move_delegate_votes
Moves delegated votes from one delegate to another.
May emit one or two DelegateVotesChanged events.
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::InternalTrait::move_delegate_votes
fn move_delegate_votes(
ref self: ComponentState<TContractState>,
from: ContractAddress,
to: ContractAddress,
amount: u256,
)
transfer_voting_units
Transfers, mints, or burns voting units.
To register a mint, from should be zero. To register a burn, to
should be zero. Total supply of voting units will be adjusted with mints and burns.
WARNING: If voting units are based on an underlying transferable asset (like a token), you must call this function every time the asset is transferred to keep the internal voting power accounting in sync. For ERC20 and ERC721 tokens, this is typically handled using hooks.
May emit one or two DelegateVotesChanged events.
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::InternalTrait::transfer_voting_units
fn transfer_voting_units(
ref self: ComponentState<TContractState>,
from: ContractAddress,
to: ContractAddress,
amount: u256,
)
num_checkpoints
Returns the number of checkpoints for account.
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::InternalTrait::num_checkpoints
fn num_checkpoints(self: @ComponentState<TContractState>, account: ContractAddress) -> u64
checkpoints
Returns the pos-th checkpoint for account.
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::InternalTrait::checkpoints
fn checkpoints(
self: @ComponentState<TContractState>, account: ContractAddress, pos: u64,
) -> Checkpoint
_delegate
Delegates all of account’s voting units to delegatee.
Emits a DelegateChanged event.
May emit one or two DelegateVotesChanged events.
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::InternalTrait::_delegate
fn _delegate(
ref self: ComponentState<TContractState>, account: ContractAddress, delegatee: ContractAddress,
)
UnsafeNewContractStateTraitForVotesImpl
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::UnsafeNewContractStateTraitForVotesImpl
pub trait UnsafeNewContractStateTraitForVotesImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_governance::votes::votes::VotesComponent::UnsafeNewContractStateTraitForVotesImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
openzeppelin_interfaces
Fully qualified path: openzeppelin_interfaces
Modules
Re-exports:
Modules
Modules
access
Fully qualified path: openzeppelin_interfaces::access
Modules
Modules
Modules
accesscontrol
Fully qualified path: openzeppelin_interfaces::access::accesscontrol
Modules
Constants
Enums
Traits
Groups:
dispatchers
Modules
Modules
__external_IAccessControlForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::__external_IAccessControlForwardImpl
__l1_handler_IAccessControlForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::__l1_handler_IAccessControlForwardImpl
__constructor_IAccessControlForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::__constructor_IAccessControlForwardImpl
__external_IAccessControlWithDelayForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::__external_IAccessControlWithDelayForwardImpl
__l1_handler_IAccessControlWithDelayForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::__l1_handler_IAccessControlWithDelayForwardImpl
__constructor_IAccessControlWithDelayForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::__constructor_IAccessControlWithDelayForwardImpl
__external_IAccessControlCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::__external_IAccessControlCamelForwardImpl
__l1_handler_IAccessControlCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::__l1_handler_IAccessControlCamelForwardImpl
__constructor_IAccessControlCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::__constructor_IAccessControlCamelForwardImpl
__external_AccessControlABIForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::__external_AccessControlABIForwardImpl
__l1_handler_AccessControlABIForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::__l1_handler_AccessControlABIForwardImpl
__constructor_AccessControlABIForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::__constructor_AccessControlABIForwardImpl
Constants
Constants
IACCESSCONTROL_ID
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IACCESSCONTROL_ID
pub const IACCESSCONTROL_ID: felt252 =
1001807408384776055325597999563763399844584597967568367993760252342220232529;
Enums
Enums
RoleStatus
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::RoleStatus
pub enum RoleStatus {
NotGranted,
Delayed: u64,
Effective,
}
Variants
NotGranted
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::RoleStatus::NotGranted
NotGranted
Delayed
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::RoleStatus::Delayed
Delayed: u64
Effective
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::RoleStatus::Effective
Effective
Traits
Traits
IAccessControl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControl
pub trait IAccessControl<TState>
Trait functions
has_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControl::has_role
fn has_role(self: @TState, role: felt252, account: ContractAddress) -> bool
get_role_admin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControl::get_role_admin
fn get_role_admin(self: @TState, role: felt252) -> felt252
grant_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControl::grant_role
fn grant_role(ref self: TState, role: felt252, account: ContractAddress)
revoke_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControl::revoke_role
fn revoke_role(ref self: TState, role: felt252, account: ContractAddress)
renounce_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControl::renounce_role
fn renounce_role(ref self: TState, role: felt252, account: ContractAddress)
IAccessControlWithDelay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlWithDelay
pub trait IAccessControlWithDelay<TState>
Trait functions
get_role_status
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlWithDelay::get_role_status
fn get_role_status(self: @TState, role: felt252, account: ContractAddress) -> RoleStatus
grant_role_with_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlWithDelay::grant_role_with_delay
fn grant_role_with_delay(ref self: TState, role: felt252, account: ContractAddress, delay: u64)
IAccessControlCamel
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamel
pub trait IAccessControlCamel<TState>
Trait functions
hasRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamel::hasRole
fn hasRole(self: @TState, role: felt252, account: ContractAddress) -> bool
getRoleAdmin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamel::getRoleAdmin
fn getRoleAdmin(self: @TState, role: felt252) -> felt252
grantRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamel::grantRole
fn grantRole(ref self: TState, role: felt252, account: ContractAddress)
revokeRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamel::revokeRole
fn revokeRole(ref self: TState, role: felt252, account: ContractAddress)
renounceRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamel::renounceRole
fn renounceRole(ref self: TState, role: felt252, account: ContractAddress)
AccessControlABI
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABI
pub trait AccessControlABI<TState>
Trait functions
has_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABI::has_role
fn has_role(self: @TState, role: felt252, account: ContractAddress) -> bool
get_role_admin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABI::get_role_admin
fn get_role_admin(self: @TState, role: felt252) -> felt252
grant_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABI::grant_role
fn grant_role(ref self: TState, role: felt252, account: ContractAddress)
revoke_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABI::revoke_role
fn revoke_role(ref self: TState, role: felt252, account: ContractAddress)
renounce_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABI::renounce_role
fn renounce_role(ref self: TState, role: felt252, account: ContractAddress)
hasRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABI::hasRole
fn hasRole(self: @TState, role: felt252, account: ContractAddress) -> bool
getRoleAdmin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABI::getRoleAdmin
fn getRoleAdmin(self: @TState, role: felt252) -> felt252
grantRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABI::grantRole
fn grantRole(ref self: TState, role: felt252, account: ContractAddress)
revokeRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABI::revokeRole
fn revokeRole(ref self: TState, role: felt252, account: ContractAddress)
renounceRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABI::renounceRole
fn renounceRole(ref self: TState, role: felt252, account: ContractAddress)
get_role_status
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABI::get_role_status
fn get_role_status(self: @TState, role: felt252, account: ContractAddress) -> RoleStatus
grant_role_with_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABI::grant_role_with_delay
fn grant_role_with_delay(ref self: TState, role: felt252, account: ContractAddress, delay: u64)
supports_interface
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABI::supports_interface
fn supports_interface(self: @TState, interface_id: felt252) -> bool
UnsafeNewContractStateTraitForIAccessControlForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::UnsafeNewContractStateTraitForIAccessControlForwardImpl
pub trait UnsafeNewContractStateTraitForIAccessControlForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::UnsafeNewContractStateTraitForIAccessControlForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIAccessControlWithDelayForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::UnsafeNewContractStateTraitForIAccessControlWithDelayForwardImpl
pub trait UnsafeNewContractStateTraitForIAccessControlWithDelayForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::UnsafeNewContractStateTraitForIAccessControlWithDelayForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIAccessControlCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::UnsafeNewContractStateTraitForIAccessControlCamelForwardImpl
pub trait UnsafeNewContractStateTraitForIAccessControlCamelForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::UnsafeNewContractStateTraitForIAccessControlCamelForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForAccessControlABIForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::UnsafeNewContractStateTraitForAccessControlABIForwardImpl
pub trait UnsafeNewContractStateTraitForAccessControlABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::UnsafeNewContractStateTraitForAccessControlABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
accesscontrol_default_admin_rules
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules
Modules
Constants
Traits
Groups:
dispatchers
Modules
Modules
__external_IAccessControlDefaultAdminRulesForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::__external_IAccessControlDefaultAdminRulesForwardImpl
__l1_handler_IAccessControlDefaultAdminRulesForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::__l1_handler_IAccessControlDefaultAdminRulesForwardImpl
__constructor_IAccessControlDefaultAdminRulesForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::__constructor_IAccessControlDefaultAdminRulesForwardImpl
__external_AccessControlDefaultAdminRulesABIForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::__external_AccessControlDefaultAdminRulesABIForwardImpl
__l1_handler_AccessControlDefaultAdminRulesABIForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::__l1_handler_AccessControlDefaultAdminRulesABIForwardImpl
__constructor_AccessControlDefaultAdminRulesABIForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::__constructor_AccessControlDefaultAdminRulesABIForwardImpl
Constants
Constants
IACCESSCONTROL_DEFAULT_ADMIN_RULES_ID
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IACCESSCONTROL_DEFAULT_ADMIN_RULES_ID
pub const IACCESSCONTROL_DEFAULT_ADMIN_RULES_ID: felt252 =
1499357389572001366848494400001343811240433588055363293228161410022555530219;
Traits
Traits
IAccessControlDefaultAdminRules
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRules
pub trait IAccessControlDefaultAdminRules<TState>
Trait functions
default_admin
Returns the address of the current DEFAULT_ADMIN_ROLE holder.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRules::default_admin
fn default_admin(self: @TState) -> ContractAddress
pending_default_admin
Returns a tuple of a new_admin and an accept_schedule.
After the accept_schedule passes, the new_admin will be able to accept the
default_admin role by calling accept_default_admin_transfer, completing the role
transfer.
A zero value only in accept_schedule indicates no pending admin transfer.
NOTE: A zero address new_admin means that default_admin is being renounced.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRules::pending_default_admin
fn pending_default_admin(self: @TState) -> (ContractAddress, u64)
default_admin_delay
Returns the delay required to schedule the acceptance of a default_admin transfer started.
This delay will be added to the current timestamp when calling
begin_default_admin_transfer to set the acceptance schedule.
NOTE: If a delay change has been scheduled, it will take effect as soon as the schedule passes, making this function return the new delay.
See change_default_admin_delay.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRules::default_admin_delay
fn default_admin_delay(self: @TState) -> u64
pending_default_admin_delay
Returns a tuple of new_delay and an effect_schedule.
After the effect_schedule passes, the new_delay will get into effect immediately for
every new default_admin transfer started with begin_default_admin_transfer.
A zero value only in effect_schedule indicates no pending delay change.
NOTE: A zero value only for new_delay means that the next default_admin_delay
will be zero after the effect schedule.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRules::pending_default_admin_delay
fn pending_default_admin_delay(self: @TState) -> (u64, u64)
begin_default_admin_transfer
Starts a default_admin transfer by setting a pending_default_admin scheduled for
acceptance after the current timestamp plus a default_admin_delay.
Requirements:
- Only can be called by the current
default_admin.
Emits a DefaultAdminRoleChangeStarted event.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRules::begin_default_admin_transfer
fn begin_default_admin_transfer(ref self: TState, new_admin: ContractAddress)
cancel_default_admin_transfer
Cancels a default_admin transfer previously started with begin_default_admin_transfer.
A pending_default_admin not yet accepted can also be canceled with this function.
Requirements:
- Only can be called by the current
default_admin.
May emit a DefaultAdminTransferCanceled event.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRules::cancel_default_admin_transfer
fn cancel_default_admin_transfer(ref self: TState)
accept_default_admin_transfer
Completes a default_admin transfer previously started with begin_default_admin_transfer.
After calling the function:
DEFAULT_ADMIN_ROLEmust be granted to the caller.DEFAULT_ADMIN_ROLEmust be revoked from the previous holder.pending_default_adminmust be reset to zero value.
Requirements:
- Only can be called by the
pending_default_admin’snew_admin. - The
pending_default_admin’saccept_scheduleshould’ve passed.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRules::accept_default_admin_transfer
fn accept_default_admin_transfer(ref self: TState)
change_default_admin_delay
Initiates a default_admin_delay update by setting a pending_default_admin_delay
scheduled to take effect after the current timestamp plus a default_admin_delay.
This function guarantees that any call to begin_default_admin_transfer done between the
timestamp this method is called at and the pending_default_admin_delay effect schedule
will use the current default_admin_delay set before calling.
The pending_default_admin_delay’s effect schedule is defined in a way that waiting until
the schedule and then calling begin_default_admin_transfer with the new delay will take at
least the same as another default_admin complete transfer (including acceptance).
The schedule is designed for two scenarios:
- When the delay is changed for a larger one the schedule is
block.timestamp + new delaycapped bydefault_admin_delay_increase_wait. - When the delay is changed for a shorter one, the schedule is
block.timestamp + (current delay - new delay).
A pending_default_admin_delay that never got into effect will be canceled in favor of a
new scheduled change.
Requirements:
- Only can be called by the current
default_admin.
Emits a DefaultAdminDelayChangeScheduled event and may emit a
DefaultAdminDelayChangeCanceled event.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRules::change_default_admin_delay
fn change_default_admin_delay(ref self: TState, new_delay: u64)
rollback_default_admin_delay
Cancels a scheduled default_admin_delay change.
Requirements:
- Only can be called by the current
default_admin.
May emit a DefaultAdminDelayChangeCanceled event.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRules::rollback_default_admin_delay
fn rollback_default_admin_delay(ref self: TState)
default_admin_delay_increase_wait
Maximum time in seconds for an increase to default_admin_delay (that is scheduled
using change_default_admin_delay) to take effect.
IMPORTANT:
Make sure to add a reasonable amount of time while setting this value, otherwise, there’s a risk of setting a high new delay that goes into effect almost immediately without the possibility of human intervention in the case of an input error (eg. set milliseconds instead of seconds).
Consider carefully the value set for maximum_default_admin_transfer_delay too, since
it will affect how fast you can recover from an accidental delay increase.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRules::default_admin_delay_increase_wait
fn default_admin_delay_increase_wait(self: @TState) -> u64
maximum_default_admin_transfer_delay
Maximum time in seconds for a default_admin transfer delay.
IMPORTANT:
If this value is set too high, you might be unable to recover
from an accidental delay increase for an extended period. Too low, and it unnecessarily
restricts how much security delay you can impose for default_admin transfers. As a best
practice, consider setting it in the 30-60 day range for a good balance between security and
recoverability.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRules::maximum_default_admin_transfer_delay
fn maximum_default_admin_transfer_delay(self: @TState) -> u64
AccessControlDefaultAdminRulesABI
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI
pub trait AccessControlDefaultAdminRulesABI<TState>
Trait functions
default_admin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::default_admin
fn default_admin(self: @TState) -> ContractAddress
pending_default_admin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::pending_default_admin
fn pending_default_admin(self: @TState) -> (ContractAddress, u64)
default_admin_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::default_admin_delay
fn default_admin_delay(self: @TState) -> u64
pending_default_admin_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::pending_default_admin_delay
fn pending_default_admin_delay(self: @TState) -> (u64, u64)
begin_default_admin_transfer
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::begin_default_admin_transfer
fn begin_default_admin_transfer(ref self: TState, new_admin: ContractAddress)
cancel_default_admin_transfer
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::cancel_default_admin_transfer
fn cancel_default_admin_transfer(ref self: TState)
accept_default_admin_transfer
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::accept_default_admin_transfer
fn accept_default_admin_transfer(ref self: TState)
change_default_admin_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::change_default_admin_delay
fn change_default_admin_delay(ref self: TState, new_delay: u64)
rollback_default_admin_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::rollback_default_admin_delay
fn rollback_default_admin_delay(ref self: TState)
default_admin_delay_increase_wait
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::default_admin_delay_increase_wait
fn default_admin_delay_increase_wait(self: @TState) -> u64
has_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::has_role
fn has_role(self: @TState, role: felt252, account: ContractAddress) -> bool
get_role_admin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::get_role_admin
fn get_role_admin(self: @TState, role: felt252) -> felt252
grant_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::grant_role
fn grant_role(ref self: TState, role: felt252, account: ContractAddress)
revoke_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::revoke_role
fn revoke_role(ref self: TState, role: felt252, account: ContractAddress)
renounce_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::renounce_role
fn renounce_role(ref self: TState, role: felt252, account: ContractAddress)
hasRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::hasRole
fn hasRole(self: @TState, role: felt252, account: ContractAddress) -> bool
getRoleAdmin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::getRoleAdmin
fn getRoleAdmin(self: @TState, role: felt252) -> felt252
grantRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::grantRole
fn grantRole(ref self: TState, role: felt252, account: ContractAddress)
revokeRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::revokeRole
fn revokeRole(ref self: TState, role: felt252, account: ContractAddress)
renounceRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::renounceRole
fn renounceRole(ref self: TState, role: felt252, account: ContractAddress)
get_role_status
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::get_role_status
fn get_role_status(self: @TState, role: felt252, account: ContractAddress) -> RoleStatus
grant_role_with_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::grant_role_with_delay
fn grant_role_with_delay(ref self: TState, role: felt252, account: ContractAddress, delay: u64)
supports_interface
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABI::supports_interface
fn supports_interface(self: @TState, interface_id: felt252) -> bool
UnsafeNewContractStateTraitForIAccessControlDefaultAdminRulesForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::UnsafeNewContractStateTraitForIAccessControlDefaultAdminRulesForwardImpl
pub trait UnsafeNewContractStateTraitForIAccessControlDefaultAdminRulesForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::UnsafeNewContractStateTraitForIAccessControlDefaultAdminRulesForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForAccessControlDefaultAdminRulesABIForwardImpl
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::UnsafeNewContractStateTraitForAccessControlDefaultAdminRulesABIForwardImpl
pub trait UnsafeNewContractStateTraitForAccessControlDefaultAdminRulesABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::UnsafeNewContractStateTraitForAccessControlDefaultAdminRulesABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
ownable
Fully qualified path: openzeppelin_interfaces::access::ownable
Modules
Traits
Groups:
dispatchers
Modules
Modules
__external_IOwnableForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__external_IOwnableForwardImpl
__l1_handler_IOwnableForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__l1_handler_IOwnableForwardImpl
__constructor_IOwnableForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__constructor_IOwnableForwardImpl
__external_IOwnableCamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__external_IOwnableCamelOnlyForwardImpl
__l1_handler_IOwnableCamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__l1_handler_IOwnableCamelOnlyForwardImpl
__constructor_IOwnableCamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__constructor_IOwnableCamelOnlyForwardImpl
__external_OwnableABIForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__external_OwnableABIForwardImpl
__l1_handler_OwnableABIForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__l1_handler_OwnableABIForwardImpl
__constructor_OwnableABIForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__constructor_OwnableABIForwardImpl
__external_IOwnableTwoStepForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__external_IOwnableTwoStepForwardImpl
__l1_handler_IOwnableTwoStepForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__l1_handler_IOwnableTwoStepForwardImpl
__constructor_IOwnableTwoStepForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__constructor_IOwnableTwoStepForwardImpl
__external_IOwnableTwoStepCamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__external_IOwnableTwoStepCamelOnlyForwardImpl
__l1_handler_IOwnableTwoStepCamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__l1_handler_IOwnableTwoStepCamelOnlyForwardImpl
__constructor_IOwnableTwoStepCamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__constructor_IOwnableTwoStepCamelOnlyForwardImpl
__external_OwnableTwoStepABIForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__external_OwnableTwoStepABIForwardImpl
__l1_handler_OwnableTwoStepABIForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__l1_handler_OwnableTwoStepABIForwardImpl
__constructor_OwnableTwoStepABIForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::__constructor_OwnableTwoStepABIForwardImpl
Traits
Traits
IOwnable
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnable
pub trait IOwnable<TState>
Trait functions
owner
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnable::owner
fn owner(self: @TState) -> ContractAddress
transfer_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnable::transfer_ownership
fn transfer_ownership(ref self: TState, new_owner: ContractAddress)
renounce_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnable::renounce_ownership
fn renounce_ownership(ref self: TState)
IOwnableCamelOnly
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableCamelOnly
pub trait IOwnableCamelOnly<TState>
Trait functions
transferOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableCamelOnly::transferOwnership
fn transferOwnership(ref self: TState, newOwner: ContractAddress)
renounceOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableCamelOnly::renounceOwnership
fn renounceOwnership(ref self: TState)
OwnableABI
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABI
pub trait OwnableABI<TState>
Trait functions
owner
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABI::owner
fn owner(self: @TState) -> ContractAddress
transfer_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABI::transfer_ownership
fn transfer_ownership(ref self: TState, new_owner: ContractAddress)
renounce_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABI::renounce_ownership
fn renounce_ownership(ref self: TState)
transferOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABI::transferOwnership
fn transferOwnership(ref self: TState, newOwner: ContractAddress)
renounceOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABI::renounceOwnership
fn renounceOwnership(ref self: TState)
IOwnableTwoStep
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStep
pub trait IOwnableTwoStep<TState>
Trait functions
owner
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStep::owner
fn owner(self: @TState) -> ContractAddress
pending_owner
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStep::pending_owner
fn pending_owner(self: @TState) -> ContractAddress
accept_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStep::accept_ownership
fn accept_ownership(ref self: TState)
transfer_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStep::transfer_ownership
fn transfer_ownership(ref self: TState, new_owner: ContractAddress)
renounce_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStep::renounce_ownership
fn renounce_ownership(ref self: TState)
IOwnableTwoStepCamelOnly
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnly
pub trait IOwnableTwoStepCamelOnly<TState>
Trait functions
pendingOwner
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnly::pendingOwner
fn pendingOwner(self: @TState) -> ContractAddress
acceptOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnly::acceptOwnership
fn acceptOwnership(ref self: TState)
transferOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnly::transferOwnership
fn transferOwnership(ref self: TState, newOwner: ContractAddress)
renounceOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnly::renounceOwnership
fn renounceOwnership(ref self: TState)
OwnableTwoStepABI
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABI
pub trait OwnableTwoStepABI<TState>
Trait functions
owner
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABI::owner
fn owner(self: @TState) -> ContractAddress
pending_owner
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABI::pending_owner
fn pending_owner(self: @TState) -> ContractAddress
accept_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABI::accept_ownership
fn accept_ownership(ref self: TState)
transfer_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABI::transfer_ownership
fn transfer_ownership(ref self: TState, new_owner: ContractAddress)
renounce_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABI::renounce_ownership
fn renounce_ownership(ref self: TState)
pendingOwner
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABI::pendingOwner
fn pendingOwner(self: @TState) -> ContractAddress
acceptOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABI::acceptOwnership
fn acceptOwnership(ref self: TState)
transferOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABI::transferOwnership
fn transferOwnership(ref self: TState, newOwner: ContractAddress)
renounceOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABI::renounceOwnership
fn renounceOwnership(ref self: TState)
UnsafeNewContractStateTraitForIOwnableForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::UnsafeNewContractStateTraitForIOwnableForwardImpl
pub trait UnsafeNewContractStateTraitForIOwnableForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::access::ownable::UnsafeNewContractStateTraitForIOwnableForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIOwnableCamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::UnsafeNewContractStateTraitForIOwnableCamelOnlyForwardImpl
pub trait UnsafeNewContractStateTraitForIOwnableCamelOnlyForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::access::ownable::UnsafeNewContractStateTraitForIOwnableCamelOnlyForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForOwnableABIForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::UnsafeNewContractStateTraitForOwnableABIForwardImpl
pub trait UnsafeNewContractStateTraitForOwnableABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::access::ownable::UnsafeNewContractStateTraitForOwnableABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIOwnableTwoStepForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::UnsafeNewContractStateTraitForIOwnableTwoStepForwardImpl
pub trait UnsafeNewContractStateTraitForIOwnableTwoStepForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::access::ownable::UnsafeNewContractStateTraitForIOwnableTwoStepForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIOwnableTwoStepCamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::UnsafeNewContractStateTraitForIOwnableTwoStepCamelOnlyForwardImpl
pub trait UnsafeNewContractStateTraitForIOwnableTwoStepCamelOnlyForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::access::ownable::UnsafeNewContractStateTraitForIOwnableTwoStepCamelOnlyForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForOwnableTwoStepABIForwardImpl
Fully qualified path: openzeppelin_interfaces::access::ownable::UnsafeNewContractStateTraitForOwnableTwoStepABIForwardImpl
pub trait UnsafeNewContractStateTraitForOwnableTwoStepABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::access::ownable::UnsafeNewContractStateTraitForOwnableTwoStepABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
account
Fully qualified path: openzeppelin_interfaces::account
Modules
Modules
Modules
accounts
Fully qualified path: openzeppelin_interfaces::account::accounts
Modules
Constants
Type aliases
Traits
Groups:
dispatchers
Modules
Modules
__external_ISRC6ForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__external_ISRC6ForwardImpl
__l1_handler_ISRC6ForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__l1_handler_ISRC6ForwardImpl
__constructor_ISRC6ForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__constructor_ISRC6ForwardImpl
__external_IDeclarerForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__external_IDeclarerForwardImpl
__l1_handler_IDeclarerForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__l1_handler_IDeclarerForwardImpl
__constructor_IDeclarerForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__constructor_IDeclarerForwardImpl
__external_IDeployableForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__external_IDeployableForwardImpl
__l1_handler_IDeployableForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__l1_handler_IDeployableForwardImpl
__constructor_IDeployableForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__constructor_IDeployableForwardImpl
__external_IPublicKeyForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__external_IPublicKeyForwardImpl
__l1_handler_IPublicKeyForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__l1_handler_IPublicKeyForwardImpl
__constructor_IPublicKeyForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__constructor_IPublicKeyForwardImpl
__external_ISRC6CamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__external_ISRC6CamelOnlyForwardImpl
__l1_handler_ISRC6CamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__l1_handler_ISRC6CamelOnlyForwardImpl
__constructor_ISRC6CamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__constructor_ISRC6CamelOnlyForwardImpl
__external_IPublicKeyCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__external_IPublicKeyCamelForwardImpl
__l1_handler_IPublicKeyCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__l1_handler_IPublicKeyCamelForwardImpl
__constructor_IPublicKeyCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__constructor_IPublicKeyCamelForwardImpl
__external_AccountABIForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__external_AccountABIForwardImpl
__l1_handler_AccountABIForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__l1_handler_AccountABIForwardImpl
__constructor_AccountABIForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__constructor_AccountABIForwardImpl
__external_IEthDeployableForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__external_IEthDeployableForwardImpl
__l1_handler_IEthDeployableForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__l1_handler_IEthDeployableForwardImpl
__constructor_IEthDeployableForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__constructor_IEthDeployableForwardImpl
__external_IEthPublicKeyForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__external_IEthPublicKeyForwardImpl
__l1_handler_IEthPublicKeyForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__l1_handler_IEthPublicKeyForwardImpl
__constructor_IEthPublicKeyForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__constructor_IEthPublicKeyForwardImpl
__external_IEthPublicKeyCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__external_IEthPublicKeyCamelForwardImpl
__l1_handler_IEthPublicKeyCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__l1_handler_IEthPublicKeyCamelForwardImpl
__constructor_IEthPublicKeyCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__constructor_IEthPublicKeyCamelForwardImpl
__external_EthAccountABIForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__external_EthAccountABIForwardImpl
__l1_handler_EthAccountABIForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__l1_handler_EthAccountABIForwardImpl
__constructor_EthAccountABIForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::__constructor_EthAccountABIForwardImpl
Constants
Constants
ISRC6_ID
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6_ID
pub const ISRC6_ID: felt252 =
1270010605630597976495846281167968799381097569185364931397797212080166453709;
Type aliases
Type aliases
EthPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::EthPublicKey
pub type EthPublicKey = Secp256k1Point;
P256PublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::P256PublicKey
pub type P256PublicKey = Secp256r1Point;
Traits
Traits
ISRC6
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6
pub trait ISRC6<TState>
Trait functions
execute
Executes a list of calls from the account.
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6::execute
fn __execute__(self: @TState, calls: Array<Call>)
validate
Validates a transaction before execution.
This function is used by the protocol to verify invoke transactions.
Returns the short string ‘VALID’ if valid, otherwise it reverts.
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6::validate
fn __validate__(self: @TState, calls: Array<Call>) -> felt252
is_valid_signature
Verifies that the given signature is valid for the given hash.
Returns the short string ‘VALID’ if valid, otherwise returns 0.
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6::is_valid_signature
fn is_valid_signature(self: @TState, hash: felt252, signature: Array<felt252>) -> felt252
IDeclarer
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeclarer
pub trait IDeclarer<TState>
Trait functions
validate_declare
Validates a transaction before declaration.
This function is used by the protocol to verify declare transactions.
Returns the short string ‘VALID’ if valid, otherwise it reverts.
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeclarer::validate_declare
fn __validate_declare__(self: @TState, class_hash: felt252) -> felt252
IDeployable
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeployable
pub trait IDeployable<TState>
Trait functions
validate_deploy
Validates a transaction before deployment.
This function is used by the protocol to verify deploy_account transactions.
Returns the short string ‘VALID’ if valid, otherwise it reverts.
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeployable::validate_deploy
fn __validate_deploy__(
self: @TState, class_hash: felt252, contract_address_salt: felt252, public_key: felt252,
) -> felt252
IPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKey
pub trait IPublicKey<TState>
Trait functions
get_public_key
Returns the current public key of the account.
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKey::get_public_key
fn get_public_key(self: @TState) -> felt252
set_public_key
Sets the public key of the account to new_public_key.
Emits both an OwnerRemoved and an OwnerAdded event.
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKey::set_public_key
fn set_public_key(ref self: TState, new_public_key: felt252, signature: Span<felt252>)
ISRC6CamelOnly
Adds camelCase support for ISRC6.
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6CamelOnly
pub trait ISRC6CamelOnly<TState>
Trait functions
isValidSignature
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6CamelOnly::isValidSignature
fn isValidSignature(self: @TState, hash: felt252, signature: Array<felt252>) -> felt252
IPublicKeyCamel
Adds camelCase support for IPublicKey.
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyCamel
pub trait IPublicKeyCamel<TState>
Trait functions
getPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyCamel::getPublicKey
fn getPublicKey(self: @TState) -> felt252
setPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyCamel::setPublicKey
fn setPublicKey(ref self: TState, newPublicKey: felt252, signature: Span<felt252>)
AccountABI
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABI
pub trait AccountABI<TState>
Trait functions
execute
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABI::execute
fn __execute__(self: @TState, calls: Array<Call>)
validate
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABI::validate
fn __validate__(self: @TState, calls: Array<Call>) -> felt252
is_valid_signature
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABI::is_valid_signature
fn is_valid_signature(self: @TState, hash: felt252, signature: Array<felt252>) -> felt252
supports_interface
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABI::supports_interface
fn supports_interface(self: @TState, interface_id: felt252) -> bool
validate_declare
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABI::validate_declare
fn __validate_declare__(self: @TState, class_hash: felt252) -> felt252
validate_deploy
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABI::validate_deploy
fn __validate_deploy__(
self: @TState, class_hash: felt252, contract_address_salt: felt252, public_key: felt252,
) -> felt252
get_public_key
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABI::get_public_key
fn get_public_key(self: @TState) -> felt252
set_public_key
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABI::set_public_key
fn set_public_key(ref self: TState, new_public_key: felt252, signature: Span<felt252>)
isValidSignature
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABI::isValidSignature
fn isValidSignature(self: @TState, hash: felt252, signature: Array<felt252>) -> felt252
getPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABI::getPublicKey
fn getPublicKey(self: @TState) -> felt252
setPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABI::setPublicKey
fn setPublicKey(ref self: TState, newPublicKey: felt252, signature: Span<felt252>)
IEthDeployable
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthDeployable
pub trait IEthDeployable<TState>
Trait functions
validate_deploy
Validates a transaction before deployment.
This function is used by the protocol to verify deploy_account transactions.
Returns the short string ‘VALID’ if valid, otherwise it reverts.
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthDeployable::validate_deploy
fn __validate_deploy__(
self: @TState, class_hash: felt252, contract_address_salt: felt252, public_key: Secp256k1Point,
) -> felt252
IEthPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKey
pub trait IEthPublicKey<TState>
Trait functions
get_public_key
Returns the current Ethereum public key of the account.
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKey::get_public_key
fn get_public_key(self: @TState) -> Secp256k1Point
set_public_key
Sets the Ethereum public key of the account to new_public_key.
Emits both an OwnerRemoved and an OwnerAdded event.
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKey::set_public_key
fn set_public_key(ref self: TState, new_public_key: Secp256k1Point, signature: Span<felt252>)
IEthPublicKeyCamel
Adds camelCase support for IEthPublicKey.
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyCamel
pub trait IEthPublicKeyCamel<TState>
Trait functions
getPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyCamel::getPublicKey
fn getPublicKey(self: @TState) -> Secp256k1Point
setPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyCamel::setPublicKey
fn setPublicKey(ref self: TState, newPublicKey: Secp256k1Point, signature: Span<felt252>)
EthAccountABI
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABI
pub trait EthAccountABI<TState>
Trait functions
execute
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABI::execute
fn __execute__(self: @TState, calls: Array<Call>)
validate
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABI::validate
fn __validate__(self: @TState, calls: Array<Call>) -> felt252
is_valid_signature
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABI::is_valid_signature
fn is_valid_signature(self: @TState, hash: felt252, signature: Array<felt252>) -> felt252
supports_interface
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABI::supports_interface
fn supports_interface(self: @TState, interface_id: felt252) -> bool
validate_declare
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABI::validate_declare
fn __validate_declare__(self: @TState, class_hash: felt252) -> felt252
validate_deploy
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABI::validate_deploy
fn __validate_deploy__(
self: @TState, class_hash: felt252, contract_address_salt: felt252, public_key: Secp256k1Point,
) -> felt252
get_public_key
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABI::get_public_key
fn get_public_key(self: @TState) -> Secp256k1Point
set_public_key
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABI::set_public_key
fn set_public_key(ref self: TState, new_public_key: Secp256k1Point, signature: Span<felt252>)
isValidSignature
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABI::isValidSignature
fn isValidSignature(self: @TState, hash: felt252, signature: Array<felt252>) -> felt252
getPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABI::getPublicKey
fn getPublicKey(self: @TState) -> Secp256k1Point
setPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABI::setPublicKey
fn setPublicKey(ref self: TState, newPublicKey: Secp256k1Point, signature: Span<felt252>)
UnsafeNewContractStateTraitForISRC6ForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForISRC6ForwardImpl
pub trait UnsafeNewContractStateTraitForISRC6ForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForISRC6ForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIDeclarerForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForIDeclarerForwardImpl
pub trait UnsafeNewContractStateTraitForIDeclarerForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForIDeclarerForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIDeployableForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForIDeployableForwardImpl
pub trait UnsafeNewContractStateTraitForIDeployableForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForIDeployableForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIPublicKeyForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForIPublicKeyForwardImpl
pub trait UnsafeNewContractStateTraitForIPublicKeyForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForIPublicKeyForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForISRC6CamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForISRC6CamelOnlyForwardImpl
pub trait UnsafeNewContractStateTraitForISRC6CamelOnlyForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForISRC6CamelOnlyForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIPublicKeyCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForIPublicKeyCamelForwardImpl
pub trait UnsafeNewContractStateTraitForIPublicKeyCamelForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForIPublicKeyCamelForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForAccountABIForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForAccountABIForwardImpl
pub trait UnsafeNewContractStateTraitForAccountABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForAccountABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIEthDeployableForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForIEthDeployableForwardImpl
pub trait UnsafeNewContractStateTraitForIEthDeployableForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForIEthDeployableForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIEthPublicKeyForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForIEthPublicKeyForwardImpl
pub trait UnsafeNewContractStateTraitForIEthPublicKeyForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForIEthPublicKeyForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIEthPublicKeyCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForIEthPublicKeyCamelForwardImpl
pub trait UnsafeNewContractStateTraitForIEthPublicKeyCamelForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForIEthPublicKeyCamelForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForEthAccountABIForwardImpl
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForEthAccountABIForwardImpl
pub trait UnsafeNewContractStateTraitForEthAccountABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::account::accounts::UnsafeNewContractStateTraitForEthAccountABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
src9
Fully qualified path: openzeppelin_interfaces::account::src9
Modules
| __external_ISRC9_V2ForwardImpl | — |
| __l1_handler_ISRC9_V2ForwardImpl | — |
| __constructor_ISRC9_V2ForwardImpl | — |
Constants
Structs
Traits
Groups:
dispatchers
| ISRC9_V2Dispatcher | — |
| ISRC9_V2LibraryDispatcher | — |
| ISRC9_V2SafeLibraryDispatcher | — |
| ISRC9_V2SafeDispatcher | — |
Modules
Modules
| __external_ISRC9_V2ForwardImpl | — |
| __l1_handler_ISRC9_V2ForwardImpl | — |
| __constructor_ISRC9_V2ForwardImpl | — |
__external_ISRC9_V2ForwardImpl
Fully qualified path: openzeppelin_interfaces::account::src9::__external_ISRC9_V2ForwardImpl
__l1_handler_ISRC9_V2ForwardImpl
Fully qualified path: openzeppelin_interfaces::account::src9::__l1_handler_ISRC9_V2ForwardImpl
__constructor_ISRC9_V2ForwardImpl
Fully qualified path: openzeppelin_interfaces::account::src9::__constructor_ISRC9_V2ForwardImpl
Constants
Constants
ISRC9_V2_ID
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2_ID
pub const ISRC9_V2_ID: felt252 =
3209859221869139765176135677240653758719660219476686940288388044331456626;
Structs
Structs
OutsideExecution
Fully qualified path: openzeppelin_interfaces::account::src9::OutsideExecution
[derive(Copy, Drop, Serde)]
pub struct OutsideExecution {
pub caller: ContractAddress,
pub nonce: felt252,
pub execute_after: u64,
pub execute_before: u64,
pub calls: Span<Call>,
}
Members
caller
Fully qualified path: openzeppelin_interfaces::account::src9::OutsideExecution::caller
pub caller: ContractAddress
nonce
Fully qualified path: openzeppelin_interfaces::account::src9::OutsideExecution::nonce
pub nonce: felt252
execute_after
Fully qualified path: openzeppelin_interfaces::account::src9::OutsideExecution::execute_after
pub execute_after: u64
execute_before
Fully qualified path: openzeppelin_interfaces::account::src9::OutsideExecution::execute_before
pub execute_before: u64
calls
Fully qualified path: openzeppelin_interfaces::account::src9::OutsideExecution::calls
pub calls: Span<Call>
Traits
Traits
ISRC9_V2
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2
pub trait ISRC9_V2<TContractState>
Trait functions
execute_from_outside_v2
Allows anyone to submit a transaction on behalf of the account as long as they have the relevant signatures.
This method allows reentrancy. A call to __execute__ or execute_from_outside_v2 can
trigger another nested transaction to execute_from_outside_v2 thus the implementation MUST
verify that the provided signature matches the hash of outside_execution and that
nonce was not already used.
The implementation should expect version to be set to 2 in the domain separator.
Arguments:
outside_execution- The parameters of the transaction to execute.signature- A valid signature on the SNIP-12 message encoding ofoutside_execution.
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2::execute_from_outside_v2
fn execute_from_outside_v2(
ref self: TContractState, outside_execution: OutsideExecution, signature: Span<felt252>,
) -> Array<Span<felt252>>
is_valid_outside_execution_nonce
Get the status of a given nonce. true if the nonce is available to use.
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2::is_valid_outside_execution_nonce
fn is_valid_outside_execution_nonce(self: @TContractState, nonce: felt252) -> bool
UnsafeNewContractStateTraitForISRC9_V2ForwardImpl
Fully qualified path: openzeppelin_interfaces::account::src9::UnsafeNewContractStateTraitForISRC9_V2ForwardImpl
pub trait UnsafeNewContractStateTraitForISRC9_V2ForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::account::src9::UnsafeNewContractStateTraitForISRC9_V2ForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
finance
Fully qualified path: openzeppelin_interfaces::finance
Modules
Modules
Modules
vesting
Fully qualified path: openzeppelin_interfaces::finance::vesting
Modules
| __external_IVestingForwardImpl | — |
| __l1_handler_IVestingForwardImpl | — |
| __constructor_IVestingForwardImpl | — |
Traits
Groups:
dispatchers
| IVestingDispatcher | — |
| IVestingLibraryDispatcher | — |
| IVestingSafeLibraryDispatcher | — |
| IVestingSafeDispatcher | — |
Modules
Modules
| __external_IVestingForwardImpl | — |
| __l1_handler_IVestingForwardImpl | — |
| __constructor_IVestingForwardImpl | — |
__external_IVestingForwardImpl
Fully qualified path: openzeppelin_interfaces::finance::vesting::__external_IVestingForwardImpl
__l1_handler_IVestingForwardImpl
Fully qualified path: openzeppelin_interfaces::finance::vesting::__l1_handler_IVestingForwardImpl
__constructor_IVestingForwardImpl
Fully qualified path: openzeppelin_interfaces::finance::vesting::__constructor_IVestingForwardImpl
Traits
Traits
IVesting
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVesting
pub trait IVesting<TState>
Trait functions
start
Returns the timestamp marking the beginning of the vesting period.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVesting::start
fn start(self: @TState) -> u64
cliff
Returns the timestamp marking the end of the cliff period.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVesting::cliff
fn cliff(self: @TState) -> u64
duration
Returns the total duration of the vesting period.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVesting::duration
fn duration(self: @TState) -> u64
end
Returns the timestamp marking the end of the vesting period.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVesting::end
fn end(self: @TState) -> u64
released
Returns the already released amount for a given token.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVesting::released
fn released(self: @TState, token: ContractAddress) -> u256
releasable
Returns the amount of a given token that can be released at the time of the call.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVesting::releasable
fn releasable(self: @TState, token: ContractAddress) -> u256
vested_amount
Returns the total vested amount of a specified token at a given timestamp.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVesting::vested_amount
fn vested_amount(self: @TState, token: ContractAddress, timestamp: u64) -> u256
release
Releases the amount of a given token that has already vested.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVesting::release
fn release(ref self: TState, token: ContractAddress) -> u256
UnsafeNewContractStateTraitForIVestingForwardImpl
Fully qualified path: openzeppelin_interfaces::finance::vesting::UnsafeNewContractStateTraitForIVestingForwardImpl
pub trait UnsafeNewContractStateTraitForIVestingForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::finance::vesting::UnsafeNewContractStateTraitForIVestingForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
governance
Fully qualified path: openzeppelin_interfaces::governance
Modules
Modules
Modules
extensions
Fully qualified path: openzeppelin_interfaces::governance::extensions
Modules
Traits
Groups:
dispatchers
Modules
Modules
__external_IQuorumFractionForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::extensions::__external_IQuorumFractionForwardImpl
__l1_handler_IQuorumFractionForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::extensions::__l1_handler_IQuorumFractionForwardImpl
__constructor_IQuorumFractionForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::extensions::__constructor_IQuorumFractionForwardImpl
__external_IVotesTokenForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::extensions::__external_IVotesTokenForwardImpl
__l1_handler_IVotesTokenForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::extensions::__l1_handler_IVotesTokenForwardImpl
__constructor_IVotesTokenForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::extensions::__constructor_IVotesTokenForwardImpl
__external_ITimelockedForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::extensions::__external_ITimelockedForwardImpl
__l1_handler_ITimelockedForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::extensions::__l1_handler_ITimelockedForwardImpl
__constructor_ITimelockedForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::extensions::__constructor_ITimelockedForwardImpl
__external_IGovernorSettingsAdminForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::extensions::__external_IGovernorSettingsAdminForwardImpl
__l1_handler_IGovernorSettingsAdminForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::extensions::__l1_handler_IGovernorSettingsAdminForwardImpl
__constructor_IGovernorSettingsAdminForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::extensions::__constructor_IGovernorSettingsAdminForwardImpl
Traits
Traits
IQuorumFraction
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFraction
pub trait IQuorumFraction<TState>
Trait functions
token
Returns the token that voting power is sourced from.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFraction::token
fn token(self: @TState) -> ContractAddress
current_quorum_numerator
Returns the current quorum numerator.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFraction::current_quorum_numerator
fn current_quorum_numerator(self: @TState) -> u256
quorum_numerator
Returns the quorum numerator at a specific timepoint.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFraction::quorum_numerator
fn quorum_numerator(self: @TState, timepoint: u64) -> u256
quorum_denominator
Returns the quorum denominator.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFraction::quorum_denominator
fn quorum_denominator(self: @TState) -> u256
IVotesToken
Fully qualified path: openzeppelin_interfaces::governance::extensions::IVotesToken
pub trait IVotesToken<TState>
Trait functions
token
Returns the token that voting power is sourced from.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IVotesToken::token
fn token(self: @TState) -> ContractAddress
ITimelocked
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelocked
pub trait ITimelocked<TState>
Trait functions
timelock
Returns address of the associated timelock.
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelocked::timelock
fn timelock(self: @TState) -> ContractAddress
get_timelock_id
Returns the timelock proposal id for a given proposal id.
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelocked::get_timelock_id
fn get_timelock_id(self: @TState, proposal_id: felt252) -> felt252
update_timelock
Updates the associated timelock.
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelocked::update_timelock
fn update_timelock(ref self: TState, new_timelock: ContractAddress)
IGovernorSettingsAdmin
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdmin
pub trait IGovernorSettingsAdmin<TState>
Trait functions
set_voting_delay
Sets the voting delay.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdmin::set_voting_delay
fn set_voting_delay(ref self: TState, new_voting_delay: u64)
set_voting_period
Sets the voting period.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdmin::set_voting_period
fn set_voting_period(ref self: TState, new_voting_period: u64)
set_proposal_threshold
Sets the proposal threshold.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdmin::set_proposal_threshold
fn set_proposal_threshold(ref self: TState, new_proposal_threshold: u256)
UnsafeNewContractStateTraitForIQuorumFractionForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::extensions::UnsafeNewContractStateTraitForIQuorumFractionForwardImpl
pub trait UnsafeNewContractStateTraitForIQuorumFractionForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::governance::extensions::UnsafeNewContractStateTraitForIQuorumFractionForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIVotesTokenForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::extensions::UnsafeNewContractStateTraitForIVotesTokenForwardImpl
pub trait UnsafeNewContractStateTraitForIVotesTokenForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::governance::extensions::UnsafeNewContractStateTraitForIVotesTokenForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForITimelockedForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::extensions::UnsafeNewContractStateTraitForITimelockedForwardImpl
pub trait UnsafeNewContractStateTraitForITimelockedForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::governance::extensions::UnsafeNewContractStateTraitForITimelockedForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIGovernorSettingsAdminForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::extensions::UnsafeNewContractStateTraitForIGovernorSettingsAdminForwardImpl
pub trait UnsafeNewContractStateTraitForIGovernorSettingsAdminForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::governance::extensions::UnsafeNewContractStateTraitForIGovernorSettingsAdminForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
governor
Fully qualified path: openzeppelin_interfaces::governance::governor
Modules
| __external_IGovernorForwardImpl | — |
| __l1_handler_IGovernorForwardImpl | — |
| __constructor_IGovernorForwardImpl | — |
Constants
Enums
Traits
Groups:
dispatchers
| IGovernorDispatcher | — |
| IGovernorLibraryDispatcher | — |
| IGovernorSafeLibraryDispatcher | — |
| IGovernorSafeDispatcher | — |
Modules
Modules
| __external_IGovernorForwardImpl | — |
| __l1_handler_IGovernorForwardImpl | — |
| __constructor_IGovernorForwardImpl | — |
__external_IGovernorForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::governor::__external_IGovernorForwardImpl
__l1_handler_IGovernorForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::governor::__l1_handler_IGovernorForwardImpl
__constructor_IGovernorForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::governor::__constructor_IGovernorForwardImpl
Constants
Constants
IGOVERNOR_ID
Fully qualified path: openzeppelin_interfaces::governance::governor::IGOVERNOR_ID
pub const IGOVERNOR_ID: felt252 =
480652268877009837579729057731246200845025841874226280448218857230898133705;
Enums
Enums
ProposalState
Fully qualified path: openzeppelin_interfaces::governance::governor::ProposalState
pub enum ProposalState {
Pending,
Active,
Canceled,
Defeated,
Succeeded,
Queued,
Executed,
}
Variants
Pending
Fully qualified path: openzeppelin_interfaces::governance::governor::ProposalState::Pending
Pending
Active
Fully qualified path: openzeppelin_interfaces::governance::governor::ProposalState::Active
Active
Canceled
Fully qualified path: openzeppelin_interfaces::governance::governor::ProposalState::Canceled
Canceled
Defeated
Fully qualified path: openzeppelin_interfaces::governance::governor::ProposalState::Defeated
Defeated
Succeeded
Fully qualified path: openzeppelin_interfaces::governance::governor::ProposalState::Succeeded
Succeeded
Queued
Fully qualified path: openzeppelin_interfaces::governance::governor::ProposalState::Queued
Queued
Executed
Fully qualified path: openzeppelin_interfaces::governance::governor::ProposalState::Executed
Executed
Traits
Traits
IGovernor
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor
pub trait IGovernor<TState>
Trait functions
name
Name of the governor instance (used in building the SNIP-12 domain separator).
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::name
fn name(self: @TState) -> felt252
version
Version of the governor instance (used in building SNIP-12 domain separator).
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::version
fn version(self: @TState) -> felt252
COUNTING_MODE
A description of the possible support values for cast_vote and the way these votes are
counted, meant to be consumed by UIs to show correct vote options and interpret the results.
The string is a URL-encoded sequence of key-value pairs that each describe one aspect, for
example support=bravo&quorum=for,abstain.
There are 2 standard keys: support and quorum.
support=bravorefers to the vote options 0 = Against, 1 = For, 2 = Abstain, as inGovernorBravo.quorum=bravomeans that only For votes are counted towards quorum.quorum=for,abstainmeans that both For and Abstain votes are counted towards quorum.
If a counting module makes use of encoded params, it should include this under a params
key with a unique name that describes the behavior. For example:
params=fractionalmight refer to a scheme where votes are divided fractionally between for/against/abstain.params=erc721might refer to a scheme where specific NFTs are delegated to vote.
NOTE: The string can be decoded by the standard
https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParamsURLSearchParams
JavaScript class.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::COUNTING_MODE
fn COUNTING_MODE(self: @TState) -> ByteArray
hash_proposal
Hashing function used to (re)build the proposal id from the proposal details.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::hash_proposal
fn hash_proposal(self: @TState, calls: Span<Call>, description_hash: felt252) -> felt252
state
Returns the state of a proposal, given its id.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::state
fn state(self: @TState, proposal_id: felt252) -> ProposalState
proposal_threshold
The number of votes required in order for a voter to become a proposer.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::proposal_threshold
fn proposal_threshold(self: @TState) -> u256
proposal_snapshot
Timepoint used to retrieve user’s votes and quorum. If using block number, the snapshot is performed at the end of this block. Hence, voting for this proposal starts at the beginning of the following block.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::proposal_snapshot
fn proposal_snapshot(self: @TState, proposal_id: felt252) -> u64
proposal_deadline
Timepoint at which votes close. If using block number, votes close at the end of this block, so it is possible to cast a vote during this block.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::proposal_deadline
fn proposal_deadline(self: @TState, proposal_id: felt252) -> u64
proposal_proposer
The account that created a proposal.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::proposal_proposer
fn proposal_proposer(self: @TState, proposal_id: felt252) -> ContractAddress
proposal_eta
The time when a queued proposal becomes executable (“ETA”). Unlike proposal_snapshot and
proposal_deadline, this doesn’t use the governor clock, and instead relies on the
executor’s clock which may be different. In most cases this will be a timestamp.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::proposal_eta
fn proposal_eta(self: @TState, proposal_id: felt252) -> u64
proposal_needs_queuing
Whether a proposal needs to be queued before execution.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::proposal_needs_queuing
fn proposal_needs_queuing(self: @TState, proposal_id: felt252) -> bool
voting_delay
Delay between the proposal is created and the vote starts. The unit this duration is expressed in depends on the clock (see ERC-6372) this contract uses.
This can be increased to leave time for users to buy voting power, or delegate it, before the voting of a proposal starts.
NOTE: While this function returns a u64 value, timepoints must fit into u48 according to the EIP-6372 specification. Consequently this value must fit in a u48 (when added to the current clock).
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::voting_delay
fn voting_delay(self: @TState) -> u64
voting_period
Delay between the vote start and vote end. The unit this duration is expressed in depends on the clock (see ERC-6372) this contract uses.
NOTE: The voting_delay can delay the start of the vote. This must be considered when
setting the voting duration compared to the voting delay.
NOTE: This value is stored when the proposal is submitted so that possible changes to the value do not affect proposals that have already been submitted.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::voting_period
fn voting_period(self: @TState) -> u64
quorum
Minimum number of cast voted required for a proposal to be successful.
NOTE: The timepoint parameter corresponds to the snapshot used for counting vote. This
allows the quorum to scale depending on values such as the total supply of a token at this
timepoint.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::quorum
fn quorum(self: @TState, timepoint: u64) -> u256
get_votes
Voting power of an account at a specific timepoint.
NOTE: This can be implemented in a number of ways, for example by reading the delegated
balance from one (or multiple) ERC20Votes tokens.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::get_votes
fn get_votes(self: @TState, account: ContractAddress, timepoint: u64) -> u256
get_votes_with_params
Voting power of an account at a specific timepoint given additional encoded parameters.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::get_votes_with_params
fn get_votes_with_params(
self: @TState, account: ContractAddress, timepoint: u64, params: Span<felt252>,
) -> u256
has_voted
Returns whether account has cast a vote on proposal_id.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::has_voted
fn has_voted(self: @TState, proposal_id: felt252, account: ContractAddress) -> bool
propose
Creates a new proposal. Vote start after a delay specified by voting_delay and
lasts for a duration specified by voting_period.
NOTE: The state of the Governor and targets may change between the proposal creation and its execution. This may be the result of third party actions on the targeted contracts, or other governor proposals. For example, the balance of this contract could be updated or its access control permissions may be modified, possibly compromising the proposal’s ability to execute successfully (e.g. the governor doesn’t have enough value to cover a proposal with multiple transfers).
Returns the id of the proposal.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::propose
fn propose(ref self: TState, calls: Span<Call>, description: ByteArray) -> felt252
queue
Queue a proposal. Some governors require this step to be performed before execution can happen. If queuing is not necessary, this function may revert. Queuing a proposal requires the quorum to be reached, the vote to be successful, and the deadline to be reached.
Returns the id of the proposal.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::queue
fn queue(ref self: TState, calls: Span<Call>, description_hash: felt252) -> felt252
execute
Execute a successful proposal. This requires the quorum to be reached, the vote to be successful, and the deadline to be reached. Depending on the governor it might also be required that the proposal was queued and that some delay passed.
NOTE: Some modules can modify the requirements for execution, for example by adding an
additional timelock (See timelock_controller).
Returns the id of the proposal.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::execute
fn execute(ref self: TState, calls: Span<Call>, description_hash: felt252) -> felt252
cancel
Cancel a proposal. A proposal is cancellable by the proposer, but only while it is Pending state, i.e. before the vote starts.
Returns the id of the proposal.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::cancel
fn cancel(ref self: TState, calls: Span<Call>, description_hash: felt252) -> felt252
cast_vote
Cast a vote.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::cast_vote
fn cast_vote(ref self: TState, proposal_id: felt252, support: u8) -> u256
cast_vote_with_reason
Cast a vote with a reason.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::cast_vote_with_reason
fn cast_vote_with_reason(
ref self: TState, proposal_id: felt252, support: u8, reason: ByteArray,
) -> u256
cast_vote_with_reason_and_params
Cast a vote with a reason and additional serialized params.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::cast_vote_with_reason_and_params
fn cast_vote_with_reason_and_params(
ref self: TState, proposal_id: felt252, support: u8, reason: ByteArray, params: Span<felt252>,
) -> u256
cast_vote_by_sig
Cast a vote using the voter’s signature.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::cast_vote_by_sig
fn cast_vote_by_sig(
ref self: TState,
proposal_id: felt252,
support: u8,
voter: ContractAddress,
signature: Span<felt252>,
) -> u256
cast_vote_with_reason_and_params_by_sig
Cast a vote with a reason and additional serialized params using the voter’s
signature.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::cast_vote_with_reason_and_params_by_sig
fn cast_vote_with_reason_and_params_by_sig(
ref self: TState,
proposal_id: felt252,
support: u8,
voter: ContractAddress,
reason: ByteArray,
params: Span<felt252>,
signature: Span<felt252>,
) -> u256
nonces
Returns the next unused nonce for an address.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::nonces
fn nonces(self: @TState, voter: ContractAddress) -> felt252
relay
Relays a transaction or function call to an arbitrary target.
In cases where the governance executor is some contract other than the governor itself, like when using a timelock, this function can be invoked in a governance proposal to recover tokens that were sent to the governor contract by mistake.
NOTE: If the executor is simply the governor itself, use of relay is redundant.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernor::relay
fn relay(ref self: TState, call: Call)
UnsafeNewContractStateTraitForIGovernorForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::governor::UnsafeNewContractStateTraitForIGovernorForwardImpl
pub trait UnsafeNewContractStateTraitForIGovernorForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::governance::governor::UnsafeNewContractStateTraitForIGovernorForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
multisig
Fully qualified path: openzeppelin_interfaces::governance::multisig
Modules
| __external_IMultisigForwardImpl | — |
| __l1_handler_IMultisigForwardImpl | — |
| __constructor_IMultisigForwardImpl | — |
Enums
| TransactionState | Represents the possible states of a Multisig transaction. |
Type aliases
Traits
| IMultisig | Interface of a contract providing the Multisig functionality. |
| UnsafeNewContractStateTraitForIMultisigForwardImpl | — |
Groups:
dispatchers
| IMultisigDispatcher | — |
| IMultisigLibraryDispatcher | — |
| IMultisigSafeLibraryDispatcher | — |
| IMultisigSafeDispatcher | — |
Modules
Modules
| __external_IMultisigForwardImpl | — |
| __l1_handler_IMultisigForwardImpl | — |
| __constructor_IMultisigForwardImpl | — |
__external_IMultisigForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::multisig::__external_IMultisigForwardImpl
__l1_handler_IMultisigForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::multisig::__l1_handler_IMultisigForwardImpl
__constructor_IMultisigForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::multisig::__constructor_IMultisigForwardImpl
Enums
Enums
| TransactionState | Represents the possible states of a Multisig transaction. |
TransactionState
Represents the possible states of a Multisig transaction.
Fully qualified path: openzeppelin_interfaces::governance::multisig::TransactionState
pub enum TransactionState {
NotFound,
Pending,
Confirmed,
Executed,
}
Variants
NotFound
Fully qualified path: openzeppelin_interfaces::governance::multisig::TransactionState::NotFound
NotFound
Pending
Fully qualified path: openzeppelin_interfaces::governance::multisig::TransactionState::Pending
Pending
Confirmed
Fully qualified path: openzeppelin_interfaces::governance::multisig::TransactionState::Confirmed
Confirmed
Executed
Fully qualified path: openzeppelin_interfaces::governance::multisig::TransactionState::Executed
Executed
Type aliases
Type aliases
TransactionID
Fully qualified path: openzeppelin_interfaces::governance::multisig::TransactionID
pub type TransactionID = felt252;
Traits
Traits
| IMultisig | Interface of a contract providing the Multisig functionality. |
| UnsafeNewContractStateTraitForIMultisigForwardImpl | — |
IMultisig
Interface of a contract providing the Multisig functionality.
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig
pub trait IMultisig<TState>
Trait functions
get_quorum
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::get_quorum
fn get_quorum(self: @TState) -> u32
is_signer
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::is_signer
fn is_signer(self: @TState, signer: ContractAddress) -> bool
get_signers
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::get_signers
fn get_signers(self: @TState) -> Span<ContractAddress>
is_confirmed
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::is_confirmed
fn is_confirmed(self: @TState, id: felt252) -> bool
is_confirmed_by
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::is_confirmed_by
fn is_confirmed_by(self: @TState, id: felt252, signer: ContractAddress) -> bool
is_executed
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::is_executed
fn is_executed(self: @TState, id: felt252) -> bool
get_submitted_block
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::get_submitted_block
fn get_submitted_block(self: @TState, id: felt252) -> u64
get_transaction_state
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::get_transaction_state
fn get_transaction_state(self: @TState, id: felt252) -> TransactionState
get_transaction_confirmations
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::get_transaction_confirmations
fn get_transaction_confirmations(self: @TState, id: felt252) -> u32
hash_transaction
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::hash_transaction
fn hash_transaction(
self: @TState, to: ContractAddress, selector: felt252, calldata: Span<felt252>, salt: felt252,
) -> felt252
hash_transaction_batch
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::hash_transaction_batch
fn hash_transaction_batch(self: @TState, calls: Span<Call>, salt: felt252) -> felt252
add_signers
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::add_signers
fn add_signers(ref self: TState, new_quorum: u32, signers_to_add: Span<ContractAddress>)
remove_signers
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::remove_signers
fn remove_signers(ref self: TState, new_quorum: u32, signers_to_remove: Span<ContractAddress>)
replace_signer
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::replace_signer
fn replace_signer(
ref self: TState, signer_to_remove: ContractAddress, signer_to_add: ContractAddress,
)
change_quorum
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::change_quorum
fn change_quorum(ref self: TState, new_quorum: u32)
submit_transaction
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::submit_transaction
fn submit_transaction(
ref self: TState,
to: ContractAddress,
selector: felt252,
calldata: Span<felt252>,
salt: felt252,
) -> felt252
submit_transaction_batch
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::submit_transaction_batch
fn submit_transaction_batch(ref self: TState, calls: Span<Call>, salt: felt252) -> felt252
confirm_transaction
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::confirm_transaction
fn confirm_transaction(ref self: TState, id: felt252)
revoke_confirmation
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::revoke_confirmation
fn revoke_confirmation(ref self: TState, id: felt252)
execute_transaction
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::execute_transaction
fn execute_transaction(
ref self: TState,
to: ContractAddress,
selector: felt252,
calldata: Span<felt252>,
salt: felt252,
)
execute_transaction_batch
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisig::execute_transaction_batch
fn execute_transaction_batch(ref self: TState, calls: Span<Call>, salt: felt252)
UnsafeNewContractStateTraitForIMultisigForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::multisig::UnsafeNewContractStateTraitForIMultisigForwardImpl
pub trait UnsafeNewContractStateTraitForIMultisigForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::governance::multisig::UnsafeNewContractStateTraitForIMultisigForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
timelock
Fully qualified path: openzeppelin_interfaces::governance::timelock
Modules
Enums
Traits
| ITimelock | — |
| TimelockABI | — |
| UnsafeNewContractStateTraitForITimelockForwardImpl | — |
| UnsafeNewContractStateTraitForTimelockABIForwardImpl | — |
Groups:
dispatchers
| ITimelockDispatcherTrait | — |
| ITimelockSafeDispatcherTrait | — |
| TimelockABIDispatcherTrait | — |
| TimelockABISafeDispatcherTrait | — |
Modules
Modules
__external_ITimelockForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::timelock::__external_ITimelockForwardImpl
__l1_handler_ITimelockForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::timelock::__l1_handler_ITimelockForwardImpl
__constructor_ITimelockForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::timelock::__constructor_ITimelockForwardImpl
__external_TimelockABIForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::timelock::__external_TimelockABIForwardImpl
__l1_handler_TimelockABIForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::timelock::__l1_handler_TimelockABIForwardImpl
__constructor_TimelockABIForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::timelock::__constructor_TimelockABIForwardImpl
Enums
Enums
OperationState
Fully qualified path: openzeppelin_interfaces::governance::timelock::OperationState
pub enum OperationState {
Unset,
Waiting,
Ready,
Done,
}
Variants
Unset
Fully qualified path: openzeppelin_interfaces::governance::timelock::OperationState::Unset
Unset
Waiting
Fully qualified path: openzeppelin_interfaces::governance::timelock::OperationState::Waiting
Waiting
Ready
Fully qualified path: openzeppelin_interfaces::governance::timelock::OperationState::Ready
Ready
Done
Fully qualified path: openzeppelin_interfaces::governance::timelock::OperationState::Done
Done
Traits
Traits
| ITimelock | — |
| TimelockABI | — |
| UnsafeNewContractStateTraitForITimelockForwardImpl | — |
| UnsafeNewContractStateTraitForTimelockABIForwardImpl | — |
ITimelock
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelock
pub trait ITimelock<TState>
Trait functions
is_operation
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelock::is_operation
fn is_operation(self: @TState, id: felt252) -> bool
is_operation_pending
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelock::is_operation_pending
fn is_operation_pending(self: @TState, id: felt252) -> bool
is_operation_ready
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelock::is_operation_ready
fn is_operation_ready(self: @TState, id: felt252) -> bool
is_operation_done
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelock::is_operation_done
fn is_operation_done(self: @TState, id: felt252) -> bool
get_timestamp
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelock::get_timestamp
fn get_timestamp(self: @TState, id: felt252) -> u64
get_operation_state
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelock::get_operation_state
fn get_operation_state(self: @TState, id: felt252) -> OperationState
get_min_delay
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelock::get_min_delay
fn get_min_delay(self: @TState) -> u64
hash_operation
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelock::hash_operation
fn hash_operation(self: @TState, call: Call, predecessor: felt252, salt: felt252) -> felt252
hash_operation_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelock::hash_operation_batch
fn hash_operation_batch(
self: @TState, calls: Span<Call>, predecessor: felt252, salt: felt252,
) -> felt252
schedule
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelock::schedule
fn schedule(ref self: TState, call: Call, predecessor: felt252, salt: felt252, delay: u64)
schedule_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelock::schedule_batch
fn schedule_batch(
ref self: TState, calls: Span<Call>, predecessor: felt252, salt: felt252, delay: u64,
)
cancel
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelock::cancel
fn cancel(ref self: TState, id: felt252)
execute
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelock::execute
fn execute(ref self: TState, call: Call, predecessor: felt252, salt: felt252)
execute_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelock::execute_batch
fn execute_batch(ref self: TState, calls: Span<Call>, predecessor: felt252, salt: felt252)
update_delay
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelock::update_delay
fn update_delay(ref self: TState, new_delay: u64)
TimelockABI
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI
pub trait TimelockABI<TState>
Trait functions
is_operation
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::is_operation
fn is_operation(self: @TState, id: felt252) -> bool
is_operation_pending
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::is_operation_pending
fn is_operation_pending(self: @TState, id: felt252) -> bool
is_operation_ready
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::is_operation_ready
fn is_operation_ready(self: @TState, id: felt252) -> bool
is_operation_done
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::is_operation_done
fn is_operation_done(self: @TState, id: felt252) -> bool
get_timestamp
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::get_timestamp
fn get_timestamp(self: @TState, id: felt252) -> u64
get_operation_state
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::get_operation_state
fn get_operation_state(self: @TState, id: felt252) -> OperationState
get_min_delay
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::get_min_delay
fn get_min_delay(self: @TState) -> u64
hash_operation
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::hash_operation
fn hash_operation(self: @TState, call: Call, predecessor: felt252, salt: felt252) -> felt252
hash_operation_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::hash_operation_batch
fn hash_operation_batch(
self: @TState, calls: Span<Call>, predecessor: felt252, salt: felt252,
) -> felt252
schedule
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::schedule
fn schedule(ref self: TState, call: Call, predecessor: felt252, salt: felt252, delay: u64)
schedule_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::schedule_batch
fn schedule_batch(
ref self: TState, calls: Span<Call>, predecessor: felt252, salt: felt252, delay: u64,
)
cancel
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::cancel
fn cancel(ref self: TState, id: felt252)
execute
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::execute
fn execute(ref self: TState, call: Call, predecessor: felt252, salt: felt252)
execute_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::execute_batch
fn execute_batch(ref self: TState, calls: Span<Call>, predecessor: felt252, salt: felt252)
update_delay
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::update_delay
fn update_delay(ref self: TState, new_delay: u64)
supports_interface
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::supports_interface
fn supports_interface(self: @TState, interface_id: felt252) -> bool
has_role
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::has_role
fn has_role(self: @TState, role: felt252, account: ContractAddress) -> bool
get_role_admin
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::get_role_admin
fn get_role_admin(self: @TState, role: felt252) -> felt252
grant_role
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::grant_role
fn grant_role(ref self: TState, role: felt252, account: ContractAddress)
revoke_role
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::revoke_role
fn revoke_role(ref self: TState, role: felt252, account: ContractAddress)
renounce_role
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::renounce_role
fn renounce_role(ref self: TState, role: felt252, account: ContractAddress)
hasRole
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::hasRole
fn hasRole(self: @TState, role: felt252, account: ContractAddress) -> bool
getRoleAdmin
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::getRoleAdmin
fn getRoleAdmin(self: @TState, role: felt252) -> felt252
grantRole
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::grantRole
fn grantRole(ref self: TState, role: felt252, account: ContractAddress)
revokeRole
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::revokeRole
fn revokeRole(ref self: TState, role: felt252, account: ContractAddress)
renounceRole
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABI::renounceRole
fn renounceRole(ref self: TState, role: felt252, account: ContractAddress)
UnsafeNewContractStateTraitForITimelockForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::timelock::UnsafeNewContractStateTraitForITimelockForwardImpl
pub trait UnsafeNewContractStateTraitForITimelockForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::governance::timelock::UnsafeNewContractStateTraitForITimelockForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForTimelockABIForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::timelock::UnsafeNewContractStateTraitForTimelockABIForwardImpl
pub trait UnsafeNewContractStateTraitForTimelockABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::governance::timelock::UnsafeNewContractStateTraitForTimelockABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
votes
Fully qualified path: openzeppelin_interfaces::governance::votes
Modules
| __external_IVotesForwardImpl | — |
| __l1_handler_IVotesForwardImpl | — |
| __constructor_IVotesForwardImpl | — |
| __external_VotesABIForwardImpl | — |
| __l1_handler_VotesABIForwardImpl | — |
| __constructor_VotesABIForwardImpl | — |
Traits
| IVotes | Common interface for Votes-enabled contracts. |
| VotesABI | Common interface to interact with the Votes component. |
| UnsafeNewContractStateTraitForIVotesForwardImpl | — |
| UnsafeNewContractStateTraitForVotesABIForwardImpl | — |
Groups:
dispatchers
| IVotesDispatcher | — |
| IVotesLibraryDispatcher | — |
| IVotesSafeLibraryDispatcher | — |
| IVotesSafeDispatcher | — |
| VotesABIDispatcher | — |
| VotesABILibraryDispatcher | — |
| VotesABISafeLibraryDispatcher | — |
| VotesABISafeDispatcher | — |
| IVotesDispatcherTrait | — |
| IVotesSafeDispatcherTrait | — |
| VotesABIDispatcherTrait | — |
| VotesABISafeDispatcherTrait | — |
Modules
Modules
| __external_IVotesForwardImpl | — |
| __l1_handler_IVotesForwardImpl | — |
| __constructor_IVotesForwardImpl | — |
| __external_VotesABIForwardImpl | — |
| __l1_handler_VotesABIForwardImpl | — |
| __constructor_VotesABIForwardImpl | — |
__external_IVotesForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::votes::__external_IVotesForwardImpl
__l1_handler_IVotesForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::votes::__l1_handler_IVotesForwardImpl
__constructor_IVotesForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::votes::__constructor_IVotesForwardImpl
__external_VotesABIForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::votes::__external_VotesABIForwardImpl
__l1_handler_VotesABIForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::votes::__l1_handler_VotesABIForwardImpl
__constructor_VotesABIForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::votes::__constructor_VotesABIForwardImpl
Traits
Traits
| IVotes | Common interface for Votes-enabled contracts. |
| VotesABI | Common interface to interact with the Votes component. |
| UnsafeNewContractStateTraitForIVotesForwardImpl | — |
| UnsafeNewContractStateTraitForVotesABIForwardImpl | — |
IVotes
Common interface for Votes-enabled contracts.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotes
pub trait IVotes<TState>
Trait functions
get_votes
Returns the current amount of votes that account has.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotes::get_votes
fn get_votes(self: @TState, account: ContractAddress) -> u256
get_past_votes
Returns the amount of votes that account had at a specific moment in the past.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotes::get_past_votes
fn get_past_votes(self: @TState, account: ContractAddress, timepoint: u64) -> u256
get_past_total_supply
Returns the total supply of votes available at a specific moment in the past.
NOTE: This value is the sum of all available votes, which is not necessarily the sum of all delegated votes. Votes that have not been delegated are still part of total supply, even though they would not participate in a vote.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotes::get_past_total_supply
fn get_past_total_supply(self: @TState, timepoint: u64) -> u256
delegates
Returns the delegate that account has chosen.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotes::delegates
fn delegates(self: @TState, account: ContractAddress) -> ContractAddress
delegate
Delegates votes from the sender to delegatee.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotes::delegate
fn delegate(ref self: TState, delegatee: ContractAddress)
delegate_by_sig
Delegates votes from delegator to delegatee.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotes::delegate_by_sig
fn delegate_by_sig(
ref self: TState,
delegator: ContractAddress,
delegatee: ContractAddress,
nonce: felt252,
expiry: u64,
signature: Span<felt252>,
)
clock
Returns the current timepoint determined by the contract’s operational mode, intended for use in time-sensitive logic. See https://eips.ethereum.org/EIPS/eip-6372#clock.
Requirements:
- This function MUST always be non-decreasing.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotes::clock
fn clock(self: @TState) -> u64
CLOCK_MODE
Returns a description of the clock the contract is operating in. See https://eips.ethereum.org/EIPS/eip-6372#clock_mode.
Requirements:
- The output MUST be formatted like a URL query string, decodable in standard JavaScript.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotes::CLOCK_MODE
fn CLOCK_MODE(self: @TState) -> ByteArray
VotesABI
Common interface to interact with the Votes component.
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABI
pub trait VotesABI<TState>
Trait functions
get_votes
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABI::get_votes
fn get_votes(self: @TState, account: ContractAddress) -> u256
get_past_votes
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABI::get_past_votes
fn get_past_votes(self: @TState, account: ContractAddress, timepoint: u64) -> u256
get_past_total_supply
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABI::get_past_total_supply
fn get_past_total_supply(self: @TState, timepoint: u64) -> u256
delegates
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABI::delegates
fn delegates(self: @TState, account: ContractAddress) -> ContractAddress
delegate
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABI::delegate
fn delegate(ref self: TState, delegatee: ContractAddress)
delegate_by_sig
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABI::delegate_by_sig
fn delegate_by_sig(
ref self: TState,
delegator: ContractAddress,
delegatee: ContractAddress,
nonce: felt252,
expiry: u64,
signature: Span<felt252>,
)
nonces
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABI::nonces
fn nonces(self: @TState, owner: ContractAddress) -> felt252
clock
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABI::clock
fn clock(self: @TState) -> u64
CLOCK_MODE
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABI::CLOCK_MODE
fn CLOCK_MODE(self: @TState) -> ByteArray
UnsafeNewContractStateTraitForIVotesForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::votes::UnsafeNewContractStateTraitForIVotesForwardImpl
pub trait UnsafeNewContractStateTraitForIVotesForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::governance::votes::UnsafeNewContractStateTraitForIVotesForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForVotesABIForwardImpl
Fully qualified path: openzeppelin_interfaces::governance::votes::UnsafeNewContractStateTraitForVotesABIForwardImpl
pub trait UnsafeNewContractStateTraitForVotesABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::governance::votes::UnsafeNewContractStateTraitForVotesABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
introspection
Fully qualified path: openzeppelin_interfaces::introspection
Modules
Constants
Traits
Groups:
dispatchers
Modules
Modules
__external_ISRC5ForwardImpl
Fully qualified path: openzeppelin_interfaces::introspection::__external_ISRC5ForwardImpl
__l1_handler_ISRC5ForwardImpl
Fully qualified path: openzeppelin_interfaces::introspection::__l1_handler_ISRC5ForwardImpl
__constructor_ISRC5ForwardImpl
Fully qualified path: openzeppelin_interfaces::introspection::__constructor_ISRC5ForwardImpl
Constants
Constants
ISRC5_ID
Fully qualified path: openzeppelin_interfaces::introspection::ISRC5_ID
pub const ISRC5_ID: felt252 =
1797054754729183305928171726271749999318198861813713898581160688510183841877;
Traits
Traits
ISRC5
Fully qualified path: openzeppelin_interfaces::introspection::ISRC5
pub trait ISRC5<TState>
Trait functions
supports_interface
Fully qualified path: openzeppelin_interfaces::introspection::ISRC5::supports_interface
fn supports_interface(self: @TState, interface_id: felt252) -> bool
UnsafeNewContractStateTraitForISRC5ForwardImpl
Fully qualified path: openzeppelin_interfaces::introspection::UnsafeNewContractStateTraitForISRC5ForwardImpl
pub trait UnsafeNewContractStateTraitForISRC5ForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::introspection::UnsafeNewContractStateTraitForISRC5ForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
security
Fully qualified path: openzeppelin_interfaces::security
Modules
Modules
Modules
initializable
Fully qualified path: openzeppelin_interfaces::security::initializable
Modules
| __external_IInitializableForwardImpl | — |
| __l1_handler_IInitializableForwardImpl | — |
| __constructor_IInitializableForwardImpl | — |
Traits
Groups:
dispatchers
| IInitializableDispatcher | — |
| IInitializableLibraryDispatcher | — |
| IInitializableSafeLibraryDispatcher | — |
| IInitializableSafeDispatcher | — |
Modules
Modules
| __external_IInitializableForwardImpl | — |
| __l1_handler_IInitializableForwardImpl | — |
| __constructor_IInitializableForwardImpl | — |
__external_IInitializableForwardImpl
Fully qualified path: openzeppelin_interfaces::security::initializable::__external_IInitializableForwardImpl
__l1_handler_IInitializableForwardImpl
Fully qualified path: openzeppelin_interfaces::security::initializable::__l1_handler_IInitializableForwardImpl
__constructor_IInitializableForwardImpl
Fully qualified path: openzeppelin_interfaces::security::initializable::__constructor_IInitializableForwardImpl
Traits
Traits
IInitializable
Fully qualified path: openzeppelin_interfaces::security::initializable::IInitializable
pub trait IInitializable<TState>
Trait functions
is_initialized
Fully qualified path: openzeppelin_interfaces::security::initializable::IInitializable::is_initialized
fn is_initialized(self: @TState) -> bool
UnsafeNewContractStateTraitForIInitializableForwardImpl
Fully qualified path: openzeppelin_interfaces::security::initializable::UnsafeNewContractStateTraitForIInitializableForwardImpl
pub trait UnsafeNewContractStateTraitForIInitializableForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::security::initializable::UnsafeNewContractStateTraitForIInitializableForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
pausable
Fully qualified path: openzeppelin_interfaces::security::pausable
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: openzeppelin_interfaces::security::pausable::__external_IPausableForwardImpl
__l1_handler_IPausableForwardImpl
Fully qualified path: openzeppelin_interfaces::security::pausable::__l1_handler_IPausableForwardImpl
__constructor_IPausableForwardImpl
Fully qualified path: openzeppelin_interfaces::security::pausable::__constructor_IPausableForwardImpl
Traits
Traits
IPausable
Fully qualified path: openzeppelin_interfaces::security::pausable::IPausable
pub trait IPausable<TState>
Trait functions
is_paused
Fully qualified path: openzeppelin_interfaces::security::pausable::IPausable::is_paused
fn is_paused(self: @TState) -> bool
UnsafeNewContractStateTraitForIPausableForwardImpl
Fully qualified path: openzeppelin_interfaces::security::pausable::UnsafeNewContractStateTraitForIPausableForwardImpl
pub trait UnsafeNewContractStateTraitForIPausableForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::security::pausable::UnsafeNewContractStateTraitForIPausableForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
token
Fully qualified path: openzeppelin_interfaces::token
Modules
Modules
Modules
erc1155
Fully qualified path: openzeppelin_interfaces::token::erc1155
Modules
Constants
Traits
Groups:
dispatchers
Modules
Modules
__external_IERC1155ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__external_IERC1155ForwardImpl
__l1_handler_IERC1155ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__l1_handler_IERC1155ForwardImpl
__constructor_IERC1155ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__constructor_IERC1155ForwardImpl
__external_IERC1155MetadataURIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__external_IERC1155MetadataURIForwardImpl
__l1_handler_IERC1155MetadataURIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__l1_handler_IERC1155MetadataURIForwardImpl
__constructor_IERC1155MetadataURIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__constructor_IERC1155MetadataURIForwardImpl
__external_IERC1155CamelForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__external_IERC1155CamelForwardImpl
__l1_handler_IERC1155CamelForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__l1_handler_IERC1155CamelForwardImpl
__constructor_IERC1155CamelForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__constructor_IERC1155CamelForwardImpl
__external_ERC1155ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__external_ERC1155ABIForwardImpl
__l1_handler_ERC1155ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__l1_handler_ERC1155ABIForwardImpl
__constructor_ERC1155ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__constructor_ERC1155ABIForwardImpl
__external_IERC1155ReceiverForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__external_IERC1155ReceiverForwardImpl
__l1_handler_IERC1155ReceiverForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__l1_handler_IERC1155ReceiverForwardImpl
__constructor_IERC1155ReceiverForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__constructor_IERC1155ReceiverForwardImpl
__external_IERC1155ReceiverCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__external_IERC1155ReceiverCamelForwardImpl
__l1_handler_IERC1155ReceiverCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__l1_handler_IERC1155ReceiverCamelForwardImpl
__constructor_IERC1155ReceiverCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__constructor_IERC1155ReceiverCamelForwardImpl
__external_ERC1155ReceiverABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__external_ERC1155ReceiverABIForwardImpl
__l1_handler_ERC1155ReceiverABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__l1_handler_ERC1155ReceiverABIForwardImpl
__constructor_ERC1155ReceiverABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::__constructor_ERC1155ReceiverABIForwardImpl
Constants
Constants
IERC1155_ID
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155_ID
pub const IERC1155_ID: felt252 =
171526755528726620767716901105953212358419028569576438355661780120349907794;
IERC1155_METADATA_URI_ID
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155_METADATA_URI_ID
pub const IERC1155_METADATA_URI_ID: felt252 =
358215409537235645103577935016882197524612100481971422555274166713895657207;
IERC1155_RECEIVER_ID
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155_RECEIVER_ID
pub const IERC1155_RECEIVER_ID: felt252 =
619324048771084896933651189367413709524441469864785024096531083413719306590;
Traits
Traits
IERC1155
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155
pub trait IERC1155<TState>
Trait functions
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155::balance_of
fn balance_of(self: @TState, account: ContractAddress, token_id: u256) -> u256
balance_of_batch
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155::balance_of_batch
fn balance_of_batch(
self: @TState, accounts: Span<ContractAddress>, token_ids: Span<u256>,
) -> Span<u256>
safe_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155::safe_transfer_from
fn safe_transfer_from(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
token_id: u256,
value: u256,
data: Span<felt252>,
)
safe_batch_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155::safe_batch_transfer_from
fn safe_batch_transfer_from(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
)
is_approved_for_all
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155::is_approved_for_all
fn is_approved_for_all(self: @TState, owner: ContractAddress, operator: ContractAddress) -> bool
set_approval_for_all
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155::set_approval_for_all
fn set_approval_for_all(ref self: TState, operator: ContractAddress, approved: bool)
IERC1155MetadataURI
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155MetadataURI
pub trait IERC1155MetadataURI<TState>
Trait functions
uri
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155MetadataURI::uri
fn uri(self: @TState, token_id: u256) -> ByteArray
IERC1155Camel
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155Camel
pub trait IERC1155Camel<TState>
Trait functions
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155Camel::balanceOf
fn balanceOf(self: @TState, account: ContractAddress, tokenId: u256) -> u256
balanceOfBatch
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155Camel::balanceOfBatch
fn balanceOfBatch(
self: @TState, accounts: Span<ContractAddress>, tokenIds: Span<u256>,
) -> Span<u256>
safeTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155Camel::safeTransferFrom
fn safeTransferFrom(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
tokenId: u256,
value: u256,
data: Span<felt252>,
)
safeBatchTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155Camel::safeBatchTransferFrom
fn safeBatchTransferFrom(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
tokenIds: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
)
isApprovedForAll
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155Camel::isApprovedForAll
fn isApprovedForAll(self: @TState, owner: ContractAddress, operator: ContractAddress) -> bool
setApprovalForAll
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155Camel::setApprovalForAll
fn setApprovalForAll(ref self: TState, operator: ContractAddress, approved: bool)
ERC1155ABI
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABI
pub trait ERC1155ABI<TState>
Trait functions
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABI::balance_of
fn balance_of(self: @TState, account: ContractAddress, token_id: u256) -> u256
balance_of_batch
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABI::balance_of_batch
fn balance_of_batch(
self: @TState, accounts: Span<ContractAddress>, token_ids: Span<u256>,
) -> Span<u256>
safe_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABI::safe_transfer_from
fn safe_transfer_from(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
token_id: u256,
value: u256,
data: Span<felt252>,
)
safe_batch_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABI::safe_batch_transfer_from
fn safe_batch_transfer_from(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
)
is_approved_for_all
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABI::is_approved_for_all
fn is_approved_for_all(self: @TState, owner: ContractAddress, operator: ContractAddress) -> bool
set_approval_for_all
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABI::set_approval_for_all
fn set_approval_for_all(ref self: TState, operator: ContractAddress, approved: bool)
supports_interface
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABI::supports_interface
fn supports_interface(self: @TState, interface_id: felt252) -> bool
uri
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABI::uri
fn uri(self: @TState, token_id: u256) -> ByteArray
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABI::balanceOf
fn balanceOf(self: @TState, account: ContractAddress, tokenId: u256) -> u256
balanceOfBatch
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABI::balanceOfBatch
fn balanceOfBatch(
self: @TState, accounts: Span<ContractAddress>, tokenIds: Span<u256>,
) -> Span<u256>
safeTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABI::safeTransferFrom
fn safeTransferFrom(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
tokenId: u256,
value: u256,
data: Span<felt252>,
)
safeBatchTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABI::safeBatchTransferFrom
fn safeBatchTransferFrom(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
tokenIds: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
)
isApprovedForAll
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABI::isApprovedForAll
fn isApprovedForAll(self: @TState, owner: ContractAddress, operator: ContractAddress) -> bool
setApprovalForAll
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABI::setApprovalForAll
fn setApprovalForAll(ref self: TState, operator: ContractAddress, approved: bool)
IERC1155Receiver
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155Receiver
pub trait IERC1155Receiver<TState>
Trait functions
on_erc1155_received
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155Receiver::on_erc1155_received
fn on_erc1155_received(
self: @TState,
operator: ContractAddress,
from: ContractAddress,
token_id: u256,
value: u256,
data: Span<felt252>,
) -> felt252
on_erc1155_batch_received
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155Receiver::on_erc1155_batch_received
fn on_erc1155_batch_received(
self: @TState,
operator: ContractAddress,
from: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> felt252
IERC1155ReceiverCamel
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverCamel
pub trait IERC1155ReceiverCamel<TState>
Trait functions
onERC1155Received
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverCamel::onERC1155Received
fn onERC1155Received(
self: @TState,
operator: ContractAddress,
from: ContractAddress,
tokenId: u256,
value: u256,
data: Span<felt252>,
) -> felt252
onERC1155BatchReceived
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverCamel::onERC1155BatchReceived
fn onERC1155BatchReceived(
self: @TState,
operator: ContractAddress,
from: ContractAddress,
tokenIds: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> felt252
ERC1155ReceiverABI
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABI
pub trait ERC1155ReceiverABI<TState>
Trait functions
on_erc1155_received
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABI::on_erc1155_received
fn on_erc1155_received(
self: @TState,
operator: ContractAddress,
from: ContractAddress,
token_id: u256,
value: u256,
data: Span<felt252>,
) -> felt252
on_erc1155_batch_received
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABI::on_erc1155_batch_received
fn on_erc1155_batch_received(
self: @TState,
operator: ContractAddress,
from: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> felt252
onERC1155Received
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABI::onERC1155Received
fn onERC1155Received(
self: @TState,
operator: ContractAddress,
from: ContractAddress,
tokenId: u256,
value: u256,
data: Span<felt252>,
) -> felt252
onERC1155BatchReceived
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABI::onERC1155BatchReceived
fn onERC1155BatchReceived(
self: @TState,
operator: ContractAddress,
from: ContractAddress,
tokenIds: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> felt252
supports_interface
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABI::supports_interface
fn supports_interface(self: @TState, interface_id: felt252) -> bool
UnsafeNewContractStateTraitForIERC1155ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::UnsafeNewContractStateTraitForIERC1155ForwardImpl
pub trait UnsafeNewContractStateTraitForIERC1155ForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc1155::UnsafeNewContractStateTraitForIERC1155ForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC1155MetadataURIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::UnsafeNewContractStateTraitForIERC1155MetadataURIForwardImpl
pub trait UnsafeNewContractStateTraitForIERC1155MetadataURIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc1155::UnsafeNewContractStateTraitForIERC1155MetadataURIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC1155CamelForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::UnsafeNewContractStateTraitForIERC1155CamelForwardImpl
pub trait UnsafeNewContractStateTraitForIERC1155CamelForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc1155::UnsafeNewContractStateTraitForIERC1155CamelForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC1155ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::UnsafeNewContractStateTraitForERC1155ABIForwardImpl
pub trait UnsafeNewContractStateTraitForERC1155ABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc1155::UnsafeNewContractStateTraitForERC1155ABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC1155ReceiverForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::UnsafeNewContractStateTraitForIERC1155ReceiverForwardImpl
pub trait UnsafeNewContractStateTraitForIERC1155ReceiverForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc1155::UnsafeNewContractStateTraitForIERC1155ReceiverForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC1155ReceiverCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::UnsafeNewContractStateTraitForIERC1155ReceiverCamelForwardImpl
pub trait UnsafeNewContractStateTraitForIERC1155ReceiverCamelForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc1155::UnsafeNewContractStateTraitForIERC1155ReceiverCamelForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC1155ReceiverABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc1155::UnsafeNewContractStateTraitForERC1155ReceiverABIForwardImpl
pub trait UnsafeNewContractStateTraitForERC1155ReceiverABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc1155::UnsafeNewContractStateTraitForERC1155ReceiverABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
erc20
Fully qualified path: openzeppelin_interfaces::token::erc20
Modules
Traits
Groups:
dispatchers
Modules
Modules
__external_IERC20ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__external_IERC20ForwardImpl
__l1_handler_IERC20ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__l1_handler_IERC20ForwardImpl
__constructor_IERC20ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__constructor_IERC20ForwardImpl
__external_IERC20MetadataForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__external_IERC20MetadataForwardImpl
__l1_handler_IERC20MetadataForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__l1_handler_IERC20MetadataForwardImpl
__constructor_IERC20MetadataForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__constructor_IERC20MetadataForwardImpl
__external_IERC20CamelForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__external_IERC20CamelForwardImpl
__l1_handler_IERC20CamelForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__l1_handler_IERC20CamelForwardImpl
__constructor_IERC20CamelForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__constructor_IERC20CamelForwardImpl
__external_IERC20CamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__external_IERC20CamelOnlyForwardImpl
__l1_handler_IERC20CamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__l1_handler_IERC20CamelOnlyForwardImpl
__constructor_IERC20CamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__constructor_IERC20CamelOnlyForwardImpl
__external_IERC20MixinForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__external_IERC20MixinForwardImpl
__l1_handler_IERC20MixinForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__l1_handler_IERC20MixinForwardImpl
__constructor_IERC20MixinForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__constructor_IERC20MixinForwardImpl
__external_IERC20PermitForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__external_IERC20PermitForwardImpl
__l1_handler_IERC20PermitForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__l1_handler_IERC20PermitForwardImpl
__constructor_IERC20PermitForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__constructor_IERC20PermitForwardImpl
__external_ERC20ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__external_ERC20ABIForwardImpl
__l1_handler_ERC20ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__l1_handler_ERC20ABIForwardImpl
__constructor_ERC20ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::__constructor_ERC20ABIForwardImpl
Traits
Traits
IERC20
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20
pub trait IERC20<TState>
Trait functions
total_supply
Returns the total supply of tokens.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20::total_supply
fn total_supply(self: @TState) -> u256
balance_of
Returns the amount of tokens owned by account.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20::balance_of
fn balance_of(self: @TState, account: ContractAddress) -> u256
allowance
Returns the remaining number of tokens that spender will be allowed to spend on behalf of
owner through transfer_from.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20::allowance
fn allowance(self: @TState, owner: ContractAddress, spender: ContractAddress) -> u256
transfer
Moves amount tokens from the caller’s account to recipient.
Returns a boolean value indicating whether the operation succeeded.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20::transfer
fn transfer(ref self: TState, recipient: ContractAddress, amount: u256) -> bool
transfer_from
Moves amount tokens from sender to recipient using the allowance mechanism.
Returns a boolean value indicating whether the operation succeeded.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20::transfer_from
fn transfer_from(
ref self: TState, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> bool
approve
Sets amount as the allowance of spender over the caller’s tokens.
Returns a boolean value indicating whether the operation succeeded.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20::approve
fn approve(ref self: TState, spender: ContractAddress, amount: u256) -> bool
IERC20Metadata
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Metadata
pub trait IERC20Metadata<TState>
Trait functions
name
Returns the name of the token.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Metadata::name
fn name(self: @TState) -> ByteArray
symbol
Returns the symbol of the token.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Metadata::symbol
fn symbol(self: @TState) -> ByteArray
decimals
Returns the number of decimals used to get its user representation.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Metadata::decimals
fn decimals(self: @TState) -> u8
IERC20Camel
Adds camelCase support for ‘ERC20’.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Camel
pub trait IERC20Camel<TState>
Trait functions
totalSupply
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Camel::totalSupply
fn totalSupply(self: @TState) -> u256
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Camel::balanceOf
fn balanceOf(self: @TState, account: ContractAddress) -> u256
allowance
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Camel::allowance
fn allowance(self: @TState, owner: ContractAddress, spender: ContractAddress) -> u256
transfer
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Camel::transfer
fn transfer(ref self: TState, recipient: ContractAddress, amount: u256) -> bool
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Camel::transferFrom
fn transferFrom(
ref self: TState, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> bool
approve
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Camel::approve
fn approve(ref self: TState, spender: ContractAddress, amount: u256) -> bool
IERC20CamelOnly
Adds camelCase support for ‘ERC20’.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnly
pub trait IERC20CamelOnly<TState>
Trait functions
totalSupply
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnly::totalSupply
fn totalSupply(self: @TState) -> u256
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnly::balanceOf
fn balanceOf(self: @TState, account: ContractAddress) -> u256
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnly::transferFrom
fn transferFrom(
ref self: TState, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> bool
IERC20Mixin
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Mixin
pub trait IERC20Mixin<TState>
Trait functions
total_supply
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Mixin::total_supply
fn total_supply(self: @TState) -> u256
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Mixin::balance_of
fn balance_of(self: @TState, account: ContractAddress) -> u256
allowance
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Mixin::allowance
fn allowance(self: @TState, owner: ContractAddress, spender: ContractAddress) -> u256
transfer
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Mixin::transfer
fn transfer(ref self: TState, recipient: ContractAddress, amount: u256) -> bool
transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Mixin::transfer_from
fn transfer_from(
ref self: TState, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> bool
approve
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Mixin::approve
fn approve(ref self: TState, spender: ContractAddress, amount: u256) -> bool
name
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Mixin::name
fn name(self: @TState) -> ByteArray
symbol
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Mixin::symbol
fn symbol(self: @TState) -> ByteArray
decimals
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Mixin::decimals
fn decimals(self: @TState) -> u8
totalSupply
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Mixin::totalSupply
fn totalSupply(self: @TState) -> u256
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Mixin::balanceOf
fn balanceOf(self: @TState, account: ContractAddress) -> u256
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Mixin::transferFrom
fn transferFrom(
ref self: TState, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> bool
IERC20Permit
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Permit
pub trait IERC20Permit<TState>
Trait functions
permit
Sets amount as the allowance of spender over owner’s tokens, given the signature.
Requirements:
deadlinemust be a timestamp in the future.signaturemust be a valid secp256k1 signature fromownerover the EIP712-formatted function arguments.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Permit::permit
fn permit(
ref self: TState,
owner: ContractAddress,
spender: ContractAddress,
amount: u256,
deadline: u64,
signature: Span<felt252>,
)
nonces
Returns the current nonce for owner.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Permit::nonces
fn nonces(self: @TState, owner: ContractAddress) -> felt252
DOMAIN_SEPARATOR
Returns the domain separator used in the encoding of the signatures for permit.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Permit::DOMAIN_SEPARATOR
fn DOMAIN_SEPARATOR(self: @TState) -> felt252
ERC20ABI
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABI
pub trait ERC20ABI<TState>
Trait functions
total_supply
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABI::total_supply
fn total_supply(self: @TState) -> u256
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABI::balance_of
fn balance_of(self: @TState, account: ContractAddress) -> u256
allowance
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABI::allowance
fn allowance(self: @TState, owner: ContractAddress, spender: ContractAddress) -> u256
transfer
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABI::transfer
fn transfer(ref self: TState, recipient: ContractAddress, amount: u256) -> bool
transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABI::transfer_from
fn transfer_from(
ref self: TState, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> bool
approve
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABI::approve
fn approve(ref self: TState, spender: ContractAddress, amount: u256) -> bool
name
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABI::name
fn name(self: @TState) -> ByteArray
symbol
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABI::symbol
fn symbol(self: @TState) -> ByteArray
decimals
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABI::decimals
fn decimals(self: @TState) -> u8
totalSupply
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABI::totalSupply
fn totalSupply(self: @TState) -> u256
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABI::balanceOf
fn balanceOf(self: @TState, account: ContractAddress) -> u256
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABI::transferFrom
fn transferFrom(
ref self: TState, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> bool
permit
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABI::permit
fn permit(
ref self: TState,
owner: ContractAddress,
spender: ContractAddress,
amount: u256,
deadline: u64,
signature: Span<felt252>,
)
nonces
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABI::nonces
fn nonces(self: @TState, owner: ContractAddress) -> felt252
DOMAIN_SEPARATOR
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABI::DOMAIN_SEPARATOR
fn DOMAIN_SEPARATOR(self: @TState) -> felt252
snip12_metadata
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABI::snip12_metadata
fn snip12_metadata(self: @TState) -> (felt252, felt252)
UnsafeNewContractStateTraitForIERC20ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::UnsafeNewContractStateTraitForIERC20ForwardImpl
pub trait UnsafeNewContractStateTraitForIERC20ForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc20::UnsafeNewContractStateTraitForIERC20ForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC20MetadataForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::UnsafeNewContractStateTraitForIERC20MetadataForwardImpl
pub trait UnsafeNewContractStateTraitForIERC20MetadataForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc20::UnsafeNewContractStateTraitForIERC20MetadataForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC20CamelForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::UnsafeNewContractStateTraitForIERC20CamelForwardImpl
pub trait UnsafeNewContractStateTraitForIERC20CamelForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc20::UnsafeNewContractStateTraitForIERC20CamelForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC20CamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::UnsafeNewContractStateTraitForIERC20CamelOnlyForwardImpl
pub trait UnsafeNewContractStateTraitForIERC20CamelOnlyForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc20::UnsafeNewContractStateTraitForIERC20CamelOnlyForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC20MixinForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::UnsafeNewContractStateTraitForIERC20MixinForwardImpl
pub trait UnsafeNewContractStateTraitForIERC20MixinForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc20::UnsafeNewContractStateTraitForIERC20MixinForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC20PermitForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::UnsafeNewContractStateTraitForIERC20PermitForwardImpl
pub trait UnsafeNewContractStateTraitForIERC20PermitForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc20::UnsafeNewContractStateTraitForIERC20PermitForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC20ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc20::UnsafeNewContractStateTraitForERC20ABIForwardImpl
pub trait UnsafeNewContractStateTraitForERC20ABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc20::UnsafeNewContractStateTraitForERC20ABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
erc2981
Fully qualified path: openzeppelin_interfaces::token::erc2981
Modules
Constants
Traits
| IERC2981 | Interface of the ERC2981 standard. |
| IERC2981Info | Interface providing external read functions for discovering the state of ERC2981 component. |
| IERC2981Admin | Interface providing external admin functions for managing the settings of ERC2981 component. |
| IERC2981ABI | Interface that aggregates all ERC2981 component’s external functions. |
| UnsafeNewContractStateTraitForIERC2981ForwardImpl | — |
| UnsafeNewContractStateTraitForIERC2981InfoForwardImpl | — |
| UnsafeNewContractStateTraitForIERC2981AdminForwardImpl | — |
| UnsafeNewContractStateTraitForIERC2981ABIForwardImpl | — |
Groups:
dispatchers
Modules
Modules
__external_IERC2981ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc2981::__external_IERC2981ForwardImpl
__l1_handler_IERC2981ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc2981::__l1_handler_IERC2981ForwardImpl
__constructor_IERC2981ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc2981::__constructor_IERC2981ForwardImpl
__external_IERC2981InfoForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc2981::__external_IERC2981InfoForwardImpl
__l1_handler_IERC2981InfoForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc2981::__l1_handler_IERC2981InfoForwardImpl
__constructor_IERC2981InfoForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc2981::__constructor_IERC2981InfoForwardImpl
__external_IERC2981AdminForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc2981::__external_IERC2981AdminForwardImpl
__l1_handler_IERC2981AdminForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc2981::__l1_handler_IERC2981AdminForwardImpl
__constructor_IERC2981AdminForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc2981::__constructor_IERC2981AdminForwardImpl
__external_IERC2981ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc2981::__external_IERC2981ABIForwardImpl
__l1_handler_IERC2981ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc2981::__l1_handler_IERC2981ABIForwardImpl
__constructor_IERC2981ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc2981::__constructor_IERC2981ABIForwardImpl
Constants
Constants
IERC2981_ID
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981_ID
pub const IERC2981_ID: felt252 =
1277881151558992664637335587755523664426301861744014091380362373697119870678;
Traits
Traits
| IERC2981 | Interface of the ERC2981 standard. |
| IERC2981Info | Interface providing external read functions for discovering the state of ERC2981 component. |
| IERC2981Admin | Interface providing external admin functions for managing the settings of ERC2981 component. |
| IERC2981ABI | Interface that aggregates all ERC2981 component’s external functions. |
| UnsafeNewContractStateTraitForIERC2981ForwardImpl | — |
| UnsafeNewContractStateTraitForIERC2981InfoForwardImpl | — |
| UnsafeNewContractStateTraitForIERC2981AdminForwardImpl | — |
| UnsafeNewContractStateTraitForIERC2981ABIForwardImpl | — |
IERC2981
Interface of the ERC2981 standard.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981
pub trait IERC2981<TState>
Trait functions
royalty_info
Returns how much royalty is owed and to whom, based on a sale price that may be denominated in any unit of exchange. The royalty amount is denominated and should be paid in that same unit of exchange.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981::royalty_info
fn royalty_info(self: @TState, token_id: u256, sale_price: u256) -> (ContractAddress, u256)
IERC2981Info
Interface providing external read functions for discovering the state of ERC2981 component.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981Info
pub trait IERC2981Info<TState>
Trait functions
default_royalty
Returns the royalty information that all ids in this contract will default to.
The returned tuple contains:
t.0: The receiver of the royalty payment.t.1: The numerator of the royalty fraction.t.2: The denominator of the royalty fraction.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981Info::default_royalty
fn default_royalty(self: @TState) -> (ContractAddress, u128, u128)
token_royalty
Returns the royalty information specific to a token. If no specific royalty information is set for the token, the default is returned.
The returned tuple contains:
t.0: The receiver of the royalty payment.t.1: The numerator of the royalty fraction.t.2: The denominator of the royalty fraction.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981Info::token_royalty
fn token_royalty(self: @TState, token_id: u256) -> (ContractAddress, u128, u128)
IERC2981Admin
Interface providing external admin functions for managing the settings of ERC2981 component.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981Admin
pub trait IERC2981Admin<TState>
Trait functions
set_default_royalty
Sets the royalty information that all ids in this contract will default to.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981Admin::set_default_royalty
fn set_default_royalty(ref self: TState, receiver: ContractAddress, fee_numerator: u128)
delete_default_royalty
Sets the default royalty percentage and receiver to zero.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981Admin::delete_default_royalty
fn delete_default_royalty(ref self: TState)
set_token_royalty
Sets the royalty information for a specific token id that takes precedence over the global default.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981Admin::set_token_royalty
fn set_token_royalty(
ref self: TState, token_id: u256, receiver: ContractAddress, fee_numerator: u128,
)
reset_token_royalty
Resets royalty information for the token id back to unset.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981Admin::reset_token_royalty
fn reset_token_royalty(ref self: TState, token_id: u256)
IERC2981ABI
Interface that aggregates all ERC2981 component’s external functions.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABI
pub trait IERC2981ABI<TState>
Trait functions
royalty_info
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABI::royalty_info
fn royalty_info(self: @TState, token_id: u256, sale_price: u256) -> (ContractAddress, u256)
default_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABI::default_royalty
fn default_royalty(self: @TState) -> (ContractAddress, u128, u128)
token_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABI::token_royalty
fn token_royalty(self: @TState, token_id: u256) -> (ContractAddress, u128, u128)
set_default_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABI::set_default_royalty
fn set_default_royalty(ref self: TState, receiver: ContractAddress, fee_numerator: u128)
delete_default_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABI::delete_default_royalty
fn delete_default_royalty(ref self: TState)
set_token_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABI::set_token_royalty
fn set_token_royalty(
ref self: TState, token_id: u256, receiver: ContractAddress, fee_numerator: u128,
)
reset_token_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABI::reset_token_royalty
fn reset_token_royalty(ref self: TState, token_id: u256)
UnsafeNewContractStateTraitForIERC2981ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc2981::UnsafeNewContractStateTraitForIERC2981ForwardImpl
pub trait UnsafeNewContractStateTraitForIERC2981ForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc2981::UnsafeNewContractStateTraitForIERC2981ForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC2981InfoForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc2981::UnsafeNewContractStateTraitForIERC2981InfoForwardImpl
pub trait UnsafeNewContractStateTraitForIERC2981InfoForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc2981::UnsafeNewContractStateTraitForIERC2981InfoForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC2981AdminForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc2981::UnsafeNewContractStateTraitForIERC2981AdminForwardImpl
pub trait UnsafeNewContractStateTraitForIERC2981AdminForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc2981::UnsafeNewContractStateTraitForIERC2981AdminForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC2981ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc2981::UnsafeNewContractStateTraitForIERC2981ABIForwardImpl
pub trait UnsafeNewContractStateTraitForIERC2981ABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc2981::UnsafeNewContractStateTraitForIERC2981ABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
erc4626
Fully qualified path: openzeppelin_interfaces::token::erc4626
Modules
Traits
| IERC4626 | — |
| ERC4626ABI | — |
| UnsafeNewContractStateTraitForIERC4626ForwardImpl | — |
| UnsafeNewContractStateTraitForERC4626ABIForwardImpl | — |
Groups:
dispatchers
| IERC4626DispatcherTrait | — |
| IERC4626SafeDispatcherTrait | — |
| ERC4626ABIDispatcherTrait | — |
| ERC4626ABISafeDispatcherTrait | — |
Modules
Modules
__external_IERC4626ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc4626::__external_IERC4626ForwardImpl
__l1_handler_IERC4626ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc4626::__l1_handler_IERC4626ForwardImpl
__constructor_IERC4626ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc4626::__constructor_IERC4626ForwardImpl
__external_ERC4626ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc4626::__external_ERC4626ABIForwardImpl
__l1_handler_ERC4626ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc4626::__l1_handler_ERC4626ABIForwardImpl
__constructor_ERC4626ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc4626::__constructor_ERC4626ABIForwardImpl
Traits
Traits
| IERC4626 | — |
| ERC4626ABI | — |
| UnsafeNewContractStateTraitForIERC4626ForwardImpl | — |
| UnsafeNewContractStateTraitForERC4626ABIForwardImpl | — |
IERC4626
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626
pub trait IERC4626<TState>
Trait functions
asset
Returns the address of the underlying token used for the Vault for accounting, depositing, and withdrawing.
Requirements:
- MUST be an ERC20 token contract.
- MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626::asset
fn asset(self: @TState) -> ContractAddress
total_assets
Returns the total amount of the underlying asset that is “managed” by Vault.
Requirements:
- SHOULD include any compounding that occurs from yield.
- MUST be inclusive of any fees that are charged against assets in the Vault.
- MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626::total_assets
fn total_assets(self: @TState) -> u256
convert_to_shares
Returns the amount of shares that the Vault would exchange for the amount of assets provided irrespective of slippage or fees.
Requirements:
- MUST NOT be inclusive of any fees that are charged against assets in the Vault.
- MUST NOT show any variations depending on the caller.
- MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange.
- MUST NOT panic unless due to integer overflow caused by an unreasonably large input.
- MUST round down towards 0.
NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and from.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626::convert_to_shares
fn convert_to_shares(self: @TState, assets: u256) -> u256
convert_to_assets
Returns the amount of assets that the Vault would exchange for the amount of shares provided irrespective of slippage or fees.
Requirements:
- MUST NOT be inclusive of any fees that are charged against assets in the Vault.
- MUST NOT show any variations depending on the caller.
- MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange.
- MUST NOT panic unless due to integer overflow caused by an unreasonably large input.
- MUST round down towards 0.
NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and from.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626::convert_to_assets
fn convert_to_assets(self: @TState, shares: u256) -> u256
max_deposit
Returns the maximum amount of the underlying asset that can be deposited into the Vault for
receiver, through a deposit call.
Requirements:
- MUST return a limited value if receiver is subject to some deposit limit.
- MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of assets that may be deposited.
- MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626::max_deposit
fn max_deposit(self: @TState, receiver: ContractAddress) -> u256
preview_deposit
Allows an on-chain or off-chain user to simulate the effects of their deposit at the current block, given current on-chain conditions.
Requirements:
- MUST return as close to and no more than the exact amount of Vault shares that would be
minted in a deposit call in the same transaction i.e. deposit should return the same or
more shares as
preview_depositif called in the same transaction. - MUST NOT account for deposit limits like those returned from
max_depositand should always act as though the deposit would be accepted, regardless if the user has enough tokens approved, etc. - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
- MUST NOT panic.
NOTE: Any unfavorable discrepancy between convert_to_shares and preview_deposit
SHOULD be considered slippage in share price or some other type of condition, meaning the
depositor will lose assets by depositing.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626::preview_deposit
fn preview_deposit(self: @TState, assets: u256) -> u256
deposit
Mints Vault shares to receiver by depositing exactly amount of assets.
Requirements:
- MUST emit the Deposit event.
- MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the deposit execution, and are accounted for during deposit.
- MUST panic if all of assets cannot be deposited (due to deposit limit being reached, slippage, the user not approving enough underlying tokens to the Vault contract, etc).
NOTE: Most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626::deposit
fn deposit(ref self: TState, assets: u256, receiver: ContractAddress) -> u256
max_mint
Returns the maximum amount of the Vault shares that can be minted for the receiver, through a mint call.
Requirements:
- MUST return a limited value if receiver is subject to some mint limit.
- MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of shares that may be minted.
- MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626::max_mint
fn max_mint(self: @TState, receiver: ContractAddress) -> u256
preview_mint
Allows an on-chain or off-chain user to simulate the effects of their mint at the current block, given current on-chain conditions.
Requirements:
- MUST return as close to and no fewer than the exact amount of assets that would be
deposited in a
mintcall in the same transaction. I.e.mintshould return the same or fewer assets aspreview_mintif called in the same transaction. - MUST NOT account for mint limits like those returned from
max_mintand should always act as though the mint would be accepted, regardless if the user has enough tokens approved, etc. - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
- MUST NOT panic.
NOTE: Any unfavorable discrepancy between convertToAssets and previewMint SHOULD be considered slippage in share price or some other type of condition, meaning the depositor will lose assets by minting.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626::preview_mint
fn preview_mint(self: @TState, shares: u256) -> u256
mint
Mints exactly shares Vault shares to receiver by depositing amount of underlying tokens.
Requirements:
- MUST emit the
Depositevent. - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the mint execution, and are accounted for during mint.
- MUST panic if all of shares cannot be minted (due to deposit limit being reached, slippage, the user not approving enough underlying tokens to the Vault contract, etc).
NOTE: Most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626::mint
fn mint(ref self: TState, shares: u256, receiver: ContractAddress) -> u256
max_withdraw
Returns the maximum amount of the underlying asset that can be withdrawn from the owner balance in the Vault, through a withdraw call.
Requirements:
- MUST return a limited value if owner is subject to some withdrawal limit or timelock.
- MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626::max_withdraw
fn max_withdraw(self: @TState, owner: ContractAddress) -> u256
preview_withdraw
Allows an on-chain or off-chain user to simulate the effects of their withdrawal at the current block, given current on-chain conditions.
Requirements:
- MUST return as close to and no fewer than the exact amount of Vault shares that would be burned in a withdraw call in the same transaction i.e. withdraw should return the same or fewer shares as preview_withdraw if called in the same transaction.
- MUST NOT account for withdrawal limits like those returned from max_withdraw and should always act as though the withdrawal would be accepted, regardless if the user has enough shares, etc.
- MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
- MUST not panic.
NOTE: Any unfavorable discrepancy between convert_to_shares and preview_withdraw
SHOULD be considered slippage in share price or some other type of condition, meaning the
depositor will lose assets by depositing.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626::preview_withdraw
fn preview_withdraw(self: @TState, assets: u256) -> u256
withdraw
Burns shares from owner and sends exactly assets of underlying tokens to receiver.
Requirements:
- MUST emit the
Withdrawevent. - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the withdraw execution, and are accounted for during withdraw.
- MUST revert if all of assets cannot be withdrawn (due to withdrawal limit being reached, slippage, the owner not having enough shares, etc).
NOTE: Some implementations will require pre-requesting to the Vault before a withdrawal may be performed. Those methods should be performed separately.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626::withdraw
fn withdraw(
ref self: TState, assets: u256, receiver: ContractAddress, owner: ContractAddress,
) -> u256
max_redeem
Returns the maximum amount of Vault shares that can be redeemed from the owner balance in the Vault, through a redeem call.
Requirements:
- MUST return a limited value if owner is subject to some withdrawal limit or timelock.
- MUST return
ERC20::balance_of(owner)ifowneris not subject to any withdrawal limit or timelock. - MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626::max_redeem
fn max_redeem(self: @TState, owner: ContractAddress) -> u256
preview_redeem
Allows an on-chain or off-chain user to simulate the effects of their redemption at the current block, given current on-chain conditions.
Requirements:
- MUST return as close to and no more than the exact amount of assets that would be withdrawn in a redeem call in the same transaction i.e. redeem should return the same or more assets as preview_redeem if called in the same transaction.
- MUST NOT account for redemption limits like those returned from max_redeem and should always act as though the redemption would be accepted, regardless if the user has enough shares, etc.
- MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
- MUST NOT panic.
NOTE: Any unfavorable discrepancy between convert_to_assets and preview_redeem SHOULD be
considered slippage in share price or some other type of condition, meaning the depositor
will lose assets by redeeming.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626::preview_redeem
fn preview_redeem(self: @TState, shares: u256) -> u256
redeem
Burns exactly shares from owner and sends assets of underlying tokens to receiver.
Requirements:
- MUST emit the
Withdrawevent. - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the redeem execution, and are accounted for during redeem.
- MUST revert if all of shares cannot be redeemed (due to withdrawal limit being reached, slippage, the owner not having enough shares, etc).
NOTE: Some implementations will require pre-requesting to the Vault before a withdrawal may be performed. Those methods should be performed separately.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626::redeem
fn redeem(ref self: TState, shares: u256, receiver: ContractAddress, owner: ContractAddress) -> u256
ERC4626ABI
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI
pub trait ERC4626ABI<TState>
Trait functions
asset
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::asset
fn asset(self: @TState) -> ContractAddress
total_assets
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::total_assets
fn total_assets(self: @TState) -> u256
convert_to_shares
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::convert_to_shares
fn convert_to_shares(self: @TState, assets: u256) -> u256
convert_to_assets
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::convert_to_assets
fn convert_to_assets(self: @TState, shares: u256) -> u256
max_deposit
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::max_deposit
fn max_deposit(self: @TState, receiver: ContractAddress) -> u256
preview_deposit
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::preview_deposit
fn preview_deposit(self: @TState, assets: u256) -> u256
deposit
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::deposit
fn deposit(ref self: TState, assets: u256, receiver: ContractAddress) -> u256
max_mint
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::max_mint
fn max_mint(self: @TState, receiver: ContractAddress) -> u256
preview_mint
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::preview_mint
fn preview_mint(self: @TState, shares: u256) -> u256
mint
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::mint
fn mint(ref self: TState, shares: u256, receiver: ContractAddress) -> u256
max_withdraw
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::max_withdraw
fn max_withdraw(self: @TState, owner: ContractAddress) -> u256
preview_withdraw
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::preview_withdraw
fn preview_withdraw(self: @TState, assets: u256) -> u256
withdraw
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::withdraw
fn withdraw(
ref self: TState, assets: u256, receiver: ContractAddress, owner: ContractAddress,
) -> u256
max_redeem
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::max_redeem
fn max_redeem(self: @TState, owner: ContractAddress) -> u256
preview_redeem
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::preview_redeem
fn preview_redeem(self: @TState, shares: u256) -> u256
redeem
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::redeem
fn redeem(ref self: TState, shares: u256, receiver: ContractAddress, owner: ContractAddress) -> u256
total_supply
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::total_supply
fn total_supply(self: @TState) -> u256
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::balance_of
fn balance_of(self: @TState, account: ContractAddress) -> u256
allowance
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::allowance
fn allowance(self: @TState, owner: ContractAddress, spender: ContractAddress) -> u256
transfer
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::transfer
fn transfer(ref self: TState, recipient: ContractAddress, amount: u256) -> bool
transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::transfer_from
fn transfer_from(
ref self: TState, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> bool
approve
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::approve
fn approve(ref self: TState, spender: ContractAddress, amount: u256) -> bool
name
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::name
fn name(self: @TState) -> ByteArray
symbol
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::symbol
fn symbol(self: @TState) -> ByteArray
decimals
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::decimals
fn decimals(self: @TState) -> u8
totalSupply
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::totalSupply
fn totalSupply(self: @TState) -> u256
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::balanceOf
fn balanceOf(self: @TState, account: ContractAddress) -> u256
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABI::transferFrom
fn transferFrom(
ref self: TState, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> bool
UnsafeNewContractStateTraitForIERC4626ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc4626::UnsafeNewContractStateTraitForIERC4626ForwardImpl
pub trait UnsafeNewContractStateTraitForIERC4626ForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc4626::UnsafeNewContractStateTraitForIERC4626ForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC4626ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc4626::UnsafeNewContractStateTraitForERC4626ABIForwardImpl
pub trait UnsafeNewContractStateTraitForERC4626ABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc4626::UnsafeNewContractStateTraitForERC4626ABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
erc721
Fully qualified path: openzeppelin_interfaces::token::erc721
Modules
Constants
Traits
Groups:
dispatchers
Modules
Modules
__external_IERC721ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__external_IERC721ForwardImpl
__l1_handler_IERC721ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__l1_handler_IERC721ForwardImpl
__constructor_IERC721ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__constructor_IERC721ForwardImpl
__external_IERC721MetadataForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__external_IERC721MetadataForwardImpl
__l1_handler_IERC721MetadataForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__l1_handler_IERC721MetadataForwardImpl
__constructor_IERC721MetadataForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__constructor_IERC721MetadataForwardImpl
__external_IERC721CamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__external_IERC721CamelOnlyForwardImpl
__l1_handler_IERC721CamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__l1_handler_IERC721CamelOnlyForwardImpl
__constructor_IERC721CamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__constructor_IERC721CamelOnlyForwardImpl
__external_IERC721MetadataCamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__external_IERC721MetadataCamelOnlyForwardImpl
__l1_handler_IERC721MetadataCamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__l1_handler_IERC721MetadataCamelOnlyForwardImpl
__constructor_IERC721MetadataCamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__constructor_IERC721MetadataCamelOnlyForwardImpl
__external_ERC721ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__external_ERC721ABIForwardImpl
__l1_handler_ERC721ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__l1_handler_ERC721ABIForwardImpl
__constructor_ERC721ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__constructor_ERC721ABIForwardImpl
__external_IERC721ReceiverForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__external_IERC721ReceiverForwardImpl
__l1_handler_IERC721ReceiverForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__l1_handler_IERC721ReceiverForwardImpl
__constructor_IERC721ReceiverForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__constructor_IERC721ReceiverForwardImpl
__external_IERC721ReceiverCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__external_IERC721ReceiverCamelForwardImpl
__l1_handler_IERC721ReceiverCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__l1_handler_IERC721ReceiverCamelForwardImpl
__constructor_IERC721ReceiverCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__constructor_IERC721ReceiverCamelForwardImpl
__external_ERC721ReceiverMixinForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__external_ERC721ReceiverMixinForwardImpl
__l1_handler_ERC721ReceiverMixinForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__l1_handler_ERC721ReceiverMixinForwardImpl
__constructor_ERC721ReceiverMixinForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__constructor_ERC721ReceiverMixinForwardImpl
__external_IERC721EnumerableForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__external_IERC721EnumerableForwardImpl
__l1_handler_IERC721EnumerableForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__l1_handler_IERC721EnumerableForwardImpl
__constructor_IERC721EnumerableForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__constructor_IERC721EnumerableForwardImpl
__external_ERC721EnumerableABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__external_ERC721EnumerableABIForwardImpl
__l1_handler_ERC721EnumerableABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__l1_handler_ERC721EnumerableABIForwardImpl
__constructor_ERC721EnumerableABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::__constructor_ERC721EnumerableABIForwardImpl
Constants
Constants
IERC721_ID
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721_ID
pub const IERC721_ID: felt252 =
1467718268706281244674970845983991537323184336467042268477710080361019201859;
IERC721_METADATA_ID
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721_METADATA_ID
pub const IERC721_METADATA_ID: felt252 =
303434134618515872336526189619683271528155806609653412645136104657213005605;
IERC721_RECEIVER_ID
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721_RECEIVER_ID
pub const IERC721_RECEIVER_ID: felt252 =
1641179796754298462023048047512908064098046193999068160815085949035849781436;
IERC721_ENUMERABLE_ID
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721_ENUMERABLE_ID
pub const IERC721_ENUMERABLE_ID: felt252 =
642697225308884709487601780552297428279722672770363535496174788185861360775;
Traits
Traits
IERC721
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721
pub trait IERC721<TState>
Trait functions
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721::balance_of
fn balance_of(self: @TState, account: ContractAddress) -> u256
owner_of
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721::owner_of
fn owner_of(self: @TState, token_id: u256) -> ContractAddress
safe_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721::safe_transfer_from
fn safe_transfer_from(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
token_id: u256,
data: Span<felt252>,
)
transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721::transfer_from
fn transfer_from(ref self: TState, from: ContractAddress, to: ContractAddress, token_id: u256)
approve
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721::approve
fn approve(ref self: TState, to: ContractAddress, token_id: u256)
set_approval_for_all
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721::set_approval_for_all
fn set_approval_for_all(ref self: TState, operator: ContractAddress, approved: bool)
get_approved
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721::get_approved
fn get_approved(self: @TState, token_id: u256) -> ContractAddress
is_approved_for_all
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721::is_approved_for_all
fn is_approved_for_all(self: @TState, owner: ContractAddress, operator: ContractAddress) -> bool
IERC721Metadata
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721Metadata
pub trait IERC721Metadata<TState>
Trait functions
name
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721Metadata::name
fn name(self: @TState) -> ByteArray
symbol
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721Metadata::symbol
fn symbol(self: @TState) -> ByteArray
token_uri
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721Metadata::token_uri
fn token_uri(self: @TState, token_id: u256) -> ByteArray
IERC721CamelOnly
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnly
pub trait IERC721CamelOnly<TState>
Trait functions
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnly::balanceOf
fn balanceOf(self: @TState, account: ContractAddress) -> u256
ownerOf
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnly::ownerOf
fn ownerOf(self: @TState, tokenId: u256) -> ContractAddress
safeTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnly::safeTransferFrom
fn safeTransferFrom(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
tokenId: u256,
data: Span<felt252>,
)
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnly::transferFrom
fn transferFrom(ref self: TState, from: ContractAddress, to: ContractAddress, tokenId: u256)
setApprovalForAll
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnly::setApprovalForAll
fn setApprovalForAll(ref self: TState, operator: ContractAddress, approved: bool)
getApproved
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnly::getApproved
fn getApproved(self: @TState, tokenId: u256) -> ContractAddress
isApprovedForAll
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnly::isApprovedForAll
fn isApprovedForAll(self: @TState, owner: ContractAddress, operator: ContractAddress) -> bool
IERC721MetadataCamelOnly
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataCamelOnly
pub trait IERC721MetadataCamelOnly<TState>
Trait functions
tokenURI
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataCamelOnly::tokenURI
fn tokenURI(self: @TState, tokenId: u256) -> ByteArray
ERC721ABI
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI
pub trait ERC721ABI<TState>
Trait functions
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::balance_of
fn balance_of(self: @TState, account: ContractAddress) -> u256
owner_of
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::owner_of
fn owner_of(self: @TState, token_id: u256) -> ContractAddress
safe_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::safe_transfer_from
fn safe_transfer_from(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
token_id: u256,
data: Span<felt252>,
)
transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::transfer_from
fn transfer_from(ref self: TState, from: ContractAddress, to: ContractAddress, token_id: u256)
approve
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::approve
fn approve(ref self: TState, to: ContractAddress, token_id: u256)
set_approval_for_all
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::set_approval_for_all
fn set_approval_for_all(ref self: TState, operator: ContractAddress, approved: bool)
get_approved
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::get_approved
fn get_approved(self: @TState, token_id: u256) -> ContractAddress
is_approved_for_all
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::is_approved_for_all
fn is_approved_for_all(self: @TState, owner: ContractAddress, operator: ContractAddress) -> bool
supports_interface
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::supports_interface
fn supports_interface(self: @TState, interface_id: felt252) -> bool
name
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::name
fn name(self: @TState) -> ByteArray
symbol
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::symbol
fn symbol(self: @TState) -> ByteArray
token_uri
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::token_uri
fn token_uri(self: @TState, token_id: u256) -> ByteArray
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::balanceOf
fn balanceOf(self: @TState, account: ContractAddress) -> u256
ownerOf
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::ownerOf
fn ownerOf(self: @TState, tokenId: u256) -> ContractAddress
safeTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::safeTransferFrom
fn safeTransferFrom(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
tokenId: u256,
data: Span<felt252>,
)
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::transferFrom
fn transferFrom(ref self: TState, from: ContractAddress, to: ContractAddress, tokenId: u256)
setApprovalForAll
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::setApprovalForAll
fn setApprovalForAll(ref self: TState, operator: ContractAddress, approved: bool)
getApproved
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::getApproved
fn getApproved(self: @TState, tokenId: u256) -> ContractAddress
isApprovedForAll
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::isApprovedForAll
fn isApprovedForAll(self: @TState, owner: ContractAddress, operator: ContractAddress) -> bool
tokenURI
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABI::tokenURI
fn tokenURI(self: @TState, tokenId: u256) -> ByteArray
IERC721Receiver
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721Receiver
pub trait IERC721Receiver<TState>
Trait functions
on_erc721_received
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721Receiver::on_erc721_received
fn on_erc721_received(
self: @TState,
operator: ContractAddress,
from: ContractAddress,
token_id: u256,
data: Span<felt252>,
) -> felt252
IERC721ReceiverCamel
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverCamel
pub trait IERC721ReceiverCamel<TState>
Trait functions
onERC721Received
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverCamel::onERC721Received
fn onERC721Received(
self: @TState,
operator: ContractAddress,
from: ContractAddress,
tokenId: u256,
data: Span<felt252>,
) -> felt252
ERC721ReceiverMixin
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixin
pub trait ERC721ReceiverMixin<TState>
Trait functions
on_erc721_received
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixin::on_erc721_received
fn on_erc721_received(
self: @TState,
operator: ContractAddress,
from: ContractAddress,
token_id: u256,
data: Span<felt252>,
) -> felt252
onERC721Received
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixin::onERC721Received
fn onERC721Received(
self: @TState,
operator: ContractAddress,
from: ContractAddress,
tokenId: u256,
data: Span<felt252>,
) -> felt252
supports_interface
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixin::supports_interface
fn supports_interface(self: @TState, interface_id: felt252) -> bool
IERC721Enumerable
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721Enumerable
pub trait IERC721Enumerable<TState>
Trait functions
total_supply
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721Enumerable::total_supply
fn total_supply(self: @TState) -> u256
token_by_index
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721Enumerable::token_by_index
fn token_by_index(self: @TState, index: u256) -> u256
token_of_owner_by_index
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721Enumerable::token_of_owner_by_index
fn token_of_owner_by_index(self: @TState, owner: ContractAddress, index: u256) -> u256
ERC721EnumerableABI
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABI
pub trait ERC721EnumerableABI<TState>
Trait functions
total_supply
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABI::total_supply
fn total_supply(self: @TState) -> u256
token_by_index
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABI::token_by_index
fn token_by_index(self: @TState, index: u256) -> u256
token_of_owner_by_index
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABI::token_of_owner_by_index
fn token_of_owner_by_index(self: @TState, owner: ContractAddress, index: u256) -> u256
all_tokens_of_owner
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABI::all_tokens_of_owner
fn all_tokens_of_owner(self: @TState, owner: ContractAddress) -> Span<u256>
UnsafeNewContractStateTraitForIERC721ForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForIERC721ForwardImpl
pub trait UnsafeNewContractStateTraitForIERC721ForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForIERC721ForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC721MetadataForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForIERC721MetadataForwardImpl
pub trait UnsafeNewContractStateTraitForIERC721MetadataForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForIERC721MetadataForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC721CamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForIERC721CamelOnlyForwardImpl
pub trait UnsafeNewContractStateTraitForIERC721CamelOnlyForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForIERC721CamelOnlyForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC721MetadataCamelOnlyForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForIERC721MetadataCamelOnlyForwardImpl
pub trait UnsafeNewContractStateTraitForIERC721MetadataCamelOnlyForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForIERC721MetadataCamelOnlyForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC721ABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForERC721ABIForwardImpl
pub trait UnsafeNewContractStateTraitForERC721ABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForERC721ABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC721ReceiverForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForIERC721ReceiverForwardImpl
pub trait UnsafeNewContractStateTraitForIERC721ReceiverForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForIERC721ReceiverForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC721ReceiverCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForIERC721ReceiverCamelForwardImpl
pub trait UnsafeNewContractStateTraitForIERC721ReceiverCamelForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForIERC721ReceiverCamelForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC721ReceiverMixinForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForERC721ReceiverMixinForwardImpl
pub trait UnsafeNewContractStateTraitForERC721ReceiverMixinForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForERC721ReceiverMixinForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIERC721EnumerableForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForIERC721EnumerableForwardImpl
pub trait UnsafeNewContractStateTraitForIERC721EnumerableForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForIERC721EnumerableForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC721EnumerableABIForwardImpl
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForERC721EnumerableABIForwardImpl
pub trait UnsafeNewContractStateTraitForERC721EnumerableABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::token::erc721::UnsafeNewContractStateTraitForERC721EnumerableABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
upgrades
Fully qualified path: openzeppelin_interfaces::upgrades
Modules
Traits
| IUpgradeable | — |
| IUpgradeAndCall | — |
| UnsafeNewContractStateTraitForIUpgradeableForwardImpl | — |
| UnsafeNewContractStateTraitForIUpgradeAndCallForwardImpl | — |
Groups:
dispatchers
| IUpgradeableDispatcherTrait | — |
| IUpgradeableSafeDispatcherTrait | — |
| IUpgradeAndCallDispatcherTrait | — |
| IUpgradeAndCallSafeDispatcherTrait | — |
Modules
Modules
__external_IUpgradeableForwardImpl
Fully qualified path: openzeppelin_interfaces::upgrades::__external_IUpgradeableForwardImpl
__l1_handler_IUpgradeableForwardImpl
Fully qualified path: openzeppelin_interfaces::upgrades::__l1_handler_IUpgradeableForwardImpl
__constructor_IUpgradeableForwardImpl
Fully qualified path: openzeppelin_interfaces::upgrades::__constructor_IUpgradeableForwardImpl
__external_IUpgradeAndCallForwardImpl
Fully qualified path: openzeppelin_interfaces::upgrades::__external_IUpgradeAndCallForwardImpl
__l1_handler_IUpgradeAndCallForwardImpl
Fully qualified path: openzeppelin_interfaces::upgrades::__l1_handler_IUpgradeAndCallForwardImpl
__constructor_IUpgradeAndCallForwardImpl
Fully qualified path: openzeppelin_interfaces::upgrades::__constructor_IUpgradeAndCallForwardImpl
Traits
Traits
| IUpgradeable | — |
| IUpgradeAndCall | — |
| UnsafeNewContractStateTraitForIUpgradeableForwardImpl | — |
| UnsafeNewContractStateTraitForIUpgradeAndCallForwardImpl | — |
IUpgradeable
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeable
pub trait IUpgradeable<TState>
Trait functions
upgrade
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeable::upgrade
fn upgrade(ref self: TState, new_class_hash: ClassHash)
IUpgradeAndCall
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeAndCall
pub trait IUpgradeAndCall<TState>
Trait functions
upgrade_and_call
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeAndCall::upgrade_and_call
fn upgrade_and_call(
ref self: TState, new_class_hash: ClassHash, selector: felt252, calldata: Span<felt252>,
) -> Span<felt252>
UnsafeNewContractStateTraitForIUpgradeableForwardImpl
Fully qualified path: openzeppelin_interfaces::upgrades::UnsafeNewContractStateTraitForIUpgradeableForwardImpl
pub trait UnsafeNewContractStateTraitForIUpgradeableForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::upgrades::UnsafeNewContractStateTraitForIUpgradeableForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIUpgradeAndCallForwardImpl
Fully qualified path: openzeppelin_interfaces::upgrades::UnsafeNewContractStateTraitForIUpgradeAndCallForwardImpl
pub trait UnsafeNewContractStateTraitForIUpgradeAndCallForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::upgrades::UnsafeNewContractStateTraitForIUpgradeAndCallForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
utils
Fully qualified path: openzeppelin_interfaces::utils
Modules
Modules
Modules
deployments
Fully qualified path: openzeppelin_interfaces::utils::deployments
Modules
Traits
Groups:
dispatchers
Modules
Modules
__external_IUniversalDeployerForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::deployments::__external_IUniversalDeployerForwardImpl
__l1_handler_IUniversalDeployerForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::deployments::__l1_handler_IUniversalDeployerForwardImpl
__constructor_IUniversalDeployerForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::deployments::__constructor_IUniversalDeployerForwardImpl
__external_IUniversalDeployerCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::deployments::__external_IUniversalDeployerCamelForwardImpl
__l1_handler_IUniversalDeployerCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::deployments::__l1_handler_IUniversalDeployerCamelForwardImpl
__constructor_IUniversalDeployerCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::deployments::__constructor_IUniversalDeployerCamelForwardImpl
__external_UniversalDeployerABIForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::deployments::__external_UniversalDeployerABIForwardImpl
__l1_handler_UniversalDeployerABIForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::deployments::__l1_handler_UniversalDeployerABIForwardImpl
__constructor_UniversalDeployerABIForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::deployments::__constructor_UniversalDeployerABIForwardImpl
Traits
Traits
IUniversalDeployer
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployer
pub trait IUniversalDeployer<TState>
Trait functions
deploy_contract
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployer::deploy_contract
fn deploy_contract(
ref self: TState,
class_hash: ClassHash,
salt: felt252,
not_from_zero: bool,
calldata: Span<felt252>,
) -> ContractAddress
IUniversalDeployerCamel
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerCamel
pub trait IUniversalDeployerCamel<TState>
Trait functions
deployContract
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerCamel::deployContract
fn deployContract(
ref self: TState,
classHash: ClassHash,
salt: felt252,
notFromZero: bool,
calldata: Span<felt252>,
) -> ContractAddress
UniversalDeployerABI
Fully qualified path: openzeppelin_interfaces::utils::deployments::UniversalDeployerABI
pub trait UniversalDeployerABI<TState>
Trait functions
deploy_contract
Fully qualified path: openzeppelin_interfaces::utils::deployments::UniversalDeployerABI::deploy_contract
fn deploy_contract(
ref self: TState,
class_hash: ClassHash,
salt: felt252,
not_from_zero: bool,
calldata: Span<felt252>,
) -> ContractAddress
deployContract
Fully qualified path: openzeppelin_interfaces::utils::deployments::UniversalDeployerABI::deployContract
fn deployContract(
ref self: TState,
classHash: ClassHash,
salt: felt252,
notFromZero: bool,
calldata: Span<felt252>,
) -> ContractAddress
UnsafeNewContractStateTraitForIUniversalDeployerForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::deployments::UnsafeNewContractStateTraitForIUniversalDeployerForwardImpl
pub trait UnsafeNewContractStateTraitForIUniversalDeployerForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::utils::deployments::UnsafeNewContractStateTraitForIUniversalDeployerForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForIUniversalDeployerCamelForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::deployments::UnsafeNewContractStateTraitForIUniversalDeployerCamelForwardImpl
pub trait UnsafeNewContractStateTraitForIUniversalDeployerCamelForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::utils::deployments::UnsafeNewContractStateTraitForIUniversalDeployerCamelForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForUniversalDeployerABIForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::deployments::UnsafeNewContractStateTraitForUniversalDeployerABIForwardImpl
pub trait UnsafeNewContractStateTraitForUniversalDeployerABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::utils::deployments::UnsafeNewContractStateTraitForUniversalDeployerABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
nonces
Fully qualified path: openzeppelin_interfaces::utils::nonces
Modules
Traits
Groups:
dispatchers
Modules
Modules
__external_INoncesForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::nonces::__external_INoncesForwardImpl
__l1_handler_INoncesForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::nonces::__l1_handler_INoncesForwardImpl
__constructor_INoncesForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::nonces::__constructor_INoncesForwardImpl
Traits
Traits
INonces
Fully qualified path: openzeppelin_interfaces::utils::nonces::INonces
pub trait INonces<TState>
Trait functions
nonces
Fully qualified path: openzeppelin_interfaces::utils::nonces::INonces::nonces
fn nonces(self: @TState, owner: ContractAddress) -> felt252
UnsafeNewContractStateTraitForINoncesForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::nonces::UnsafeNewContractStateTraitForINoncesForwardImpl
pub trait UnsafeNewContractStateTraitForINoncesForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::utils::nonces::UnsafeNewContractStateTraitForINoncesForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
snip12
Fully qualified path: openzeppelin_interfaces::utils::snip12
Modules
| __external_ISNIP12MetadataForwardImpl | — |
| __l1_handler_ISNIP12MetadataForwardImpl | — |
| __constructor_ISNIP12MetadataForwardImpl | — |
Traits
Groups:
dispatchers
| ISNIP12MetadataDispatcher | — |
| ISNIP12MetadataLibraryDispatcher | — |
| ISNIP12MetadataSafeLibraryDispatcher | — |
| ISNIP12MetadataSafeDispatcher | — |
Modules
Modules
| __external_ISNIP12MetadataForwardImpl | — |
| __l1_handler_ISNIP12MetadataForwardImpl | — |
| __constructor_ISNIP12MetadataForwardImpl | — |
__external_ISNIP12MetadataForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::snip12::__external_ISNIP12MetadataForwardImpl
__l1_handler_ISNIP12MetadataForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::snip12::__l1_handler_ISNIP12MetadataForwardImpl
__constructor_ISNIP12MetadataForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::snip12::__constructor_ISNIP12MetadataForwardImpl
Traits
Traits
ISNIP12Metadata
Fully qualified path: openzeppelin_interfaces::utils::snip12::ISNIP12Metadata
pub trait ISNIP12Metadata<TState>
Trait functions
snip12_metadata
Fully qualified path: openzeppelin_interfaces::utils::snip12::ISNIP12Metadata::snip12_metadata
fn snip12_metadata(self: @TState) -> (felt252, felt252)
UnsafeNewContractStateTraitForISNIP12MetadataForwardImpl
Fully qualified path: openzeppelin_interfaces::utils::snip12::UnsafeNewContractStateTraitForISNIP12MetadataForwardImpl
pub trait UnsafeNewContractStateTraitForISNIP12MetadataForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_interfaces::utils::snip12::UnsafeNewContractStateTraitForISNIP12MetadataForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
openzeppelin_introspection
Fully qualified path: openzeppelin_introspection
Modules
| src5 | — |
Modules
Modules
| src5 | — |
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
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
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_idis notISRC5_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
openzeppelin_merkle_tree
Fully qualified path: openzeppelin_merkle_tree
Modules
Modules
Modules
hashes
Fully qualified path: openzeppelin_merkle_tree::hashes
Traits
| CommutativeHasher | Computes a commutative hash of a sorted pair of felt252 values. This is usually implemented as an extension of a non-commutative hash function, like… |
Impls
| PedersenCHasher | Computes the Pedersen commutative hash of a sorted pair of felt252 values. |
| PoseidonCHasher | Computes the Poseidon commutative hash of a sorted pair of felt252 values. |
Traits
Traits
| CommutativeHasher | Computes a commutative hash of a sorted pair of felt252 values. This is usually implemented as an extension of a non-commutative hash function, like… |
CommutativeHasher
Computes a commutative hash of a sorted pair of felt252 values.
This is usually implemented as an extension of a non-commutative hash function, like Pedersen or Poseidon, returning the hash of the concatenation of the two values by first sorting them.
Frequently used when working with merkle proofs.
Fully qualified path: openzeppelin_merkle_tree::hashes::CommutativeHasher
pub trait CommutativeHasher
Trait functions
commutative_hash
Fully qualified path: openzeppelin_merkle_tree::hashes::CommutativeHasher::commutative_hash
fn commutative_hash(a: felt252, b: felt252) -> felt252
Impls
Impls
| PedersenCHasher | Computes the Pedersen commutative hash of a sorted pair of felt252 values. |
| PoseidonCHasher | Computes the Poseidon commutative hash of a sorted pair of felt252 values. |
PedersenCHasher
Computes the Pedersen commutative hash of a sorted pair of felt252 values.
Fully qualified path: openzeppelin_merkle_tree::hashes::PedersenCHasher
pub impl PedersenCHasher of CommutativeHasher;
Impl functions
commutative_hash
Computes the Pedersen hash by chaining the two values with the length, sorting the pair first.
Fully qualified path: openzeppelin_merkle_tree::hashes::PedersenCHasher::commutative_hash
fn commutative_hash(a: felt252, b: felt252) -> felt252
PoseidonCHasher
Computes the Poseidon commutative hash of a sorted pair of felt252 values.
Fully qualified path: openzeppelin_merkle_tree::hashes::PoseidonCHasher
pub impl PoseidonCHasher of CommutativeHasher;
Impl functions
commutative_hash
Computes the Poseidon hash of the concatenation of two values, sorting the pair first.
Fully qualified path: openzeppelin_merkle_tree::hashes::PoseidonCHasher::commutative_hash
fn commutative_hash(a: felt252, b: felt252) -> felt252
merkle_proof
Fully qualified path: openzeppelin_merkle_tree::merkle_proof
Free functions
| verify | Returns true if a leaf can be proved to be a part of a Merkle tree defined by root . For this, a proof must be provided, containing… |
| verify_pedersen | Version of verify using Pedersen as the hashing function. |
| verify_poseidon | Version of verify using Poseidon as the hashing function. |
| process_proof | Returns the rebuilt hash obtained by traversing a Merkle tree up from leaf using proof . A proof is valid if and only if the rebuilt… |
| verify_multi_proof | Returns true if the leaves can be simultaneously proven to be a part of a Merkle tree defined by root , according to proof and proof_flags as described in process_multi_proof …. |
| process_multi_proof | Returns the root of a tree reconstructed from leaves and sibling nodes in proof . The reconstruction proceeds by incrementally reconstructing all inner nodes by combining a… |
Free functions
Free functions
| verify | Returns true if a leaf can be proved to be a part of a Merkle tree defined by root . For this, a proof must be provided, containing… |
| verify_pedersen | Version of verify using Pedersen as the hashing function. |
| verify_poseidon | Version of verify using Poseidon as the hashing function. |
| process_proof | Returns the rebuilt hash obtained by traversing a Merkle tree up from leaf using proof . A proof is valid if and only if the rebuilt… |
| verify_multi_proof | Returns true if the leaves can be simultaneously proven to be a part of a Merkle tree defined by root , according to proof and proof_flags as described in process_multi_proof …. |
| process_multi_proof | Returns the root of a tree reconstructed from leaves and sibling nodes in proof . The reconstruction proceeds by incrementally reconstructing all inner nodes by combining a… |
verify
Returns true if a leaf can be proved to be a part of a Merkle tree
defined by root. For this, a proof must be provided, containing
sibling hashes on the branch from the leaf to the root of the tree. Each
pair of leaves and each pair of pre-images are assumed to be sorted.
Fully qualified path: openzeppelin_merkle_tree::merkle_proof::verify
pub fn verify<impl Hasher: CommutativeHasher>(
proof: Span<felt252>, root: felt252, leaf: felt252,
) -> bool
verify_pedersen
Version of verify using Pedersen as the hashing function.
Fully qualified path: openzeppelin_merkle_tree::merkle_proof::verify_pedersen
pub fn verify_pedersen(proof: Span<felt252>, root: felt252, leaf: felt252) -> bool
verify_poseidon
Version of verify using Poseidon as the hashing function.
Fully qualified path: openzeppelin_merkle_tree::merkle_proof::verify_poseidon
pub fn verify_poseidon(proof: Span<felt252>, root: felt252, leaf: felt252) -> bool
process_proof
Returns the rebuilt hash obtained by traversing a Merkle tree up
from leaf using proof. A proof is valid if and only if the rebuilt
hash matches the root of the tree. When processing the proof, the pairs
of leaves & pre-images are assumed to be sorted.
Fully qualified path: openzeppelin_merkle_tree::merkle_proof::process_proof
pub fn process_proof<impl Hasher: CommutativeHasher>(proof: Span<felt252>, leaf: felt252) -> felt252
verify_multi_proof
Returns true if the leaves can be simultaneously proven to be a part of a Merkle tree defined
by root, according to proof and proof_flags as described in process_multi_proof.
CAUTION: Not all Merkle trees admit multiproofs. See process_multi_proof for details.
NOTE: Consider the case where root == proof.at(0) && leaves.len() == 0
as it will return true.
The leaves must be validated independently. See process_multi_proof.
Fully qualified path: openzeppelin_merkle_tree::merkle_proof::verify_multi_proof
pub fn verify_multi_proof<impl Hasher: CommutativeHasher>(
proof: Span<felt252>, proof_flags: Span<bool>, root: felt252, leaves: Span<felt252>,
) -> bool
process_multi_proof
Returns the root of a tree reconstructed from leaves and sibling nodes in proof. The
reconstruction proceeds by incrementally reconstructing all inner nodes by combining a
leaf/inner node with either another leaf/inner node or a proof sibling node, depending on
whether each proof_flags item is true or false respectively.
CAUTION: Not all Merkle trees admit multiproofs. To use multiproofs, it is sufficient to ensure that: 1) the tree is complete (but not necessarily perfect), 2) the leaves to be proven are in the opposite order than they are in the tree (i.e., as seen from right to left starting at the deepest layer and continuing at the next layer).
NOTE: The empty set (i.e. the case where proof.len() == 1 && leaves.len() == 0) is
considered a no-op, and therefore a valid multiproof (i.e. it returns proof.at(0)). Consider
disallowing this case if you’re not validating the leaves elsewhere.
Fully qualified path: openzeppelin_merkle_tree::merkle_proof::process_multi_proof
pub fn process_multi_proof<impl Hasher: CommutativeHasher>(
proof: Span<felt252>, proof_flags: Span<bool>, leaves: Span<felt252>,
) -> felt252
openzeppelin_presets
Fully qualified path: openzeppelin_presets
Modules
Re-exports:
| AccountUpgradeable | … |
| ERC1155Upgradeable | … |
| ERC20Upgradeable | … |
| ERC721Upgradeable | … |
| EthAccountUpgradeable | … |
| MetaTransactionV0 | — |
| UniversalDeployer | … |
| VestingWallet | — |
Modules
Modules
account
Fully qualified path: openzeppelin_presets::account
Modules
Modules
Modules
AccountUpgradeable
Account Preset
OpenZeppelin’s upgradeable account which can change its public key and declare, deploy, or call contracts. Supports outside execution by implementing SRC9.
Fully qualified path: openzeppelin_presets::account::AccountUpgradeable
Free functions
Structs
Free functions
Free functions
constructor
Fully qualified path: openzeppelin_presets::account::AccountUpgradeable::constructor
pub fn constructor(ref self: ContractState, public_key: felt252)
unsafe_new_contract_state
Fully qualified path: openzeppelin_presets::account::AccountUpgradeable::unsafe_new_contract_state
pub fn unsafe_new_contract_state() -> ContractState
Structs
Structs
Storage
Fully qualified path: openzeppelin_presets::account::AccountUpgradeable::Storage
[storage]
pub struct Storage {
pub account: Storage,
pub src5: Storage,
pub src9: Storage,
pub upgradeable: Storage,
}
Members
account
Fully qualified path: openzeppelin_presets::account::AccountUpgradeable::Storage::account
pub account: Storage
src5
Fully qualified path: openzeppelin_presets::account::AccountUpgradeable::Storage::src5
pub src5: Storage
src9
Fully qualified path: openzeppelin_presets::account::AccountUpgradeable::Storage::src9
pub src9: Storage
upgradeable
Fully qualified path: openzeppelin_presets::account::AccountUpgradeable::Storage::upgradeable
pub upgradeable: Storage
ContractState
Fully qualified path: openzeppelin_presets::account::AccountUpgradeable::ContractState
pub struct ContractState {
pub account: ComponentState<ContractState>,
pub src5: ComponentState<ContractState>,
pub src9: ComponentState<ContractState>,
pub upgradeable: ComponentState<ContractState>,
}
Members
account
Fully qualified path: openzeppelin_presets::account::AccountUpgradeable::ContractState::account
pub account: ComponentState<ContractState>
src5
Fully qualified path: openzeppelin_presets::account::AccountUpgradeable::ContractState::src5
pub src5: ComponentState<ContractState>
src9
Fully qualified path: openzeppelin_presets::account::AccountUpgradeable::ContractState::src9
pub src9: ComponentState<ContractState>
upgradeable
Fully qualified path: openzeppelin_presets::account::AccountUpgradeable::ContractState::upgradeable
pub upgradeable: ComponentState<ContractState>
erc1155
Fully qualified path: openzeppelin_presets::erc1155
Modules
Modules
Modules
ERC1155Upgradeable
ERC1155Upgradeable Preset
The upgradeable ERC1155 contract offers a batch-mint mechanism that can only be executed once upon contract construction.
For more complex or custom contracts, use Wizard for Cairo https://wizard.openzeppelin.com/cairo
Fully qualified path: openzeppelin_presets::erc1155::ERC1155Upgradeable
Free functions
Structs
Free functions
Free functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_presets::erc1155::ERC1155Upgradeable::unsafe_new_contract_state
pub fn unsafe_new_contract_state() -> ContractState
Structs
Structs
Storage
Fully qualified path: openzeppelin_presets::erc1155::ERC1155Upgradeable::Storage
[storage]
pub struct Storage {
pub ownable: Storage,
pub erc1155: Storage,
pub src5: Storage,
pub upgradeable: Storage,
}
Members
ownable
Fully qualified path: openzeppelin_presets::erc1155::ERC1155Upgradeable::Storage::ownable
pub ownable: Storage
erc1155
Fully qualified path: openzeppelin_presets::erc1155::ERC1155Upgradeable::Storage::erc1155
pub erc1155: Storage
src5
Fully qualified path: openzeppelin_presets::erc1155::ERC1155Upgradeable::Storage::src5
pub src5: Storage
upgradeable
Fully qualified path: openzeppelin_presets::erc1155::ERC1155Upgradeable::Storage::upgradeable
pub upgradeable: Storage
ContractState
Fully qualified path: openzeppelin_presets::erc1155::ERC1155Upgradeable::ContractState
pub struct ContractState {
pub ownable: ComponentState<ContractState>,
pub erc1155: ComponentState<ContractState>,
pub src5: ComponentState<ContractState>,
pub upgradeable: ComponentState<ContractState>,
}
Members
ownable
Fully qualified path: openzeppelin_presets::erc1155::ERC1155Upgradeable::ContractState::ownable
pub ownable: ComponentState<ContractState>
erc1155
Fully qualified path: openzeppelin_presets::erc1155::ERC1155Upgradeable::ContractState::erc1155
pub erc1155: ComponentState<ContractState>
src5
Fully qualified path: openzeppelin_presets::erc1155::ERC1155Upgradeable::ContractState::src5
pub src5: ComponentState<ContractState>
upgradeable
Fully qualified path: openzeppelin_presets::erc1155::ERC1155Upgradeable::ContractState::upgradeable
pub upgradeable: ComponentState<ContractState>
erc20
Fully qualified path: openzeppelin_presets::erc20
Modules
Modules
Modules
ERC20Upgradeable
ERC20 Preset
The upgradeable ERC20 contract offers basic functionality and provides a fixed-supply mechanism for token distribution. The fixed supply is set in the constructor.
For more complex or custom contracts, use Wizard for Cairo https://wizard.openzeppelin.com/cairo
Fully qualified path: openzeppelin_presets::erc20::ERC20Upgradeable
Free functions
Structs
Free functions
Free functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_presets::erc20::ERC20Upgradeable::unsafe_new_contract_state
pub fn unsafe_new_contract_state() -> ContractState
Structs
Structs
Storage
Fully qualified path: openzeppelin_presets::erc20::ERC20Upgradeable::Storage
[storage]
pub struct Storage {
pub ownable: Storage,
pub erc20: Storage,
pub upgradeable: Storage,
}
Members
ownable
Fully qualified path: openzeppelin_presets::erc20::ERC20Upgradeable::Storage::ownable
pub ownable: Storage
erc20
Fully qualified path: openzeppelin_presets::erc20::ERC20Upgradeable::Storage::erc20
pub erc20: Storage
upgradeable
Fully qualified path: openzeppelin_presets::erc20::ERC20Upgradeable::Storage::upgradeable
pub upgradeable: Storage
ContractState
Fully qualified path: openzeppelin_presets::erc20::ERC20Upgradeable::ContractState
pub struct ContractState {
pub ownable: ComponentState<ContractState>,
pub erc20: ComponentState<ContractState>,
pub upgradeable: ComponentState<ContractState>,
}
Members
ownable
Fully qualified path: openzeppelin_presets::erc20::ERC20Upgradeable::ContractState::ownable
pub ownable: ComponentState<ContractState>
erc20
Fully qualified path: openzeppelin_presets::erc20::ERC20Upgradeable::ContractState::erc20
pub erc20: ComponentState<ContractState>
upgradeable
Fully qualified path: openzeppelin_presets::erc20::ERC20Upgradeable::ContractState::upgradeable
pub upgradeable: ComponentState<ContractState>
erc721
Fully qualified path: openzeppelin_presets::erc721
Modules
Modules
Modules
ERC721Upgradeable
ERC721 Preset
The upgradeable ERC721 contract offers a batch-mint mechanism that can only be executed once upon contract construction.
For more complex or custom contracts, use Wizard for Cairo https://wizard.openzeppelin.com/cairo
Fully qualified path: openzeppelin_presets::erc721::ERC721Upgradeable
Free functions
Structs
Free functions
Free functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_presets::erc721::ERC721Upgradeable::unsafe_new_contract_state
pub fn unsafe_new_contract_state() -> ContractState
Structs
Structs
Storage
Fully qualified path: openzeppelin_presets::erc721::ERC721Upgradeable::Storage
[storage]
pub struct Storage {
pub ownable: Storage,
pub erc721: Storage,
pub src5: Storage,
pub upgradeable: Storage,
}
Members
ownable
Fully qualified path: openzeppelin_presets::erc721::ERC721Upgradeable::Storage::ownable
pub ownable: Storage
erc721
Fully qualified path: openzeppelin_presets::erc721::ERC721Upgradeable::Storage::erc721
pub erc721: Storage
src5
Fully qualified path: openzeppelin_presets::erc721::ERC721Upgradeable::Storage::src5
pub src5: Storage
upgradeable
Fully qualified path: openzeppelin_presets::erc721::ERC721Upgradeable::Storage::upgradeable
pub upgradeable: Storage
ContractState
Fully qualified path: openzeppelin_presets::erc721::ERC721Upgradeable::ContractState
pub struct ContractState {
pub ownable: ComponentState<ContractState>,
pub erc721: ComponentState<ContractState>,
pub src5: ComponentState<ContractState>,
pub upgradeable: ComponentState<ContractState>,
}
Members
ownable
Fully qualified path: openzeppelin_presets::erc721::ERC721Upgradeable::ContractState::ownable
pub ownable: ComponentState<ContractState>
erc721
Fully qualified path: openzeppelin_presets::erc721::ERC721Upgradeable::ContractState::erc721
pub erc721: ComponentState<ContractState>
src5
Fully qualified path: openzeppelin_presets::erc721::ERC721Upgradeable::ContractState::src5
pub src5: ComponentState<ContractState>
upgradeable
Fully qualified path: openzeppelin_presets::erc721::ERC721Upgradeable::ContractState::upgradeable
pub upgradeable: ComponentState<ContractState>
eth_account
Fully qualified path: openzeppelin_presets::eth_account
interfaces
Fully qualified path: openzeppelin_presets::interfaces
Modules
Re-exports:
Groups:
dispatchers
Modules
Modules
account
Fully qualified path: openzeppelin_presets::interfaces::account
Modules
| __external_AccountUpgradeableABIForwardImpl | — |
| __l1_handler_AccountUpgradeableABIForwardImpl | — |
| __constructor_AccountUpgradeableABIForwardImpl | — |
Traits
Groups:
dispatchers
| AccountUpgradeableABIDispatcher | — |
| AccountUpgradeableABILibraryDispatcher | — |
| AccountUpgradeableABISafeLibraryDispatcher | — |
| AccountUpgradeableABISafeDispatcher | — |
Modules
Modules
| __external_AccountUpgradeableABIForwardImpl | — |
| __l1_handler_AccountUpgradeableABIForwardImpl | — |
| __constructor_AccountUpgradeableABIForwardImpl | — |
__external_AccountUpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::account::__external_AccountUpgradeableABIForwardImpl
__l1_handler_AccountUpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::account::__l1_handler_AccountUpgradeableABIForwardImpl
__constructor_AccountUpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::account::__constructor_AccountUpgradeableABIForwardImpl
Traits
Traits
AccountUpgradeableABI
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABI
pub trait AccountUpgradeableABI<TState>
Trait functions
execute
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABI::execute
fn __execute__(self: @TState, calls: Array<Call>)
validate
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABI::validate
fn __validate__(self: @TState, calls: Array<Call>) -> felt252
is_valid_signature
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABI::is_valid_signature
fn is_valid_signature(self: @TState, hash: felt252, signature: Array<felt252>) -> felt252
supports_interface
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABI::supports_interface
fn supports_interface(self: @TState, interface_id: felt252) -> bool
execute_from_outside_v2
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABI::execute_from_outside_v2
fn execute_from_outside_v2(
ref self: TState, outside_execution: OutsideExecution, signature: Span<felt252>,
) -> Array<Span<felt252>>
is_valid_outside_execution_nonce
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABI::is_valid_outside_execution_nonce
fn is_valid_outside_execution_nonce(self: @TState, nonce: felt252) -> bool
validate_declare
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABI::validate_declare
fn __validate_declare__(self: @TState, class_hash: felt252) -> felt252
validate_deploy
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABI::validate_deploy
fn __validate_deploy__(
self: @TState, class_hash: felt252, contract_address_salt: felt252, public_key: felt252,
) -> felt252
get_public_key
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABI::get_public_key
fn get_public_key(self: @TState) -> felt252
set_public_key
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABI::set_public_key
fn set_public_key(ref self: TState, new_public_key: felt252, signature: Span<felt252>)
isValidSignature
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABI::isValidSignature
fn isValidSignature(self: @TState, hash: felt252, signature: Array<felt252>) -> felt252
getPublicKey
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABI::getPublicKey
fn getPublicKey(self: @TState) -> felt252
setPublicKey
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABI::setPublicKey
fn setPublicKey(ref self: TState, newPublicKey: felt252, signature: Span<felt252>)
upgrade
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABI::upgrade
fn upgrade(ref self: TState, new_class_hash: ClassHash)
UnsafeNewContractStateTraitForAccountUpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::account::UnsafeNewContractStateTraitForAccountUpgradeableABIForwardImpl
pub trait UnsafeNewContractStateTraitForAccountUpgradeableABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_presets::interfaces::account::UnsafeNewContractStateTraitForAccountUpgradeableABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
erc1155
Fully qualified path: openzeppelin_presets::interfaces::erc1155
Modules
| __external_ERC1155UpgradeableABIForwardImpl | — |
| __l1_handler_ERC1155UpgradeableABIForwardImpl | — |
| __constructor_ERC1155UpgradeableABIForwardImpl | — |
Traits
Groups:
dispatchers
| ERC1155UpgradeableABIDispatcher | — |
| ERC1155UpgradeableABILibraryDispatcher | — |
| ERC1155UpgradeableABISafeLibraryDispatcher | — |
| ERC1155UpgradeableABISafeDispatcher | — |
Modules
Modules
| __external_ERC1155UpgradeableABIForwardImpl | — |
| __l1_handler_ERC1155UpgradeableABIForwardImpl | — |
| __constructor_ERC1155UpgradeableABIForwardImpl | — |
__external_ERC1155UpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::erc1155::__external_ERC1155UpgradeableABIForwardImpl
__l1_handler_ERC1155UpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::erc1155::__l1_handler_ERC1155UpgradeableABIForwardImpl
__constructor_ERC1155UpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::erc1155::__constructor_ERC1155UpgradeableABIForwardImpl
Traits
Traits
ERC1155UpgradeableABI
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI
pub trait ERC1155UpgradeableABI<TState>
Trait functions
balance_of
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::balance_of
fn balance_of(self: @TState, account: ContractAddress, token_id: u256) -> u256
balance_of_batch
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::balance_of_batch
fn balance_of_batch(
self: @TState, accounts: Span<ContractAddress>, token_ids: Span<u256>,
) -> Span<u256>
safe_transfer_from
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::safe_transfer_from
fn safe_transfer_from(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
token_id: u256,
value: u256,
data: Span<felt252>,
)
safe_batch_transfer_from
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::safe_batch_transfer_from
fn safe_batch_transfer_from(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
)
is_approved_for_all
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::is_approved_for_all
fn is_approved_for_all(self: @TState, owner: ContractAddress, operator: ContractAddress) -> bool
set_approval_for_all
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::set_approval_for_all
fn set_approval_for_all(ref self: TState, operator: ContractAddress, approved: bool)
supports_interface
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::supports_interface
fn supports_interface(self: @TState, interface_id: felt252) -> bool
uri
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::uri
fn uri(self: @TState, token_id: u256) -> ByteArray
balanceOf
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::balanceOf
fn balanceOf(self: @TState, account: ContractAddress, tokenId: u256) -> u256
balanceOfBatch
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::balanceOfBatch
fn balanceOfBatch(
self: @TState, accounts: Span<ContractAddress>, tokenIds: Span<u256>,
) -> Span<u256>
safeTransferFrom
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::safeTransferFrom
fn safeTransferFrom(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
tokenId: u256,
value: u256,
data: Span<felt252>,
)
safeBatchTransferFrom
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::safeBatchTransferFrom
fn safeBatchTransferFrom(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
tokenIds: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
)
isApprovedForAll
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::isApprovedForAll
fn isApprovedForAll(self: @TState, owner: ContractAddress, operator: ContractAddress) -> bool
setApprovalForAll
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::setApprovalForAll
fn setApprovalForAll(ref self: TState, operator: ContractAddress, approved: bool)
owner
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::owner
fn owner(self: @TState) -> ContractAddress
transfer_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::transfer_ownership
fn transfer_ownership(ref self: TState, new_owner: ContractAddress)
renounce_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::renounce_ownership
fn renounce_ownership(ref self: TState)
transferOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::transferOwnership
fn transferOwnership(ref self: TState, newOwner: ContractAddress)
renounceOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::renounceOwnership
fn renounceOwnership(ref self: TState)
upgrade
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABI::upgrade
fn upgrade(ref self: TState, new_class_hash: ClassHash)
UnsafeNewContractStateTraitForERC1155UpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::erc1155::UnsafeNewContractStateTraitForERC1155UpgradeableABIForwardImpl
pub trait UnsafeNewContractStateTraitForERC1155UpgradeableABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_presets::interfaces::erc1155::UnsafeNewContractStateTraitForERC1155UpgradeableABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
erc20
Fully qualified path: openzeppelin_presets::interfaces::erc20
Modules
| __external_ERC20UpgradeableABIForwardImpl | — |
| __l1_handler_ERC20UpgradeableABIForwardImpl | — |
| __constructor_ERC20UpgradeableABIForwardImpl | — |
Traits
Groups:
dispatchers
| ERC20UpgradeableABIDispatcher | — |
| ERC20UpgradeableABILibraryDispatcher | — |
| ERC20UpgradeableABISafeLibraryDispatcher | — |
| ERC20UpgradeableABISafeDispatcher | — |
Modules
Modules
| __external_ERC20UpgradeableABIForwardImpl | — |
| __l1_handler_ERC20UpgradeableABIForwardImpl | — |
| __constructor_ERC20UpgradeableABIForwardImpl | — |
__external_ERC20UpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::erc20::__external_ERC20UpgradeableABIForwardImpl
__l1_handler_ERC20UpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::erc20::__l1_handler_ERC20UpgradeableABIForwardImpl
__constructor_ERC20UpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::erc20::__constructor_ERC20UpgradeableABIForwardImpl
Traits
Traits
ERC20UpgradeableABI
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI
pub trait ERC20UpgradeableABI<TState>
Trait functions
total_supply
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::total_supply
fn total_supply(self: @TState) -> u256
balance_of
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::balance_of
fn balance_of(self: @TState, account: ContractAddress) -> u256
allowance
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::allowance
fn allowance(self: @TState, owner: ContractAddress, spender: ContractAddress) -> u256
transfer
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::transfer
fn transfer(ref self: TState, recipient: ContractAddress, amount: u256) -> bool
transfer_from
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::transfer_from
fn transfer_from(
ref self: TState, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> bool
approve
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::approve
fn approve(ref self: TState, spender: ContractAddress, amount: u256) -> bool
name
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::name
fn name(self: @TState) -> ByteArray
symbol
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::symbol
fn symbol(self: @TState) -> ByteArray
decimals
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::decimals
fn decimals(self: @TState) -> u8
totalSupply
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::totalSupply
fn totalSupply(self: @TState) -> u256
balanceOf
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::balanceOf
fn balanceOf(self: @TState, account: ContractAddress) -> u256
transferFrom
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::transferFrom
fn transferFrom(
ref self: TState, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> bool
owner
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::owner
fn owner(self: @TState) -> ContractAddress
transfer_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::transfer_ownership
fn transfer_ownership(ref self: TState, new_owner: ContractAddress)
renounce_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::renounce_ownership
fn renounce_ownership(ref self: TState)
transferOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::transferOwnership
fn transferOwnership(ref self: TState, newOwner: ContractAddress)
renounceOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::renounceOwnership
fn renounceOwnership(ref self: TState)
upgrade
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABI::upgrade
fn upgrade(ref self: TState, new_class_hash: ClassHash)
UnsafeNewContractStateTraitForERC20UpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::erc20::UnsafeNewContractStateTraitForERC20UpgradeableABIForwardImpl
pub trait UnsafeNewContractStateTraitForERC20UpgradeableABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_presets::interfaces::erc20::UnsafeNewContractStateTraitForERC20UpgradeableABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
erc721
Fully qualified path: openzeppelin_presets::interfaces::erc721
Modules
| __external_ERC721UpgradeableABIForwardImpl | — |
| __l1_handler_ERC721UpgradeableABIForwardImpl | — |
| __constructor_ERC721UpgradeableABIForwardImpl | — |
Traits
Groups:
dispatchers
| ERC721UpgradeableABIDispatcher | — |
| ERC721UpgradeableABILibraryDispatcher | — |
| ERC721UpgradeableABISafeLibraryDispatcher | — |
| ERC721UpgradeableABISafeDispatcher | — |
Modules
Modules
| __external_ERC721UpgradeableABIForwardImpl | — |
| __l1_handler_ERC721UpgradeableABIForwardImpl | — |
| __constructor_ERC721UpgradeableABIForwardImpl | — |
__external_ERC721UpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::erc721::__external_ERC721UpgradeableABIForwardImpl
__l1_handler_ERC721UpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::erc721::__l1_handler_ERC721UpgradeableABIForwardImpl
__constructor_ERC721UpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::erc721::__constructor_ERC721UpgradeableABIForwardImpl
Traits
Traits
ERC721UpgradeableABI
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI
pub trait ERC721UpgradeableABI<TState>
Trait functions
balance_of
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::balance_of
fn balance_of(self: @TState, account: ContractAddress) -> u256
owner_of
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::owner_of
fn owner_of(self: @TState, token_id: u256) -> ContractAddress
safe_transfer_from
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::safe_transfer_from
fn safe_transfer_from(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
token_id: u256,
data: Span<felt252>,
)
transfer_from
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::transfer_from
fn transfer_from(ref self: TState, from: ContractAddress, to: ContractAddress, token_id: u256)
approve
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::approve
fn approve(ref self: TState, to: ContractAddress, token_id: u256)
set_approval_for_all
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::set_approval_for_all
fn set_approval_for_all(ref self: TState, operator: ContractAddress, approved: bool)
get_approved
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::get_approved
fn get_approved(self: @TState, token_id: u256) -> ContractAddress
is_approved_for_all
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::is_approved_for_all
fn is_approved_for_all(self: @TState, owner: ContractAddress, operator: ContractAddress) -> bool
supports_interface
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::supports_interface
fn supports_interface(self: @TState, interface_id: felt252) -> bool
name
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::name
fn name(self: @TState) -> ByteArray
symbol
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::symbol
fn symbol(self: @TState) -> ByteArray
token_uri
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::token_uri
fn token_uri(self: @TState, token_id: u256) -> ByteArray
balanceOf
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::balanceOf
fn balanceOf(self: @TState, account: ContractAddress) -> u256
ownerOf
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::ownerOf
fn ownerOf(self: @TState, tokenId: u256) -> ContractAddress
safeTransferFrom
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::safeTransferFrom
fn safeTransferFrom(
ref self: TState,
from: ContractAddress,
to: ContractAddress,
tokenId: u256,
data: Span<felt252>,
)
transferFrom
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::transferFrom
fn transferFrom(ref self: TState, from: ContractAddress, to: ContractAddress, tokenId: u256)
setApprovalForAll
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::setApprovalForAll
fn setApprovalForAll(ref self: TState, operator: ContractAddress, approved: bool)
getApproved
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::getApproved
fn getApproved(self: @TState, tokenId: u256) -> ContractAddress
isApprovedForAll
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::isApprovedForAll
fn isApprovedForAll(self: @TState, owner: ContractAddress, operator: ContractAddress) -> bool
tokenURI
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::tokenURI
fn tokenURI(self: @TState, tokenId: u256) -> ByteArray
owner
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::owner
fn owner(self: @TState) -> ContractAddress
transfer_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::transfer_ownership
fn transfer_ownership(ref self: TState, new_owner: ContractAddress)
renounce_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::renounce_ownership
fn renounce_ownership(ref self: TState)
transferOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::transferOwnership
fn transferOwnership(ref self: TState, newOwner: ContractAddress)
renounceOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::renounceOwnership
fn renounceOwnership(ref self: TState)
upgrade
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABI::upgrade
fn upgrade(ref self: TState, new_class_hash: ClassHash)
UnsafeNewContractStateTraitForERC721UpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::erc721::UnsafeNewContractStateTraitForERC721UpgradeableABIForwardImpl
pub trait UnsafeNewContractStateTraitForERC721UpgradeableABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_presets::interfaces::erc721::UnsafeNewContractStateTraitForERC721UpgradeableABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
eth_account
Fully qualified path: openzeppelin_presets::interfaces::eth_account
Modules
| __external_EthAccountUpgradeableABIForwardImpl | — |
| __l1_handler_EthAccountUpgradeableABIForwardImpl | — |
| __constructor_EthAccountUpgradeableABIForwardImpl | — |
Traits
Groups:
dispatchers
| EthAccountUpgradeableABIDispatcher | — |
| EthAccountUpgradeableABILibraryDispatcher | — |
| EthAccountUpgradeableABISafeLibraryDispatcher | — |
| EthAccountUpgradeableABISafeDispatcher | — |
Modules
Modules
| __external_EthAccountUpgradeableABIForwardImpl | — |
| __l1_handler_EthAccountUpgradeableABIForwardImpl | — |
| __constructor_EthAccountUpgradeableABIForwardImpl | — |
__external_EthAccountUpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::eth_account::__external_EthAccountUpgradeableABIForwardImpl
__l1_handler_EthAccountUpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::eth_account::__l1_handler_EthAccountUpgradeableABIForwardImpl
__constructor_EthAccountUpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::eth_account::__constructor_EthAccountUpgradeableABIForwardImpl
Traits
Traits
EthAccountUpgradeableABI
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABI
pub trait EthAccountUpgradeableABI<TState>
Trait functions
execute
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABI::execute
fn __execute__(self: @TState, calls: Array<Call>)
validate
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABI::validate
fn __validate__(self: @TState, calls: Array<Call>) -> felt252
is_valid_signature
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABI::is_valid_signature
fn is_valid_signature(self: @TState, hash: felt252, signature: Array<felt252>) -> felt252
supports_interface
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABI::supports_interface
fn supports_interface(self: @TState, interface_id: felt252) -> bool
execute_from_outside_v2
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABI::execute_from_outside_v2
fn execute_from_outside_v2(
ref self: TState, outside_execution: OutsideExecution, signature: Span<felt252>,
) -> Array<Span<felt252>>
is_valid_outside_execution_nonce
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABI::is_valid_outside_execution_nonce
fn is_valid_outside_execution_nonce(self: @TState, nonce: felt252) -> bool
validate_declare
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABI::validate_declare
fn __validate_declare__(self: @TState, class_hash: felt252) -> felt252
validate_deploy
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABI::validate_deploy
fn __validate_deploy__(
self: @TState, class_hash: felt252, contract_address_salt: felt252, public_key: Secp256k1Point,
) -> felt252
get_public_key
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABI::get_public_key
fn get_public_key(self: @TState) -> Secp256k1Point
set_public_key
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABI::set_public_key
fn set_public_key(ref self: TState, new_public_key: Secp256k1Point, signature: Span<felt252>)
isValidSignature
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABI::isValidSignature
fn isValidSignature(self: @TState, hash: felt252, signature: Array<felt252>) -> felt252
getPublicKey
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABI::getPublicKey
fn getPublicKey(self: @TState) -> Secp256k1Point
setPublicKey
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABI::setPublicKey
fn setPublicKey(ref self: TState, newPublicKey: Secp256k1Point, signature: Span<felt252>)
upgrade
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABI::upgrade
fn upgrade(ref self: TState, new_class_hash: ClassHash)
UnsafeNewContractStateTraitForEthAccountUpgradeableABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::eth_account::UnsafeNewContractStateTraitForEthAccountUpgradeableABIForwardImpl
pub trait UnsafeNewContractStateTraitForEthAccountUpgradeableABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_presets::interfaces::eth_account::UnsafeNewContractStateTraitForEthAccountUpgradeableABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
meta_tx_v0
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0
Modules
| __external_MetaTransactionV0ABIForwardImpl | — |
| __l1_handler_MetaTransactionV0ABIForwardImpl | — |
| __constructor_MetaTransactionV0ABIForwardImpl | — |
Traits
Groups:
dispatchers
| MetaTransactionV0ABIDispatcher | — |
| MetaTransactionV0ABILibraryDispatcher | — |
| MetaTransactionV0ABISafeLibraryDispatcher | — |
| MetaTransactionV0ABISafeDispatcher | — |
Modules
Modules
| __external_MetaTransactionV0ABIForwardImpl | — |
| __l1_handler_MetaTransactionV0ABIForwardImpl | — |
| __constructor_MetaTransactionV0ABIForwardImpl | — |
__external_MetaTransactionV0ABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::__external_MetaTransactionV0ABIForwardImpl
__l1_handler_MetaTransactionV0ABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::__l1_handler_MetaTransactionV0ABIForwardImpl
__constructor_MetaTransactionV0ABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::__constructor_MetaTransactionV0ABIForwardImpl
Traits
Traits
MetaTransactionV0ABI
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::MetaTransactionV0ABI
pub trait MetaTransactionV0ABI<TState>
Trait functions
execute_meta_tx_v0
Wrapper around the meta_tx_v0_syscall function.
Invokes the given entry point as a v0 meta transaction.
- The signature is replaced with the given signature.
- The caller is the OS (address 0).
- The transaction version is replaced by 0.
- The transaction hash is replaced by the corresponding version-0 transaction hash.
The context changes apply to the called contract and the inner contracts it calls, except for the caller, which is updated appropriately in subcalls.
NOTE: This syscall should only be used to allow support for old version-0 bound accounts, and should not be used for other purposes.
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::MetaTransactionV0ABI::execute_meta_tx_v0
fn execute_meta_tx_v0(
ref self: TState,
target: ContractAddress,
entry_point_selector: felt252,
calldata: Span<felt252>,
signature: Span<felt252>,
) -> Result<Span<felt252>, Array<felt252>>
UnsafeNewContractStateTraitForMetaTransactionV0ABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::UnsafeNewContractStateTraitForMetaTransactionV0ABIForwardImpl
pub trait UnsafeNewContractStateTraitForMetaTransactionV0ABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::UnsafeNewContractStateTraitForMetaTransactionV0ABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
vesting
Fully qualified path: openzeppelin_presets::interfaces::vesting
Modules
| __external_VestingWalletABIForwardImpl | — |
| __l1_handler_VestingWalletABIForwardImpl | — |
| __constructor_VestingWalletABIForwardImpl | — |
Traits
Groups:
dispatchers
| VestingWalletABIDispatcher | — |
| VestingWalletABILibraryDispatcher | — |
| VestingWalletABISafeLibraryDispatcher | — |
| VestingWalletABISafeDispatcher | — |
Modules
Modules
| __external_VestingWalletABIForwardImpl | — |
| __l1_handler_VestingWalletABIForwardImpl | — |
| __constructor_VestingWalletABIForwardImpl | — |
__external_VestingWalletABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::vesting::__external_VestingWalletABIForwardImpl
__l1_handler_VestingWalletABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::vesting::__l1_handler_VestingWalletABIForwardImpl
__constructor_VestingWalletABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::vesting::__constructor_VestingWalletABIForwardImpl
Traits
Traits
VestingWalletABI
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABI
pub trait VestingWalletABI<TState>
Trait functions
start
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABI::start
fn start(self: @TState) -> u64
cliff
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABI::cliff
fn cliff(self: @TState) -> u64
duration
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABI::duration
fn duration(self: @TState) -> u64
end
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABI::end
fn end(self: @TState) -> u64
released
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABI::released
fn released(self: @TState, token: ContractAddress) -> u256
releasable
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABI::releasable
fn releasable(self: @TState, token: ContractAddress) -> u256
vested_amount
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABI::vested_amount
fn vested_amount(self: @TState, token: ContractAddress, timestamp: u64) -> u256
release
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABI::release
fn release(ref self: TState, token: ContractAddress) -> u256
owner
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABI::owner
fn owner(self: @TState) -> ContractAddress
transfer_ownership
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABI::transfer_ownership
fn transfer_ownership(ref self: TState, new_owner: ContractAddress)
renounce_ownership
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABI::renounce_ownership
fn renounce_ownership(ref self: TState)
transferOwnership
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABI::transferOwnership
fn transferOwnership(ref self: TState, newOwner: ContractAddress)
renounceOwnership
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABI::renounceOwnership
fn renounceOwnership(ref self: TState)
UnsafeNewContractStateTraitForVestingWalletABIForwardImpl
Fully qualified path: openzeppelin_presets::interfaces::vesting::UnsafeNewContractStateTraitForVestingWalletABIForwardImpl
pub trait UnsafeNewContractStateTraitForVestingWalletABIForwardImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_presets::interfaces::vesting::UnsafeNewContractStateTraitForVestingWalletABIForwardImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
meta_tx_v0
Fully qualified path: openzeppelin_presets::meta_tx_v0
Modules
Modules
Modules
MetaTransactionV0
Fully qualified path: openzeppelin_presets::meta_tx_v0::MetaTransactionV0
Free functions
Structs
Enums
Free functions
Free functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_presets::meta_tx_v0::MetaTransactionV0::unsafe_new_contract_state
pub fn unsafe_new_contract_state() -> ContractState
Structs
Structs
ContractState
Fully qualified path: openzeppelin_presets::meta_tx_v0::MetaTransactionV0::ContractState
pub struct ContractState {}
Enums
Enums
Event
Fully qualified path: openzeppelin_presets::meta_tx_v0::MetaTransactionV0::Event
pub enum Event {}
universal_deployer
Fully qualified path: openzeppelin_presets::universal_deployer
Modules
Modules
Modules
UniversalDeployer
UniversalDeployerContract Preset
The Universal Deployer Contract is a standardized generic factory of Starknet contracts.
Fully qualified path: openzeppelin_presets::universal_deployer::UniversalDeployer
Free functions
Structs
Free functions
Free functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_presets::universal_deployer::UniversalDeployer::unsafe_new_contract_state
pub fn unsafe_new_contract_state() -> ContractState
Structs
Structs
Storage
Fully qualified path: openzeppelin_presets::universal_deployer::UniversalDeployer::Storage
[storage]
pub struct Storage {}
ContractState
Fully qualified path: openzeppelin_presets::universal_deployer::UniversalDeployer::ContractState
pub struct ContractState {}
vesting
Fully qualified path: openzeppelin_presets::vesting
Modules
Modules
Modules
VestingWallet
Fully qualified path: openzeppelin_presets::vesting::VestingWallet
Free functions
Structs
Free functions
Free functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_presets::vesting::VestingWallet::unsafe_new_contract_state
pub fn unsafe_new_contract_state() -> ContractState
Structs
Structs
Storage
Fully qualified path: openzeppelin_presets::vesting::VestingWallet::Storage
[storage]
pub struct Storage {
pub ownable: Storage,
pub vesting: Storage,
}
Members
ownable
Fully qualified path: openzeppelin_presets::vesting::VestingWallet::Storage::ownable
pub ownable: Storage
vesting
Fully qualified path: openzeppelin_presets::vesting::VestingWallet::Storage::vesting
pub vesting: Storage
ContractState
Fully qualified path: openzeppelin_presets::vesting::VestingWallet::ContractState
pub struct ContractState {
pub ownable: ComponentState<ContractState>,
pub vesting: ComponentState<ContractState>,
}
Members
ownable
Fully qualified path: openzeppelin_presets::vesting::VestingWallet::ContractState::ownable
pub ownable: ComponentState<ContractState>
vesting
Fully qualified path: openzeppelin_presets::vesting::VestingWallet::ContractState::vesting
pub vesting: ComponentState<ContractState>
openzeppelin_security
Fully qualified path: openzeppelin_security
Modules
Re-exports:
Modules
Modules
initializable
Fully qualified path: openzeppelin_security::initializable
Modules
Modules
Modules
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
Structs
Enums
Traits
Modules
Modules
| Errors | — |
| __external_InitializableImpl | — |
| __l1_handler_InitializableImpl | — |
| __constructor_InitializableImpl | — |
Errors
Fully qualified path: openzeppelin_security::initializable::InitializableComponent::Errors
Constants
Constants
Constants
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
Fully qualified path: openzeppelin_security::initializable::InitializableComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
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
Fully qualified path: openzeppelin_security::initializable::InitializableComponent::Event
pub enum Event {}
Traits
Traits
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:
initializewas 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
Modules
Modules
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
Free functions
Structs
| Storage | — |
| Paused | Emitted when the pause is triggered by account . |
| Unpaused | Emitted when the pause is lifted by account . |
| ComponentState | — |
Enums
Traits
Modules
Modules
Errors
Fully qualified path: openzeppelin_security::pausable::PausableComponent::Errors
Constants
Constants
Constants
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
Fully qualified path: openzeppelin_security::pausable::PausableComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| Paused | Emitted when the pause is triggered by account . |
| Unpaused | Emitted 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
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
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
Modules
Modules
ReentrancyGuardComponent
ReentrancyGuard Component
The ReentrancyGuard component helps prevent nested (reentrant) calls to a function.
Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent
Modules
Free functions
Structs
Enums
Traits
Modules
Modules
Errors
Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::Errors
Constants
Constants
Constants
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
Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
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
Fully qualified path: openzeppelin_security::reentrancyguard::ReentrancyGuardComponent::Event
pub enum Event {}
Traits
Traits
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>)
openzeppelin_token
Fully qualified path: openzeppelin_token
Modules
Modules
Modules
common
Fully qualified path: openzeppelin_token::common
Modules
Modules
Modules
erc2981
Fully qualified path: openzeppelin_token::common::erc2981
Modules
Re-exports:
| DefaultConfig | Implementation of the default ERC2981Component ImmutableConfig. See https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-107.md#defaultconfig-implementation The default fee denominator is set to… |
Modules
Modules
erc2981
Fully qualified path: openzeppelin_token::common::erc2981::erc2981
Modules
Impls
| DefaultConfig | Implementation of the default ERC2981Component ImmutableConfig. See https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-107.md#defaultconfig-implementation The default fee denominator is set to… |
Modules
Modules
ERC2981Component
ERC2981 Component
Implementation of the NFT Royalty Standard, a standardized way to retrieve royalty payment information.
Royalty information can be specified globally for all token ids via set_default_royalty,
and/or individually for specific token ids via set_token_royalty. The latter takes precedence
over the first.
Royalty is specified as a fraction of sale price. The denominator is set by the contract by using the Immutable Component Config pattern. See https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-107.md
IMPORTANT: ERC-2981 only specifies a way to signal royalty information and does not enforce its payment. See https://eips.ethereum.org/EIPS/eip-2981#optional-royalty-paymentsRationale in the ERC. Marketplaces are expected to voluntarily pay royalties together with sales.
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component
Modules
Constants
| ROYALTY_ADMIN_ROLE | Role for the admin responsible for managing royalty settings. |
| DEFAULT_FEE_DENOMINATOR | — |
Free functions
Structs
Enums
Traits
| ImmutableConfig | Constants expected to be defined at the contract level used to configure the component behavior…. |
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForERC2981Impl | — |
| UnsafeNewContractStateTraitForERC2981InfoImpl | — |
| UnsafeNewContractStateTraitForERC2981AdminOwnableImpl | — |
| UnsafeNewContractStateTraitForERC2981AdminAccessControlImpl | — |
| UnsafeNewContractStateTraitForERC2981AdminAccessControlDefaultAdminRulesImpl | — |
Modules
Modules
Errors
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::Errors
Constants
Constants
Constants
INVALID_ROYALTY
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::Errors::INVALID_ROYALTY
pub const INVALID_ROYALTY: felt252 = 1699754257840709950168247819197704976323732217030010238073;
INVALID_ROYALTY_RECEIVER
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::Errors::INVALID_ROYALTY_RECEIVER
pub const INVALID_ROYALTY_RECEIVER: felt252 =
435137090007221747243071441714612473938875444720760727692658;
INVALID_FEE_DENOMINATOR
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::Errors::INVALID_FEE_DENOMINATOR
pub const INVALID_FEE_DENOMINATOR: felt252 =
7033339804690827301661156860845027271122137638134640498;
__external_ERC2981Impl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::__external_ERC2981Impl
__l1_handler_ERC2981Impl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::__l1_handler_ERC2981Impl
__constructor_ERC2981Impl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::__constructor_ERC2981Impl
__external_ERC2981InfoImpl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::__external_ERC2981InfoImpl
__l1_handler_ERC2981InfoImpl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::__l1_handler_ERC2981InfoImpl
__constructor_ERC2981InfoImpl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::__constructor_ERC2981InfoImpl
__external_ERC2981AdminOwnableImpl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::__external_ERC2981AdminOwnableImpl
__l1_handler_ERC2981AdminOwnableImpl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::__l1_handler_ERC2981AdminOwnableImpl
__constructor_ERC2981AdminOwnableImpl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::__constructor_ERC2981AdminOwnableImpl
__external_ERC2981AdminAccessControlImpl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::__external_ERC2981AdminAccessControlImpl
__l1_handler_ERC2981AdminAccessControlImpl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::__l1_handler_ERC2981AdminAccessControlImpl
__constructor_ERC2981AdminAccessControlImpl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::__constructor_ERC2981AdminAccessControlImpl
__external_ERC2981AdminAccessControlDefaultAdminRulesImpl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::__external_ERC2981AdminAccessControlDefaultAdminRulesImpl
__l1_handler_ERC2981AdminAccessControlDefaultAdminRulesImpl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::__l1_handler_ERC2981AdminAccessControlDefaultAdminRulesImpl
__constructor_ERC2981AdminAccessControlDefaultAdminRulesImpl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::__constructor_ERC2981AdminAccessControlDefaultAdminRulesImpl
Constants
Constants
| ROYALTY_ADMIN_ROLE | Role for the admin responsible for managing royalty settings. |
| DEFAULT_FEE_DENOMINATOR | — |
ROYALTY_ADMIN_ROLE
Role for the admin responsible for managing royalty settings.
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::ROYALTY_ADMIN_ROLE
pub const ROYALTY_ADMIN_ROLE: felt252 =
770387435133372507257642958672645943185612715122236777234933570164353708049;
DEFAULT_FEE_DENOMINATOR
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::DEFAULT_FEE_DENOMINATOR
pub const DEFAULT_FEE_DENOMINATOR: u128 = 10000;
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
RoyaltyInfo
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::RoyaltyInfo
[derive(Serde, Drop, starknet::Store)]
pub struct RoyaltyInfo {
pub receiver: ContractAddress,
pub royalty_fraction: u128,
}
Members
receiver
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::RoyaltyInfo::receiver
pub receiver: ContractAddress
royalty_fraction
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::RoyaltyInfo::royalty_fraction
pub royalty_fraction: u128
Storage
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::Storage
[storage]
pub struct Storage {
pub ERC2981_default_royalty_info: RoyaltyInfo,
pub ERC2981_token_royalty_info: Map<u256, RoyaltyInfo>,
}
Members
ERC2981_default_royalty_info
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::Storage::ERC2981_default_royalty_info
pub ERC2981_default_royalty_info: RoyaltyInfo
ERC2981_token_royalty_info
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::Storage::ERC2981_token_royalty_info
pub ERC2981_token_royalty_info: Map<u256, RoyaltyInfo>
ComponentState
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::Event
pub enum Event {}
Traits
Traits
| ImmutableConfig | Constants expected to be defined at the contract level used to configure the component behavior…. |
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForERC2981Impl | — |
| UnsafeNewContractStateTraitForERC2981InfoImpl | — |
| UnsafeNewContractStateTraitForERC2981AdminOwnableImpl | — |
| UnsafeNewContractStateTraitForERC2981AdminAccessControlImpl | — |
| UnsafeNewContractStateTraitForERC2981AdminAccessControlDefaultAdminRulesImpl | — |
ImmutableConfig
Constants expected to be defined at the contract level used to configure the component behavior.
FEE_DENOMINATOR: The denominator with which to interpret the fee set in_set_token_royaltyand_set_default_royaltyas a fraction of the sale price.
Requirements:
FEE_DENOMINATORmust be greater than 0.
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::ImmutableConfig
pub trait ImmutableConfig
Trait constants
FEE_DENOMINATOR
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::ImmutableConfig::FEE_DENOMINATOR
const FEE_DENOMINATOR: u128;
Trait functions
validate
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::ImmutableConfig::validate
fn validate()
HasComponent
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::HasComponent::emit
fn emit<
S, impl IntoImp: Into<S, openzeppelin_token::common::erc2981::erc2981::ERC2981Component::Event>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::InternalTrait
pub trait InternalTrait<
TContractState,
+HasComponent<TContractState>,
impl Immutable: ImmutableConfig,
impl SRC5: HasComponent<TContractState>,
+Drop<TContractState>,
>
Trait functions
initializer
Initializes the contract by setting the default royalty.
Requirements:
default_receivercannot be the zero address.default_royalty_fractioncannot be greater than the fee denominator.- The fee denominator must be greater than 0.
NOTE: The fee denominator is set by the contract using the Immutable Component Config.
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::InternalTrait::initializer
fn initializer(
ref self: ComponentState<TContractState>,
default_receiver: ContractAddress,
default_royalty_fraction: u128,
)
_default_royalty
Returns the royalty information that all ids in this contract will default to.
The returned tuple contains:
t.0: The receiver of the royalty payment.t.1: The numerator of the royalty fraction.t.2: The denominator of the royalty fraction.
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::InternalTrait::_default_royalty
fn _default_royalty(self: @ComponentState<TContractState>) -> (ContractAddress, u128, u128)
_set_default_royalty
Sets the royalty information that all ids in this contract will default to.
Requirements:
receivercannot be the zero address.fee_numeratorcannot be greater than the fee denominator.
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::InternalTrait::_set_default_royalty
fn _set_default_royalty(
ref self: ComponentState<TContractState>, receiver: ContractAddress, fee_numerator: u128,
)
_delete_default_royalty
Sets the default royalty percentage and receiver to zero.
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::InternalTrait::_delete_default_royalty
fn _delete_default_royalty(ref self: ComponentState<TContractState>)
_token_royalty
Returns the royalty information specific to a token. If no specific royalty information is set for the token, the default is returned.
The returned tuple contains:
t.0: The receiver of the royalty payment.t.1: The numerator of the royalty fraction.t.2: The denominator of the royalty fraction.
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::InternalTrait::_token_royalty
fn _token_royalty(
self: @ComponentState<TContractState>, token_id: u256,
) -> (ContractAddress, u128, u128)
_set_token_royalty
Sets the royalty information for a specific token id that takes precedence over the global default.
Requirements:
receivercannot be the zero address.fee_numeratorcannot be greater than the fee denominator.
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::InternalTrait::_set_token_royalty
fn _set_token_royalty(
ref self: ComponentState<TContractState>,
token_id: u256,
receiver: ContractAddress,
fee_numerator: u128,
)
_reset_token_royalty
Resets royalty information for the token id back to unset.
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::InternalTrait::_reset_token_royalty
fn _reset_token_royalty(ref self: ComponentState<TContractState>, token_id: u256)
UnsafeNewContractStateTraitForERC2981Impl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::UnsafeNewContractStateTraitForERC2981Impl
pub trait UnsafeNewContractStateTraitForERC2981Impl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::UnsafeNewContractStateTraitForERC2981Impl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC2981InfoImpl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::UnsafeNewContractStateTraitForERC2981InfoImpl
pub trait UnsafeNewContractStateTraitForERC2981InfoImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::UnsafeNewContractStateTraitForERC2981InfoImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC2981AdminOwnableImpl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::UnsafeNewContractStateTraitForERC2981AdminOwnableImpl
pub trait UnsafeNewContractStateTraitForERC2981AdminOwnableImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::UnsafeNewContractStateTraitForERC2981AdminOwnableImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC2981AdminAccessControlImpl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::UnsafeNewContractStateTraitForERC2981AdminAccessControlImpl
pub trait UnsafeNewContractStateTraitForERC2981AdminAccessControlImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::UnsafeNewContractStateTraitForERC2981AdminAccessControlImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC2981AdminAccessControlDefaultAdminRulesImpl
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::UnsafeNewContractStateTraitForERC2981AdminAccessControlDefaultAdminRulesImpl
pub trait UnsafeNewContractStateTraitForERC2981AdminAccessControlDefaultAdminRulesImpl<
TContractState,
>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::ERC2981Component::UnsafeNewContractStateTraitForERC2981AdminAccessControlDefaultAdminRulesImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
Impls
Impls
| DefaultConfig | Implementation of the default ERC2981Component ImmutableConfig. See https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-107.md#defaultconfig-implementation The default fee denominator is set to… |
DefaultConfig
Implementation of the default ERC2981Component ImmutableConfig.
See https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-107.md#defaultconfig-implementation
The default fee denominator is set to DEFAULT_FEE_DENOMINATOR.
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::DefaultConfig
pub impl DefaultConfig of ImmutableConfig;
Impl constants
FEE_DENOMINATOR
Fully qualified path: openzeppelin_token::common::erc2981::erc2981::DefaultConfig::FEE_DENOMINATOR
const FEE_DENOMINATOR: u128 = ERC2981Component::DEFAULT_FEE_DENOMINATOR;
erc1155
Fully qualified path: openzeppelin_token::erc1155
Modules
Re-exports:
| ERC1155HooksEmptyImpl | An empty implementation of the ERC1155 hooks to be used in basic ERC1155 preset contracts. |
Modules
Modules
erc1155
Fully qualified path: openzeppelin_token::erc1155::erc1155
Modules
Modules
Modules
ERC1155Component
ERC1155 Component
The ERC1155 component provides an implementation of the basic standard multi-token. See https://eips.ethereum.org/EIPS/eip-1155.
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component
Modules
Free functions
Structs
| Storage | — |
| TransferSingle | Emitted when value token is transferred from from to to for id . |
| TransferBatch | Emitted when values are transferred from from to to for ids . |
| ApprovalForAll | Emitted when account enables or disables ( approved ) operator to manage all of its assets. |
| URI | Emitted when the URI for token type id changes to value , if it is a non-programmatic URI. If an URI event was emitted for id , the standard guarantees that value will equal the… |
| ComponentState | — |
Enums
Traits
Modules
Modules
Errors
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::Errors
Constants
| UNAUTHORIZED | — |
| SELF_APPROVAL | — |
| INVALID_RECEIVER | — |
| INVALID_SENDER | — |
| INVALID_ARRAY_LENGTH | — |
| INSUFFICIENT_BALANCE | — |
| SAFE_TRANSFER_FAILED | — |
Constants
Constants
| UNAUTHORIZED | — |
| SELF_APPROVAL | — |
| INVALID_RECEIVER | — |
| INVALID_SENDER | — |
| INVALID_ARRAY_LENGTH | — |
| INSUFFICIENT_BALANCE | — |
| SAFE_TRANSFER_FAILED | — |
UNAUTHORIZED
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::Errors::UNAUTHORIZED
pub const UNAUTHORIZED: felt252 =
478438289715301829996768881402087393226436157487501112331320631571541874;
SELF_APPROVAL
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::Errors::SELF_APPROVAL
pub const SELF_APPROVAL: felt252 = 25936191655478970838689484552120815602561389442785644;
INVALID_RECEIVER
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::Errors::INVALID_RECEIVER
pub const INVALID_RECEIVER: felt252 = 435137089621368277218381393912759544813016424183403967309170;
INVALID_SENDER
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::Errors::INVALID_SENDER
pub const INVALID_SENDER: felt252 = 6639665063802616534704305937389519421585334720658695538;
INVALID_ARRAY_LENGTH
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::Errors::INVALID_ARRAY_LENGTH
pub const INVALID_ARRAY_LENGTH: felt252 =
478438289715301829996758655148673609610493128314849328529588103118550120;
INSUFFICIENT_BALANCE
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::Errors::INSUFFICIENT_BALANCE
pub const INSUFFICIENT_BALANCE: felt252 =
1868899569200397773424809936655656520788742270802102168023995413062501;
SAFE_TRANSFER_FAILED
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::Errors::SAFE_TRANSFER_FAILED
pub const SAFE_TRANSFER_FAILED: felt252 =
1868899569200397773424866735515679970217101410251298792678887764288868;
__external_ERC1155Impl
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::__external_ERC1155Impl
__l1_handler_ERC1155Impl
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::__l1_handler_ERC1155Impl
__constructor_ERC1155Impl
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::__constructor_ERC1155Impl
__external_ERC1155MetadataURIImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::__external_ERC1155MetadataURIImpl
__l1_handler_ERC1155MetadataURIImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::__l1_handler_ERC1155MetadataURIImpl
__constructor_ERC1155MetadataURIImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::__constructor_ERC1155MetadataURIImpl
__external_ERC1155CamelImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::__external_ERC1155CamelImpl
__l1_handler_ERC1155CamelImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::__l1_handler_ERC1155CamelImpl
__constructor_ERC1155CamelImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::__constructor_ERC1155CamelImpl
__external_ERC1155MixinImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::__external_ERC1155MixinImpl
__l1_handler_ERC1155MixinImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::__l1_handler_ERC1155MixinImpl
__constructor_ERC1155MixinImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::__constructor_ERC1155MixinImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| TransferSingle | Emitted when value token is transferred from from to to for id . |
| TransferBatch | Emitted when values are transferred from from to to for ids . |
| ApprovalForAll | Emitted when account enables or disables ( approved ) operator to manage all of its assets. |
| URI | Emitted when the URI for token type id changes to value , if it is a non-programmatic URI. If an URI event was emitted for id , the standard guarantees that value will equal the… |
| ComponentState | — |
Storage
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::Storage
[storage]
pub struct Storage {
pub ERC1155_balances: Map<(u256, ContractAddress), u256>,
pub ERC1155_operator_approvals: Map<(ContractAddress, ContractAddress), bool>,
pub ERC1155_uri: ByteArray,
}
Members
ERC1155_balances
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::Storage::ERC1155_balances
pub ERC1155_balances: Map<(u256, ContractAddress), u256>
ERC1155_operator_approvals
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::Storage::ERC1155_operator_approvals
pub ERC1155_operator_approvals: Map<(ContractAddress, ContractAddress), bool>
ERC1155_uri
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::Storage::ERC1155_uri
pub ERC1155_uri: ByteArray
TransferSingle
Emitted when value token is transferred from from to to for id.
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::TransferSingle
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct TransferSingle {
pub operator: ContractAddress,
pub from: ContractAddress,
pub to: ContractAddress,
pub id: u256,
pub value: u256,
}
Members
operator
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::TransferSingle::operator
pub operator: ContractAddress
from
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::TransferSingle::from
pub from: ContractAddress
to
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::TransferSingle::to
pub to: ContractAddress
id
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::TransferSingle::id
pub id: u256
value
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::TransferSingle::value
pub value: u256
TransferBatch
Emitted when values are transferred from from to to for ids.
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::TransferBatch
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct TransferBatch {
pub operator: ContractAddress,
pub from: ContractAddress,
pub to: ContractAddress,
pub ids: Span<u256>,
pub values: Span<u256>,
}
Members
operator
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::TransferBatch::operator
pub operator: ContractAddress
from
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::TransferBatch::from
pub from: ContractAddress
to
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::TransferBatch::to
pub to: ContractAddress
ids
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::TransferBatch::ids
pub ids: Span<u256>
values
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::TransferBatch::values
pub values: Span<u256>
ApprovalForAll
Emitted when account enables or disables (approved) operator to manage
all of its assets.
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::ApprovalForAll
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct ApprovalForAll {
pub owner: ContractAddress,
pub operator: ContractAddress,
pub approved: bool,
}
Members
owner
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::ApprovalForAll::owner
pub owner: ContractAddress
operator
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::ApprovalForAll::operator
pub operator: ContractAddress
approved
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::ApprovalForAll::approved
pub approved: bool
URI
Emitted when the URI for token type id changes to value, if it is a non-programmatic
URI.
If an URI event was emitted for id, the standard guarantees that value will equal the
value returned by IERC1155MetadataURI::uri.
https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::URI
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct URI {
pub value: ByteArray,
pub id: u256,
}
Members
value
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::URI::value
pub value: ByteArray
id
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::URI::id
pub id: u256
ComponentState
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::Event
pub enum Event {
TransferSingle: TransferSingle,
TransferBatch: TransferBatch,
ApprovalForAll: ApprovalForAll,
URI: URI,
}
Variants
TransferSingle
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::Event::TransferSingle
TransferSingle: TransferSingle
TransferBatch
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::Event::TransferBatch
TransferBatch: TransferBatch
ApprovalForAll
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::Event::ApprovalForAll
ApprovalForAll: ApprovalForAll
URI
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::Event::URI
URI: URI
Traits
Traits
ERC1155HooksTrait
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::ERC1155HooksTrait
pub trait ERC1155HooksTrait<TContractState>
Trait functions
before_update
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::ERC1155HooksTrait::before_update
fn before_update(
ref self: ComponentState<TContractState>,
from: ContractAddress,
to: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
)
after_update
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::ERC1155HooksTrait::after_update
fn after_update(
ref self: ComponentState<TContractState>,
from: ContractAddress,
to: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
)
HasComponent
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::HasComponent::emit
fn emit<S, impl IntoImp: Into<S, openzeppelin_token::erc1155::erc1155::ERC1155Component::Event>>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::InternalTrait
pub trait InternalTrait<
TContractState,
+HasComponent<TContractState>,
impl SRC5: HasComponent<TContractState>,
impl Hooks: ERC1155HooksTrait<TContractState>,
+Drop<TContractState>,
>
Trait functions
initializer
Initializes the contract by setting the base_uri for all tokens,
and registering the supported interfaces.
This should only be used inside the contract’s constructor.
WARNING: Most ERC1155 contracts expose the IERC1155MetadataURI interface which
is what this initializer is meant to support.
If the contract DOES NOT expose the IERC1155MetadataURI interface,
meaning the token does not have a URI, the contract must instead use
initializer_no_metadata in the constructor.
Failure to abide by these instructions can lead to unexpected issues especially with
UIs.
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::InternalTrait::initializer
fn initializer(ref self: ComponentState<TContractState>, base_uri: ByteArray)
initializer_no_metadata
Initializes the contract with no metadata by registering only the IERC1155 interface.
WARNING: This initializer should ONLY be used during construction in the very
specific instance when the contract does NOT expose the IERC1155MetadataURI interface.
Initializing a contract with this initializer means that tokens will not
have a URI.
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::InternalTrait::initializer_no_metadata
fn initializer_no_metadata(ref self: ComponentState<TContractState>)
mint_with_acceptance_check
Creates a value amount of tokens of type token_id, and assigns them to to.
Requirements:
tocannot be the zero address.- If
torefers to a smart contract, it must implementIERC1155Receiver::on_ERC1155_receivedand return the acceptance magic value.
Emits a TransferSingle event.
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::InternalTrait::mint_with_acceptance_check
fn mint_with_acceptance_check(
ref self: ComponentState<TContractState>,
to: ContractAddress,
token_id: u256,
value: u256,
data: Span<felt252>,
)
batch_mint_with_acceptance_check
Batched version of mint_with_acceptance_check.
Requirements:
tocannot be the zero address.token_idsandvaluesmust have the same length.- If
torefers to a smart contract, it must implementIERC1155Receiver::on_ERC1155_batch_receivedand return the acceptance magic value.
Emits a TransferBatch event.
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::InternalTrait::batch_mint_with_acceptance_check
fn batch_mint_with_acceptance_check(
ref self: ComponentState<TContractState>,
to: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
)
burn
Destroys a value amount of tokens of type token_id from from.
Requirements:
fromcannot be the zero address.frommust have at leastvalueamount of tokens of typetoken_id.
Emits a TransferSingle event.
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::InternalTrait::burn
fn burn(
ref self: ComponentState<TContractState>, from: ContractAddress, token_id: u256, value: u256,
)
batch_burn
Batched version of burn.
Requirements:
fromcannot be the zero address.frommust have at leastvalueamount of tokens of typetoken_id.token_idsandvaluesmust have the same length.
Emits a TransferBatch event.
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::InternalTrait::batch_burn
fn batch_burn(
ref self: ComponentState<TContractState>,
from: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
)
update_with_acceptance_check
Version of update that performs the token acceptance check by calling
IERC1155Receiver::onERC1155Received or IERC1155Receiver::onERC1155BatchReceived if
the receiver is not recognized as an account.
Requirements:
tois either an account contract or supports theIERC1155Receiverinterface.token_idsandvaluesmust have the same length.
Emits a TransferSingle event if the arrays contain one element, and TransferBatch
otherwise.
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::InternalTrait::update_with_acceptance_check
fn update_with_acceptance_check(
ref self: ComponentState<TContractState>,
from: ContractAddress,
to: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
)
update
Transfers a value amount of tokens of type id from from to to.
Will mint (or burn) if from (or to) is the zero address.
Requirements:
token_idsandvaluesmust have the same length.
Emits a TransferSingle event if the arrays contain one element, and TransferBatch
otherwise.
NOTE: This function can be extended using the ERC1155HooksTrait, to add
functionality before and/or after the transfer, mint, or burn.
NOTE: The ERC1155 acceptance check is not performed in this function.
See update_with_acceptance_check instead.
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::InternalTrait::update
fn update(
ref self: ComponentState<TContractState>,
from: ContractAddress,
to: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
)
_set_base_uri
Sets a new URI for all token types, by relying on the token type ID substitution mechanism defined in the ERC1155 standard. See https://eips.ethereum.org/EIPS/eip-1155#metadata.
By this mechanism, any occurrence of the \{id\} substring in either the
URI or any of the values in the JSON file at said URI will be replaced by
clients with the token type ID.
For example, the https://token-cdn-domain/\{id\}.json URI would be
interpreted by clients as
https://token-cdn-domain/000000000000000000000000000000000000000000000000000000000004cce0.json
for token type ID 0x4cce0.
Because these URIs cannot be meaningfully represented by the URI event,
this function emits no events.
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::InternalTrait::_set_base_uri
fn _set_base_uri(ref self: ComponentState<TContractState>, base_uri: ByteArray)
UnsafeNewContractStateTraitForERC1155Impl
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::UnsafeNewContractStateTraitForERC1155Impl
pub trait UnsafeNewContractStateTraitForERC1155Impl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::UnsafeNewContractStateTraitForERC1155Impl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC1155MetadataURIImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::UnsafeNewContractStateTraitForERC1155MetadataURIImpl
pub trait UnsafeNewContractStateTraitForERC1155MetadataURIImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::UnsafeNewContractStateTraitForERC1155MetadataURIImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC1155CamelImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::UnsafeNewContractStateTraitForERC1155CamelImpl
pub trait UnsafeNewContractStateTraitForERC1155CamelImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::UnsafeNewContractStateTraitForERC1155CamelImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC1155MixinImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::UnsafeNewContractStateTraitForERC1155MixinImpl
pub trait UnsafeNewContractStateTraitForERC1155MixinImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc1155::erc1155::ERC1155Component::UnsafeNewContractStateTraitForERC1155MixinImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
erc1155_receiver
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver
Modules
Modules
Modules
ERC1155ReceiverComponent
ERC1155Receiver Component
The ERC1155Receiver component provides implementations for the IERC1155Receiver interface. Integrating this component allows contracts to support ERC1155 safe transfers.
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent
Modules
Free functions
Structs
Enums
Traits
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForERC1155ReceiverImpl | — |
| UnsafeNewContractStateTraitForERC1155ReceiverCamelImpl | — |
| UnsafeNewContractStateTraitForERC1155ReceiverMixinImpl | — |
Modules
Modules
__external_ERC1155ReceiverImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::__external_ERC1155ReceiverImpl
__l1_handler_ERC1155ReceiverImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::__l1_handler_ERC1155ReceiverImpl
__constructor_ERC1155ReceiverImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::__constructor_ERC1155ReceiverImpl
__external_ERC1155ReceiverCamelImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::__external_ERC1155ReceiverCamelImpl
__l1_handler_ERC1155ReceiverCamelImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::__l1_handler_ERC1155ReceiverCamelImpl
__constructor_ERC1155ReceiverCamelImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::__constructor_ERC1155ReceiverCamelImpl
__external_ERC1155ReceiverMixinImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::__external_ERC1155ReceiverMixinImpl
__l1_handler_ERC1155ReceiverMixinImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::__l1_handler_ERC1155ReceiverMixinImpl
__constructor_ERC1155ReceiverMixinImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::__constructor_ERC1155ReceiverMixinImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
Storage
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::Storage
[storage]
pub struct Storage {}
ComponentState
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::Event
pub enum Event {}
Traits
Traits
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForERC1155ReceiverImpl | — |
| UnsafeNewContractStateTraitForERC1155ReceiverCamelImpl | — |
| UnsafeNewContractStateTraitForERC1155ReceiverMixinImpl | — |
HasComponent
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::HasComponent::emit
fn emit<
S,
impl IntoImp: Into<
S, openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::Event,
>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::InternalTrait
pub trait InternalTrait<
TContractState,
+HasComponent<TContractState>,
impl SRC5: HasComponent<TContractState>,
+Drop<TContractState>,
>
Trait functions
initializer
Initializes the contract by registering the IERC1155Receiver interface ID. This should be used inside the contract’s constructor.
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::InternalTrait::initializer
fn initializer(ref self: ComponentState<TContractState>)
UnsafeNewContractStateTraitForERC1155ReceiverImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::UnsafeNewContractStateTraitForERC1155ReceiverImpl
pub trait UnsafeNewContractStateTraitForERC1155ReceiverImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::UnsafeNewContractStateTraitForERC1155ReceiverImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC1155ReceiverCamelImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::UnsafeNewContractStateTraitForERC1155ReceiverCamelImpl
pub trait UnsafeNewContractStateTraitForERC1155ReceiverCamelImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::UnsafeNewContractStateTraitForERC1155ReceiverCamelImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC1155ReceiverMixinImpl
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::UnsafeNewContractStateTraitForERC1155ReceiverMixinImpl
pub trait UnsafeNewContractStateTraitForERC1155ReceiverMixinImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc1155::erc1155_receiver::ERC1155ReceiverComponent::UnsafeNewContractStateTraitForERC1155ReceiverMixinImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
erc20
Fully qualified path: openzeppelin_token::erc20
Modules
Re-exports:
| DefaultConfig | Implementation of the default ERC20Component ImmutableConfig. See https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-107.md#defaultconfig-implementation The default decimals is set to… |
| ERC20HooksEmptyImpl | An empty implementation of the ERC20 hooks to be used in basic ERC20 preset contracts. |
Modules
Modules
erc20
Fully qualified path: openzeppelin_token::erc20::erc20
Modules
Impls
| DefaultConfig | Implementation of the default ERC20Component ImmutableConfig. See https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-107.md#defaultconfig-implementation The default decimals is set to… |
Modules
Modules
ERC20Component
ERC20 Component
The ERC20 component provides an implementation of the IERC20 interface as well as non-standard implementations that can be used to create an ERC20 contract. This component is agnostic regarding how tokens are created, which means that developers must create their own token distribution mechanism. See the documentation (https://docs.openzeppelin.com/contracts-cairo/3.0.0/guides/erc20-supply) for examples.
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component
Modules
Constants
Free functions
Structs
| Storage | — |
| Transfer | Emitted when tokens are moved from address from to address to . |
| Approval | Emitted when the allowance of a spender for an owner is set by a call to approve . value is the new allowance. |
| ComponentState | — |
Enums
Traits
| ImmutableConfig | Constants expected to be defined at the contract level used to configure the component behavior…. |
| ERC20HooksTrait | — |
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForERC20Impl | — |
| UnsafeNewContractStateTraitForERC20MetadataImpl | — |
| UnsafeNewContractStateTraitForERC20CamelOnlyImpl | — |
| UnsafeNewContractStateTraitForERC20MixinImpl | — |
| UnsafeNewContractStateTraitForERC20PermitImpl | — |
| UnsafeNewContractStateTraitForSNIP12MetadataExternalImpl | — |
Modules
Modules
Errors
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Errors
Constants
Constants
Constants
APPROVE_FROM_ZERO
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Errors::APPROVE_FROM_ZERO
pub const APPROVE_FROM_ZERO: felt252 = 101313248740993271302566317381896466254801065025584;
APPROVE_TO_ZERO
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Errors::APPROVE_TO_ZERO
pub const APPROVE_TO_ZERO: felt252 = 1545917491775410023537694051847785435030822960;
TRANSFER_FROM_ZERO
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Errors::TRANSFER_FROM_ZERO
pub const TRANSFER_FROM_ZERO: felt252 = 25936191677694277552149992725516921697451103245639728;
TRANSFER_TO_ZERO
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Errors::TRANSFER_TO_ZERO
pub const TRANSFER_TO_ZERO: felt252 = 395754877894504967531585582359572169455970492464;
BURN_FROM_ZERO
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Errors::BURN_FROM_ZERO
pub const BURN_FROM_ZERO: felt252 = 6038740202247695405676691625063102337065008;
MINT_TO_ZERO
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Errors::MINT_TO_ZERO
pub const MINT_TO_ZERO: felt252 = 92143862949336172774019376959445737520;
INSUFFICIENT_BALANCE
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Errors::INSUFFICIENT_BALANCE
pub const INSUFFICIENT_BALANCE: felt252 =
28517144329851979398958244156126768237078601998068993600170910565;
INSUFFICIENT_ALLOWANCE
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Errors::INSUFFICIENT_ALLOWANCE
pub const INSUFFICIENT_ALLOWANCE: felt252 =
1868899570801179321890127489015923883185183260545431910485693286998885;
EXPIRED_PERMIT_SIGNATURE
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Errors::EXPIRED_PERMIT_SIGNATURE
pub const EXPIRED_PERMIT_SIGNATURE: felt252 =
122480202272026087942268350314979893259331706174981672776230904878641541733;
INVALID_PERMIT_SIGNATURE
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Errors::INVALID_PERMIT_SIGNATURE
pub const INVALID_PERMIT_SIGNATURE: felt252 =
122480202272026088039392488357692699633302049598224187374825241184790999653;
__external_ERC20Impl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__external_ERC20Impl
__l1_handler_ERC20Impl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__l1_handler_ERC20Impl
__constructor_ERC20Impl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__constructor_ERC20Impl
__external_ERC20MetadataImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__external_ERC20MetadataImpl
__l1_handler_ERC20MetadataImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__l1_handler_ERC20MetadataImpl
__constructor_ERC20MetadataImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__constructor_ERC20MetadataImpl
__external_ERC20CamelOnlyImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__external_ERC20CamelOnlyImpl
__l1_handler_ERC20CamelOnlyImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__l1_handler_ERC20CamelOnlyImpl
__constructor_ERC20CamelOnlyImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__constructor_ERC20CamelOnlyImpl
__external_ERC20MixinImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__external_ERC20MixinImpl
__l1_handler_ERC20MixinImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__l1_handler_ERC20MixinImpl
__constructor_ERC20MixinImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__constructor_ERC20MixinImpl
__external_ERC20PermitImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__external_ERC20PermitImpl
__l1_handler_ERC20PermitImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__l1_handler_ERC20PermitImpl
__constructor_ERC20PermitImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__constructor_ERC20PermitImpl
__external_SNIP12MetadataExternalImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__external_SNIP12MetadataExternalImpl
__l1_handler_SNIP12MetadataExternalImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__l1_handler_SNIP12MetadataExternalImpl
__constructor_SNIP12MetadataExternalImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::__constructor_SNIP12MetadataExternalImpl
Constants
Constants
DEFAULT_DECIMALS
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::DEFAULT_DECIMALS
pub const DEFAULT_DECIMALS: u8 = 18;
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| Transfer | Emitted when tokens are moved from address from to address to . |
| Approval | Emitted when the allowance of a spender for an owner is set by a call to approve . value is the new allowance. |
| ComponentState | — |
Storage
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Storage
[storage]
pub struct Storage {
pub ERC20_name: ByteArray,
pub ERC20_symbol: ByteArray,
pub ERC20_total_supply: u256,
pub ERC20_balances: Map<ContractAddress, u256>,
pub ERC20_allowances: Map<(ContractAddress, ContractAddress), u256>,
}
Members
ERC20_name
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Storage::ERC20_name
pub ERC20_name: ByteArray
ERC20_symbol
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Storage::ERC20_symbol
pub ERC20_symbol: ByteArray
ERC20_total_supply
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Storage::ERC20_total_supply
pub ERC20_total_supply: u256
ERC20_balances
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Storage::ERC20_balances
pub ERC20_balances: Map<ContractAddress, u256>
ERC20_allowances
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Storage::ERC20_allowances
pub ERC20_allowances: Map<(ContractAddress, ContractAddress), u256>
Transfer
Emitted when tokens are moved from address from to address to.
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Transfer
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct Transfer {
pub from: ContractAddress,
pub to: ContractAddress,
pub value: u256,
}
Members
from
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Transfer::from
pub from: ContractAddress
to
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Transfer::to
pub to: ContractAddress
value
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Transfer::value
pub value: u256
Approval
Emitted when the allowance of a spender for an owner is set by a call
to approve. value is the new allowance.
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Approval
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct Approval {
pub owner: ContractAddress,
pub spender: ContractAddress,
pub value: u256,
}
Members
owner
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Approval::owner
pub owner: ContractAddress
spender
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Approval::spender
pub spender: ContractAddress
value
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Approval::value
pub value: u256
ComponentState
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Event
pub enum Event {
Transfer: Transfer,
Approval: Approval,
}
Variants
Transfer
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Event::Transfer
Transfer: Transfer
Approval
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::Event::Approval
Approval: Approval
Traits
Traits
| ImmutableConfig | Constants expected to be defined at the contract level used to configure the component behavior…. |
| ERC20HooksTrait | — |
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForERC20Impl | — |
| UnsafeNewContractStateTraitForERC20MetadataImpl | — |
| UnsafeNewContractStateTraitForERC20CamelOnlyImpl | — |
| UnsafeNewContractStateTraitForERC20MixinImpl | — |
| UnsafeNewContractStateTraitForERC20PermitImpl | — |
| UnsafeNewContractStateTraitForSNIP12MetadataExternalImpl | — |
ImmutableConfig
Constants expected to be defined at the contract level used to configure the component behavior.
DECIMALS: Returns the number of decimals the token uses.
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::ImmutableConfig
pub trait ImmutableConfig
Trait constants
DECIMALS
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::ImmutableConfig::DECIMALS
const DECIMALS: u8;
ERC20HooksTrait
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::ERC20HooksTrait
pub trait ERC20HooksTrait<TContractState>
Trait functions
before_update
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::ERC20HooksTrait::before_update
fn before_update(
ref self: ComponentState<TContractState>,
from: ContractAddress,
recipient: ContractAddress,
amount: u256,
)
after_update
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::ERC20HooksTrait::after_update
fn after_update(
ref self: ComponentState<TContractState>,
from: ContractAddress,
recipient: ContractAddress,
amount: u256,
)
HasComponent
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::HasComponent::emit
fn emit<S, impl IntoImp: Into<S, openzeppelin_token::erc20::erc20::ERC20Component::Event>>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::InternalTrait
pub trait InternalTrait<
TContractState, +HasComponent<TContractState>, impl Hooks: ERC20HooksTrait<TContractState>,
>
Trait functions
initializer
Initializes the contract by setting the token name and symbol. To prevent reinitialization, this should only be used inside of a contract’s constructor.
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::InternalTrait::initializer
fn initializer(ref self: ComponentState<TContractState>, name: ByteArray, symbol: ByteArray)
mint
Creates a value amount of tokens and assigns them to account.
Requirements:
recipientis not the zero address.
Emits a Transfer event with from set to the zero address.
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::InternalTrait::mint
fn mint(ref self: ComponentState<TContractState>, recipient: ContractAddress, amount: u256)
burn
Destroys amount of tokens from account.
Requirements:
accountis not the zero address.accountmust have at least a balance ofamount.
Emits a Transfer event with to set to the zero address.
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::InternalTrait::burn
fn burn(ref self: ComponentState<TContractState>, account: ContractAddress, amount: u256)
update
Transfers an amount of tokens from from to to, or alternatively mints (or burns)
if from (or to) is the zero address.
NOTE: This function can be extended using the ERC20HooksTrait, to add
functionality before and/or after the transfer, mint, or burn.
Emits a Transfer event.
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::InternalTrait::update
fn update(
ref self: ComponentState<TContractState>,
from: ContractAddress,
to: ContractAddress,
amount: u256,
)
_transfer
Internal method that moves an amount of tokens from from to to.
Requirements:
senderis not the zero address.sendermust have at least a balance ofamount.recipientis not the zero address.
Emits a Transfer event.
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::InternalTrait::_transfer
fn _transfer(
ref self: ComponentState<TContractState>,
sender: ContractAddress,
recipient: ContractAddress,
amount: u256,
)
_approve
Internal method that sets amount as the allowance of spender over the
owners tokens.
Requirements:
owneris not the zero address.spenderis not the zero address.
Emits an Approval event.
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::InternalTrait::_approve
fn _approve(
ref self: ComponentState<TContractState>,
owner: ContractAddress,
spender: ContractAddress,
amount: u256,
)
_spend_allowance
Updates owners allowance for spender based on spent amount.
Does not update the allowance value in case of infinite allowance.
Requirements:
spendermust have at least an allowance ofamountfromowner.
Possibly emits an Approval event.
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::InternalTrait::_spend_allowance
fn _spend_allowance(
ref self: ComponentState<TContractState>,
owner: ContractAddress,
spender: ContractAddress,
amount: u256,
)
UnsafeNewContractStateTraitForERC20Impl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::UnsafeNewContractStateTraitForERC20Impl
pub trait UnsafeNewContractStateTraitForERC20Impl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::UnsafeNewContractStateTraitForERC20Impl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC20MetadataImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::UnsafeNewContractStateTraitForERC20MetadataImpl
pub trait UnsafeNewContractStateTraitForERC20MetadataImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::UnsafeNewContractStateTraitForERC20MetadataImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC20CamelOnlyImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::UnsafeNewContractStateTraitForERC20CamelOnlyImpl
pub trait UnsafeNewContractStateTraitForERC20CamelOnlyImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::UnsafeNewContractStateTraitForERC20CamelOnlyImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC20MixinImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::UnsafeNewContractStateTraitForERC20MixinImpl
pub trait UnsafeNewContractStateTraitForERC20MixinImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::UnsafeNewContractStateTraitForERC20MixinImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC20PermitImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::UnsafeNewContractStateTraitForERC20PermitImpl
pub trait UnsafeNewContractStateTraitForERC20PermitImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::UnsafeNewContractStateTraitForERC20PermitImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForSNIP12MetadataExternalImpl
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::UnsafeNewContractStateTraitForSNIP12MetadataExternalImpl
pub trait UnsafeNewContractStateTraitForSNIP12MetadataExternalImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc20::erc20::ERC20Component::UnsafeNewContractStateTraitForSNIP12MetadataExternalImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
Impls
Impls
| DefaultConfig | Implementation of the default ERC20Component ImmutableConfig. See https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-107.md#defaultconfig-implementation The default decimals is set to… |
DefaultConfig
Implementation of the default ERC20Component ImmutableConfig.
See https://github.com/starknet-io/SNIPs/blob/main/SNIPS/snip-107.md#defaultconfig-implementation
The default decimals is set to DEFAULT_DECIMALS.
Fully qualified path: openzeppelin_token::erc20::erc20::DefaultConfig
pub impl DefaultConfig of ImmutableConfig;
Impl constants
DECIMALS
Fully qualified path: openzeppelin_token::erc20::erc20::DefaultConfig::DECIMALS
const DECIMALS: u8 = ERC20Component::DEFAULT_DECIMALS;
extensions
Fully qualified path: openzeppelin_token::erc20::extensions
Modules
Modules
Modules
erc4626
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626
Modules
Re-exports:
| DefaultConfig | Implementation of the default ERC4626Component::ImmutableConfig . See… |
| ERC4626DefaultNoFees | — |
| ERC4626DefaultNoLimits | — |
| ERC4626EmptyHooks | — |
| ERC4626SelfAssetsManagement | — |
Modules
Modules
erc4626
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626
Modules
Impls
| DefaultConfig | Implementation of the default ERC4626Component::ImmutableConfig . See… |
Modules
Modules
ERC4626Component
ERC4626 Component
The ERC4626 component is an extension of ERC20 and provides an implementation of the IERC4626 interface which allows the minting and burning of “shares” in exchange for an underlying “asset”. The component leverages traits to configure fees, limits, and decimals.
CAUTION: In empty (or nearly empty) ERC-4626 vaults, deposits are at high risk of being stolen through frontrunning with a “donation” to the vault that inflates the price of a share. This is variously known as a donation or inflation attack and is essentially a problem of slippage. Vault deployers can protect against this attack by making an initial deposit of a non-trivial amount of the asset, such that price manipulation becomes infeasible. Withdrawals may similarly be affected by slippage. Users can protect against this attack as well as unexpected slippage in general by verifying the amount received is as expected, using a wrapper that performs these checks.
This implementation offers configurable virtual assets and shares to help developers mitigate
that risk. ImmutableConfig::DECIMALS_OFFSET corresponds to an offset in the decimal
representation between the underlying asset’s decimals and vault decimals. This offset also
determines the rate of virtual shares to virtual assets in the vault, which itself determines
the initial exchange rate. While not fully preventing the attack, analysis shows that the
default offset (0) makes it non-profitable even if an attacker is able to capture value from
multiple user deposits, as a result of the value being captured by the virtual shares (out of
the attacker’s donation) matching the attacker’s expected gains. With a larger offset, the
attack becomes orders of magnitude more expensive than it is profitable.
The drawback of this approach is that the virtual shares do capture (a very small) part of the value being accrued to the vault. Also, if the vault experiences losses and users try to exit the vault, the virtual shares and assets will cause the first exiting user to experience reduced losses to the detriment to the last users who will experience bigger losses.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component
Modules
| Errors | — |
| __external_ERC4626Impl | — |
| __l1_handler_ERC4626Impl | — |
| __constructor_ERC4626Impl | — |
| __external_ERC4626MetadataImpl | — |
| __l1_handler_ERC4626MetadataImpl | — |
| __constructor_ERC4626MetadataImpl | — |
Constants
Free functions
Structs
| Storage | — |
| Deposit | Emitted when sender exchanges assets for shares and transfers those shares to owner . |
| Withdraw | Emitted when sender exchanges shares , owned by owner , for assets and transfers those assets to receiver . |
| Preview | Internal helper struct containing assets, shares, and fees calculated in preview functions. |
| ComponentState | — |
Enums
Traits
| ImmutableConfig | Constants expected to be defined at the contract level which configure virtual assets and shares. UNDERLYING_DECIMALS should match the underlying asset’s decimals. The default value is 18 …. |
| FeeConfigTrait | The logic for calculating entry and exit fees is expected to be defined at the contract level. Defaults to no entry or exit fees…. |
| LimitConfigTrait | Sets limits to the target exchange type and is expected to be defined at the contract level. It’s important to note that these limits correspond directly to the max_<OPERATION> i.e. deposit_limit… |
| ERC4626HooksTrait | Allows contracts to hook logic into deposit and withdraw transactions. This is where contracts can transfer fees. NOTE: ERC4626 preview methods must be inclusive of any entry or exit fees…. |
| AssetsManagementTrait | Defines how the ERC4626 vault manages its underlying assets. This trait provides the core asset management functionality for the vault, abstracting the actual storage and transfer mechanisms…. |
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForERC4626Impl | — |
| UnsafeNewContractStateTraitForERC4626MetadataImpl | — |
Modules
Modules
| Errors | — |
| __external_ERC4626Impl | — |
| __l1_handler_ERC4626Impl | — |
| __constructor_ERC4626Impl | — |
| __external_ERC4626MetadataImpl | — |
| __l1_handler_ERC4626MetadataImpl | — |
| __constructor_ERC4626MetadataImpl | — |
Errors
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Errors
Constants
| EXCEEDED_MAX_DEPOSIT | — |
| EXCEEDED_MAX_MINT | — |
| EXCEEDED_MAX_WITHDRAW | — |
| EXCEEDED_MAX_REDEEM | — |
| TOKEN_TRANSFER_FAILED | — |
| INVALID_ASSET_ADDRESS | — |
| DECIMALS_OVERFLOW | — |
Constants
Constants
| EXCEEDED_MAX_DEPOSIT | — |
| EXCEEDED_MAX_MINT | — |
| EXCEEDED_MAX_WITHDRAW | — |
| EXCEEDED_MAX_REDEEM | — |
| TOKEN_TRANSFER_FAILED | — |
| INVALID_ASSET_ADDRESS | — |
| DECIMALS_OVERFLOW | — |
EXCEEDED_MAX_DEPOSIT
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Errors::EXCEEDED_MAX_DEPOSIT
pub const EXCEEDED_MAX_DEPOSIT: felt252 =
7300388961142671683100395680463673630553974429045141526829168028020;
EXCEEDED_MAX_MINT
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Errors::EXCEEDED_MAX_MINT
pub const EXCEEDED_MAX_MINT: felt252 = 435137090751091938203596811322192766103385354819604400664180;
EXCEEDED_MAX_WITHDRAW
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Errors::EXCEEDED_MAX_WITHDRAW
pub const EXCEEDED_MAX_WITHDRAW: felt252 =
1868899574052523950873701294198700449421817453835557601092821373313399;
EXCEEDED_MAX_REDEEM
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Errors::EXCEEDED_MAX_REDEEM
pub const EXCEEDED_MAX_REDEEM: felt252 =
28517144379463561262110920626811225119351462613457599482137240941;
TOKEN_TRANSFER_FAILED
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Errors::TOKEN_TRANSFER_FAILED
pub const TOKEN_TRANSFER_FAILED: felt252 =
478438290957446131423689402636919274930100673285950975284941460263953764;
INVALID_ASSET_ADDRESS
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Errors::INVALID_ASSET_ADDRESS
pub const INVALID_ASSET_ADDRESS: felt252 =
122480202485106209644457384222766355008901646292153041647981631433096503344;
DECIMALS_OVERFLOW
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Errors::DECIMALS_OVERFLOW
pub const DECIMALS_OVERFLOW: felt252 =
111395095232279536180120418160864269797789349909039835656253303;
__external_ERC4626Impl
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::__external_ERC4626Impl
__l1_handler_ERC4626Impl
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::__l1_handler_ERC4626Impl
__constructor_ERC4626Impl
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::__constructor_ERC4626Impl
__external_ERC4626MetadataImpl
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::__external_ERC4626MetadataImpl
__l1_handler_ERC4626MetadataImpl
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::__l1_handler_ERC4626MetadataImpl
__constructor_ERC4626MetadataImpl
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::__constructor_ERC4626MetadataImpl
Constants
Constants
DEFAULT_UNDERLYING_DECIMALS
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::DEFAULT_UNDERLYING_DECIMALS
pub const DEFAULT_UNDERLYING_DECIMALS: u8 = 18;
DEFAULT_DECIMALS_OFFSET
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::DEFAULT_DECIMALS_OFFSET
pub const DEFAULT_DECIMALS_OFFSET: u8 = 0;
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| Deposit | Emitted when sender exchanges assets for shares and transfers those shares to owner . |
| Withdraw | Emitted when sender exchanges shares , owned by owner , for assets and transfers those assets to receiver . |
| Preview | Internal helper struct containing assets, shares, and fees calculated in preview functions. |
| ComponentState | — |
Storage
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Storage
[storage]
pub struct Storage {
pub ERC4626_asset: ContractAddress,
}
Members
ERC4626_asset
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Storage::ERC4626_asset
pub ERC4626_asset: ContractAddress
Deposit
Emitted when sender exchanges assets for shares and transfers those
shares to owner.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Deposit
[derive(Drop, PartialEq, starknet::Event)]
pub struct Deposit {
pub sender: ContractAddress,
pub owner: ContractAddress,
pub assets: u256,
pub shares: u256,
}
Members
sender
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Deposit::sender
pub sender: ContractAddress
owner
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Deposit::owner
pub owner: ContractAddress
assets
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Deposit::assets
pub assets: u256
shares
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Deposit::shares
pub shares: u256
Withdraw
Emitted when sender exchanges shares, owned by owner, for assets and transfers
those assets to receiver.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Withdraw
[derive(Drop, PartialEq, starknet::Event)]
pub struct Withdraw {
pub sender: ContractAddress,
pub receiver: ContractAddress,
pub owner: ContractAddress,
pub assets: u256,
pub shares: u256,
}
Members
sender
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Withdraw::sender
pub sender: ContractAddress
receiver
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Withdraw::receiver
pub receiver: ContractAddress
owner
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Withdraw::owner
pub owner: ContractAddress
assets
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Withdraw::assets
pub assets: u256
shares
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Withdraw::shares
pub shares: u256
Preview
Internal helper struct containing assets, shares, and fees calculated in preview functions.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Preview
[derive(Drop, Copy)]
pub struct Preview { /* private fields */ }
ComponentState
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Event
pub enum Event {
Deposit: Deposit,
Withdraw: Withdraw,
}
Variants
Deposit
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Event::Deposit
Deposit: Deposit
Withdraw
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Event::Withdraw
Withdraw: Withdraw
Fee
A fee amount represented either in underlying assets or in shares.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Fee
pub enum Fee {
Assets: u256,
Shares: u256,
}
Variants
Assets
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Fee::Assets
Assets: u256
Shares
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Fee::Shares
Shares: u256
Traits
Traits
| ImmutableConfig | Constants expected to be defined at the contract level which configure virtual assets and shares. UNDERLYING_DECIMALS should match the underlying asset’s decimals. The default value is 18 …. |
| FeeConfigTrait | The logic for calculating entry and exit fees is expected to be defined at the contract level. Defaults to no entry or exit fees…. |
| LimitConfigTrait | Sets limits to the target exchange type and is expected to be defined at the contract level. It’s important to note that these limits correspond directly to the max_<OPERATION> i.e. deposit_limit… |
| ERC4626HooksTrait | Allows contracts to hook logic into deposit and withdraw transactions. This is where contracts can transfer fees. NOTE: ERC4626 preview methods must be inclusive of any entry or exit fees…. |
| AssetsManagementTrait | Defines how the ERC4626 vault manages its underlying assets. This trait provides the core asset management functionality for the vault, abstracting the actual storage and transfer mechanisms…. |
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForERC4626Impl | — |
| UnsafeNewContractStateTraitForERC4626MetadataImpl | — |
ImmutableConfig
Constants expected to be defined at the contract level which configure virtual assets and shares.
UNDERLYING_DECIMALS should match the underlying asset’s decimals. The default
value is 18.
DECIMALS_OFFSET corresponds to the representational offset between UNDERLYING_DECIMALS
and the vault decimals. The greater the offset, the more expensive it is for attackers to
execute an inflation attack.
Requirements:
UNDERLYING_DECIMALS+DECIMALS_OFFSETcannot exceed 255 (max u8).
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::ImmutableConfig
pub trait ImmutableConfig
Trait constants
UNDERLYING_DECIMALS
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::ImmutableConfig::UNDERLYING_DECIMALS
const UNDERLYING_DECIMALS: u8;
DECIMALS_OFFSET
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::ImmutableConfig::DECIMALS_OFFSET
const DECIMALS_OFFSET: u8;
Trait functions
validate
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::ImmutableConfig::validate
fn validate()
FeeConfigTrait
The logic for calculating entry and exit fees is expected to be defined at the contract level. Defaults to no entry or exit fees.
NOTE: The FeeConfigTrait hooks directly into the preview methods of the ERC4626 component. The preview methods must return as close to the exact amount of shares or assets as possible if the actual (previewed) operation occurred in the same transaction (according to EIP-4626 spec). All operations use their corresponding preview method as the value of assets or shares being moved to or from the user. The fees calculated in FeeConfigTrait are used to adjust the final asset and share amounts used in both the preview and the actual operations.
NOTE: To transfer fees, this trait needs to be coordinated with
ERC4626Component::ERC4626Hooks.
See the ERC4626AssetsFeesMock and ERC4626SharesFeesMock examples:
https://github.com/OpenZeppelin/cairo-contracts/tree/main/packages/test_common/src/mocks/erc4626.cairo
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::FeeConfigTrait
pub trait FeeConfigTrait<TContractState, +HasComponent<TContractState>>
Trait functions
calculate_deposit_fee
Calculates the entry fee for a deposit during preview_deposit. The returned fee
affects the final asset and share amounts. Fees are not transferred automatically and
must be handled in the after_deposit hook: asset fees should be transferred from the
vault’s management to the fee recipient, while share fees should be minted to the fee
recipient.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::FeeConfigTrait::calculate_deposit_fee
fn calculate_deposit_fee(
self: @ComponentState<TContractState>, assets: u256, shares: u256,
) -> Option<Fee>
calculate_mint_fee
Calculates the entry fee for a mint during preview_mint. The returned fee affects
the final asset and share amounts. Fees are not transferred automatically and must be
handled in the after_deposit hook: asset fees should be transferred from the vault’s
management to the fee recipient, while share fees should be minted to the fee recipient.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::FeeConfigTrait::calculate_mint_fee
fn calculate_mint_fee(
self: @ComponentState<TContractState>, assets: u256, shares: u256,
) -> Option<Fee>
calculate_withdraw_fee
Calculates the exit fee for a withdraw during preview_withdraw. The returned fee
affects the final asset and share amounts. Fees are not transferred automatically and
must be handled in the before_withdraw hook: asset fees should be transferred from the
vault’s management to the fee recipient, while share fees should be transferred from the
owner to the fee recipient.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::FeeConfigTrait::calculate_withdraw_fee
fn calculate_withdraw_fee(
self: @ComponentState<TContractState>, assets: u256, shares: u256,
) -> Option<Fee>
calculate_redeem_fee
Calculates the exit fee for a redeem during preview_redeem. The returned fee affects
the final asset and share amounts. Fees are not transferred automatically and must be
handled in the before_withdraw hook: asset fees should be transferred from the vault’s
management to the fee recipient, while share fees should be transferred from the owner
to the fee recipient.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::FeeConfigTrait::calculate_redeem_fee
fn calculate_redeem_fee(
self: @ComponentState<TContractState>, assets: u256, shares: u256,
) -> Option<Fee>
LimitConfigTrait
Sets limits to the target exchange type and is expected to be defined at the contract level.
It’s important to note that these limits correspond directly to the max_<OPERATION>
i.e. deposit_limit -> max_deposit.
The EIP-4626 spec states that the max_<OPERATION> methods must take into account all
global and user-specific limits.
If an operation is disabled (even temporarily), the corresponding limit MUST be 0
and MUST NOT panic.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::LimitConfigTrait
pub trait LimitConfigTrait<TContractState, +HasComponent<TContractState>>
Trait functions
deposit_limit
The max deposit allowed.
Defaults (Option::None) to 2 ** 256 - 1.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::LimitConfigTrait::deposit_limit
fn deposit_limit(self: @ComponentState<TContractState>, receiver: ContractAddress) -> Option<u256>
mint_limit
The max mint allowed.
Defaults (Option::None) to 2 ** 256 - 1.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::LimitConfigTrait::mint_limit
fn mint_limit(self: @ComponentState<TContractState>, receiver: ContractAddress) -> Option<u256>
withdraw_limit
The max withdraw allowed.
Defaults (Option::None) to the full asset balance of owner converted from shares.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::LimitConfigTrait::withdraw_limit
fn withdraw_limit(self: @ComponentState<TContractState>, owner: ContractAddress) -> Option<u256>
redeem_limit
The max redeem allowed.
Defaults (Option::None) to the full asset balance of owner.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::LimitConfigTrait::redeem_limit
fn redeem_limit(self: @ComponentState<TContractState>, owner: ContractAddress) -> Option<u256>
ERC4626HooksTrait
Allows contracts to hook logic into deposit and withdraw transactions. This is where contracts can transfer fees.
NOTE: ERC4626 preview methods must be inclusive of any entry or exit fees.
Fees are calculated using FeeConfigTrait methods and automatically adjust the final
asset and share amounts. Fee transfers are handled in ERC4626HooksTrait methods.
NOTE: When a vault implements fees on deposits or withdrawals (either in shares or assets), fee transfers must be handled in these hooks by library clients. This creates a non-atomic operation flow consisting of multiple state-changing steps: transferring assets, minting or burning shares, and transferring (or minting) fees. Between these steps, the vault’s state is temporarily inconsistent: the asset-to-share conversion rate does not accurately reflect the vault’s final state until all steps have completed. Therefore, it is critical to avoid making any external calls (including to the vault contract itself) or querying conversion rates during hook execution.
CAUTION: Special care must be taken when calling external contracts in these hooks. In
that case, consider implementing reentrancy protections. For example, in the
withdraw flow, the withdraw_limit is checked before the before_withdraw hook
is invoked. If this hook performs a reentrant call that invokes withdraw again, the
subsequent check on withdraw_limit will be done before the first withdrawal’s core logic
(e.g., burning shares and transferring assets) is executed. This could
lead to bypassing withdrawal constraints or draining funds.
See the example: https://github.com/OpenZeppelin/cairo-contracts/tree/main/packages/test_common/src/mocks/erc4626.cairo
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::ERC4626HooksTrait
pub trait ERC4626HooksTrait<TContractState, +HasComponent<TContractState>>
Trait functions
before_deposit
Hooks into InternalImpl::_deposit.
Executes logic before transferring assets and minting shares.
The fee is calculated via FeeConfigTrait. Assets and shares
represent the actual amounts the user will spend and receive, respectively.
Asset fees are included in assets; share fees are excluded from shares.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::ERC4626HooksTrait::before_deposit
fn before_deposit(
ref self: ComponentState<TContractState>,
caller: ContractAddress,
receiver: ContractAddress,
assets: u256,
shares: u256,
fee: Option<Fee>,
)
after_deposit
Hooks into InternalImpl::_deposit.
Executes logic after transferring assets and minting shares.
The fee is calculated via FeeConfigTrait. Assets and shares
represent the actual amounts the user will spend and receive, respectively.
Asset fees are included in assets; share fees are excluded from shares.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::ERC4626HooksTrait::after_deposit
fn after_deposit(
ref self: ComponentState<TContractState>,
caller: ContractAddress,
receiver: ContractAddress,
assets: u256,
shares: u256,
fee: Option<Fee>,
)
before_withdraw
Hooks into InternalImpl::_withdraw.
Executes logic before burning shares and transferring assets.
The fee is calculated via FeeConfigTrait. Assets and shares
represent the actual amounts the user will receive and spend, respectively.
Asset fees are excluded from assets; share fees are included in shares.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::ERC4626HooksTrait::before_withdraw
fn before_withdraw(
ref self: ComponentState<TContractState>,
caller: ContractAddress,
receiver: ContractAddress,
owner: ContractAddress,
assets: u256,
shares: u256,
fee: Option<Fee>,
)
after_withdraw
Hooks into InternalImpl::_withdraw.
Executes logic after burning shares and transferring assets.
The fee is calculated via FeeConfigTrait. Assets and shares
represent the actual amounts the user will receive and spend, respectively.
Asset fees are excluded from assets; share fees are included in shares.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::ERC4626HooksTrait::after_withdraw
fn after_withdraw(
ref self: ComponentState<TContractState>,
caller: ContractAddress,
receiver: ContractAddress,
owner: ContractAddress,
assets: u256,
shares: u256,
fee: Option<Fee>,
)
AssetsManagementTrait
Defines how the ERC4626 vault manages its underlying assets. This trait provides the core asset management functionality for the vault, abstracting the actual storage and transfer mechanisms. It enables two primary implementation patterns:
1. Self-managed assets: The vault contract holds assets directly on its own address.
This is the default behavior provided by ERC4626SelfAssetsManagement implementation.
2. External vault: Assets are managed by an external contract, allowing for more complex asset management strategies. The exact implementation is expected to be defined by the contract implementing the ERC4626 component.
The trait methods are called during deposit, withdrawal, and total assets calculations, ensuring that the vault’s share pricing remains accurate regardless of the underlying asset management strategy.
CAUTION: Implementations must ensure that get_total_assets returns the actual amount
of assets that can be withdrawn by users. Inaccurate reporting can lead to incorrect
share valuations and potential economic attacks.
See the examples:
- Self-managed vault:
ERC4626SelfAssetsManagementat the end of the file. - External vault:
ERC4626ExternalAssetsManagementinERC4626ExternalVaultMock.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::AssetsManagementTrait
pub trait AssetsManagementTrait<TContractState, +HasComponent<TContractState>>
Trait functions
get_total_assets
Returns the total amount of underlying assets under the vault’s management. Used for share price calculations and determining the vault’s total value.
This method should return the actual amount of assets that the vault controls and that can be used to satisfy withdrawal requests. For self-managed vaults, this is typically the vault contract’s token balance. For external vaults, this should include any assets deposited in external protocols, minus any that are locked or unredeemable.
The accuracy of this method is critical for proper vault operation:
- Overreporting can lead to share dilution and user losses.
- Underreporting can lead to share inflation and potential economic attacks.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::AssetsManagementTrait::get_total_assets
fn get_total_assets(self: @ComponentState<TContractState>) -> u256
transfer_assets_in
Transfers assets from an external address into the vault’s management.
Called during deposit and mint operations.
This method should handle the actual transfer of underlying assets from the from
address into the vault’s control. For self-managed vaults, this typically means
transferring tokens to the vault contract’s address. For external vaults, this
might involve transferring into an external contract.
Requirements:
- MUST transfer exactly
assetsamount of the underlying token. - SHOULD revert if the transfer fails or insufficient allowance/balance.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::AssetsManagementTrait::transfer_assets_in
fn transfer_assets_in(ref self: ComponentState<TContractState>, from: ContractAddress, assets: u256)
transfer_assets_out
Transfers assets from the vault’s management to an external address. Called during withdraw and redeem operations.
This method should handle the actual transfer of underlying assets from the vault’s
control to the to address. For self-managed vaults, this typically means
transferring tokens from the vault contract’s address. For external vaults, this
might involve withdrawing from an external contract first.
Requirements:
- MUST transfer exactly
assetsamount of the underlying token. - SHOULD revert if insufficient assets are available or transfer fails.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::AssetsManagementTrait::transfer_assets_out
fn transfer_assets_out(ref self: ComponentState<TContractState>, to: ContractAddress, assets: u256)
HasComponent
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::HasComponent::emit
fn emit<
S,
impl IntoImp: Into<
S, openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::Event,
>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::InternalTrait
pub trait InternalTrait<TContractState, +HasComponent<TContractState>, impl Hooks: ERC4626HooksTrait<TContractState, +HasComponent<TContractState>>, impl Immutable: ImmutableConfig, impl ERC20: HasComponent<TContractState>, impl Assets: AssetsManagementTrait<TContractState, +HasComponent<TContractState>>, impl FeeConfig: FeeConfigTrait<TContractState, +HasComponent<TContractState>>, +LimitConfigTrait<TContractState>, impl ERC20HooksTrait<TContractState>: ERC20HooksTrait<TContractState>, +Drop<TContractState>>
Trait functions
initializer
Validates the ImmutableConfig constants and sets the asset_address to the vault.
This should be set in the contract’s constructor.
Requirements:
asset_addresscannot be the zero address.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::InternalTrait::initializer
fn initializer(ref self: ComponentState<TContractState>, asset_address: ContractAddress)
_preview_deposit
Internal preview function for deposit operations. Returns the actual assets the user will spend and shares the user will receive. Asset fees are included in assets, share fees are excluded from shares.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::InternalTrait::_preview_deposit
fn _preview_deposit(self: @ComponentState<TContractState>, assets: u256) -> Preview
_preview_mint
Internal preview function for mint operations. Returns the actual assets the user will spend and shares the user will receive. Asset fees are included in assets, share fees are excluded from shares.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::InternalTrait::_preview_mint
fn _preview_mint(self: @ComponentState<TContractState>, shares: u256) -> Preview
_preview_withdraw
Internal preview function for withdraw operations. Returns the actual assets the user will receive and shares the user will spend. Asset fees are excluded from assets, share fees are included in shares.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::InternalTrait::_preview_withdraw
fn _preview_withdraw(self: @ComponentState<TContractState>, assets: u256) -> Preview
_preview_redeem
Internal preview function for redeem operations. Returns the actual assets the user will receive and shares the user will spend. Asset fees are excluded from assets, share fees are included in shares.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::InternalTrait::_preview_redeem
fn _preview_redeem(self: @ComponentState<TContractState>, shares: u256) -> Preview
_deposit
Internal logic for deposit and mint.
Transfers assets from caller to the Vault contract then mints shares to
receiver.
Fees can be transferred in the ERC4626Hooks::after_deposit hook which is executed
after assets are transferred and shares are minted.
Requirements:
ERC20::transfer_frommust return true.
Emits two ERC20::Transfer events (ERC20::mint and ERC20::transfer_from).
Emits a Deposit event.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::InternalTrait::_deposit
fn _deposit(
ref self: ComponentState<TContractState>,
caller: ContractAddress,
receiver: ContractAddress,
assets: u256,
shares: u256,
fee: Option<Fee>,
)
_withdraw
Internal logic for withdraw and redeem.
Burns shares from owner and then transfers assets to receiver.
Fees can be transferred in the ERC4626Hooks::before_withdraw hook which is executed
before shares are burned and assets are transferred.
Requirements:
ERC20::transfermust return true.
Emits two ERC20::Transfer events (ERC20::burn and ERC20::transfer).
Emits a Withdraw event.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::InternalTrait::_withdraw
fn _withdraw(
ref self: ComponentState<TContractState>,
caller: ContractAddress,
receiver: ContractAddress,
owner: ContractAddress,
assets: u256,
shares: u256,
fee: Option<Fee>,
)
_convert_to_shares
Internal conversion function (from assets to shares) with support for rounding
direction.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::InternalTrait::_convert_to_shares
fn _convert_to_shares(
self: @ComponentState<TContractState>, assets: u256, rounding: Rounding,
) -> u256
_convert_to_assets
Internal conversion function (from shares to assets) with support for rounding
direction.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::InternalTrait::_convert_to_assets
fn _convert_to_assets(
self: @ComponentState<TContractState>, shares: u256, rounding: Rounding,
) -> u256
UnsafeNewContractStateTraitForERC4626Impl
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::UnsafeNewContractStateTraitForERC4626Impl
pub trait UnsafeNewContractStateTraitForERC4626Impl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::UnsafeNewContractStateTraitForERC4626Impl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC4626MetadataImpl
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::UnsafeNewContractStateTraitForERC4626MetadataImpl
pub trait UnsafeNewContractStateTraitForERC4626MetadataImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::ERC4626Component::UnsafeNewContractStateTraitForERC4626MetadataImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
Impls
Impls
| DefaultConfig | Implementation of the default ERC4626Component::ImmutableConfig . See… |
DefaultConfig
Implementation of the default ERC4626Component::ImmutableConfig.
See https://github.com/starknet-io/SNIPs/blob/963848f0752bde75c7087c2446d83b7da8118b25/SNIPS/snip-107.md#defaultconfig-implementation
The default UNDERLYING_DECIMALS is set to 18.
The default DECIMALS_OFFSET is set to 0.
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::DefaultConfig
pub impl DefaultConfig of ImmutableConfig;
Impl constants
UNDERLYING_DECIMALS
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::DefaultConfig::UNDERLYING_DECIMALS
const UNDERLYING_DECIMALS: u8 = ERC4626Component::DEFAULT_UNDERLYING_DECIMALS;
DECIMALS_OFFSET
Fully qualified path: openzeppelin_token::erc20::extensions::erc4626::erc4626::DefaultConfig::DECIMALS_OFFSET
const DECIMALS_OFFSET: u8 = ERC4626Component::DEFAULT_DECIMALS_OFFSET;
snip12_utils
Fully qualified path: openzeppelin_token::erc20::snip12_utils
Modules
Modules
Modules
permit
Fully qualified path: openzeppelin_token::erc20::snip12_utils::permit
Constants
Structs
Constants
Constants
PERMIT_TYPE_HASH
Fully qualified path: openzeppelin_token::erc20::snip12_utils::permit::PERMIT_TYPE_HASH
pub const PERMIT_TYPE_HASH: felt252 =
1415336368914719292163152228389901548672538424606611267979437740446022424015;
Structs
Structs
Permit
Fully qualified path: openzeppelin_token::erc20::snip12_utils::permit::Permit
[derive(Copy, Drop, Hash)]
pub struct Permit {
pub token: ContractAddress,
pub spender: ContractAddress,
pub amount: u256,
pub nonce: felt252,
pub deadline: u64,
}
Members
token
Fully qualified path: openzeppelin_token::erc20::snip12_utils::permit::Permit::token
pub token: ContractAddress
spender
Fully qualified path: openzeppelin_token::erc20::snip12_utils::permit::Permit::spender
pub spender: ContractAddress
amount
Fully qualified path: openzeppelin_token::erc20::snip12_utils::permit::Permit::amount
pub amount: u256
nonce
Fully qualified path: openzeppelin_token::erc20::snip12_utils::permit::Permit::nonce
pub nonce: felt252
deadline
Fully qualified path: openzeppelin_token::erc20::snip12_utils::permit::Permit::deadline
pub deadline: u64
erc721
Fully qualified path: openzeppelin_token::erc721
Modules
Re-exports:
| ERC721HooksEmptyImpl | An empty implementation of the ERC721 hooks to be used in basic ERC721 preset contracts. |
Modules
Modules
erc721
Fully qualified path: openzeppelin_token::erc721::erc721
Modules
Modules
Modules
ERC721Component
ERC721 Component
The ERC721 component provides implementations for both the IERC721 interface and the IERC721Metadata interface.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component
Modules
Free functions
Structs
| Storage | — |
| Transfer | Emitted when token_id token is transferred from from to to . |
| Approval | Emitted when owner enables approved to manage the token_id token. |
| ApprovalForAll | Emitted when owner enables or disables ( approved ) operator to manage all of its assets. |
| ComponentState | — |
Enums
Traits
Modules
Modules
Errors
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Errors
Constants
| INVALID_TOKEN_ID | — |
| INVALID_ACCOUNT | — |
| INVALID_OPERATOR | — |
| UNAUTHORIZED | — |
| INVALID_RECEIVER | — |
| ALREADY_MINTED | — |
| INVALID_SENDER | — |
| SAFE_MINT_FAILED | — |
| SAFE_TRANSFER_FAILED | — |
Constants
Constants
| INVALID_TOKEN_ID | — |
| INVALID_ACCOUNT | — |
| INVALID_OPERATOR | — |
| UNAUTHORIZED | — |
| INVALID_RECEIVER | — |
| ALREADY_MINTED | — |
| INVALID_SENDER | — |
| SAFE_MINT_FAILED | — |
| SAFE_TRANSFER_FAILED | — |
INVALID_TOKEN_ID
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Errors::INVALID_TOKEN_ID
pub const INVALID_TOKEN_ID: felt252 = 1699754265108099871470897430857803785044358442022594431300;
INVALID_ACCOUNT
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Errors::INVALID_ACCOUNT
pub const INVALID_ACCOUNT: felt252 = 6639665098078515122933193089288296035324163911262236276;
INVALID_OPERATOR
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Errors::INVALID_OPERATOR
pub const INVALID_OPERATOR: felt252 = 1699754265108099871470897430857803785043998428985933721458;
UNAUTHORIZED
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Errors::UNAUTHORIZED
pub const UNAUTHORIZED: felt252 = 28517144452639854893507085734425180430328771592574685650394834290;
INVALID_RECEIVER
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Errors::INVALID_RECEIVER
pub const INVALID_RECEIVER: felt252 = 1699754265108099871470897430857803785044211503288580203890;
ALREADY_MINTED
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Errors::ALREADY_MINTED
pub const ALREADY_MINTED: felt252 =
7300388979875802852732128123657212830355657500092055048969713378660;
INVALID_SENDER
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Errors::INVALID_SENDER
pub const INVALID_SENDER: felt252 = 25936191789369199698957785505032406388004815261427058;
SAFE_MINT_FAILED
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Errors::SAFE_MINT_FAILED
pub const SAFE_MINT_FAILED: felt252 = 1699754265108099871484121886731334982652068626744482751844;
SAFE_TRANSFER_FAILED
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Errors::SAFE_TRANSFER_FAILED
pub const SAFE_TRANSFER_FAILED: felt252 =
7300388979875802852726106486788936616499335593446695555330055365988;
__external_ERC721Impl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::__external_ERC721Impl
__l1_handler_ERC721Impl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::__l1_handler_ERC721Impl
__constructor_ERC721Impl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::__constructor_ERC721Impl
__external_ERC721MetadataImpl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::__external_ERC721MetadataImpl
__l1_handler_ERC721MetadataImpl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::__l1_handler_ERC721MetadataImpl
__constructor_ERC721MetadataImpl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::__constructor_ERC721MetadataImpl
__external_ERC721CamelOnlyImpl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::__external_ERC721CamelOnlyImpl
__l1_handler_ERC721CamelOnlyImpl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::__l1_handler_ERC721CamelOnlyImpl
__constructor_ERC721CamelOnlyImpl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::__constructor_ERC721CamelOnlyImpl
__external_ERC721MetadataCamelOnlyImpl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::__external_ERC721MetadataCamelOnlyImpl
__l1_handler_ERC721MetadataCamelOnlyImpl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::__l1_handler_ERC721MetadataCamelOnlyImpl
__constructor_ERC721MetadataCamelOnlyImpl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::__constructor_ERC721MetadataCamelOnlyImpl
__external_ERC721MixinImpl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::__external_ERC721MixinImpl
__l1_handler_ERC721MixinImpl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::__l1_handler_ERC721MixinImpl
__constructor_ERC721MixinImpl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::__constructor_ERC721MixinImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| Transfer | Emitted when token_id token is transferred from from to to . |
| Approval | Emitted when owner enables approved to manage the token_id token. |
| ApprovalForAll | Emitted when owner enables or disables ( approved ) operator to manage all of its assets. |
| ComponentState | — |
Storage
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Storage
[storage]
pub struct Storage {
pub ERC721_name: ByteArray,
pub ERC721_symbol: ByteArray,
pub ERC721_owners: Map<u256, ContractAddress>,
pub ERC721_balances: Map<ContractAddress, u256>,
pub ERC721_token_approvals: Map<u256, ContractAddress>,
pub ERC721_operator_approvals: Map<(ContractAddress, ContractAddress), bool>,
pub ERC721_base_uri: ByteArray,
}
Members
ERC721_name
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Storage::ERC721_name
pub ERC721_name: ByteArray
ERC721_symbol
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Storage::ERC721_symbol
pub ERC721_symbol: ByteArray
ERC721_owners
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Storage::ERC721_owners
pub ERC721_owners: Map<u256, ContractAddress>
ERC721_balances
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Storage::ERC721_balances
pub ERC721_balances: Map<ContractAddress, u256>
ERC721_token_approvals
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Storage::ERC721_token_approvals
pub ERC721_token_approvals: Map<u256, ContractAddress>
ERC721_operator_approvals
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Storage::ERC721_operator_approvals
pub ERC721_operator_approvals: Map<(ContractAddress, ContractAddress), bool>
ERC721_base_uri
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Storage::ERC721_base_uri
pub ERC721_base_uri: ByteArray
Transfer
Emitted when token_id token is transferred from from to to.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Transfer
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct Transfer {
pub from: ContractAddress,
pub to: ContractAddress,
pub token_id: u256,
}
Members
from
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Transfer::from
pub from: ContractAddress
to
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Transfer::to
pub to: ContractAddress
token_id
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Transfer::token_id
pub token_id: u256
Approval
Emitted when owner enables approved to manage the token_id token.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Approval
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct Approval {
pub owner: ContractAddress,
pub approved: ContractAddress,
pub token_id: u256,
}
Members
owner
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Approval::owner
pub owner: ContractAddress
approved
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Approval::approved
pub approved: ContractAddress
token_id
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Approval::token_id
pub token_id: u256
ApprovalForAll
Emitted when owner enables or disables (approved) operator to manage
all of its assets.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::ApprovalForAll
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct ApprovalForAll {
pub owner: ContractAddress,
pub operator: ContractAddress,
pub approved: bool,
}
Members
owner
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::ApprovalForAll::owner
pub owner: ContractAddress
operator
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::ApprovalForAll::operator
pub operator: ContractAddress
approved
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::ApprovalForAll::approved
pub approved: bool
ComponentState
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Event
pub enum Event {
Transfer: Transfer,
Approval: Approval,
ApprovalForAll: ApprovalForAll,
}
Variants
Transfer
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Event::Transfer
Transfer: Transfer
Approval
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Event::Approval
Approval: Approval
ApprovalForAll
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::Event::ApprovalForAll
ApprovalForAll: ApprovalForAll
Traits
Traits
ERC721HooksTrait
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::ERC721HooksTrait
pub trait ERC721HooksTrait<TContractState>
Trait functions
before_update
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::ERC721HooksTrait::before_update
fn before_update(
ref self: ComponentState<TContractState>,
to: ContractAddress,
token_id: u256,
auth: ContractAddress,
)
after_update
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::ERC721HooksTrait::after_update
fn after_update(
ref self: ComponentState<TContractState>,
to: ContractAddress,
token_id: u256,
auth: ContractAddress,
)
HasComponent
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::HasComponent::emit
fn emit<S, impl IntoImp: Into<S, openzeppelin_token::erc721::erc721::ERC721Component::Event>>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait
pub trait InternalTrait<
TContractState,
+HasComponent<TContractState>,
impl SRC5: HasComponent<TContractState>,
impl Hooks: ERC721HooksTrait<TContractState>,
+Drop<TContractState>,
>
Trait functions
initializer
Initializes the contract by setting the token name, symbol, and base URI. This should only be used inside the contract’s constructor.
WARNING: Most ERC721 contracts expose the IERC721Metadata interface which
is what this initializer is meant to support.
If the contract DOES NOT expose the IERC721Metadata interface,
meaning the token does not have a name, symbol, or URI,
the contract must instead instead use initializer_no_metadata in the constructor.
Failure to abide by these instructions can lead to unexpected issues especially with
UIs.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::initializer
fn initializer(
ref self: ComponentState<TContractState>,
name: ByteArray,
symbol: ByteArray,
base_uri: ByteArray,
)
initializer_no_metadata
Initializes the contract with no metadata by registering only the IERC721 interface.
WARNING: This initializer should ONLY be used during construction in the very specific instance when the contract does NOT expose the IERC721Metadata interface. Initializing a contract with this initializer means that tokens will not have a name, symbol, or URI.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::initializer_no_metadata
fn initializer_no_metadata(ref self: ComponentState<TContractState>)
exists
Returns whether token_id exists.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::exists
fn exists(self: @ComponentState<TContractState>, token_id: u256) -> bool
transfer
Transfers token_id from from to to.
Internal function without access restriction.
WARNING: This method may lead to the loss of tokens if to is not aware of the ERC721
protocol.
Requirements:
tois not the zero address.fromis the token owner.token_idexists.
Emits a Transfer event.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::transfer
fn transfer(
ref self: ComponentState<TContractState>,
from: ContractAddress,
to: ContractAddress,
token_id: u256,
)
mint
Mints token_id and transfers it to to.
Internal function without access restriction.
WARNING: This method may lead to the loss of tokens if to is not aware of the ERC721
protocol.
Requirements:
tois not the zero address.token_iddoes not exist.
Emits a Transfer event.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::mint
fn mint(ref self: ComponentState<TContractState>, to: ContractAddress, token_id: u256)
safe_transfer
Transfers ownership of token_id from from if to is either an account or
IERC721Receiver.
data is additional data, it has no specified format and it is sent in call to to.
WARNING: This method makes an external call to the recipient contract, which can lead to reentrancy vulnerabilities.
Requirements:
tocannot be the zero address.frommust be the token owner.token_idexists.tois either an account contract or supports theIERC721Receiverinterface.
Emits a Transfer event.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::safe_transfer
fn safe_transfer(
ref self: ComponentState<TContractState>,
from: ContractAddress,
to: ContractAddress,
token_id: u256,
data: Span<felt252>,
)
safe_mint
Mints token_id if to is either an account or IERC721Receiver.
data is additional data, it has no specified format and it is sent in call to to.
WARNING: This method makes an external call to the recipient contract, which can lead to reentrancy vulnerabilities.
Requirements:
token_iddoes not exist.tois either an account contract or supports theIERC721Receiverinterface.
Emits a Transfer event.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::safe_mint
fn safe_mint(
ref self: ComponentState<TContractState>,
to: ContractAddress,
token_id: u256,
data: Span<felt252>,
)
burn
Destroys token_id. The approval is cleared when the token is burned.
This internal function does not check if the caller is authorized to operate on the token.
Requirements:
token_idexists.
Emits a Transfer event.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::burn
fn burn(ref self: ComponentState<TContractState>, token_id: u256)
update
Transfers token_id from its current owner to to, or alternatively mints (or burns)
if the current owner (or to) is the zero address. Returns the owner of the token_id
before the update.
The auth argument is optional. If the value passed is non-zero, then this function
will check that auth is either the owner of the token, or approved to operate on the
token (by the owner).
Emits a Transfer event.
NOTE: This function can be extended using the ERC721HooksTrait, to add
functionality before and/or after the transfer, mint, or burn.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::update
fn update(
ref self: ComponentState<TContractState>,
to: ContractAddress,
token_id: u256,
auth: ContractAddress,
) -> ContractAddress
_owner_of
Returns the owner address of token_id.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::_owner_of
fn _owner_of(self: @ComponentState<TContractState>, token_id: u256) -> ContractAddress
_require_owned
Returns the owner address of token_id.
Requirements:
token_idexists.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::_require_owned
fn _require_owned(self: @ComponentState<TContractState>, token_id: u256) -> ContractAddress
_approve
Approve to to operate on token_id
The auth argument is optional. If the value passed is non-zero, then this function
will check that auth is either the owner of the token, or approved to operate on all
tokens held by this owner.
Emits an Approval event.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::_approve
fn _approve(
ref self: ComponentState<TContractState>,
to: ContractAddress,
token_id: u256,
auth: ContractAddress,
)
_approve_with_optional_event
Variant of _approve with an optional flag to enable or disable the Approval event.
The event is not emitted in the context of transfers.
WARNING: If auth is zero and emit_event is false, this function will not check that
the token exists.
Requirements:
- If
authis non-zero, it must be either the owner of the token or approved to operate on all of its tokens.
May emit an Approval event.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::_approve_with_optional_event
fn _approve_with_optional_event(
ref self: ComponentState<TContractState>,
to: ContractAddress,
token_id: u256,
auth: ContractAddress,
emit_event: bool,
)
_set_approval_for_all
Enables or disables approval for operator to manage
all of the owner assets.
Requirements:
operatoris not the zero address.
Emits an Approval event.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::_set_approval_for_all
fn _set_approval_for_all(
ref self: ComponentState<TContractState>,
owner: ContractAddress,
operator: ContractAddress,
approved: bool,
)
_set_base_uri
Sets the base URI.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::_set_base_uri
fn _set_base_uri(ref self: ComponentState<TContractState>, base_uri: ByteArray)
_base_uri
Base URI for computing token_uri.
If set, the resulting URI for each token will be the concatenation of the base URI and
the token ID.
Returns an empty ByteArray if not set.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::_base_uri
fn _base_uri(self: @ComponentState<TContractState>) -> ByteArray
_is_authorized
Returns whether spender is allowed to manage owner’s tokens, or token_id in
particular (ignoring whether it is owned by owner).
WARNING: This function assumes that owner is the actual owner of token_id and does
not verify this assumption.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::_is_authorized
fn _is_authorized(
self: @ComponentState<TContractState>,
owner: ContractAddress,
spender: ContractAddress,
token_id: u256,
) -> bool
_check_authorized
Checks if spender can operate on token_id, assuming the provided owner is the
actual owner.
Requirements:
ownercannot be the zero address.spendercannot be the zero address.spendermust be the owner oftoken_idor be approved to operate on it.
WARNING: This function assumes that owner is the actual owner of token_id and does
not verify this assumption.
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::InternalTrait::_check_authorized
fn _check_authorized(
self: @ComponentState<TContractState>,
owner: ContractAddress,
spender: ContractAddress,
token_id: u256,
)
UnsafeNewContractStateTraitForERC721Impl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::UnsafeNewContractStateTraitForERC721Impl
pub trait UnsafeNewContractStateTraitForERC721Impl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::UnsafeNewContractStateTraitForERC721Impl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC721MetadataImpl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::UnsafeNewContractStateTraitForERC721MetadataImpl
pub trait UnsafeNewContractStateTraitForERC721MetadataImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::UnsafeNewContractStateTraitForERC721MetadataImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC721CamelOnlyImpl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::UnsafeNewContractStateTraitForERC721CamelOnlyImpl
pub trait UnsafeNewContractStateTraitForERC721CamelOnlyImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::UnsafeNewContractStateTraitForERC721CamelOnlyImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC721MetadataCamelOnlyImpl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::UnsafeNewContractStateTraitForERC721MetadataCamelOnlyImpl
pub trait UnsafeNewContractStateTraitForERC721MetadataCamelOnlyImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::UnsafeNewContractStateTraitForERC721MetadataCamelOnlyImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC721MixinImpl
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::UnsafeNewContractStateTraitForERC721MixinImpl
pub trait UnsafeNewContractStateTraitForERC721MixinImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc721::erc721::ERC721Component::UnsafeNewContractStateTraitForERC721MixinImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
erc721_receiver
Fully qualified path: openzeppelin_token::erc721::erc721_receiver
Modules
Modules
Modules
ERC721ReceiverComponent
ERC721Receiver Component
The ERC721Receiver component provides implementations for the IERC721Receiver interface. Integrating this component allows contracts to support ERC721 safe transfers.
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent
Modules
Free functions
Structs
Enums
Traits
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForERC721ReceiverImpl | — |
| UnsafeNewContractStateTraitForERC721ReceiverCamelImpl | — |
| UnsafeNewContractStateTraitForERC721ReceiverMixinImpl | — |
Modules
Modules
__external_ERC721ReceiverImpl
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::__external_ERC721ReceiverImpl
__l1_handler_ERC721ReceiverImpl
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::__l1_handler_ERC721ReceiverImpl
__constructor_ERC721ReceiverImpl
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::__constructor_ERC721ReceiverImpl
__external_ERC721ReceiverCamelImpl
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::__external_ERC721ReceiverCamelImpl
__l1_handler_ERC721ReceiverCamelImpl
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::__l1_handler_ERC721ReceiverCamelImpl
__constructor_ERC721ReceiverCamelImpl
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::__constructor_ERC721ReceiverCamelImpl
__external_ERC721ReceiverMixinImpl
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::__external_ERC721ReceiverMixinImpl
__l1_handler_ERC721ReceiverMixinImpl
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::__l1_handler_ERC721ReceiverMixinImpl
__constructor_ERC721ReceiverMixinImpl
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::__constructor_ERC721ReceiverMixinImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
Storage
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::Storage
[storage]
pub struct Storage {}
ComponentState
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::Event
pub enum Event {}
Traits
Traits
| HasComponent | — |
| InternalTrait | — |
| UnsafeNewContractStateTraitForERC721ReceiverImpl | — |
| UnsafeNewContractStateTraitForERC721ReceiverCamelImpl | — |
| UnsafeNewContractStateTraitForERC721ReceiverMixinImpl | — |
HasComponent
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::HasComponent::emit
fn emit<
S,
impl IntoImp: Into<
S, openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::Event,
>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::InternalTrait
pub trait InternalTrait<
TContractState,
+HasComponent<TContractState>,
impl SRC5: HasComponent<TContractState>,
+Drop<TContractState>,
>
Trait functions
initializer
Initializes the contract by registering the IERC721Receiver interface ID. This should be used inside the contract’s constructor.
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::InternalTrait::initializer
fn initializer(ref self: ComponentState<TContractState>)
UnsafeNewContractStateTraitForERC721ReceiverImpl
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::UnsafeNewContractStateTraitForERC721ReceiverImpl
pub trait UnsafeNewContractStateTraitForERC721ReceiverImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::UnsafeNewContractStateTraitForERC721ReceiverImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC721ReceiverCamelImpl
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::UnsafeNewContractStateTraitForERC721ReceiverCamelImpl
pub trait UnsafeNewContractStateTraitForERC721ReceiverCamelImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::UnsafeNewContractStateTraitForERC721ReceiverCamelImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
UnsafeNewContractStateTraitForERC721ReceiverMixinImpl
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::UnsafeNewContractStateTraitForERC721ReceiverMixinImpl
pub trait UnsafeNewContractStateTraitForERC721ReceiverMixinImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc721::erc721_receiver::ERC721ReceiverComponent::UnsafeNewContractStateTraitForERC721ReceiverMixinImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
extensions
Fully qualified path: openzeppelin_token::erc721::extensions
Modules
Re-exports:
Modules
Modules
erc721_enumerable
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable
Modules
Re-exports:
Modules
Modules
erc721_enumerable
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable
Modules
Modules
Modules
ERC721EnumerableComponent
ERC721Enumerable Component
Extension of ERC721 as defined in the EIP that adds enumerability of all the token ids in the contract as well as all token ids owned by each account. It allows contracts to publish their entire list of NFTs and make them discoverable.
NOTE: Implementing ERC721Component is a requirement for this component to be implemented.
WARNING: To properly track token ids, this extension requires that the ERC721EnumerableComponent::before_update function is called after every transfer, mint, or burn operation. For this, the ERC721HooksTrait::before_update hook must be used.
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent
Modules
| Errors | — |
| __external_ERC721EnumerableImpl | — |
| __l1_handler_ERC721EnumerableImpl | — |
| __constructor_ERC721EnumerableImpl | — |
Free functions
Structs
Enums
Traits
Modules
Modules
| Errors | — |
| __external_ERC721EnumerableImpl | — |
| __l1_handler_ERC721EnumerableImpl | — |
| __constructor_ERC721EnumerableImpl | — |
Errors
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::Errors
Constants
Constants
Constants
OUT_OF_BOUNDS_INDEX
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::Errors::OUT_OF_BOUNDS_INDEX
pub const OUT_OF_BOUNDS_INDEX: felt252 =
122480202799396068594471588599384390921845137422556154739854694742137005432;
__external_ERC721EnumerableImpl
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::__external_ERC721EnumerableImpl
__l1_handler_ERC721EnumerableImpl
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::__l1_handler_ERC721EnumerableImpl
__constructor_ERC721EnumerableImpl
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::__constructor_ERC721EnumerableImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
Storage
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::Storage
[storage]
pub struct Storage {
pub ERC721Enumerable_owned_tokens: Map<(ContractAddress, u256), u256>,
pub ERC721Enumerable_owned_tokens_index: Map<u256, u256>,
pub ERC721Enumerable_all_tokens_len: u256,
pub ERC721Enumerable_all_tokens: Map<u256, u256>,
pub ERC721Enumerable_all_tokens_index: Map<u256, u256>,
}
Members
ERC721Enumerable_owned_tokens
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::Storage::ERC721Enumerable_owned_tokens
pub ERC721Enumerable_owned_tokens: Map<(ContractAddress, u256), u256>
ERC721Enumerable_owned_tokens_index
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::Storage::ERC721Enumerable_owned_tokens_index
pub ERC721Enumerable_owned_tokens_index: Map<u256, u256>
ERC721Enumerable_all_tokens_len
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::Storage::ERC721Enumerable_all_tokens_len
pub ERC721Enumerable_all_tokens_len: u256
ERC721Enumerable_all_tokens
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::Storage::ERC721Enumerable_all_tokens
pub ERC721Enumerable_all_tokens: Map<u256, u256>
ERC721Enumerable_all_tokens_index
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::Storage::ERC721Enumerable_all_tokens_index
pub ERC721Enumerable_all_tokens_index: Map<u256, u256>
ComponentState
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::Event
pub enum Event {}
Traits
Traits
HasComponent
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::HasComponent::emit
fn emit<
S,
impl IntoImp: Into<
S,
openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::Event,
>,
>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::InternalTrait
pub trait InternalTrait<TContractState, +HasComponent<TContractState>, impl ERC721: HasComponent<TContractState>, impl ERC721HooksTrait<TContractState>: ERC721HooksTrait<TContractState>, impl SRC5: HasComponent<TContractState>, +Drop<TContractState>>
Trait functions
initializer
Initializes the contract by declaring support for the IERC721Enumerable
interface id.
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::InternalTrait::initializer
fn initializer(ref self: ComponentState<TContractState>)
before_update
Updates the ownership and token-tracking data structures.
When a token is minted (or burned), token_id is added to (or removed from)
the token-tracking structures.
When a token is transferred, minted, or burned, the ownership-tracking data structures
reflect the change in ownership of token_id.
This must be added to the implementing contract’s ERC721HooksTrait::before_update
hook.
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::InternalTrait::before_update
fn before_update(ref self: ComponentState<TContractState>, to: ContractAddress, token_id: u256)
all_tokens_of_owner
Returns a list of all token ids owned by the specified owner.
This function provides a more efficient alternative to calling ERC721::balance_of
and iterating through tokens with ERC721Enumerable::token_of_owner_by_index.
Requirements:
owneris not the zero address.
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::InternalTrait::all_tokens_of_owner
fn all_tokens_of_owner(self: @ComponentState<TContractState>, owner: ContractAddress) -> Span<u256>
_add_token_to_owner_enumeration
Adds token to this extension’s ownership-tracking data structures.
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::InternalTrait::_add_token_to_owner_enumeration
fn _add_token_to_owner_enumeration(
ref self: ComponentState<TContractState>, to: ContractAddress, token_id: u256,
)
_add_token_to_all_tokens_enumeration
Adds token to this extension’s token-tracking data structures.
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::InternalTrait::_add_token_to_all_tokens_enumeration
fn _add_token_to_all_tokens_enumeration(ref self: ComponentState<TContractState>, token_id: u256)
_remove_token_from_owner_enumeration
Removes a token from this extension’s ownership-tracking data structures.
This has O(1) time complexity but alters the indexed order of owned-tokens by
swapping token_id and the index thereof with the last token id and the index
thereof.
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::InternalTrait::_remove_token_from_owner_enumeration
fn _remove_token_from_owner_enumeration(
ref self: ComponentState<TContractState>, from: ContractAddress, token_id: u256,
)
_remove_token_from_all_tokens_enumeration
Removes token_id from this extension’s token-tracking data structures.
This has O(1) time complexity but alters the indexed order by swapping
token_id and the index thereof with the last token id and the index thereof.
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::InternalTrait::_remove_token_from_all_tokens_enumeration
fn _remove_token_from_all_tokens_enumeration(
ref self: ComponentState<TContractState>, token_id: u256,
)
UnsafeNewContractStateTraitForERC721EnumerableImpl
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::UnsafeNewContractStateTraitForERC721EnumerableImpl
pub trait UnsafeNewContractStateTraitForERC721EnumerableImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_token::erc721::extensions::erc721_enumerable::erc721_enumerable::ERC721EnumerableComponent::UnsafeNewContractStateTraitForERC721EnumerableImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
openzeppelin_upgrades
Fully qualified path: openzeppelin_upgrades
Modules
Re-exports:
Modules
Modules
upgradeable
Fully qualified path: openzeppelin_upgrades::upgradeable
Modules
Modules
Modules
UpgradeableComponent
Upgradeable Component
The Upgradeable component provides a mechanism to make a contract upgradeable.
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent
Modules
Free functions
Structs
| Storage | — |
| Upgraded | Emitted when the contract is upgraded. |
| ComponentState | — |
Enums
Traits
Modules
Modules
Errors
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::Errors
Constants
Constants
Constants
INVALID_CLASS
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::Errors::INVALID_CLASS
pub const INVALID_CLASS: felt252 = 423223302514606273361610285513559705916828015570713607238255;
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
| Storage | — |
| Upgraded | Emitted when the contract is upgraded. |
| ComponentState | — |
Storage
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::Storage
[storage]
pub struct Storage {}
Upgraded
Emitted when the contract is upgraded.
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::Upgraded
[derive(Drop, Debug, PartialEq, starknet::Event)]
pub struct Upgraded {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::Upgraded::class_hash
pub class_hash: ClassHash
ComponentState
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::Event
pub enum Event {
Upgraded: Upgraded,
}
Variants
Upgraded
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::Event::Upgraded
Upgraded: Upgraded
Traits
Traits
HasComponent
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::HasComponent::emit
fn emit<S, impl IntoImp: Into<S, openzeppelin_upgrades::upgradeable::UpgradeableComponent::Event>>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::InternalTrait
pub trait InternalTrait<TContractState, +HasComponent<TContractState>>
Trait functions
upgrade
Replaces the contract’s class hash with new_class_hash.
Requirements:
new_class_hashis not zero.
Emits an Upgraded event.
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::InternalTrait::upgrade
fn upgrade(ref self: ComponentState<TContractState>, new_class_hash: ClassHash)
upgrade_and_call
Replaces the contract’s class hash with new_class_hash and then calls selector
from the upgraded context.
This function returns the unwrapped response data from a call made to the contract
itself, using the specified selector as the entrypoint.
Requirements:
new_class_hashis not zero.
Emits an Upgraded event.
Fully qualified path: openzeppelin_upgrades::upgradeable::UpgradeableComponent::InternalTrait::upgrade_and_call
fn upgrade_and_call(
ref self: ComponentState<TContractState>,
new_class_hash: ClassHash,
selector: felt252,
calldata: Span<felt252>,
) -> Span<felt252>
openzeppelin_utils
Fully qualified path: openzeppelin_utils
Modules
Re-exports:
Modules
Modules
bytearray
Fully qualified path: openzeppelin_utils::bytearray
Free functions
| read_n_bytes | Reads n bytes from a byte array starting from a given index. Requirements:… |
| to_byte_array | Converts a value to a byte array with a given base and padding. Requirements:… |
| hash_byte_array | Returns a unique hash given a ByteArray. The hash is computed by serializing the data into a span of felts, and then hashing the span using the Pedersen hash algorithm. |
Traits
Impls
| ByteArrayExtImpl | ByteArray extension trait. |
Free functions
Free functions
| read_n_bytes | Reads n bytes from a byte array starting from a given index. Requirements:… |
| to_byte_array | Converts a value to a byte array with a given base and padding. Requirements:… |
| hash_byte_array | Returns a unique hash given a ByteArray. The hash is computed by serializing the data into a span of felts, and then hashing the span using the Pedersen hash algorithm. |
read_n_bytes
Reads n bytes from a byte array starting from a given index.
Requirements:
start + nmust be less than or equal to the length of the byte array.
Fully qualified path: openzeppelin_utils::bytearray::read_n_bytes
pub fn read_n_bytes(data: @ByteArray, start: u32, n: u32) -> ByteArray
to_byte_array
Converts a value to a byte array with a given base and padding.
Requirements:
basecannot be zero.
Fully qualified path: openzeppelin_utils::bytearray::to_byte_array
pub fn to_byte_array<T, +Into<T, felt252>, +Copy<T>>(value: @T, base: u8, padding: u16) -> ByteArray
hash_byte_array
Returns a unique hash given a ByteArray.
The hash is computed by serializing the data into a span of felts, and then hashing the span using the Pedersen hash algorithm.
Fully qualified path: openzeppelin_utils::bytearray::hash_byte_array
pub fn hash_byte_array(data: @ByteArray) -> felt252
Traits
Traits
ByteArrayExtTrait
Fully qualified path: openzeppelin_utils::bytearray::ByteArrayExtTrait
pub trait ByteArrayExtTrait
Trait functions
read_n_bytes
Requirements:
start + nmust be less than or equal to the length of the byte array.
Fully qualified path: openzeppelin_utils::bytearray::ByteArrayExtTrait::read_n_bytes
fn read_n_bytes(self: @ByteArray, start: u32, n: u32) -> ByteArray
to_byte_array
Converts a value to a byte array with a given base and padding.
Requirements:
basecannot be zero.
Fully qualified path: openzeppelin_utils::bytearray::ByteArrayExtTrait::to_byte_array
fn to_byte_array<T, +Into<T, felt252>, +Copy<T>>(self: @T, base: u8, padding: u16) -> ByteArray
hash
Hashes a byte array using the Pedersen hash algorithm. Encodes the byte array as a ´Span´ by serializing ´data´.
Fully qualified path: openzeppelin_utils::bytearray::ByteArrayExtTrait::hash
fn hash(self: @ByteArray) -> felt252
Impls
Impls
| ByteArrayExtImpl | ByteArray extension trait. |
ByteArrayExtImpl
ByteArray extension trait.
Fully qualified path: openzeppelin_utils::bytearray::ByteArrayExtImpl
pub impl ByteArrayExtImpl of ByteArrayExtTrait;
Impl functions
read_n_bytes
Requirements:
start + nmust be less than or equal to the length of the byte array.
Fully qualified path: openzeppelin_utils::bytearray::ByteArrayExtImpl::read_n_bytes
fn read_n_bytes(self: @ByteArray, start: u32, n: u32) -> ByteArray
to_byte_array
Converts a value to a byte array with a given base and padding.
Requirements:
basecannot be zero.
Fully qualified path: openzeppelin_utils::bytearray::ByteArrayExtImpl::to_byte_array
fn to_byte_array(self: @T, base: u8, padding: u16) -> ByteArray
hash
Hashes a byte array using the Pedersen hash algorithm. Encodes the byte array as a ´Span´ by serializing ´data´.
Fully qualified path: openzeppelin_utils::bytearray::ByteArrayExtImpl::hash
fn hash(self: @ByteArray) -> felt252
contract_clock
Fully qualified path: openzeppelin_utils::contract_clock
Modules
Re-exports:
Modules
Modules
block_number
Fully qualified path: openzeppelin_utils::contract_clock::block_number
Impls
Impls
Impls
ERC6372BlockNumberClock
Fully qualified path: openzeppelin_utils::contract_clock::block_number::ERC6372BlockNumberClock
pub impl ERC6372BlockNumberClock of ERC6372Clock;
Impl functions
clock
See ERC6372Clock::clock.
Fully qualified path: openzeppelin_utils::contract_clock::block_number::ERC6372BlockNumberClock::clock
fn clock() -> u64
CLOCK_MODE
See ERC6372Clock::CLOCK_MODE.
Fully qualified path: openzeppelin_utils::contract_clock::block_number::ERC6372BlockNumberClock::CLOCK_MODE
fn CLOCK_MODE() -> ByteArray
erc_6372
Fully qualified path: openzeppelin_utils::contract_clock::erc_6372
Traits
Traits
Traits
ERC6372Clock
Fully qualified path: openzeppelin_utils::contract_clock::erc_6372::ERC6372Clock
pub trait ERC6372Clock
Trait functions
clock
Returns the current timepoint determined by the contract’s operational mode, intended for use in time-sensitive logic. See https://eips.ethereum.org/EIPS/eip-6372#clock.
Requirements:
- This function MUST always be non-decreasing.
NOTE: While this function returns a u64 value, timepoints must fit into u48 according to the EIP-6372 specification.
Fully qualified path: openzeppelin_utils::contract_clock::erc_6372::ERC6372Clock::clock
fn clock() -> u64
CLOCK_MODE
Returns a description of the clock the contract is operating in. See https://eips.ethereum.org/EIPS/eip-6372#clock_mode.
Requirements:
- The output MUST be formatted like a URL query string, decodable in standard JavaScript.
Fully qualified path: openzeppelin_utils::contract_clock::erc_6372::ERC6372Clock::CLOCK_MODE
fn CLOCK_MODE() -> ByteArray
timestamp
Fully qualified path: openzeppelin_utils::contract_clock::timestamp
Impls
Impls
Impls
ERC6372TimestampClock
Fully qualified path: openzeppelin_utils::contract_clock::timestamp::ERC6372TimestampClock
pub impl ERC6372TimestampClock of ERC6372Clock;
Impl functions
clock
See ERC6372Clock::clock.
Fully qualified path: openzeppelin_utils::contract_clock::timestamp::ERC6372TimestampClock::clock
fn clock() -> u64
CLOCK_MODE
See ERC6372Clock::CLOCK_MODE.
Fully qualified path: openzeppelin_utils::contract_clock::timestamp::ERC6372TimestampClock::CLOCK_MODE
fn CLOCK_MODE() -> ByteArray
cryptography
Fully qualified path: openzeppelin_utils::cryptography
Modules
Modules
Modules
nonces
Fully qualified path: openzeppelin_utils::cryptography::nonces
Modules
Modules
Modules
NoncesComponent
Nonces Component
The Nonces component provides a simple mechanism for handling incremental nonces for a set of addresses. It is commonly used to prevent replay attacks when contracts accept signatures as input.
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent
Modules
Free functions
Structs
Enums
Traits
Modules
Modules
Errors
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::Errors
Constants
Constants
Constants
INVALID_NONCE
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::Errors::INVALID_NONCE
pub const INVALID_NONCE: felt252 = 114633287427981701509025378867516584301826866570085;
__external_NoncesImpl
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::__external_NoncesImpl
__l1_handler_NoncesImpl
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::__l1_handler_NoncesImpl
__constructor_NoncesImpl
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::__constructor_NoncesImpl
Free functions
Free functions
unsafe_new_component_state
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::unsafe_new_component_state
pub fn unsafe_new_component_state<TContractState>() -> ComponentState<TContractState>
Structs
Structs
Storage
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::Storage
[storage]
pub struct Storage {
pub Nonces_nonces: Map<ContractAddress, felt252>,
}
Members
Nonces_nonces
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::Storage::Nonces_nonces
pub Nonces_nonces: Map<ContractAddress, felt252>
ComponentState
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::ComponentState
pub struct ComponentState<TContractState> {}
Enums
Enums
Event
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::Event
pub enum Event {}
Traits
Traits
HasComponent
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::HasComponent
pub trait HasComponent<TContractState>
Trait functions
get_component
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::HasComponent::get_component
fn get_component(self: @TContractState) -> @ComponentState<TContractState>
get_component_mut
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::HasComponent::get_component_mut
fn get_component_mut(ref self: TContractState) -> ComponentState<TContractState>
get_contract
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::HasComponent::get_contract
fn get_contract(self: @ComponentState<TContractState>) -> @TContractState
get_contract_mut
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::HasComponent::get_contract_mut
fn get_contract_mut(ref self: ComponentState<TContractState>) -> TContractState
emit
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::HasComponent::emit
fn emit<S, impl IntoImp: Into<S, openzeppelin_utils::cryptography::nonces::NoncesComponent::Event>>(
ref self: ComponentState<TContractState>, event: S,
)
InternalTrait
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::InternalTrait
pub trait InternalTrait<TContractState, +HasComponent<TContractState>>
Trait functions
use_nonce
Consumes a nonce, returns the current value, and increments nonce.
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::InternalTrait::use_nonce
fn use_nonce(ref self: ComponentState<TContractState>, owner: ContractAddress) -> felt252
use_checked_nonce
Same as use_nonce but checking that nonce is the next valid one for owner.
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::InternalTrait::use_checked_nonce
fn use_checked_nonce(
ref self: ComponentState<TContractState>, owner: ContractAddress, nonce: felt252,
) -> felt252
UnsafeNewContractStateTraitForNoncesImpl
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::UnsafeNewContractStateTraitForNoncesImpl
pub trait UnsafeNewContractStateTraitForNoncesImpl<TContractState>
Trait functions
unsafe_new_contract_state
Fully qualified path: openzeppelin_utils::cryptography::nonces::NoncesComponent::UnsafeNewContractStateTraitForNoncesImpl::unsafe_new_contract_state
fn unsafe_new_contract_state() -> TContractState
snip12
Fully qualified path: openzeppelin_utils::cryptography::snip12
Constants
Structs
| StarknetDomain | Generic Starknet domain separator representation as defined in SNIP-12. |
Traits
| StructHash | Trait for calculating the hash of a struct. |
| OffchainMessageHash | Trait for calculating the hash of a message given the passed signer . |
| SNIP12Metadata | — |
Impls
| StructHashStarknetDomainImpl | Implementation of StructHash that calculates the Poseidon hash of type StarknetDomain . |
| SNIP12HashSpanImpl | Hash trait implementation for a span of elements according to SNIP-12. |
Constants
Constants
STARKNET_DOMAIN_TYPE_HASH
Fully qualified path: openzeppelin_utils::cryptography::snip12::STARKNET_DOMAIN_TYPE_HASH
pub const STARKNET_DOMAIN_TYPE_HASH: felt252 =
903185825206485993942627316682662375025985481915563849197465435174148809232;
Structs
Structs
| StarknetDomain | Generic Starknet domain separator representation as defined in SNIP-12. |
StarknetDomain
Generic Starknet domain separator representation as defined in SNIP-12.
Fully qualified path: openzeppelin_utils::cryptography::snip12::StarknetDomain
[derive(Drop, Copy, Hash)]
pub struct StarknetDomain {
pub name: felt252,
pub version: felt252,
pub chain_id: felt252,
pub revision: felt252,
}
Members
name
Fully qualified path: openzeppelin_utils::cryptography::snip12::StarknetDomain::name
pub name: felt252
version
Fully qualified path: openzeppelin_utils::cryptography::snip12::StarknetDomain::version
pub version: felt252
chain_id
Fully qualified path: openzeppelin_utils::cryptography::snip12::StarknetDomain::chain_id
pub chain_id: felt252
revision
Fully qualified path: openzeppelin_utils::cryptography::snip12::StarknetDomain::revision
pub revision: felt252
Traits
Traits
| StructHash | Trait for calculating the hash of a struct. |
| OffchainMessageHash | Trait for calculating the hash of a message given the passed signer . |
| SNIP12Metadata | — |
StructHash
Trait for calculating the hash of a struct.
Fully qualified path: openzeppelin_utils::cryptography::snip12::StructHash
pub trait StructHash<T>
Trait functions
hash_struct
Fully qualified path: openzeppelin_utils::cryptography::snip12::StructHash::hash_struct
fn hash_struct(self: @T) -> felt252
OffchainMessageHash
Trait for calculating the hash of a message given the passed signer.
Fully qualified path: openzeppelin_utils::cryptography::snip12::OffchainMessageHash
pub trait OffchainMessageHash<T>
Trait functions
get_message_hash
Fully qualified path: openzeppelin_utils::cryptography::snip12::OffchainMessageHash::get_message_hash
fn get_message_hash(self: @T, signer: ContractAddress) -> felt252
SNIP12Metadata
Fully qualified path: openzeppelin_utils::cryptography::snip12::SNIP12Metadata
pub trait SNIP12Metadata
Trait functions
name
Returns the name of the dapp.
Fully qualified path: openzeppelin_utils::cryptography::snip12::SNIP12Metadata::name
fn name() -> felt252
version
Returns the version of the dapp.
Fully qualified path: openzeppelin_utils::cryptography::snip12::SNIP12Metadata::version
fn version() -> felt252
Impls
Impls
| StructHashStarknetDomainImpl | Implementation of StructHash that calculates the Poseidon hash of type StarknetDomain . |
| SNIP12HashSpanImpl | Hash trait implementation for a span of elements according to SNIP-12. |
StructHashStarknetDomainImpl
Implementation of StructHash that calculates the Poseidon hash of type StarknetDomain.
Fully qualified path: openzeppelin_utils::cryptography::snip12::StructHashStarknetDomainImpl
pub impl StructHashStarknetDomainImpl of StructHash<StarknetDomain>;
Impl functions
hash_struct
Fully qualified path: openzeppelin_utils::cryptography::snip12::StructHashStarknetDomainImpl::hash_struct
fn hash_struct(self: @StarknetDomain) -> felt252
SNIP12HashSpanImpl
Hash trait implementation for a span of elements according to SNIP-12.
Fully qualified path: openzeppelin_utils::cryptography::snip12::SNIP12HashSpanImpl
pub impl SNIP12HashSpanImpl<
T, +Copy<T>, +Hash<T, HashState>,
> of Hash<Span<T>, HashState, HashStateImpl>;
Impl functions
update_state
Fully qualified path: openzeppelin_utils::cryptography::snip12::SNIP12HashSpanImpl::update_state
fn update_state(mut state: HashState, value: Span<T>) -> HashState
deployments
Fully qualified path: openzeppelin_utils::deployments
Constants
Free functions
| calculate_contract_address_from_deploy_syscall | Returns the contract address from a deploy_syscall . deployer_address should be the zero address if the deployment is origin-independent (deployed from zero). For more information, see… |
| calculate_contract_address_from_udc | Returns the calculated contract address for contracts deployed through the UDC. Origin-independent deployments (deployed from zero) should pass Option::None as deployer_info . |
Structs
Constants
Constants
L2_ADDRESS_UPPER_BOUND
Fully qualified path: openzeppelin_utils::deployments::L2_ADDRESS_UPPER_BOUND
pub const L2_ADDRESS_UPPER_BOUND: felt252 =
3618502788666131106986593281521497120414687020801267626233049500247285300992;
CONTRACT_ADDRESS_PREFIX
Fully qualified path: openzeppelin_utils::deployments::CONTRACT_ADDRESS_PREFIX
pub const CONTRACT_ADDRESS_PREFIX: felt252 =
523065374597054866729014270389667305596563390979550329787219;
Free functions
Free functions
| calculate_contract_address_from_deploy_syscall | Returns the contract address from a deploy_syscall . deployer_address should be the zero address if the deployment is origin-independent (deployed from zero). For more information, see… |
| calculate_contract_address_from_udc | Returns the calculated contract address for contracts deployed through the UDC. Origin-independent deployments (deployed from zero) should pass Option::None as deployer_info . |
calculate_contract_address_from_deploy_syscall
Returns the contract address from a deploy_syscall.
deployer_address should be the zero address if the deployment is origin-independent (deployed
from zero).
For more information, see https://docs.starknet.io/architecture-and-concepts/smart-contracts/contract-address/
Fully qualified path: openzeppelin_utils::deployments::calculate_contract_address_from_deploy_syscall
pub fn calculate_contract_address_from_deploy_syscall(
salt: felt252,
class_hash: ClassHash,
constructor_calldata: Span<felt252>,
deployer_address: ContractAddress,
) -> ContractAddress
calculate_contract_address_from_udc
Returns the calculated contract address for contracts deployed through the UDC.
Origin-independent deployments (deployed from zero) should pass Option::None as
deployer_info.
Fully qualified path: openzeppelin_utils::deployments::calculate_contract_address_from_udc
pub fn calculate_contract_address_from_udc(
salt: felt252,
class_hash: ClassHash,
constructor_calldata: Span<felt252>,
deployer_info: Option<DeployerInfo>,
) -> ContractAddress
Structs
Structs
DeployerInfo
Fully qualified path: openzeppelin_utils::deployments::DeployerInfo
[derive(Drop)]
pub struct DeployerInfo {
pub caller_address: ContractAddress,
pub udc_address: ContractAddress,
}
Members
caller_address
Fully qualified path: openzeppelin_utils::deployments::DeployerInfo::caller_address
pub caller_address: ContractAddress
udc_address
Fully qualified path: openzeppelin_utils::deployments::DeployerInfo::udc_address
pub udc_address: ContractAddress
execution
Fully qualified path: openzeppelin_utils::execution
Free functions
| execute_calls | Executes a list of calls and returns the return values. |
| execute_single_call | Executes a single call and returns the return value. |
| assert_valid_signature | Validates a signature using SRC6 is_valid_signature and asserts it’s valid. Checks both ‘VALID’ (starknet::VALIDATED) and true (1) for backwards compatibility. |
Free functions
Free functions
| execute_calls | Executes a list of calls and returns the return values. |
| execute_single_call | Executes a single call and returns the return value. |
| assert_valid_signature | Validates a signature using SRC6 is_valid_signature and asserts it’s valid. Checks both ‘VALID’ (starknet::VALIDATED) and true (1) for backwards compatibility. |
execute_calls
Executes a list of calls and returns the return values.
Fully qualified path: openzeppelin_utils::execution::execute_calls
pub fn execute_calls(calls: Span<Call>) -> Array<Span<felt252>>
execute_single_call
Executes a single call and returns the return value.
Fully qualified path: openzeppelin_utils::execution::execute_single_call
pub fn execute_single_call(call: @Call) -> Span<felt252>
assert_valid_signature
Validates a signature using SRC6 is_valid_signature and asserts it’s valid.
Checks both ‘VALID’ (starknet::VALIDATED) and true (1) for backwards compatibility.
Fully qualified path: openzeppelin_utils::execution::assert_valid_signature
pub fn assert_valid_signature(
signer: ContractAddress,
hash: felt252,
signature: Span<felt252>,
invalid_signature_error: felt252,
)
math
Fully qualified path: openzeppelin_utils::math
Free functions
| average | Returns the average of two unsigned integers. The result is rounded down. |
| u256_mul_div | Returns the quotient of x * y / denominator and rounds up or down depending on rounding . Uses wide_mul and u512_safe_div_rem_by_u256 for precision. Requirements:… |
Enums
Traits
| Unsigned | A trait to represent unsigned integers. |
Free functions
Free functions
| average | Returns the average of two unsigned integers. The result is rounded down. |
| u256_mul_div | Returns the quotient of x * y / denominator and rounds up or down depending on rounding . Uses wide_mul and u512_safe_div_rem_by_u256 for precision. Requirements:… |
average
Returns the average of two unsigned integers. The result is rounded down.
Fully qualified path: openzeppelin_utils::math::average
pub fn average<
T, +Unsigned<T>, +Add<T>, +Div<T>, +BitAnd<T>, +BitXor<T>, +Into<u8, T>, +Copy<T>, +Drop<T>,
>(
a: T, b: T,
) -> T
u256_mul_div
Returns the quotient of x * y / denominator and rounds up or down depending on rounding.
Uses wide_mul and u512_safe_div_rem_by_u256 for precision.
Requirements:
denominatormust not be zero.- The quotient must not overflow u256.
Fully qualified path: openzeppelin_utils::math::u256_mul_div
pub fn u256_mul_div(x: u256, y: u256, denominator: u256, rounding: Rounding) -> u256
Enums
Enums
Rounding
Fully qualified path: openzeppelin_utils::math::Rounding
pub enum Rounding {
Floor,
Ceil,
Trunc,
Expand,
}
Variants
Floor
Fully qualified path: openzeppelin_utils::math::Rounding::Floor
Floor
Ceil
Fully qualified path: openzeppelin_utils::math::Rounding::Ceil
Ceil
Trunc
Fully qualified path: openzeppelin_utils::math::Rounding::Trunc
Trunc
Expand
Fully qualified path: openzeppelin_utils::math::Rounding::Expand
Expand
Traits
Traits
| Unsigned | A trait to represent unsigned integers. |
Unsigned
A trait to represent unsigned integers.
Fully qualified path: openzeppelin_utils::math::Unsigned
pub trait Unsigned<T>
serde
Fully qualified path: openzeppelin_utils::serde
Traits
Traits
Traits
SerializedAppend
Fully qualified path: openzeppelin_utils::serde::SerializedAppend
pub trait SerializedAppend<T>
Trait functions
append_serde
Fully qualified path: openzeppelin_utils::serde::SerializedAppend::append_serde
fn append_serde(ref self: Array<felt252>, value: T)
structs
Fully qualified path: openzeppelin_utils::structs
Modules
Re-exports:
| Checkpoint | Generic checkpoint representation. |
| Trace | Trace struct, for checkpointing values as they change at different points in time, and later looking up past values by block timestamp. |
Modules
Modules
checkpoint
Fully qualified path: openzeppelin_utils::structs::checkpoint
Structs
| Trace | Trace struct, for checkpointing values as they change at different points in time, and later looking up past values by block timestamp. |
| Checkpoint | Generic checkpoint representation. |
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. |
| Checkpoint | Generic checkpoint representation. |
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: openzeppelin_utils::structs::checkpoint::Trace
[starknet::storage_node]
pub struct Trace {
pub checkpoints: Vec<Checkpoint>,
}
Members
checkpoints
Fully qualified path: openzeppelin_utils::structs::checkpoint::Trace::checkpoints
pub checkpoints: Vec<Checkpoint>
Checkpoint
Generic checkpoint representation.
Fully qualified path: openzeppelin_utils::structs::checkpoint::Checkpoint
[derive(Copy, Drop, Serde, PartialEq, Debug)]
pub struct Checkpoint {
pub key: u64,
pub value: u256,
}
Members
key
Fully qualified path: openzeppelin_utils::structs::checkpoint::Checkpoint::key
pub key: u64
value
Fully qualified path: openzeppelin_utils::structs::checkpoint::Checkpoint::value
pub value: u256
Traits
Traits
TraceTrait
Fully qualified path: openzeppelin_utils::structs::checkpoint::TraceTrait
pub trait TraceTrait
Trait functions
push
Pushes a (key, value) pair into a Trace so that it is stored as the checkpoint
and returns both the previous and the new value.
Fully qualified path: openzeppelin_utils::structs::checkpoint::TraceTrait::push
fn push(self: StoragePath<Mutable<Trace>>, key: u64, value: u256) -> (u256, u256)
upper_lookup
Returns the value in the last (most recent) checkpoint with the key lower than or equal to the search key, or zero if there is none.
Fully qualified path: openzeppelin_utils::structs::checkpoint::TraceTrait::upper_lookup
fn upper_lookup(self: StoragePath<Trace>, key: u64) -> u256
upper_lookup_recent
Returns the value in the last (most recent) checkpoint with key lower than or equal to the search key, or zero if there is none.
NOTE: This is a variant of upper_lookup that is optimised to
find “recent” checkpoints (checkpoints with high keys).
Fully qualified path: openzeppelin_utils::structs::checkpoint::TraceTrait::upper_lookup_recent
fn upper_lookup_recent(self: StoragePath<Trace>, key: u64) -> u256
latest
Returns the value in the most recent checkpoint, or zero if there are no checkpoints.
Fully qualified path: openzeppelin_utils::structs::checkpoint::TraceTrait::latest
fn latest(self: StoragePath<Trace>) -> u256
latest_checkpoint
Returns whether there is a checkpoint in the structure (i.e. it is not empty), and if so the key and value in the most recent checkpoint.
Fully qualified path: openzeppelin_utils::structs::checkpoint::TraceTrait::latest_checkpoint
fn latest_checkpoint(self: StoragePath<Trace>) -> (bool, u64, u256)
length
Returns the total number of checkpoints.
Fully qualified path: openzeppelin_utils::structs::checkpoint::TraceTrait::length
fn length(self: StoragePath<Trace>) -> u64
at
Returns the checkpoint at the given position.
Fully qualified path: openzeppelin_utils::structs::checkpoint::TraceTrait::at
fn at(self: StoragePath<Trace>, pos: u64) -> Checkpoint
Impls
Impls
TraceImpl
Fully qualified path: openzeppelin_utils::structs::checkpoint::TraceImpl
pub impl TraceImpl of TraceTrait;
Impl functions
push
Pushes a (key, value) pair into a Trace so that it is stored as the checkpoint
and returns both the previous and the new value.
Fully qualified path: openzeppelin_utils::structs::checkpoint::TraceImpl::push
fn push(self: StoragePath<Mutable<Trace>>, key: u64, value: u256) -> (u256, u256)
upper_lookup
Returns the value in the last (most recent) checkpoint with the key lower than or equal to the search key, or zero if there is none.
Fully qualified path: openzeppelin_utils::structs::checkpoint::TraceImpl::upper_lookup
fn upper_lookup(self: StoragePath<Trace>, key: u64) -> u256
upper_lookup_recent
Returns the value in the last (most recent) checkpoint with key lower than or equal to the search key, or zero if there is none.
NOTE: This is a variant of upper_lookup that is optimised to
find “recent” checkpoints (checkpoints with high keys).
Fully qualified path: openzeppelin_utils::structs::checkpoint::TraceImpl::upper_lookup_recent
fn upper_lookup_recent(self: StoragePath<Trace>, key: u64) -> u256
latest
Returns the value in the most recent checkpoint, or zero if there are no checkpoints.
Fully qualified path: openzeppelin_utils::structs::checkpoint::TraceImpl::latest
fn latest(self: StoragePath<Trace>) -> u256
latest_checkpoint
Returns whether there is a checkpoint in the structure (i.e. it is not empty), and if so the key and value in the most recent checkpoint.
Fully qualified path: openzeppelin_utils::structs::checkpoint::TraceImpl::latest_checkpoint
fn latest_checkpoint(self: StoragePath<Trace>) -> (bool, u64, u256)
length
Returns the total number of checkpoints.
Fully qualified path: openzeppelin_utils::structs::checkpoint::TraceImpl::length
fn length(self: StoragePath<Trace>) -> u64
at
Returns the checkpoint at the given position.
Fully qualified path: openzeppelin_utils::structs::checkpoint::TraceImpl::at
fn at(self: StoragePath<Trace>, pos: u64) -> Checkpoint
dispatchers
Structs
Structs
IAccessControlDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IAccessControlDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlDispatcher::contract_address
pub contract_address: ContractAddress
IAccessControlLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IAccessControlLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlLibraryDispatcher::class_hash
pub class_hash: ClassHash
IAccessControlSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IAccessControlSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IAccessControlSafeDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IAccessControlSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlSafeDispatcher::contract_address
pub contract_address: ContractAddress
IAccessControlWithDelayDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlWithDelayDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IAccessControlWithDelayDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlWithDelayDispatcher::contract_address
pub contract_address: ContractAddress
IAccessControlWithDelayLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlWithDelayLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IAccessControlWithDelayLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlWithDelayLibraryDispatcher::class_hash
pub class_hash: ClassHash
IAccessControlWithDelaySafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlWithDelaySafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IAccessControlWithDelaySafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlWithDelaySafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IAccessControlWithDelaySafeDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlWithDelaySafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IAccessControlWithDelaySafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlWithDelaySafeDispatcher::contract_address
pub contract_address: ContractAddress
IAccessControlCamelDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IAccessControlCamelDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelDispatcher::contract_address
pub contract_address: ContractAddress
IAccessControlCamelLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IAccessControlCamelLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelLibraryDispatcher::class_hash
pub class_hash: ClassHash
IAccessControlCamelSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IAccessControlCamelSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IAccessControlCamelSafeDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IAccessControlCamelSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelSafeDispatcher::contract_address
pub contract_address: ContractAddress
AccessControlABIDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct AccessControlABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABIDispatcher::contract_address
pub contract_address: ContractAddress
AccessControlABILibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct AccessControlABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABILibraryDispatcher::class_hash
pub class_hash: ClassHash
AccessControlABISafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct AccessControlABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
AccessControlABISafeDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct AccessControlABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeDispatcher::contract_address
pub contract_address: ContractAddress
IAccessControlDefaultAdminRulesDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IAccessControlDefaultAdminRulesDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesDispatcher::contract_address
pub contract_address: ContractAddress
IAccessControlDefaultAdminRulesLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IAccessControlDefaultAdminRulesLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesLibraryDispatcher::class_hash
pub class_hash: ClassHash
IAccessControlDefaultAdminRulesSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IAccessControlDefaultAdminRulesSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IAccessControlDefaultAdminRulesSafeDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IAccessControlDefaultAdminRulesSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesSafeDispatcher::contract_address
pub contract_address: ContractAddress
AccessControlDefaultAdminRulesABIDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct AccessControlDefaultAdminRulesABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcher::contract_address
pub contract_address: ContractAddress
AccessControlDefaultAdminRulesABILibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct AccessControlDefaultAdminRulesABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABILibraryDispatcher::class_hash
pub class_hash: ClassHash
AccessControlDefaultAdminRulesABISafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct AccessControlDefaultAdminRulesABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
AccessControlDefaultAdminRulesABISafeDispatcher
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct AccessControlDefaultAdminRulesABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcher::contract_address
pub contract_address: ContractAddress
IOwnableDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IOwnableDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableDispatcher::contract_address
pub contract_address: ContractAddress
IOwnableLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IOwnableLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableLibraryDispatcher::class_hash
pub class_hash: ClassHash
IOwnableSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IOwnableSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IOwnableSafeDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IOwnableSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableSafeDispatcher::contract_address
pub contract_address: ContractAddress
IOwnableCamelOnlyDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableCamelOnlyDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IOwnableCamelOnlyDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableCamelOnlyDispatcher::contract_address
pub contract_address: ContractAddress
IOwnableCamelOnlyLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableCamelOnlyLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IOwnableCamelOnlyLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableCamelOnlyLibraryDispatcher::class_hash
pub class_hash: ClassHash
IOwnableCamelOnlySafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableCamelOnlySafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IOwnableCamelOnlySafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableCamelOnlySafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IOwnableCamelOnlySafeDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableCamelOnlySafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IOwnableCamelOnlySafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableCamelOnlySafeDispatcher::contract_address
pub contract_address: ContractAddress
OwnableABIDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct OwnableABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABIDispatcher::contract_address
pub contract_address: ContractAddress
OwnableABILibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct OwnableABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABILibraryDispatcher::class_hash
pub class_hash: ClassHash
OwnableABISafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct OwnableABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
OwnableABISafeDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct OwnableABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABISafeDispatcher::contract_address
pub contract_address: ContractAddress
IOwnableTwoStepDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IOwnableTwoStepDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepDispatcher::contract_address
pub contract_address: ContractAddress
IOwnableTwoStepLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IOwnableTwoStepLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepLibraryDispatcher::class_hash
pub class_hash: ClassHash
IOwnableTwoStepSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IOwnableTwoStepSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IOwnableTwoStepSafeDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IOwnableTwoStepSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepSafeDispatcher::contract_address
pub contract_address: ContractAddress
IOwnableTwoStepCamelOnlyDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlyDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IOwnableTwoStepCamelOnlyDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlyDispatcher::contract_address
pub contract_address: ContractAddress
IOwnableTwoStepCamelOnlyLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlyLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IOwnableTwoStepCamelOnlyLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlyLibraryDispatcher::class_hash
pub class_hash: ClassHash
IOwnableTwoStepCamelOnlySafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlySafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IOwnableTwoStepCamelOnlySafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlySafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IOwnableTwoStepCamelOnlySafeDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlySafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IOwnableTwoStepCamelOnlySafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlySafeDispatcher::contract_address
pub contract_address: ContractAddress
OwnableTwoStepABIDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct OwnableTwoStepABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABIDispatcher::contract_address
pub contract_address: ContractAddress
OwnableTwoStepABILibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct OwnableTwoStepABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABILibraryDispatcher::class_hash
pub class_hash: ClassHash
OwnableTwoStepABISafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct OwnableTwoStepABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
OwnableTwoStepABISafeDispatcher
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct OwnableTwoStepABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABISafeDispatcher::contract_address
pub contract_address: ContractAddress
ISRC6Dispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6Dispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISRC6Dispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6Dispatcher::contract_address
pub contract_address: ContractAddress
ISRC6LibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6LibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISRC6LibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6LibraryDispatcher::class_hash
pub class_hash: ClassHash
ISRC6SafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6SafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISRC6SafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6SafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
ISRC6SafeDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6SafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISRC6SafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6SafeDispatcher::contract_address
pub contract_address: ContractAddress
IDeclarerDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeclarerDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IDeclarerDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeclarerDispatcher::contract_address
pub contract_address: ContractAddress
IDeclarerLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeclarerLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IDeclarerLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeclarerLibraryDispatcher::class_hash
pub class_hash: ClassHash
IDeclarerSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeclarerSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IDeclarerSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeclarerSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IDeclarerSafeDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeclarerSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IDeclarerSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeclarerSafeDispatcher::contract_address
pub contract_address: ContractAddress
IDeployableDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeployableDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IDeployableDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeployableDispatcher::contract_address
pub contract_address: ContractAddress
IDeployableLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeployableLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IDeployableLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeployableLibraryDispatcher::class_hash
pub class_hash: ClassHash
IDeployableSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeployableSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IDeployableSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeployableSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IDeployableSafeDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeployableSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IDeployableSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeployableSafeDispatcher::contract_address
pub contract_address: ContractAddress
IPublicKeyDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IPublicKeyDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyDispatcher::contract_address
pub contract_address: ContractAddress
IPublicKeyLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IPublicKeyLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyLibraryDispatcher::class_hash
pub class_hash: ClassHash
IPublicKeySafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeySafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IPublicKeySafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeySafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IPublicKeySafeDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeySafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IPublicKeySafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeySafeDispatcher::contract_address
pub contract_address: ContractAddress
ISRC6CamelOnlyDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6CamelOnlyDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISRC6CamelOnlyDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6CamelOnlyDispatcher::contract_address
pub contract_address: ContractAddress
ISRC6CamelOnlyLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6CamelOnlyLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISRC6CamelOnlyLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6CamelOnlyLibraryDispatcher::class_hash
pub class_hash: ClassHash
ISRC6CamelOnlySafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6CamelOnlySafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISRC6CamelOnlySafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6CamelOnlySafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
ISRC6CamelOnlySafeDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6CamelOnlySafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISRC6CamelOnlySafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6CamelOnlySafeDispatcher::contract_address
pub contract_address: ContractAddress
IPublicKeyCamelDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyCamelDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IPublicKeyCamelDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyCamelDispatcher::contract_address
pub contract_address: ContractAddress
IPublicKeyCamelLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyCamelLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IPublicKeyCamelLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyCamelLibraryDispatcher::class_hash
pub class_hash: ClassHash
IPublicKeyCamelSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyCamelSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IPublicKeyCamelSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyCamelSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IPublicKeyCamelSafeDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyCamelSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IPublicKeyCamelSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyCamelSafeDispatcher::contract_address
pub contract_address: ContractAddress
AccountABIDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct AccountABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABIDispatcher::contract_address
pub contract_address: ContractAddress
AccountABILibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct AccountABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABILibraryDispatcher::class_hash
pub class_hash: ClassHash
AccountABISafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct AccountABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
AccountABISafeDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct AccountABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABISafeDispatcher::contract_address
pub contract_address: ContractAddress
IEthDeployableDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthDeployableDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IEthDeployableDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthDeployableDispatcher::contract_address
pub contract_address: ContractAddress
IEthDeployableLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthDeployableLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IEthDeployableLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthDeployableLibraryDispatcher::class_hash
pub class_hash: ClassHash
IEthDeployableSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthDeployableSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IEthDeployableSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthDeployableSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IEthDeployableSafeDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthDeployableSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IEthDeployableSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthDeployableSafeDispatcher::contract_address
pub contract_address: ContractAddress
IEthPublicKeyDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IEthPublicKeyDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyDispatcher::contract_address
pub contract_address: ContractAddress
IEthPublicKeyLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IEthPublicKeyLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyLibraryDispatcher::class_hash
pub class_hash: ClassHash
IEthPublicKeySafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeySafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IEthPublicKeySafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeySafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IEthPublicKeySafeDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeySafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IEthPublicKeySafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeySafeDispatcher::contract_address
pub contract_address: ContractAddress
IEthPublicKeyCamelDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyCamelDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IEthPublicKeyCamelDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyCamelDispatcher::contract_address
pub contract_address: ContractAddress
IEthPublicKeyCamelLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyCamelLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IEthPublicKeyCamelLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyCamelLibraryDispatcher::class_hash
pub class_hash: ClassHash
IEthPublicKeyCamelSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyCamelSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IEthPublicKeyCamelSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyCamelSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IEthPublicKeyCamelSafeDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyCamelSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IEthPublicKeyCamelSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyCamelSafeDispatcher::contract_address
pub contract_address: ContractAddress
EthAccountABIDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct EthAccountABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABIDispatcher::contract_address
pub contract_address: ContractAddress
EthAccountABILibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct EthAccountABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABILibraryDispatcher::class_hash
pub class_hash: ClassHash
EthAccountABISafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct EthAccountABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
EthAccountABISafeDispatcher
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct EthAccountABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABISafeDispatcher::contract_address
pub contract_address: ContractAddress
ISRC9_V2Dispatcher
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2Dispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISRC9_V2Dispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2Dispatcher::contract_address
pub contract_address: ContractAddress
ISRC9_V2LibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2LibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISRC9_V2LibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2LibraryDispatcher::class_hash
pub class_hash: ClassHash
ISRC9_V2SafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2SafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISRC9_V2SafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2SafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
ISRC9_V2SafeDispatcher
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2SafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISRC9_V2SafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2SafeDispatcher::contract_address
pub contract_address: ContractAddress
IVestingDispatcher
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IVestingDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingDispatcher::contract_address
pub contract_address: ContractAddress
IVestingLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IVestingLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingLibraryDispatcher::class_hash
pub class_hash: ClassHash
IVestingSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IVestingSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IVestingSafeDispatcher
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IVestingSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingSafeDispatcher::contract_address
pub contract_address: ContractAddress
IQuorumFractionDispatcher
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IQuorumFractionDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionDispatcher::contract_address
pub contract_address: ContractAddress
IQuorumFractionLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IQuorumFractionLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionLibraryDispatcher::class_hash
pub class_hash: ClassHash
IQuorumFractionSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IQuorumFractionSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IQuorumFractionSafeDispatcher
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IQuorumFractionSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionSafeDispatcher::contract_address
pub contract_address: ContractAddress
IVotesTokenDispatcher
Fully qualified path: openzeppelin_interfaces::governance::extensions::IVotesTokenDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IVotesTokenDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::extensions::IVotesTokenDispatcher::contract_address
pub contract_address: ContractAddress
IVotesTokenLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::extensions::IVotesTokenLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IVotesTokenLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::extensions::IVotesTokenLibraryDispatcher::class_hash
pub class_hash: ClassHash
IVotesTokenSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::extensions::IVotesTokenSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IVotesTokenSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::extensions::IVotesTokenSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IVotesTokenSafeDispatcher
Fully qualified path: openzeppelin_interfaces::governance::extensions::IVotesTokenSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IVotesTokenSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::extensions::IVotesTokenSafeDispatcher::contract_address
pub contract_address: ContractAddress
ITimelockedDispatcher
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelockedDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ITimelockedDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelockedDispatcher::contract_address
pub contract_address: ContractAddress
ITimelockedLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelockedLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ITimelockedLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelockedLibraryDispatcher::class_hash
pub class_hash: ClassHash
ITimelockedSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelockedSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ITimelockedSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelockedSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
ITimelockedSafeDispatcher
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelockedSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ITimelockedSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelockedSafeDispatcher::contract_address
pub contract_address: ContractAddress
IGovernorSettingsAdminDispatcher
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdminDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IGovernorSettingsAdminDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdminDispatcher::contract_address
pub contract_address: ContractAddress
IGovernorSettingsAdminLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdminLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IGovernorSettingsAdminLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdminLibraryDispatcher::class_hash
pub class_hash: ClassHash
IGovernorSettingsAdminSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdminSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IGovernorSettingsAdminSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdminSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IGovernorSettingsAdminSafeDispatcher
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdminSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IGovernorSettingsAdminSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdminSafeDispatcher::contract_address
pub contract_address: ContractAddress
IGovernorDispatcher
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IGovernorDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcher::contract_address
pub contract_address: ContractAddress
IGovernorLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IGovernorLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorLibraryDispatcher::class_hash
pub class_hash: ClassHash
IGovernorSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IGovernorSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IGovernorSafeDispatcher
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IGovernorSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcher::contract_address
pub contract_address: ContractAddress
IMultisigDispatcher
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IMultisigDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcher::contract_address
pub contract_address: ContractAddress
IMultisigLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IMultisigLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigLibraryDispatcher::class_hash
pub class_hash: ClassHash
IMultisigSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IMultisigSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IMultisigSafeDispatcher
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IMultisigSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcher::contract_address
pub contract_address: ContractAddress
ITimelockDispatcher
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ITimelockDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcher::contract_address
pub contract_address: ContractAddress
ITimelockLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ITimelockLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockLibraryDispatcher::class_hash
pub class_hash: ClassHash
ITimelockSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ITimelockSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
ITimelockSafeDispatcher
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ITimelockSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcher::contract_address
pub contract_address: ContractAddress
TimelockABIDispatcher
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct TimelockABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcher::contract_address
pub contract_address: ContractAddress
TimelockABILibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct TimelockABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABILibraryDispatcher::class_hash
pub class_hash: ClassHash
TimelockABISafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct TimelockABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
TimelockABISafeDispatcher
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct TimelockABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcher::contract_address
pub contract_address: ContractAddress
IVotesDispatcher
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IVotesDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesDispatcher::contract_address
pub contract_address: ContractAddress
IVotesLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IVotesLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesLibraryDispatcher::class_hash
pub class_hash: ClassHash
IVotesSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IVotesSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IVotesSafeDispatcher
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IVotesSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesSafeDispatcher::contract_address
pub contract_address: ContractAddress
VotesABIDispatcher
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct VotesABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABIDispatcher::contract_address
pub contract_address: ContractAddress
VotesABILibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct VotesABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABILibraryDispatcher::class_hash
pub class_hash: ClassHash
VotesABISafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct VotesABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
VotesABISafeDispatcher
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct VotesABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABISafeDispatcher::contract_address
pub contract_address: ContractAddress
ISRC5Dispatcher
Fully qualified path: openzeppelin_interfaces::introspection::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_interfaces::introspection::ISRC5Dispatcher::contract_address
pub contract_address: ContractAddress
ISRC5LibraryDispatcher
Fully qualified path: openzeppelin_interfaces::introspection::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_interfaces::introspection::ISRC5LibraryDispatcher::class_hash
pub class_hash: ClassHash
ISRC5SafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::introspection::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_interfaces::introspection::ISRC5SafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
ISRC5SafeDispatcher
Fully qualified path: openzeppelin_interfaces::introspection::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_interfaces::introspection::ISRC5SafeDispatcher::contract_address
pub contract_address: ContractAddress
IInitializableDispatcher
Fully qualified path: openzeppelin_interfaces::security::initializable::IInitializableDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IInitializableDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::security::initializable::IInitializableDispatcher::contract_address
pub contract_address: ContractAddress
IInitializableLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::security::initializable::IInitializableLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IInitializableLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::security::initializable::IInitializableLibraryDispatcher::class_hash
pub class_hash: ClassHash
IInitializableSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::security::initializable::IInitializableSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IInitializableSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::security::initializable::IInitializableSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IInitializableSafeDispatcher
Fully qualified path: openzeppelin_interfaces::security::initializable::IInitializableSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IInitializableSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::security::initializable::IInitializableSafeDispatcher::contract_address
pub contract_address: ContractAddress
IPausableDispatcher
Fully qualified path: openzeppelin_interfaces::security::pausable::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: openzeppelin_interfaces::security::pausable::IPausableDispatcher::contract_address
pub contract_address: ContractAddress
IPausableLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::security::pausable::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: openzeppelin_interfaces::security::pausable::IPausableLibraryDispatcher::class_hash
pub class_hash: ClassHash
IPausableSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::security::pausable::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: openzeppelin_interfaces::security::pausable::IPausableSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IPausableSafeDispatcher
Fully qualified path: openzeppelin_interfaces::security::pausable::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: openzeppelin_interfaces::security::pausable::IPausableSafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC1155Dispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155Dispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155Dispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155Dispatcher::contract_address
pub contract_address: ContractAddress
IERC1155LibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155LibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155LibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155LibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC1155SafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155SafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155SafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155SafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC1155SafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155SafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155SafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155SafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC1155MetadataURIDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155MetadataURIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155MetadataURIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155MetadataURIDispatcher::contract_address
pub contract_address: ContractAddress
IERC1155MetadataURILibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155MetadataURILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155MetadataURILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155MetadataURILibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC1155MetadataURISafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155MetadataURISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155MetadataURISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155MetadataURISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC1155MetadataURISafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155MetadataURISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155MetadataURISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155MetadataURISafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC1155CamelDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155CamelDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelDispatcher::contract_address
pub contract_address: ContractAddress
IERC1155CamelLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155CamelLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC1155CamelSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155CamelSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC1155CamelSafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155CamelSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelSafeDispatcher::contract_address
pub contract_address: ContractAddress
ERC1155ABIDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC1155ABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABIDispatcher::contract_address
pub contract_address: ContractAddress
ERC1155ABILibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC1155ABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABILibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC1155ABISafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC1155ABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC1155ABISafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC1155ABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC1155ReceiverDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155ReceiverDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverDispatcher::contract_address
pub contract_address: ContractAddress
IERC1155ReceiverLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155ReceiverLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC1155ReceiverSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155ReceiverSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC1155ReceiverSafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155ReceiverSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverSafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC1155ReceiverCamelDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverCamelDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155ReceiverCamelDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverCamelDispatcher::contract_address
pub contract_address: ContractAddress
IERC1155ReceiverCamelLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverCamelLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155ReceiverCamelLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverCamelLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC1155ReceiverCamelSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverCamelSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155ReceiverCamelSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverCamelSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC1155ReceiverCamelSafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverCamelSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC1155ReceiverCamelSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverCamelSafeDispatcher::contract_address
pub contract_address: ContractAddress
ERC1155ReceiverABIDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC1155ReceiverABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABIDispatcher::contract_address
pub contract_address: ContractAddress
ERC1155ReceiverABILibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC1155ReceiverABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABILibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC1155ReceiverABISafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC1155ReceiverABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC1155ReceiverABISafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC1155ReceiverABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABISafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC20Dispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Dispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20Dispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20Dispatcher::contract_address
pub contract_address: ContractAddress
IERC20LibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20LibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20LibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20LibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC20SafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20SafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20SafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20SafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC20SafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20SafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20SafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20SafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC20MetadataDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MetadataDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20MetadataDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MetadataDispatcher::contract_address
pub contract_address: ContractAddress
IERC20MetadataLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MetadataLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20MetadataLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MetadataLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC20MetadataSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MetadataSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20MetadataSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MetadataSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC20MetadataSafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MetadataSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20MetadataSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MetadataSafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC20CamelDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20CamelDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelDispatcher::contract_address
pub contract_address: ContractAddress
IERC20CamelLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20CamelLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC20CamelSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20CamelSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC20CamelSafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20CamelSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelSafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC20CamelOnlyDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnlyDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20CamelOnlyDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnlyDispatcher::contract_address
pub contract_address: ContractAddress
IERC20CamelOnlyLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnlyLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20CamelOnlyLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnlyLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC20CamelOnlySafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnlySafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20CamelOnlySafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnlySafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC20CamelOnlySafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnlySafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20CamelOnlySafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnlySafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC20MixinDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20MixinDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinDispatcher::contract_address
pub contract_address: ContractAddress
IERC20MixinLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20MixinLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC20MixinSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20MixinSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC20MixinSafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20MixinSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinSafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC20PermitDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20PermitDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20PermitDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20PermitDispatcher::contract_address
pub contract_address: ContractAddress
IERC20PermitLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20PermitLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20PermitLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20PermitLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC20PermitSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20PermitSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20PermitSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20PermitSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC20PermitSafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20PermitSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC20PermitSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20PermitSafeDispatcher::contract_address
pub contract_address: ContractAddress
ERC20ABIDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC20ABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcher::contract_address
pub contract_address: ContractAddress
ERC20ABILibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC20ABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABILibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC20ABISafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC20ABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC20ABISafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC20ABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC2981Dispatcher
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981Dispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC2981Dispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981Dispatcher::contract_address
pub contract_address: ContractAddress
IERC2981LibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981LibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC2981LibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981LibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC2981SafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981SafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC2981SafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981SafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC2981SafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981SafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC2981SafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981SafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC2981InfoDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981InfoDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC2981InfoDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981InfoDispatcher::contract_address
pub contract_address: ContractAddress
IERC2981InfoLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981InfoLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC2981InfoLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981InfoLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC2981InfoSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981InfoSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC2981InfoSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981InfoSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC2981InfoSafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981InfoSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC2981InfoSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981InfoSafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC2981AdminDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC2981AdminDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminDispatcher::contract_address
pub contract_address: ContractAddress
IERC2981AdminLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC2981AdminLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC2981AdminSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC2981AdminSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC2981AdminSafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC2981AdminSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminSafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC2981ABIDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC2981ABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABIDispatcher::contract_address
pub contract_address: ContractAddress
IERC2981ABILibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC2981ABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABILibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC2981ABISafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC2981ABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC2981ABISafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC2981ABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABISafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC4626Dispatcher
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626Dispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC4626Dispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626Dispatcher::contract_address
pub contract_address: ContractAddress
IERC4626LibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626LibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC4626LibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626LibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC4626SafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC4626SafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC4626SafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC4626SafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcher::contract_address
pub contract_address: ContractAddress
ERC4626ABIDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC4626ABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcher::contract_address
pub contract_address: ContractAddress
ERC4626ABILibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC4626ABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABILibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC4626ABISafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC4626ABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC4626ABISafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC4626ABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC721Dispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721Dispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721Dispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721Dispatcher::contract_address
pub contract_address: ContractAddress
IERC721LibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721LibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721LibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721LibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC721SafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721SafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721SafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721SafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC721SafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721SafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721SafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721SafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC721MetadataDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721MetadataDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataDispatcher::contract_address
pub contract_address: ContractAddress
IERC721MetadataLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721MetadataLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC721MetadataSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721MetadataSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC721MetadataSafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721MetadataSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataSafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC721CamelOnlyDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlyDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721CamelOnlyDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlyDispatcher::contract_address
pub contract_address: ContractAddress
IERC721CamelOnlyLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlyLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721CamelOnlyLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlyLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC721CamelOnlySafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlySafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721CamelOnlySafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlySafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC721CamelOnlySafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlySafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721CamelOnlySafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlySafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC721MetadataCamelOnlyDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataCamelOnlyDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721MetadataCamelOnlyDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataCamelOnlyDispatcher::contract_address
pub contract_address: ContractAddress
IERC721MetadataCamelOnlyLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataCamelOnlyLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721MetadataCamelOnlyLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataCamelOnlyLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC721MetadataCamelOnlySafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataCamelOnlySafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721MetadataCamelOnlySafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataCamelOnlySafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC721MetadataCamelOnlySafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataCamelOnlySafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721MetadataCamelOnlySafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataCamelOnlySafeDispatcher::contract_address
pub contract_address: ContractAddress
ERC721ABIDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC721ABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcher::contract_address
pub contract_address: ContractAddress
ERC721ABILibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC721ABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABILibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC721ABISafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC721ABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC721ABISafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC721ABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC721ReceiverDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721ReceiverDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverDispatcher::contract_address
pub contract_address: ContractAddress
IERC721ReceiverLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721ReceiverLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC721ReceiverSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721ReceiverSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC721ReceiverSafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721ReceiverSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverSafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC721ReceiverCamelDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverCamelDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721ReceiverCamelDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverCamelDispatcher::contract_address
pub contract_address: ContractAddress
IERC721ReceiverCamelLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverCamelLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721ReceiverCamelLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverCamelLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC721ReceiverCamelSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverCamelSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721ReceiverCamelSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverCamelSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC721ReceiverCamelSafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverCamelSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721ReceiverCamelSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverCamelSafeDispatcher::contract_address
pub contract_address: ContractAddress
ERC721ReceiverMixinDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixinDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC721ReceiverMixinDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixinDispatcher::contract_address
pub contract_address: ContractAddress
ERC721ReceiverMixinLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixinLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC721ReceiverMixinLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixinLibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC721ReceiverMixinSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixinSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC721ReceiverMixinSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixinSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC721ReceiverMixinSafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixinSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC721ReceiverMixinSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixinSafeDispatcher::contract_address
pub contract_address: ContractAddress
IERC721EnumerableDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721EnumerableDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721EnumerableDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721EnumerableDispatcher::contract_address
pub contract_address: ContractAddress
IERC721EnumerableLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721EnumerableLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721EnumerableLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721EnumerableLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC721EnumerableSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721EnumerableSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721EnumerableSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721EnumerableSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IERC721EnumerableSafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721EnumerableSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IERC721EnumerableSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721EnumerableSafeDispatcher::contract_address
pub contract_address: ContractAddress
ERC721EnumerableABIDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC721EnumerableABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABIDispatcher::contract_address
pub contract_address: ContractAddress
ERC721EnumerableABILibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC721EnumerableABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABILibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC721EnumerableABISafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC721EnumerableABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC721EnumerableABISafeDispatcher
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC721EnumerableABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABISafeDispatcher::contract_address
pub contract_address: ContractAddress
IUpgradeableDispatcher
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeableDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IUpgradeableDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeableDispatcher::contract_address
pub contract_address: ContractAddress
IUpgradeableLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeableLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IUpgradeableLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeableLibraryDispatcher::class_hash
pub class_hash: ClassHash
IUpgradeableSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeableSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IUpgradeableSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeableSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IUpgradeableSafeDispatcher
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeableSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IUpgradeableSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeableSafeDispatcher::contract_address
pub contract_address: ContractAddress
IUpgradeAndCallDispatcher
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeAndCallDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IUpgradeAndCallDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeAndCallDispatcher::contract_address
pub contract_address: ContractAddress
IUpgradeAndCallLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeAndCallLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IUpgradeAndCallLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeAndCallLibraryDispatcher::class_hash
pub class_hash: ClassHash
IUpgradeAndCallSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeAndCallSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IUpgradeAndCallSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeAndCallSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IUpgradeAndCallSafeDispatcher
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeAndCallSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IUpgradeAndCallSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeAndCallSafeDispatcher::contract_address
pub contract_address: ContractAddress
IUniversalDeployerDispatcher
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IUniversalDeployerDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerDispatcher::contract_address
pub contract_address: ContractAddress
IUniversalDeployerLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IUniversalDeployerLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerLibraryDispatcher::class_hash
pub class_hash: ClassHash
IUniversalDeployerSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IUniversalDeployerSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IUniversalDeployerSafeDispatcher
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IUniversalDeployerSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerSafeDispatcher::contract_address
pub contract_address: ContractAddress
IUniversalDeployerCamelDispatcher
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerCamelDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IUniversalDeployerCamelDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerCamelDispatcher::contract_address
pub contract_address: ContractAddress
IUniversalDeployerCamelLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerCamelLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IUniversalDeployerCamelLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerCamelLibraryDispatcher::class_hash
pub class_hash: ClassHash
IUniversalDeployerCamelSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerCamelSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IUniversalDeployerCamelSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerCamelSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
IUniversalDeployerCamelSafeDispatcher
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerCamelSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct IUniversalDeployerCamelSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerCamelSafeDispatcher::contract_address
pub contract_address: ContractAddress
UniversalDeployerABIDispatcher
Fully qualified path: openzeppelin_interfaces::utils::deployments::UniversalDeployerABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct UniversalDeployerABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::utils::deployments::UniversalDeployerABIDispatcher::contract_address
pub contract_address: ContractAddress
UniversalDeployerABILibraryDispatcher
Fully qualified path: openzeppelin_interfaces::utils::deployments::UniversalDeployerABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct UniversalDeployerABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::utils::deployments::UniversalDeployerABILibraryDispatcher::class_hash
pub class_hash: ClassHash
UniversalDeployerABISafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::utils::deployments::UniversalDeployerABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct UniversalDeployerABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::utils::deployments::UniversalDeployerABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
UniversalDeployerABISafeDispatcher
Fully qualified path: openzeppelin_interfaces::utils::deployments::UniversalDeployerABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct UniversalDeployerABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::utils::deployments::UniversalDeployerABISafeDispatcher::contract_address
pub contract_address: ContractAddress
INoncesDispatcher
Fully qualified path: openzeppelin_interfaces::utils::nonces::INoncesDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct INoncesDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::utils::nonces::INoncesDispatcher::contract_address
pub contract_address: ContractAddress
INoncesLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::utils::nonces::INoncesLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct INoncesLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::utils::nonces::INoncesLibraryDispatcher::class_hash
pub class_hash: ClassHash
INoncesSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::utils::nonces::INoncesSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct INoncesSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::utils::nonces::INoncesSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
INoncesSafeDispatcher
Fully qualified path: openzeppelin_interfaces::utils::nonces::INoncesSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct INoncesSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::utils::nonces::INoncesSafeDispatcher::contract_address
pub contract_address: ContractAddress
ISNIP12MetadataDispatcher
Fully qualified path: openzeppelin_interfaces::utils::snip12::ISNIP12MetadataDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISNIP12MetadataDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::utils::snip12::ISNIP12MetadataDispatcher::contract_address
pub contract_address: ContractAddress
ISNIP12MetadataLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::utils::snip12::ISNIP12MetadataLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISNIP12MetadataLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::utils::snip12::ISNIP12MetadataLibraryDispatcher::class_hash
pub class_hash: ClassHash
ISNIP12MetadataSafeLibraryDispatcher
Fully qualified path: openzeppelin_interfaces::utils::snip12::ISNIP12MetadataSafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISNIP12MetadataSafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_interfaces::utils::snip12::ISNIP12MetadataSafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
ISNIP12MetadataSafeDispatcher
Fully qualified path: openzeppelin_interfaces::utils::snip12::ISNIP12MetadataSafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ISNIP12MetadataSafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_interfaces::utils::snip12::ISNIP12MetadataSafeDispatcher::contract_address
pub contract_address: ContractAddress
AccountUpgradeableABIDispatcher
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct AccountUpgradeableABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABIDispatcher::contract_address
pub contract_address: ContractAddress
ERC1155UpgradeableABIDispatcher
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC1155UpgradeableABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcher::contract_address
pub contract_address: ContractAddress
ERC20UpgradeableABIDispatcher
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC20UpgradeableABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcher::contract_address
pub contract_address: ContractAddress
ERC721UpgradeableABIDispatcher
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC721UpgradeableABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcher::contract_address
pub contract_address: ContractAddress
EthAccountUpgradeableABIDispatcher
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct EthAccountUpgradeableABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABIDispatcher::contract_address
pub contract_address: ContractAddress
MetaTransactionV0ABIDispatcher
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::MetaTransactionV0ABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct MetaTransactionV0ABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::MetaTransactionV0ABIDispatcher::contract_address
pub contract_address: ContractAddress
VestingWalletABIDispatcher
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABIDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct VestingWalletABIDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABIDispatcher::contract_address
pub contract_address: ContractAddress
AccountUpgradeableABILibraryDispatcher
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct AccountUpgradeableABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABILibraryDispatcher::class_hash
pub class_hash: ClassHash
AccountUpgradeableABISafeLibraryDispatcher
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct AccountUpgradeableABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
AccountUpgradeableABISafeDispatcher
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct AccountUpgradeableABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeDispatcher::contract_address
pub contract_address: ContractAddress
ERC1155UpgradeableABILibraryDispatcher
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC1155UpgradeableABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABILibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC1155UpgradeableABISafeLibraryDispatcher
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC1155UpgradeableABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC1155UpgradeableABISafeDispatcher
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC1155UpgradeableABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcher::contract_address
pub contract_address: ContractAddress
ERC20UpgradeableABILibraryDispatcher
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC20UpgradeableABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABILibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC20UpgradeableABISafeLibraryDispatcher
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC20UpgradeableABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC20UpgradeableABISafeDispatcher
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC20UpgradeableABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcher::contract_address
pub contract_address: ContractAddress
ERC721UpgradeableABILibraryDispatcher
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC721UpgradeableABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABILibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC721UpgradeableABISafeLibraryDispatcher
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC721UpgradeableABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
ERC721UpgradeableABISafeDispatcher
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct ERC721UpgradeableABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcher::contract_address
pub contract_address: ContractAddress
EthAccountUpgradeableABILibraryDispatcher
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct EthAccountUpgradeableABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABILibraryDispatcher::class_hash
pub class_hash: ClassHash
EthAccountUpgradeableABISafeLibraryDispatcher
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct EthAccountUpgradeableABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
EthAccountUpgradeableABISafeDispatcher
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct EthAccountUpgradeableABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeDispatcher::contract_address
pub contract_address: ContractAddress
MetaTransactionV0ABILibraryDispatcher
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::MetaTransactionV0ABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct MetaTransactionV0ABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::MetaTransactionV0ABILibraryDispatcher::class_hash
pub class_hash: ClassHash
MetaTransactionV0ABISafeLibraryDispatcher
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::MetaTransactionV0ABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct MetaTransactionV0ABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::MetaTransactionV0ABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
MetaTransactionV0ABISafeDispatcher
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::MetaTransactionV0ABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct MetaTransactionV0ABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::MetaTransactionV0ABISafeDispatcher::contract_address
pub contract_address: ContractAddress
VestingWalletABILibraryDispatcher
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABILibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct VestingWalletABILibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABILibraryDispatcher::class_hash
pub class_hash: ClassHash
VestingWalletABISafeLibraryDispatcher
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeLibraryDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct VestingWalletABISafeLibraryDispatcher {
pub class_hash: ClassHash,
}
Members
class_hash
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeLibraryDispatcher::class_hash
pub class_hash: ClassHash
VestingWalletABISafeDispatcher
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeDispatcher
Part of the group: dispatchers
[doc(group: "dispatchers")]
[derive(Copy, Drop, starknet::Store, Serde)]
pub struct VestingWalletABISafeDispatcher {
pub contract_address: ContractAddress,
}
Members
contract_address
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeDispatcher::contract_address
pub contract_address: ContractAddress
Traits
Traits
IAccessControlDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlDispatcherTrait
Part of the group: dispatchers
pub trait IAccessControlDispatcherTrait<T>
Trait functions
has_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlDispatcherTrait::has_role
fn has_role(self: T, role: felt252, account: ContractAddress) -> bool
get_role_admin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlDispatcherTrait::get_role_admin
fn get_role_admin(self: T, role: felt252) -> felt252
grant_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlDispatcherTrait::grant_role
fn grant_role(self: T, role: felt252, account: ContractAddress)
revoke_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlDispatcherTrait::revoke_role
fn revoke_role(self: T, role: felt252, account: ContractAddress)
renounce_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlDispatcherTrait::renounce_role
fn renounce_role(self: T, role: felt252, account: ContractAddress)
IAccessControlSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlSafeDispatcherTrait
Part of the group: dispatchers
pub trait IAccessControlSafeDispatcherTrait<T>
Trait functions
has_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlSafeDispatcherTrait::has_role
fn has_role(self: T, role: felt252, account: ContractAddress) -> Result<bool, Array<felt252>>
get_role_admin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlSafeDispatcherTrait::get_role_admin
fn get_role_admin(self: T, role: felt252) -> Result<felt252, Array<felt252>>
grant_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlSafeDispatcherTrait::grant_role
fn grant_role(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
revoke_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlSafeDispatcherTrait::revoke_role
fn revoke_role(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
renounce_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlSafeDispatcherTrait::renounce_role
fn renounce_role(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
IAccessControlWithDelayDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlWithDelayDispatcherTrait
Part of the group: dispatchers
pub trait IAccessControlWithDelayDispatcherTrait<T>
Trait functions
get_role_status
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlWithDelayDispatcherTrait::get_role_status
fn get_role_status(self: T, role: felt252, account: ContractAddress) -> RoleStatus
grant_role_with_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlWithDelayDispatcherTrait::grant_role_with_delay
fn grant_role_with_delay(self: T, role: felt252, account: ContractAddress, delay: u64)
IAccessControlWithDelaySafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlWithDelaySafeDispatcherTrait
Part of the group: dispatchers
pub trait IAccessControlWithDelaySafeDispatcherTrait<T>
Trait functions
get_role_status
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlWithDelaySafeDispatcherTrait::get_role_status
fn get_role_status(
self: T, role: felt252, account: ContractAddress,
) -> Result<RoleStatus, Array<felt252>>
grant_role_with_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlWithDelaySafeDispatcherTrait::grant_role_with_delay
fn grant_role_with_delay(
self: T, role: felt252, account: ContractAddress, delay: u64,
) -> Result<(), Array<felt252>>
IAccessControlCamelDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelDispatcherTrait
Part of the group: dispatchers
pub trait IAccessControlCamelDispatcherTrait<T>
Trait functions
hasRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelDispatcherTrait::hasRole
fn hasRole(self: T, role: felt252, account: ContractAddress) -> bool
getRoleAdmin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelDispatcherTrait::getRoleAdmin
fn getRoleAdmin(self: T, role: felt252) -> felt252
grantRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelDispatcherTrait::grantRole
fn grantRole(self: T, role: felt252, account: ContractAddress)
revokeRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelDispatcherTrait::revokeRole
fn revokeRole(self: T, role: felt252, account: ContractAddress)
renounceRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelDispatcherTrait::renounceRole
fn renounceRole(self: T, role: felt252, account: ContractAddress)
IAccessControlCamelSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelSafeDispatcherTrait
Part of the group: dispatchers
pub trait IAccessControlCamelSafeDispatcherTrait<T>
Trait functions
hasRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelSafeDispatcherTrait::hasRole
fn hasRole(self: T, role: felt252, account: ContractAddress) -> Result<bool, Array<felt252>>
getRoleAdmin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelSafeDispatcherTrait::getRoleAdmin
fn getRoleAdmin(self: T, role: felt252) -> Result<felt252, Array<felt252>>
grantRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelSafeDispatcherTrait::grantRole
fn grantRole(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
revokeRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelSafeDispatcherTrait::revokeRole
fn revokeRole(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
renounceRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::IAccessControlCamelSafeDispatcherTrait::renounceRole
fn renounceRole(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
AccessControlABIDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABIDispatcherTrait
Part of the group: dispatchers
pub trait AccessControlABIDispatcherTrait<T>
Trait functions
has_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABIDispatcherTrait::has_role
fn has_role(self: T, role: felt252, account: ContractAddress) -> bool
get_role_admin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABIDispatcherTrait::get_role_admin
fn get_role_admin(self: T, role: felt252) -> felt252
grant_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABIDispatcherTrait::grant_role
fn grant_role(self: T, role: felt252, account: ContractAddress)
revoke_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABIDispatcherTrait::revoke_role
fn revoke_role(self: T, role: felt252, account: ContractAddress)
renounce_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABIDispatcherTrait::renounce_role
fn renounce_role(self: T, role: felt252, account: ContractAddress)
hasRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABIDispatcherTrait::hasRole
fn hasRole(self: T, role: felt252, account: ContractAddress) -> bool
getRoleAdmin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABIDispatcherTrait::getRoleAdmin
fn getRoleAdmin(self: T, role: felt252) -> felt252
grantRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABIDispatcherTrait::grantRole
fn grantRole(self: T, role: felt252, account: ContractAddress)
revokeRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABIDispatcherTrait::revokeRole
fn revokeRole(self: T, role: felt252, account: ContractAddress)
renounceRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABIDispatcherTrait::renounceRole
fn renounceRole(self: T, role: felt252, account: ContractAddress)
get_role_status
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABIDispatcherTrait::get_role_status
fn get_role_status(self: T, role: felt252, account: ContractAddress) -> RoleStatus
grant_role_with_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABIDispatcherTrait::grant_role_with_delay
fn grant_role_with_delay(self: T, role: felt252, account: ContractAddress, delay: u64)
supports_interface
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABIDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> bool
AccessControlABISafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeDispatcherTrait
Part of the group: dispatchers
pub trait AccessControlABISafeDispatcherTrait<T>
Trait functions
has_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeDispatcherTrait::has_role
fn has_role(self: T, role: felt252, account: ContractAddress) -> Result<bool, Array<felt252>>
get_role_admin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeDispatcherTrait::get_role_admin
fn get_role_admin(self: T, role: felt252) -> Result<felt252, Array<felt252>>
grant_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeDispatcherTrait::grant_role
fn grant_role(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
revoke_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeDispatcherTrait::revoke_role
fn revoke_role(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
renounce_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeDispatcherTrait::renounce_role
fn renounce_role(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
hasRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeDispatcherTrait::hasRole
fn hasRole(self: T, role: felt252, account: ContractAddress) -> Result<bool, Array<felt252>>
getRoleAdmin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeDispatcherTrait::getRoleAdmin
fn getRoleAdmin(self: T, role: felt252) -> Result<felt252, Array<felt252>>
grantRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeDispatcherTrait::grantRole
fn grantRole(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
revokeRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeDispatcherTrait::revokeRole
fn revokeRole(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
renounceRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeDispatcherTrait::renounceRole
fn renounceRole(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
get_role_status
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeDispatcherTrait::get_role_status
fn get_role_status(
self: T, role: felt252, account: ContractAddress,
) -> Result<RoleStatus, Array<felt252>>
grant_role_with_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeDispatcherTrait::grant_role_with_delay
fn grant_role_with_delay(
self: T, role: felt252, account: ContractAddress, delay: u64,
) -> Result<(), Array<felt252>>
supports_interface
Fully qualified path: openzeppelin_interfaces::access::accesscontrol::AccessControlABISafeDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> Result<bool, Array<felt252>>
IAccessControlDefaultAdminRulesDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesDispatcherTrait
Part of the group: dispatchers
pub trait IAccessControlDefaultAdminRulesDispatcherTrait<T>
Trait functions
default_admin
Returns the address of the current DEFAULT_ADMIN_ROLE holder.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesDispatcherTrait::default_admin
fn default_admin(self: T) -> ContractAddress
pending_default_admin
Returns a tuple of a new_admin and an accept_schedule.
After the accept_schedule passes, the new_admin will be able to accept the
default_admin role by calling accept_default_admin_transfer, completing the role
transfer.
A zero value only in accept_schedule indicates no pending admin transfer.
NOTE: A zero address new_admin means that default_admin is being renounced.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesDispatcherTrait::pending_default_admin
fn pending_default_admin(self: T) -> (ContractAddress, u64)
default_admin_delay
Returns the delay required to schedule the acceptance of a default_admin transfer started.
This delay will be added to the current timestamp when calling
begin_default_admin_transfer to set the acceptance schedule.
NOTE: If a delay change has been scheduled, it will take effect as soon as the schedule passes, making this function return the new delay.
See change_default_admin_delay.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesDispatcherTrait::default_admin_delay
fn default_admin_delay(self: T) -> u64
pending_default_admin_delay
Returns a tuple of new_delay and an effect_schedule.
After the effect_schedule passes, the new_delay will get into effect immediately for
every new default_admin transfer started with begin_default_admin_transfer.
A zero value only in effect_schedule indicates no pending delay change.
NOTE: A zero value only for new_delay means that the next default_admin_delay
will be zero after the effect schedule.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesDispatcherTrait::pending_default_admin_delay
fn pending_default_admin_delay(self: T) -> (u64, u64)
begin_default_admin_transfer
Starts a default_admin transfer by setting a pending_default_admin scheduled for
acceptance after the current timestamp plus a default_admin_delay.
Requirements:
- Only can be called by the current
default_admin.
Emits a DefaultAdminRoleChangeStarted event.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesDispatcherTrait::begin_default_admin_transfer
fn begin_default_admin_transfer(self: T, new_admin: ContractAddress)
cancel_default_admin_transfer
Cancels a default_admin transfer previously started with begin_default_admin_transfer.
A pending_default_admin not yet accepted can also be canceled with this function.
Requirements:
- Only can be called by the current
default_admin.
May emit a DefaultAdminTransferCanceled event.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesDispatcherTrait::cancel_default_admin_transfer
fn cancel_default_admin_transfer(self: T)
accept_default_admin_transfer
Completes a default_admin transfer previously started with begin_default_admin_transfer.
After calling the function:
DEFAULT_ADMIN_ROLEmust be granted to the caller.DEFAULT_ADMIN_ROLEmust be revoked from the previous holder.pending_default_adminmust be reset to zero value.
Requirements:
- Only can be called by the
pending_default_admin’snew_admin. - The
pending_default_admin’saccept_scheduleshould’ve passed.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesDispatcherTrait::accept_default_admin_transfer
fn accept_default_admin_transfer(self: T)
change_default_admin_delay
Initiates a default_admin_delay update by setting a pending_default_admin_delay
scheduled to take effect after the current timestamp plus a default_admin_delay.
This function guarantees that any call to begin_default_admin_transfer done between the
timestamp this method is called at and the pending_default_admin_delay effect schedule
will use the current default_admin_delay set before calling.
The pending_default_admin_delay’s effect schedule is defined in a way that waiting until
the schedule and then calling begin_default_admin_transfer with the new delay will take at
least the same as another default_admin complete transfer (including acceptance).
The schedule is designed for two scenarios:
- When the delay is changed for a larger one the schedule is
block.timestamp + new delaycapped bydefault_admin_delay_increase_wait. - When the delay is changed for a shorter one, the schedule is
block.timestamp + (current delay - new delay).
A pending_default_admin_delay that never got into effect will be canceled in favor of a
new scheduled change.
Requirements:
- Only can be called by the current
default_admin.
Emits a DefaultAdminDelayChangeScheduled event and may emit a
DefaultAdminDelayChangeCanceled event.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesDispatcherTrait::change_default_admin_delay
fn change_default_admin_delay(self: T, new_delay: u64)
rollback_default_admin_delay
Cancels a scheduled default_admin_delay change.
Requirements:
- Only can be called by the current
default_admin.
May emit a DefaultAdminDelayChangeCanceled event.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesDispatcherTrait::rollback_default_admin_delay
fn rollback_default_admin_delay(self: T)
default_admin_delay_increase_wait
Maximum time in seconds for an increase to default_admin_delay (that is scheduled
using change_default_admin_delay) to take effect.
IMPORTANT:
Make sure to add a reasonable amount of time while setting this value, otherwise, there’s a risk of setting a high new delay that goes into effect almost immediately without the possibility of human intervention in the case of an input error (eg. set milliseconds instead of seconds).
Consider carefully the value set for maximum_default_admin_transfer_delay too, since
it will affect how fast you can recover from an accidental delay increase.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesDispatcherTrait::default_admin_delay_increase_wait
fn default_admin_delay_increase_wait(self: T) -> u64
maximum_default_admin_transfer_delay
Maximum time in seconds for a default_admin transfer delay.
IMPORTANT:
If this value is set too high, you might be unable to recover
from an accidental delay increase for an extended period. Too low, and it unnecessarily
restricts how much security delay you can impose for default_admin transfers. As a best
practice, consider setting it in the 30-60 day range for a good balance between security and
recoverability.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesDispatcherTrait::maximum_default_admin_transfer_delay
fn maximum_default_admin_transfer_delay(self: T) -> u64
IAccessControlDefaultAdminRulesSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesSafeDispatcherTrait
Part of the group: dispatchers
pub trait IAccessControlDefaultAdminRulesSafeDispatcherTrait<T>
Trait functions
default_admin
Returns the address of the current DEFAULT_ADMIN_ROLE holder.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesSafeDispatcherTrait::default_admin
fn default_admin(self: T) -> Result<ContractAddress, Array<felt252>>
pending_default_admin
Returns a tuple of a new_admin and an accept_schedule.
After the accept_schedule passes, the new_admin will be able to accept the
default_admin role by calling accept_default_admin_transfer, completing the role
transfer.
A zero value only in accept_schedule indicates no pending admin transfer.
NOTE: A zero address new_admin means that default_admin is being renounced.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesSafeDispatcherTrait::pending_default_admin
fn pending_default_admin(self: T) -> Result<(ContractAddress, u64), Array<felt252>>
default_admin_delay
Returns the delay required to schedule the acceptance of a default_admin transfer started.
This delay will be added to the current timestamp when calling
begin_default_admin_transfer to set the acceptance schedule.
NOTE: If a delay change has been scheduled, it will take effect as soon as the schedule passes, making this function return the new delay.
See change_default_admin_delay.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesSafeDispatcherTrait::default_admin_delay
fn default_admin_delay(self: T) -> Result<u64, Array<felt252>>
pending_default_admin_delay
Returns a tuple of new_delay and an effect_schedule.
After the effect_schedule passes, the new_delay will get into effect immediately for
every new default_admin transfer started with begin_default_admin_transfer.
A zero value only in effect_schedule indicates no pending delay change.
NOTE: A zero value only for new_delay means that the next default_admin_delay
will be zero after the effect schedule.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesSafeDispatcherTrait::pending_default_admin_delay
fn pending_default_admin_delay(self: T) -> Result<(u64, u64), Array<felt252>>
begin_default_admin_transfer
Starts a default_admin transfer by setting a pending_default_admin scheduled for
acceptance after the current timestamp plus a default_admin_delay.
Requirements:
- Only can be called by the current
default_admin.
Emits a DefaultAdminRoleChangeStarted event.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesSafeDispatcherTrait::begin_default_admin_transfer
fn begin_default_admin_transfer(self: T, new_admin: ContractAddress) -> Result<(), Array<felt252>>
cancel_default_admin_transfer
Cancels a default_admin transfer previously started with begin_default_admin_transfer.
A pending_default_admin not yet accepted can also be canceled with this function.
Requirements:
- Only can be called by the current
default_admin.
May emit a DefaultAdminTransferCanceled event.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesSafeDispatcherTrait::cancel_default_admin_transfer
fn cancel_default_admin_transfer(self: T) -> Result<(), Array<felt252>>
accept_default_admin_transfer
Completes a default_admin transfer previously started with begin_default_admin_transfer.
After calling the function:
DEFAULT_ADMIN_ROLEmust be granted to the caller.DEFAULT_ADMIN_ROLEmust be revoked from the previous holder.pending_default_adminmust be reset to zero value.
Requirements:
- Only can be called by the
pending_default_admin’snew_admin. - The
pending_default_admin’saccept_scheduleshould’ve passed.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesSafeDispatcherTrait::accept_default_admin_transfer
fn accept_default_admin_transfer(self: T) -> Result<(), Array<felt252>>
change_default_admin_delay
Initiates a default_admin_delay update by setting a pending_default_admin_delay
scheduled to take effect after the current timestamp plus a default_admin_delay.
This function guarantees that any call to begin_default_admin_transfer done between the
timestamp this method is called at and the pending_default_admin_delay effect schedule
will use the current default_admin_delay set before calling.
The pending_default_admin_delay’s effect schedule is defined in a way that waiting until
the schedule and then calling begin_default_admin_transfer with the new delay will take at
least the same as another default_admin complete transfer (including acceptance).
The schedule is designed for two scenarios:
- When the delay is changed for a larger one the schedule is
block.timestamp + new delaycapped bydefault_admin_delay_increase_wait. - When the delay is changed for a shorter one, the schedule is
block.timestamp + (current delay - new delay).
A pending_default_admin_delay that never got into effect will be canceled in favor of a
new scheduled change.
Requirements:
- Only can be called by the current
default_admin.
Emits a DefaultAdminDelayChangeScheduled event and may emit a
DefaultAdminDelayChangeCanceled event.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesSafeDispatcherTrait::change_default_admin_delay
fn change_default_admin_delay(self: T, new_delay: u64) -> Result<(), Array<felt252>>
rollback_default_admin_delay
Cancels a scheduled default_admin_delay change.
Requirements:
- Only can be called by the current
default_admin.
May emit a DefaultAdminDelayChangeCanceled event.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesSafeDispatcherTrait::rollback_default_admin_delay
fn rollback_default_admin_delay(self: T) -> Result<(), Array<felt252>>
default_admin_delay_increase_wait
Maximum time in seconds for an increase to default_admin_delay (that is scheduled
using change_default_admin_delay) to take effect.
IMPORTANT:
Make sure to add a reasonable amount of time while setting this value, otherwise, there’s a risk of setting a high new delay that goes into effect almost immediately without the possibility of human intervention in the case of an input error (eg. set milliseconds instead of seconds).
Consider carefully the value set for maximum_default_admin_transfer_delay too, since
it will affect how fast you can recover from an accidental delay increase.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesSafeDispatcherTrait::default_admin_delay_increase_wait
fn default_admin_delay_increase_wait(self: T) -> Result<u64, Array<felt252>>
maximum_default_admin_transfer_delay
Maximum time in seconds for a default_admin transfer delay.
IMPORTANT:
If this value is set too high, you might be unable to recover
from an accidental delay increase for an extended period. Too low, and it unnecessarily
restricts how much security delay you can impose for default_admin transfers. As a best
practice, consider setting it in the 30-60 day range for a good balance between security and
recoverability.
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::IAccessControlDefaultAdminRulesSafeDispatcherTrait::maximum_default_admin_transfer_delay
fn maximum_default_admin_transfer_delay(self: T) -> Result<u64, Array<felt252>>
AccessControlDefaultAdminRulesABIDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait
Part of the group: dispatchers
pub trait AccessControlDefaultAdminRulesABIDispatcherTrait<T>
Trait functions
default_admin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::default_admin
fn default_admin(self: T) -> ContractAddress
pending_default_admin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::pending_default_admin
fn pending_default_admin(self: T) -> (ContractAddress, u64)
default_admin_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::default_admin_delay
fn default_admin_delay(self: T) -> u64
pending_default_admin_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::pending_default_admin_delay
fn pending_default_admin_delay(self: T) -> (u64, u64)
begin_default_admin_transfer
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::begin_default_admin_transfer
fn begin_default_admin_transfer(self: T, new_admin: ContractAddress)
cancel_default_admin_transfer
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::cancel_default_admin_transfer
fn cancel_default_admin_transfer(self: T)
accept_default_admin_transfer
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::accept_default_admin_transfer
fn accept_default_admin_transfer(self: T)
change_default_admin_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::change_default_admin_delay
fn change_default_admin_delay(self: T, new_delay: u64)
rollback_default_admin_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::rollback_default_admin_delay
fn rollback_default_admin_delay(self: T)
default_admin_delay_increase_wait
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::default_admin_delay_increase_wait
fn default_admin_delay_increase_wait(self: T) -> u64
has_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::has_role
fn has_role(self: T, role: felt252, account: ContractAddress) -> bool
get_role_admin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::get_role_admin
fn get_role_admin(self: T, role: felt252) -> felt252
grant_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::grant_role
fn grant_role(self: T, role: felt252, account: ContractAddress)
revoke_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::revoke_role
fn revoke_role(self: T, role: felt252, account: ContractAddress)
renounce_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::renounce_role
fn renounce_role(self: T, role: felt252, account: ContractAddress)
hasRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::hasRole
fn hasRole(self: T, role: felt252, account: ContractAddress) -> bool
getRoleAdmin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::getRoleAdmin
fn getRoleAdmin(self: T, role: felt252) -> felt252
grantRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::grantRole
fn grantRole(self: T, role: felt252, account: ContractAddress)
revokeRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::revokeRole
fn revokeRole(self: T, role: felt252, account: ContractAddress)
renounceRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::renounceRole
fn renounceRole(self: T, role: felt252, account: ContractAddress)
get_role_status
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::get_role_status
fn get_role_status(self: T, role: felt252, account: ContractAddress) -> RoleStatus
grant_role_with_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::grant_role_with_delay
fn grant_role_with_delay(self: T, role: felt252, account: ContractAddress, delay: u64)
supports_interface
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABIDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> bool
AccessControlDefaultAdminRulesABISafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait
Part of the group: dispatchers
pub trait AccessControlDefaultAdminRulesABISafeDispatcherTrait<T>
Trait functions
default_admin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::default_admin
fn default_admin(self: T) -> Result<ContractAddress, Array<felt252>>
pending_default_admin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::pending_default_admin
fn pending_default_admin(self: T) -> Result<(ContractAddress, u64), Array<felt252>>
default_admin_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::default_admin_delay
fn default_admin_delay(self: T) -> Result<u64, Array<felt252>>
pending_default_admin_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::pending_default_admin_delay
fn pending_default_admin_delay(self: T) -> Result<(u64, u64), Array<felt252>>
begin_default_admin_transfer
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::begin_default_admin_transfer
fn begin_default_admin_transfer(self: T, new_admin: ContractAddress) -> Result<(), Array<felt252>>
cancel_default_admin_transfer
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::cancel_default_admin_transfer
fn cancel_default_admin_transfer(self: T) -> Result<(), Array<felt252>>
accept_default_admin_transfer
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::accept_default_admin_transfer
fn accept_default_admin_transfer(self: T) -> Result<(), Array<felt252>>
change_default_admin_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::change_default_admin_delay
fn change_default_admin_delay(self: T, new_delay: u64) -> Result<(), Array<felt252>>
rollback_default_admin_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::rollback_default_admin_delay
fn rollback_default_admin_delay(self: T) -> Result<(), Array<felt252>>
default_admin_delay_increase_wait
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::default_admin_delay_increase_wait
fn default_admin_delay_increase_wait(self: T) -> Result<u64, Array<felt252>>
has_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::has_role
fn has_role(self: T, role: felt252, account: ContractAddress) -> Result<bool, Array<felt252>>
get_role_admin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::get_role_admin
fn get_role_admin(self: T, role: felt252) -> Result<felt252, Array<felt252>>
grant_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::grant_role
fn grant_role(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
revoke_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::revoke_role
fn revoke_role(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
renounce_role
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::renounce_role
fn renounce_role(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
hasRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::hasRole
fn hasRole(self: T, role: felt252, account: ContractAddress) -> Result<bool, Array<felt252>>
getRoleAdmin
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::getRoleAdmin
fn getRoleAdmin(self: T, role: felt252) -> Result<felt252, Array<felt252>>
grantRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::grantRole
fn grantRole(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
revokeRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::revokeRole
fn revokeRole(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
renounceRole
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::renounceRole
fn renounceRole(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
get_role_status
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::get_role_status
fn get_role_status(
self: T, role: felt252, account: ContractAddress,
) -> Result<RoleStatus, Array<felt252>>
grant_role_with_delay
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::grant_role_with_delay
fn grant_role_with_delay(
self: T, role: felt252, account: ContractAddress, delay: u64,
) -> Result<(), Array<felt252>>
supports_interface
Fully qualified path: openzeppelin_interfaces::access::accesscontrol_default_admin_rules::AccessControlDefaultAdminRulesABISafeDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> Result<bool, Array<felt252>>
IOwnableDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableDispatcherTrait
Part of the group: dispatchers
pub trait IOwnableDispatcherTrait<T>
Trait functions
owner
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableDispatcherTrait::owner
fn owner(self: T) -> ContractAddress
transfer_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableDispatcherTrait::transfer_ownership
fn transfer_ownership(self: T, new_owner: ContractAddress)
renounce_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableDispatcherTrait::renounce_ownership
fn renounce_ownership(self: T)
IOwnableSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableSafeDispatcherTrait
Part of the group: dispatchers
pub trait IOwnableSafeDispatcherTrait<T>
Trait functions
owner
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableSafeDispatcherTrait::owner
fn owner(self: T) -> Result<ContractAddress, Array<felt252>>
transfer_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableSafeDispatcherTrait::transfer_ownership
fn transfer_ownership(self: T, new_owner: ContractAddress) -> Result<(), Array<felt252>>
renounce_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableSafeDispatcherTrait::renounce_ownership
fn renounce_ownership(self: T) -> Result<(), Array<felt252>>
IOwnableCamelOnlyDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableCamelOnlyDispatcherTrait
Part of the group: dispatchers
pub trait IOwnableCamelOnlyDispatcherTrait<T>
Trait functions
transferOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableCamelOnlyDispatcherTrait::transferOwnership
fn transferOwnership(self: T, newOwner: ContractAddress)
renounceOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableCamelOnlyDispatcherTrait::renounceOwnership
fn renounceOwnership(self: T)
IOwnableCamelOnlySafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableCamelOnlySafeDispatcherTrait
Part of the group: dispatchers
pub trait IOwnableCamelOnlySafeDispatcherTrait<T>
Trait functions
transferOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableCamelOnlySafeDispatcherTrait::transferOwnership
fn transferOwnership(self: T, newOwner: ContractAddress) -> Result<(), Array<felt252>>
renounceOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableCamelOnlySafeDispatcherTrait::renounceOwnership
fn renounceOwnership(self: T) -> Result<(), Array<felt252>>
OwnableABIDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABIDispatcherTrait
Part of the group: dispatchers
pub trait OwnableABIDispatcherTrait<T>
Trait functions
owner
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABIDispatcherTrait::owner
fn owner(self: T) -> ContractAddress
transfer_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABIDispatcherTrait::transfer_ownership
fn transfer_ownership(self: T, new_owner: ContractAddress)
renounce_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABIDispatcherTrait::renounce_ownership
fn renounce_ownership(self: T)
transferOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABIDispatcherTrait::transferOwnership
fn transferOwnership(self: T, newOwner: ContractAddress)
renounceOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABIDispatcherTrait::renounceOwnership
fn renounceOwnership(self: T)
OwnableABISafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABISafeDispatcherTrait
Part of the group: dispatchers
pub trait OwnableABISafeDispatcherTrait<T>
Trait functions
owner
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABISafeDispatcherTrait::owner
fn owner(self: T) -> Result<ContractAddress, Array<felt252>>
transfer_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABISafeDispatcherTrait::transfer_ownership
fn transfer_ownership(self: T, new_owner: ContractAddress) -> Result<(), Array<felt252>>
renounce_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABISafeDispatcherTrait::renounce_ownership
fn renounce_ownership(self: T) -> Result<(), Array<felt252>>
transferOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABISafeDispatcherTrait::transferOwnership
fn transferOwnership(self: T, newOwner: ContractAddress) -> Result<(), Array<felt252>>
renounceOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableABISafeDispatcherTrait::renounceOwnership
fn renounceOwnership(self: T) -> Result<(), Array<felt252>>
IOwnableTwoStepDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepDispatcherTrait
Part of the group: dispatchers
pub trait IOwnableTwoStepDispatcherTrait<T>
Trait functions
owner
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepDispatcherTrait::owner
fn owner(self: T) -> ContractAddress
pending_owner
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepDispatcherTrait::pending_owner
fn pending_owner(self: T) -> ContractAddress
accept_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepDispatcherTrait::accept_ownership
fn accept_ownership(self: T)
transfer_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepDispatcherTrait::transfer_ownership
fn transfer_ownership(self: T, new_owner: ContractAddress)
renounce_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepDispatcherTrait::renounce_ownership
fn renounce_ownership(self: T)
IOwnableTwoStepSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepSafeDispatcherTrait
Part of the group: dispatchers
pub trait IOwnableTwoStepSafeDispatcherTrait<T>
Trait functions
owner
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepSafeDispatcherTrait::owner
fn owner(self: T) -> Result<ContractAddress, Array<felt252>>
pending_owner
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepSafeDispatcherTrait::pending_owner
fn pending_owner(self: T) -> Result<ContractAddress, Array<felt252>>
accept_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepSafeDispatcherTrait::accept_ownership
fn accept_ownership(self: T) -> Result<(), Array<felt252>>
transfer_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepSafeDispatcherTrait::transfer_ownership
fn transfer_ownership(self: T, new_owner: ContractAddress) -> Result<(), Array<felt252>>
renounce_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepSafeDispatcherTrait::renounce_ownership
fn renounce_ownership(self: T) -> Result<(), Array<felt252>>
IOwnableTwoStepCamelOnlyDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlyDispatcherTrait
Part of the group: dispatchers
pub trait IOwnableTwoStepCamelOnlyDispatcherTrait<T>
Trait functions
pendingOwner
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlyDispatcherTrait::pendingOwner
fn pendingOwner(self: T) -> ContractAddress
acceptOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlyDispatcherTrait::acceptOwnership
fn acceptOwnership(self: T)
transferOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlyDispatcherTrait::transferOwnership
fn transferOwnership(self: T, newOwner: ContractAddress)
renounceOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlyDispatcherTrait::renounceOwnership
fn renounceOwnership(self: T)
IOwnableTwoStepCamelOnlySafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlySafeDispatcherTrait
Part of the group: dispatchers
pub trait IOwnableTwoStepCamelOnlySafeDispatcherTrait<T>
Trait functions
pendingOwner
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlySafeDispatcherTrait::pendingOwner
fn pendingOwner(self: T) -> Result<ContractAddress, Array<felt252>>
acceptOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlySafeDispatcherTrait::acceptOwnership
fn acceptOwnership(self: T) -> Result<(), Array<felt252>>
transferOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlySafeDispatcherTrait::transferOwnership
fn transferOwnership(self: T, newOwner: ContractAddress) -> Result<(), Array<felt252>>
renounceOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::IOwnableTwoStepCamelOnlySafeDispatcherTrait::renounceOwnership
fn renounceOwnership(self: T) -> Result<(), Array<felt252>>
OwnableTwoStepABIDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABIDispatcherTrait
Part of the group: dispatchers
pub trait OwnableTwoStepABIDispatcherTrait<T>
Trait functions
owner
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABIDispatcherTrait::owner
fn owner(self: T) -> ContractAddress
pending_owner
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABIDispatcherTrait::pending_owner
fn pending_owner(self: T) -> ContractAddress
accept_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABIDispatcherTrait::accept_ownership
fn accept_ownership(self: T)
transfer_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABIDispatcherTrait::transfer_ownership
fn transfer_ownership(self: T, new_owner: ContractAddress)
renounce_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABIDispatcherTrait::renounce_ownership
fn renounce_ownership(self: T)
pendingOwner
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABIDispatcherTrait::pendingOwner
fn pendingOwner(self: T) -> ContractAddress
acceptOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABIDispatcherTrait::acceptOwnership
fn acceptOwnership(self: T)
transferOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABIDispatcherTrait::transferOwnership
fn transferOwnership(self: T, newOwner: ContractAddress)
renounceOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABIDispatcherTrait::renounceOwnership
fn renounceOwnership(self: T)
OwnableTwoStepABISafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABISafeDispatcherTrait
Part of the group: dispatchers
pub trait OwnableTwoStepABISafeDispatcherTrait<T>
Trait functions
owner
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABISafeDispatcherTrait::owner
fn owner(self: T) -> Result<ContractAddress, Array<felt252>>
pending_owner
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABISafeDispatcherTrait::pending_owner
fn pending_owner(self: T) -> Result<ContractAddress, Array<felt252>>
accept_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABISafeDispatcherTrait::accept_ownership
fn accept_ownership(self: T) -> Result<(), Array<felt252>>
transfer_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABISafeDispatcherTrait::transfer_ownership
fn transfer_ownership(self: T, new_owner: ContractAddress) -> Result<(), Array<felt252>>
renounce_ownership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABISafeDispatcherTrait::renounce_ownership
fn renounce_ownership(self: T) -> Result<(), Array<felt252>>
pendingOwner
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABISafeDispatcherTrait::pendingOwner
fn pendingOwner(self: T) -> Result<ContractAddress, Array<felt252>>
acceptOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABISafeDispatcherTrait::acceptOwnership
fn acceptOwnership(self: T) -> Result<(), Array<felt252>>
transferOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABISafeDispatcherTrait::transferOwnership
fn transferOwnership(self: T, newOwner: ContractAddress) -> Result<(), Array<felt252>>
renounceOwnership
Fully qualified path: openzeppelin_interfaces::access::ownable::OwnableTwoStepABISafeDispatcherTrait::renounceOwnership
fn renounceOwnership(self: T) -> Result<(), Array<felt252>>
ISRC6DispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6DispatcherTrait
Part of the group: dispatchers
pub trait ISRC6DispatcherTrait<T>
Trait functions
execute
Executes a list of calls from the account.
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6DispatcherTrait::execute
fn __execute__(self: T, calls: Array<Call>)
validate
Validates a transaction before execution.
This function is used by the protocol to verify invoke transactions.
Returns the short string ‘VALID’ if valid, otherwise it reverts.
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6DispatcherTrait::validate
fn __validate__(self: T, calls: Array<Call>) -> felt252
is_valid_signature
Verifies that the given signature is valid for the given hash.
Returns the short string ‘VALID’ if valid, otherwise returns 0.
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6DispatcherTrait::is_valid_signature
fn is_valid_signature(self: T, hash: felt252, signature: Array<felt252>) -> felt252
ISRC6SafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6SafeDispatcherTrait
Part of the group: dispatchers
pub trait ISRC6SafeDispatcherTrait<T>
Trait functions
execute
Executes a list of calls from the account.
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6SafeDispatcherTrait::execute
fn __execute__(self: T, calls: Array<Call>) -> Result<(), Array<felt252>>
validate
Validates a transaction before execution.
This function is used by the protocol to verify invoke transactions.
Returns the short string ‘VALID’ if valid, otherwise it reverts.
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6SafeDispatcherTrait::validate
fn __validate__(self: T, calls: Array<Call>) -> Result<felt252, Array<felt252>>
is_valid_signature
Verifies that the given signature is valid for the given hash.
Returns the short string ‘VALID’ if valid, otherwise returns 0.
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6SafeDispatcherTrait::is_valid_signature
fn is_valid_signature(
self: T, hash: felt252, signature: Array<felt252>,
) -> Result<felt252, Array<felt252>>
IDeclarerDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeclarerDispatcherTrait
Part of the group: dispatchers
pub trait IDeclarerDispatcherTrait<T>
Trait functions
validate_declare
Validates a transaction before declaration.
This function is used by the protocol to verify declare transactions.
Returns the short string ‘VALID’ if valid, otherwise it reverts.
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeclarerDispatcherTrait::validate_declare
fn __validate_declare__(self: T, class_hash: felt252) -> felt252
IDeclarerSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeclarerSafeDispatcherTrait
Part of the group: dispatchers
pub trait IDeclarerSafeDispatcherTrait<T>
Trait functions
validate_declare
Validates a transaction before declaration.
This function is used by the protocol to verify declare transactions.
Returns the short string ‘VALID’ if valid, otherwise it reverts.
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeclarerSafeDispatcherTrait::validate_declare
fn __validate_declare__(self: T, class_hash: felt252) -> Result<felt252, Array<felt252>>
IDeployableDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeployableDispatcherTrait
Part of the group: dispatchers
pub trait IDeployableDispatcherTrait<T>
Trait functions
validate_deploy
Validates a transaction before deployment.
This function is used by the protocol to verify deploy_account transactions.
Returns the short string ‘VALID’ if valid, otherwise it reverts.
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeployableDispatcherTrait::validate_deploy
fn __validate_deploy__(
self: T, class_hash: felt252, contract_address_salt: felt252, public_key: felt252,
) -> felt252
IDeployableSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeployableSafeDispatcherTrait
Part of the group: dispatchers
pub trait IDeployableSafeDispatcherTrait<T>
Trait functions
validate_deploy
Validates a transaction before deployment.
This function is used by the protocol to verify deploy_account transactions.
Returns the short string ‘VALID’ if valid, otherwise it reverts.
Fully qualified path: openzeppelin_interfaces::account::accounts::IDeployableSafeDispatcherTrait::validate_deploy
fn __validate_deploy__(
self: T, class_hash: felt252, contract_address_salt: felt252, public_key: felt252,
) -> Result<felt252, Array<felt252>>
IPublicKeyDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyDispatcherTrait
Part of the group: dispatchers
pub trait IPublicKeyDispatcherTrait<T>
Trait functions
get_public_key
Returns the current public key of the account.
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyDispatcherTrait::get_public_key
fn get_public_key(self: T) -> felt252
set_public_key
Sets the public key of the account to new_public_key.
Emits both an OwnerRemoved and an OwnerAdded event.
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyDispatcherTrait::set_public_key
fn set_public_key(self: T, new_public_key: felt252, signature: Span<felt252>)
IPublicKeySafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeySafeDispatcherTrait
Part of the group: dispatchers
pub trait IPublicKeySafeDispatcherTrait<T>
Trait functions
get_public_key
Returns the current public key of the account.
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeySafeDispatcherTrait::get_public_key
fn get_public_key(self: T) -> Result<felt252, Array<felt252>>
set_public_key
Sets the public key of the account to new_public_key.
Emits both an OwnerRemoved and an OwnerAdded event.
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeySafeDispatcherTrait::set_public_key
fn set_public_key(
self: T, new_public_key: felt252, signature: Span<felt252>,
) -> Result<(), Array<felt252>>
ISRC6CamelOnlyDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6CamelOnlyDispatcherTrait
Part of the group: dispatchers
pub trait ISRC6CamelOnlyDispatcherTrait<T>
Trait functions
isValidSignature
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6CamelOnlyDispatcherTrait::isValidSignature
fn isValidSignature(self: T, hash: felt252, signature: Array<felt252>) -> felt252
ISRC6CamelOnlySafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6CamelOnlySafeDispatcherTrait
Part of the group: dispatchers
pub trait ISRC6CamelOnlySafeDispatcherTrait<T>
Trait functions
isValidSignature
Fully qualified path: openzeppelin_interfaces::account::accounts::ISRC6CamelOnlySafeDispatcherTrait::isValidSignature
fn isValidSignature(
self: T, hash: felt252, signature: Array<felt252>,
) -> Result<felt252, Array<felt252>>
IPublicKeyCamelDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyCamelDispatcherTrait
Part of the group: dispatchers
pub trait IPublicKeyCamelDispatcherTrait<T>
Trait functions
getPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyCamelDispatcherTrait::getPublicKey
fn getPublicKey(self: T) -> felt252
setPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyCamelDispatcherTrait::setPublicKey
fn setPublicKey(self: T, newPublicKey: felt252, signature: Span<felt252>)
IPublicKeyCamelSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyCamelSafeDispatcherTrait
Part of the group: dispatchers
pub trait IPublicKeyCamelSafeDispatcherTrait<T>
Trait functions
getPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyCamelSafeDispatcherTrait::getPublicKey
fn getPublicKey(self: T) -> Result<felt252, Array<felt252>>
setPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::IPublicKeyCamelSafeDispatcherTrait::setPublicKey
fn setPublicKey(
self: T, newPublicKey: felt252, signature: Span<felt252>,
) -> Result<(), Array<felt252>>
AccountABIDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABIDispatcherTrait
Part of the group: dispatchers
pub trait AccountABIDispatcherTrait<T>
Trait functions
execute
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABIDispatcherTrait::execute
fn __execute__(self: T, calls: Array<Call>)
validate
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABIDispatcherTrait::validate
fn __validate__(self: T, calls: Array<Call>) -> felt252
is_valid_signature
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABIDispatcherTrait::is_valid_signature
fn is_valid_signature(self: T, hash: felt252, signature: Array<felt252>) -> felt252
supports_interface
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABIDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> bool
validate_declare
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABIDispatcherTrait::validate_declare
fn __validate_declare__(self: T, class_hash: felt252) -> felt252
validate_deploy
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABIDispatcherTrait::validate_deploy
fn __validate_deploy__(
self: T, class_hash: felt252, contract_address_salt: felt252, public_key: felt252,
) -> felt252
get_public_key
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABIDispatcherTrait::get_public_key
fn get_public_key(self: T) -> felt252
set_public_key
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABIDispatcherTrait::set_public_key
fn set_public_key(self: T, new_public_key: felt252, signature: Span<felt252>)
isValidSignature
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABIDispatcherTrait::isValidSignature
fn isValidSignature(self: T, hash: felt252, signature: Array<felt252>) -> felt252
getPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABIDispatcherTrait::getPublicKey
fn getPublicKey(self: T) -> felt252
setPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABIDispatcherTrait::setPublicKey
fn setPublicKey(self: T, newPublicKey: felt252, signature: Span<felt252>)
AccountABISafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABISafeDispatcherTrait
Part of the group: dispatchers
pub trait AccountABISafeDispatcherTrait<T>
Trait functions
execute
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABISafeDispatcherTrait::execute
fn __execute__(self: T, calls: Array<Call>) -> Result<(), Array<felt252>>
validate
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABISafeDispatcherTrait::validate
fn __validate__(self: T, calls: Array<Call>) -> Result<felt252, Array<felt252>>
is_valid_signature
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABISafeDispatcherTrait::is_valid_signature
fn is_valid_signature(
self: T, hash: felt252, signature: Array<felt252>,
) -> Result<felt252, Array<felt252>>
supports_interface
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABISafeDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> Result<bool, Array<felt252>>
validate_declare
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABISafeDispatcherTrait::validate_declare
fn __validate_declare__(self: T, class_hash: felt252) -> Result<felt252, Array<felt252>>
validate_deploy
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABISafeDispatcherTrait::validate_deploy
fn __validate_deploy__(
self: T, class_hash: felt252, contract_address_salt: felt252, public_key: felt252,
) -> Result<felt252, Array<felt252>>
get_public_key
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABISafeDispatcherTrait::get_public_key
fn get_public_key(self: T) -> Result<felt252, Array<felt252>>
set_public_key
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABISafeDispatcherTrait::set_public_key
fn set_public_key(
self: T, new_public_key: felt252, signature: Span<felt252>,
) -> Result<(), Array<felt252>>
isValidSignature
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABISafeDispatcherTrait::isValidSignature
fn isValidSignature(
self: T, hash: felt252, signature: Array<felt252>,
) -> Result<felt252, Array<felt252>>
getPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABISafeDispatcherTrait::getPublicKey
fn getPublicKey(self: T) -> Result<felt252, Array<felt252>>
setPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::AccountABISafeDispatcherTrait::setPublicKey
fn setPublicKey(
self: T, newPublicKey: felt252, signature: Span<felt252>,
) -> Result<(), Array<felt252>>
IEthDeployableDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthDeployableDispatcherTrait
Part of the group: dispatchers
pub trait IEthDeployableDispatcherTrait<T>
Trait functions
validate_deploy
Validates a transaction before deployment.
This function is used by the protocol to verify deploy_account transactions.
Returns the short string ‘VALID’ if valid, otherwise it reverts.
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthDeployableDispatcherTrait::validate_deploy
fn __validate_deploy__(
self: T, class_hash: felt252, contract_address_salt: felt252, public_key: Secp256k1Point,
) -> felt252
IEthDeployableSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthDeployableSafeDispatcherTrait
Part of the group: dispatchers
pub trait IEthDeployableSafeDispatcherTrait<T>
Trait functions
validate_deploy
Validates a transaction before deployment.
This function is used by the protocol to verify deploy_account transactions.
Returns the short string ‘VALID’ if valid, otherwise it reverts.
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthDeployableSafeDispatcherTrait::validate_deploy
fn __validate_deploy__(
self: T, class_hash: felt252, contract_address_salt: felt252, public_key: Secp256k1Point,
) -> Result<felt252, Array<felt252>>
IEthPublicKeyDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyDispatcherTrait
Part of the group: dispatchers
pub trait IEthPublicKeyDispatcherTrait<T>
Trait functions
get_public_key
Returns the current Ethereum public key of the account.
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyDispatcherTrait::get_public_key
fn get_public_key(self: T) -> Secp256k1Point
set_public_key
Sets the Ethereum public key of the account to new_public_key.
Emits both an OwnerRemoved and an OwnerAdded event.
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyDispatcherTrait::set_public_key
fn set_public_key(self: T, new_public_key: Secp256k1Point, signature: Span<felt252>)
IEthPublicKeySafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeySafeDispatcherTrait
Part of the group: dispatchers
pub trait IEthPublicKeySafeDispatcherTrait<T>
Trait functions
get_public_key
Returns the current Ethereum public key of the account.
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeySafeDispatcherTrait::get_public_key
fn get_public_key(self: T) -> Result<Secp256k1Point, Array<felt252>>
set_public_key
Sets the Ethereum public key of the account to new_public_key.
Emits both an OwnerRemoved and an OwnerAdded event.
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeySafeDispatcherTrait::set_public_key
fn set_public_key(
self: T, new_public_key: Secp256k1Point, signature: Span<felt252>,
) -> Result<(), Array<felt252>>
IEthPublicKeyCamelDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyCamelDispatcherTrait
Part of the group: dispatchers
pub trait IEthPublicKeyCamelDispatcherTrait<T>
Trait functions
getPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyCamelDispatcherTrait::getPublicKey
fn getPublicKey(self: T) -> Secp256k1Point
setPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyCamelDispatcherTrait::setPublicKey
fn setPublicKey(self: T, newPublicKey: Secp256k1Point, signature: Span<felt252>)
IEthPublicKeyCamelSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyCamelSafeDispatcherTrait
Part of the group: dispatchers
pub trait IEthPublicKeyCamelSafeDispatcherTrait<T>
Trait functions
getPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyCamelSafeDispatcherTrait::getPublicKey
fn getPublicKey(self: T) -> Result<Secp256k1Point, Array<felt252>>
setPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::IEthPublicKeyCamelSafeDispatcherTrait::setPublicKey
fn setPublicKey(
self: T, newPublicKey: Secp256k1Point, signature: Span<felt252>,
) -> Result<(), Array<felt252>>
EthAccountABIDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABIDispatcherTrait
Part of the group: dispatchers
pub trait EthAccountABIDispatcherTrait<T>
Trait functions
execute
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABIDispatcherTrait::execute
fn __execute__(self: T, calls: Array<Call>)
validate
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABIDispatcherTrait::validate
fn __validate__(self: T, calls: Array<Call>) -> felt252
is_valid_signature
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABIDispatcherTrait::is_valid_signature
fn is_valid_signature(self: T, hash: felt252, signature: Array<felt252>) -> felt252
supports_interface
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABIDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> bool
validate_declare
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABIDispatcherTrait::validate_declare
fn __validate_declare__(self: T, class_hash: felt252) -> felt252
validate_deploy
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABIDispatcherTrait::validate_deploy
fn __validate_deploy__(
self: T, class_hash: felt252, contract_address_salt: felt252, public_key: Secp256k1Point,
) -> felt252
get_public_key
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABIDispatcherTrait::get_public_key
fn get_public_key(self: T) -> Secp256k1Point
set_public_key
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABIDispatcherTrait::set_public_key
fn set_public_key(self: T, new_public_key: Secp256k1Point, signature: Span<felt252>)
isValidSignature
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABIDispatcherTrait::isValidSignature
fn isValidSignature(self: T, hash: felt252, signature: Array<felt252>) -> felt252
getPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABIDispatcherTrait::getPublicKey
fn getPublicKey(self: T) -> Secp256k1Point
setPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABIDispatcherTrait::setPublicKey
fn setPublicKey(self: T, newPublicKey: Secp256k1Point, signature: Span<felt252>)
EthAccountABISafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABISafeDispatcherTrait
Part of the group: dispatchers
pub trait EthAccountABISafeDispatcherTrait<T>
Trait functions
execute
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABISafeDispatcherTrait::execute
fn __execute__(self: T, calls: Array<Call>) -> Result<(), Array<felt252>>
validate
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABISafeDispatcherTrait::validate
fn __validate__(self: T, calls: Array<Call>) -> Result<felt252, Array<felt252>>
is_valid_signature
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABISafeDispatcherTrait::is_valid_signature
fn is_valid_signature(
self: T, hash: felt252, signature: Array<felt252>,
) -> Result<felt252, Array<felt252>>
supports_interface
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABISafeDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> Result<bool, Array<felt252>>
validate_declare
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABISafeDispatcherTrait::validate_declare
fn __validate_declare__(self: T, class_hash: felt252) -> Result<felt252, Array<felt252>>
validate_deploy
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABISafeDispatcherTrait::validate_deploy
fn __validate_deploy__(
self: T, class_hash: felt252, contract_address_salt: felt252, public_key: Secp256k1Point,
) -> Result<felt252, Array<felt252>>
get_public_key
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABISafeDispatcherTrait::get_public_key
fn get_public_key(self: T) -> Result<Secp256k1Point, Array<felt252>>
set_public_key
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABISafeDispatcherTrait::set_public_key
fn set_public_key(
self: T, new_public_key: Secp256k1Point, signature: Span<felt252>,
) -> Result<(), Array<felt252>>
isValidSignature
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABISafeDispatcherTrait::isValidSignature
fn isValidSignature(
self: T, hash: felt252, signature: Array<felt252>,
) -> Result<felt252, Array<felt252>>
getPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABISafeDispatcherTrait::getPublicKey
fn getPublicKey(self: T) -> Result<Secp256k1Point, Array<felt252>>
setPublicKey
Fully qualified path: openzeppelin_interfaces::account::accounts::EthAccountABISafeDispatcherTrait::setPublicKey
fn setPublicKey(
self: T, newPublicKey: Secp256k1Point, signature: Span<felt252>,
) -> Result<(), Array<felt252>>
ISRC9_V2DispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2DispatcherTrait
Part of the group: dispatchers
pub trait ISRC9_V2DispatcherTrait<T>
Trait functions
execute_from_outside_v2
Allows anyone to submit a transaction on behalf of the account as long as they have the relevant signatures.
This method allows reentrancy. A call to __execute__ or execute_from_outside_v2 can
trigger another nested transaction to execute_from_outside_v2 thus the implementation MUST
verify that the provided signature matches the hash of outside_execution and that
nonce was not already used.
The implementation should expect version to be set to 2 in the domain separator.
Arguments:
outside_execution- The parameters of the transaction to execute.signature- A valid signature on the SNIP-12 message encoding ofoutside_execution.
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2DispatcherTrait::execute_from_outside_v2
fn execute_from_outside_v2(
self: T, outside_execution: OutsideExecution, signature: Span<felt252>,
) -> Array<Span<felt252>>
is_valid_outside_execution_nonce
Get the status of a given nonce. true if the nonce is available to use.
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2DispatcherTrait::is_valid_outside_execution_nonce
fn is_valid_outside_execution_nonce(self: T, nonce: felt252) -> bool
ISRC9_V2SafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2SafeDispatcherTrait
Part of the group: dispatchers
pub trait ISRC9_V2SafeDispatcherTrait<T>
Trait functions
execute_from_outside_v2
Allows anyone to submit a transaction on behalf of the account as long as they have the relevant signatures.
This method allows reentrancy. A call to __execute__ or execute_from_outside_v2 can
trigger another nested transaction to execute_from_outside_v2 thus the implementation MUST
verify that the provided signature matches the hash of outside_execution and that
nonce was not already used.
The implementation should expect version to be set to 2 in the domain separator.
Arguments:
outside_execution- The parameters of the transaction to execute.signature- A valid signature on the SNIP-12 message encoding ofoutside_execution.
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2SafeDispatcherTrait::execute_from_outside_v2
fn execute_from_outside_v2(
self: T, outside_execution: OutsideExecution, signature: Span<felt252>,
) -> Result<Array<Span<felt252>>, Array<felt252>>
is_valid_outside_execution_nonce
Get the status of a given nonce. true if the nonce is available to use.
Fully qualified path: openzeppelin_interfaces::account::src9::ISRC9_V2SafeDispatcherTrait::is_valid_outside_execution_nonce
fn is_valid_outside_execution_nonce(self: T, nonce: felt252) -> Result<bool, Array<felt252>>
IVestingDispatcherTrait
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingDispatcherTrait
Part of the group: dispatchers
pub trait IVestingDispatcherTrait<T>
Trait functions
start
Returns the timestamp marking the beginning of the vesting period.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingDispatcherTrait::start
fn start(self: T) -> u64
cliff
Returns the timestamp marking the end of the cliff period.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingDispatcherTrait::cliff
fn cliff(self: T) -> u64
duration
Returns the total duration of the vesting period.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingDispatcherTrait::duration
fn duration(self: T) -> u64
end
Returns the timestamp marking the end of the vesting period.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingDispatcherTrait::end
fn end(self: T) -> u64
released
Returns the already released amount for a given token.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingDispatcherTrait::released
fn released(self: T, token: ContractAddress) -> u256
releasable
Returns the amount of a given token that can be released at the time of the call.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingDispatcherTrait::releasable
fn releasable(self: T, token: ContractAddress) -> u256
vested_amount
Returns the total vested amount of a specified token at a given timestamp.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingDispatcherTrait::vested_amount
fn vested_amount(self: T, token: ContractAddress, timestamp: u64) -> u256
release
Releases the amount of a given token that has already vested.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingDispatcherTrait::release
fn release(self: T, token: ContractAddress) -> u256
IVestingSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingSafeDispatcherTrait
Part of the group: dispatchers
pub trait IVestingSafeDispatcherTrait<T>
Trait functions
start
Returns the timestamp marking the beginning of the vesting period.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingSafeDispatcherTrait::start
fn start(self: T) -> Result<u64, Array<felt252>>
cliff
Returns the timestamp marking the end of the cliff period.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingSafeDispatcherTrait::cliff
fn cliff(self: T) -> Result<u64, Array<felt252>>
duration
Returns the total duration of the vesting period.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingSafeDispatcherTrait::duration
fn duration(self: T) -> Result<u64, Array<felt252>>
end
Returns the timestamp marking the end of the vesting period.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingSafeDispatcherTrait::end
fn end(self: T) -> Result<u64, Array<felt252>>
released
Returns the already released amount for a given token.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingSafeDispatcherTrait::released
fn released(self: T, token: ContractAddress) -> Result<u256, Array<felt252>>
releasable
Returns the amount of a given token that can be released at the time of the call.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingSafeDispatcherTrait::releasable
fn releasable(self: T, token: ContractAddress) -> Result<u256, Array<felt252>>
vested_amount
Returns the total vested amount of a specified token at a given timestamp.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingSafeDispatcherTrait::vested_amount
fn vested_amount(self: T, token: ContractAddress, timestamp: u64) -> Result<u256, Array<felt252>>
release
Releases the amount of a given token that has already vested.
Fully qualified path: openzeppelin_interfaces::finance::vesting::IVestingSafeDispatcherTrait::release
fn release(self: T, token: ContractAddress) -> Result<u256, Array<felt252>>
IQuorumFractionDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionDispatcherTrait
Part of the group: dispatchers
pub trait IQuorumFractionDispatcherTrait<T>
Trait functions
token
Returns the token that voting power is sourced from.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionDispatcherTrait::token
fn token(self: T) -> ContractAddress
current_quorum_numerator
Returns the current quorum numerator.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionDispatcherTrait::current_quorum_numerator
fn current_quorum_numerator(self: T) -> u256
quorum_numerator
Returns the quorum numerator at a specific timepoint.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionDispatcherTrait::quorum_numerator
fn quorum_numerator(self: T, timepoint: u64) -> u256
quorum_denominator
Returns the quorum denominator.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionDispatcherTrait::quorum_denominator
fn quorum_denominator(self: T) -> u256
IQuorumFractionSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionSafeDispatcherTrait
Part of the group: dispatchers
pub trait IQuorumFractionSafeDispatcherTrait<T>
Trait functions
token
Returns the token that voting power is sourced from.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionSafeDispatcherTrait::token
fn token(self: T) -> Result<ContractAddress, Array<felt252>>
current_quorum_numerator
Returns the current quorum numerator.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionSafeDispatcherTrait::current_quorum_numerator
fn current_quorum_numerator(self: T) -> Result<u256, Array<felt252>>
quorum_numerator
Returns the quorum numerator at a specific timepoint.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionSafeDispatcherTrait::quorum_numerator
fn quorum_numerator(self: T, timepoint: u64) -> Result<u256, Array<felt252>>
quorum_denominator
Returns the quorum denominator.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IQuorumFractionSafeDispatcherTrait::quorum_denominator
fn quorum_denominator(self: T) -> Result<u256, Array<felt252>>
IVotesTokenDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::extensions::IVotesTokenDispatcherTrait
Part of the group: dispatchers
pub trait IVotesTokenDispatcherTrait<T>
Trait functions
token
Returns the token that voting power is sourced from.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IVotesTokenDispatcherTrait::token
fn token(self: T) -> ContractAddress
IVotesTokenSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::extensions::IVotesTokenSafeDispatcherTrait
Part of the group: dispatchers
pub trait IVotesTokenSafeDispatcherTrait<T>
Trait functions
token
Returns the token that voting power is sourced from.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IVotesTokenSafeDispatcherTrait::token
fn token(self: T) -> Result<ContractAddress, Array<felt252>>
ITimelockedDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelockedDispatcherTrait
Part of the group: dispatchers
pub trait ITimelockedDispatcherTrait<T>
Trait functions
timelock
Returns address of the associated timelock.
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelockedDispatcherTrait::timelock
fn timelock(self: T) -> ContractAddress
get_timelock_id
Returns the timelock proposal id for a given proposal id.
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelockedDispatcherTrait::get_timelock_id
fn get_timelock_id(self: T, proposal_id: felt252) -> felt252
update_timelock
Updates the associated timelock.
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelockedDispatcherTrait::update_timelock
fn update_timelock(self: T, new_timelock: ContractAddress)
ITimelockedSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelockedSafeDispatcherTrait
Part of the group: dispatchers
pub trait ITimelockedSafeDispatcherTrait<T>
Trait functions
timelock
Returns address of the associated timelock.
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelockedSafeDispatcherTrait::timelock
fn timelock(self: T) -> Result<ContractAddress, Array<felt252>>
get_timelock_id
Returns the timelock proposal id for a given proposal id.
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelockedSafeDispatcherTrait::get_timelock_id
fn get_timelock_id(self: T, proposal_id: felt252) -> Result<felt252, Array<felt252>>
update_timelock
Updates the associated timelock.
Fully qualified path: openzeppelin_interfaces::governance::extensions::ITimelockedSafeDispatcherTrait::update_timelock
fn update_timelock(self: T, new_timelock: ContractAddress) -> Result<(), Array<felt252>>
IGovernorSettingsAdminDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdminDispatcherTrait
Part of the group: dispatchers
pub trait IGovernorSettingsAdminDispatcherTrait<T>
Trait functions
set_voting_delay
Sets the voting delay.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdminDispatcherTrait::set_voting_delay
fn set_voting_delay(self: T, new_voting_delay: u64)
set_voting_period
Sets the voting period.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdminDispatcherTrait::set_voting_period
fn set_voting_period(self: T, new_voting_period: u64)
set_proposal_threshold
Sets the proposal threshold.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdminDispatcherTrait::set_proposal_threshold
fn set_proposal_threshold(self: T, new_proposal_threshold: u256)
IGovernorSettingsAdminSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdminSafeDispatcherTrait
Part of the group: dispatchers
pub trait IGovernorSettingsAdminSafeDispatcherTrait<T>
Trait functions
set_voting_delay
Sets the voting delay.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdminSafeDispatcherTrait::set_voting_delay
fn set_voting_delay(self: T, new_voting_delay: u64) -> Result<(), Array<felt252>>
set_voting_period
Sets the voting period.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdminSafeDispatcherTrait::set_voting_period
fn set_voting_period(self: T, new_voting_period: u64) -> Result<(), Array<felt252>>
set_proposal_threshold
Sets the proposal threshold.
Fully qualified path: openzeppelin_interfaces::governance::extensions::IGovernorSettingsAdminSafeDispatcherTrait::set_proposal_threshold
fn set_proposal_threshold(self: T, new_proposal_threshold: u256) -> Result<(), Array<felt252>>
IGovernorDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait
Part of the group: dispatchers
pub trait IGovernorDispatcherTrait<T>
Trait functions
name
Name of the governor instance (used in building the SNIP-12 domain separator).
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::name
fn name(self: T) -> felt252
version
Version of the governor instance (used in building SNIP-12 domain separator).
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::version
fn version(self: T) -> felt252
COUNTING_MODE
A description of the possible support values for cast_vote and the way these votes are
counted, meant to be consumed by UIs to show correct vote options and interpret the results.
The string is a URL-encoded sequence of key-value pairs that each describe one aspect, for
example support=bravo&quorum=for,abstain.
There are 2 standard keys: support and quorum.
support=bravorefers to the vote options 0 = Against, 1 = For, 2 = Abstain, as inGovernorBravo.quorum=bravomeans that only For votes are counted towards quorum.quorum=for,abstainmeans that both For and Abstain votes are counted towards quorum.
If a counting module makes use of encoded params, it should include this under a params
key with a unique name that describes the behavior. For example:
params=fractionalmight refer to a scheme where votes are divided fractionally between for/against/abstain.params=erc721might refer to a scheme where specific NFTs are delegated to vote.
NOTE: The string can be decoded by the standard
https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParamsURLSearchParams
JavaScript class.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::COUNTING_MODE
fn COUNTING_MODE(self: T) -> ByteArray
hash_proposal
Hashing function used to (re)build the proposal id from the proposal details.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::hash_proposal
fn hash_proposal(self: T, calls: Span<Call>, description_hash: felt252) -> felt252
state
Returns the state of a proposal, given its id.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::state
fn state(self: T, proposal_id: felt252) -> ProposalState
proposal_threshold
The number of votes required in order for a voter to become a proposer.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::proposal_threshold
fn proposal_threshold(self: T) -> u256
proposal_snapshot
Timepoint used to retrieve user’s votes and quorum. If using block number, the snapshot is performed at the end of this block. Hence, voting for this proposal starts at the beginning of the following block.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::proposal_snapshot
fn proposal_snapshot(self: T, proposal_id: felt252) -> u64
proposal_deadline
Timepoint at which votes close. If using block number, votes close at the end of this block, so it is possible to cast a vote during this block.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::proposal_deadline
fn proposal_deadline(self: T, proposal_id: felt252) -> u64
proposal_proposer
The account that created a proposal.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::proposal_proposer
fn proposal_proposer(self: T, proposal_id: felt252) -> ContractAddress
proposal_eta
The time when a queued proposal becomes executable (“ETA”). Unlike proposal_snapshot and
proposal_deadline, this doesn’t use the governor clock, and instead relies on the
executor’s clock which may be different. In most cases this will be a timestamp.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::proposal_eta
fn proposal_eta(self: T, proposal_id: felt252) -> u64
proposal_needs_queuing
Whether a proposal needs to be queued before execution.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::proposal_needs_queuing
fn proposal_needs_queuing(self: T, proposal_id: felt252) -> bool
voting_delay
Delay between the proposal is created and the vote starts. The unit this duration is expressed in depends on the clock (see ERC-6372) this contract uses.
This can be increased to leave time for users to buy voting power, or delegate it, before the voting of a proposal starts.
NOTE: While this function returns a u64 value, timepoints must fit into u48 according to the EIP-6372 specification. Consequently this value must fit in a u48 (when added to the current clock).
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::voting_delay
fn voting_delay(self: T) -> u64
voting_period
Delay between the vote start and vote end. The unit this duration is expressed in depends on the clock (see ERC-6372) this contract uses.
NOTE: The voting_delay can delay the start of the vote. This must be considered when
setting the voting duration compared to the voting delay.
NOTE: This value is stored when the proposal is submitted so that possible changes to the value do not affect proposals that have already been submitted.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::voting_period
fn voting_period(self: T) -> u64
quorum
Minimum number of cast voted required for a proposal to be successful.
NOTE: The timepoint parameter corresponds to the snapshot used for counting vote. This
allows the quorum to scale depending on values such as the total supply of a token at this
timepoint.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::quorum
fn quorum(self: T, timepoint: u64) -> u256
get_votes
Voting power of an account at a specific timepoint.
NOTE: This can be implemented in a number of ways, for example by reading the delegated
balance from one (or multiple) ERC20Votes tokens.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::get_votes
fn get_votes(self: T, account: ContractAddress, timepoint: u64) -> u256
get_votes_with_params
Voting power of an account at a specific timepoint given additional encoded parameters.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::get_votes_with_params
fn get_votes_with_params(
self: T, account: ContractAddress, timepoint: u64, params: Span<felt252>,
) -> u256
has_voted
Returns whether account has cast a vote on proposal_id.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::has_voted
fn has_voted(self: T, proposal_id: felt252, account: ContractAddress) -> bool
propose
Creates a new proposal. Vote start after a delay specified by voting_delay and
lasts for a duration specified by voting_period.
NOTE: The state of the Governor and targets may change between the proposal creation and its execution. This may be the result of third party actions on the targeted contracts, or other governor proposals. For example, the balance of this contract could be updated or its access control permissions may be modified, possibly compromising the proposal’s ability to execute successfully (e.g. the governor doesn’t have enough value to cover a proposal with multiple transfers).
Returns the id of the proposal.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::propose
fn propose(self: T, calls: Span<Call>, description: ByteArray) -> felt252
queue
Queue a proposal. Some governors require this step to be performed before execution can happen. If queuing is not necessary, this function may revert. Queuing a proposal requires the quorum to be reached, the vote to be successful, and the deadline to be reached.
Returns the id of the proposal.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::queue
fn queue(self: T, calls: Span<Call>, description_hash: felt252) -> felt252
execute
Execute a successful proposal. This requires the quorum to be reached, the vote to be successful, and the deadline to be reached. Depending on the governor it might also be required that the proposal was queued and that some delay passed.
NOTE: Some modules can modify the requirements for execution, for example by adding an
additional timelock (See timelock_controller).
Returns the id of the proposal.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::execute
fn execute(self: T, calls: Span<Call>, description_hash: felt252) -> felt252
cancel
Cancel a proposal. A proposal is cancellable by the proposer, but only while it is Pending state, i.e. before the vote starts.
Returns the id of the proposal.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::cancel
fn cancel(self: T, calls: Span<Call>, description_hash: felt252) -> felt252
cast_vote
Cast a vote.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::cast_vote
fn cast_vote(self: T, proposal_id: felt252, support: u8) -> u256
cast_vote_with_reason
Cast a vote with a reason.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::cast_vote_with_reason
fn cast_vote_with_reason(self: T, proposal_id: felt252, support: u8, reason: ByteArray) -> u256
cast_vote_with_reason_and_params
Cast a vote with a reason and additional serialized params.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::cast_vote_with_reason_and_params
fn cast_vote_with_reason_and_params(
self: T, proposal_id: felt252, support: u8, reason: ByteArray, params: Span<felt252>,
) -> u256
cast_vote_by_sig
Cast a vote using the voter’s signature.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::cast_vote_by_sig
fn cast_vote_by_sig(
self: T, proposal_id: felt252, support: u8, voter: ContractAddress, signature: Span<felt252>,
) -> u256
cast_vote_with_reason_and_params_by_sig
Cast a vote with a reason and additional serialized params using the voter’s
signature.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::cast_vote_with_reason_and_params_by_sig
fn cast_vote_with_reason_and_params_by_sig(
self: T,
proposal_id: felt252,
support: u8,
voter: ContractAddress,
reason: ByteArray,
params: Span<felt252>,
signature: Span<felt252>,
) -> u256
nonces
Returns the next unused nonce for an address.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::nonces
fn nonces(self: T, voter: ContractAddress) -> felt252
relay
Relays a transaction or function call to an arbitrary target.
In cases where the governance executor is some contract other than the governor itself, like when using a timelock, this function can be invoked in a governance proposal to recover tokens that were sent to the governor contract by mistake.
NOTE: If the executor is simply the governor itself, use of relay is redundant.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorDispatcherTrait::relay
fn relay(self: T, call: Call)
IGovernorSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait
Part of the group: dispatchers
pub trait IGovernorSafeDispatcherTrait<T>
Trait functions
name
Name of the governor instance (used in building the SNIP-12 domain separator).
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::name
fn name(self: T) -> Result<felt252, Array<felt252>>
version
Version of the governor instance (used in building SNIP-12 domain separator).
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::version
fn version(self: T) -> Result<felt252, Array<felt252>>
COUNTING_MODE
A description of the possible support values for cast_vote and the way these votes are
counted, meant to be consumed by UIs to show correct vote options and interpret the results.
The string is a URL-encoded sequence of key-value pairs that each describe one aspect, for
example support=bravo&quorum=for,abstain.
There are 2 standard keys: support and quorum.
support=bravorefers to the vote options 0 = Against, 1 = For, 2 = Abstain, as inGovernorBravo.quorum=bravomeans that only For votes are counted towards quorum.quorum=for,abstainmeans that both For and Abstain votes are counted towards quorum.
If a counting module makes use of encoded params, it should include this under a params
key with a unique name that describes the behavior. For example:
params=fractionalmight refer to a scheme where votes are divided fractionally between for/against/abstain.params=erc721might refer to a scheme where specific NFTs are delegated to vote.
NOTE: The string can be decoded by the standard
https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParamsURLSearchParams
JavaScript class.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::COUNTING_MODE
fn COUNTING_MODE(self: T) -> Result<ByteArray, Array<felt252>>
hash_proposal
Hashing function used to (re)build the proposal id from the proposal details.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::hash_proposal
fn hash_proposal(
self: T, calls: Span<Call>, description_hash: felt252,
) -> Result<felt252, Array<felt252>>
state
Returns the state of a proposal, given its id.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::state
fn state(self: T, proposal_id: felt252) -> Result<ProposalState, Array<felt252>>
proposal_threshold
The number of votes required in order for a voter to become a proposer.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::proposal_threshold
fn proposal_threshold(self: T) -> Result<u256, Array<felt252>>
proposal_snapshot
Timepoint used to retrieve user’s votes and quorum. If using block number, the snapshot is performed at the end of this block. Hence, voting for this proposal starts at the beginning of the following block.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::proposal_snapshot
fn proposal_snapshot(self: T, proposal_id: felt252) -> Result<u64, Array<felt252>>
proposal_deadline
Timepoint at which votes close. If using block number, votes close at the end of this block, so it is possible to cast a vote during this block.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::proposal_deadline
fn proposal_deadline(self: T, proposal_id: felt252) -> Result<u64, Array<felt252>>
proposal_proposer
The account that created a proposal.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::proposal_proposer
fn proposal_proposer(self: T, proposal_id: felt252) -> Result<ContractAddress, Array<felt252>>
proposal_eta
The time when a queued proposal becomes executable (“ETA”). Unlike proposal_snapshot and
proposal_deadline, this doesn’t use the governor clock, and instead relies on the
executor’s clock which may be different. In most cases this will be a timestamp.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::proposal_eta
fn proposal_eta(self: T, proposal_id: felt252) -> Result<u64, Array<felt252>>
proposal_needs_queuing
Whether a proposal needs to be queued before execution.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::proposal_needs_queuing
fn proposal_needs_queuing(self: T, proposal_id: felt252) -> Result<bool, Array<felt252>>
voting_delay
Delay between the proposal is created and the vote starts. The unit this duration is expressed in depends on the clock (see ERC-6372) this contract uses.
This can be increased to leave time for users to buy voting power, or delegate it, before the voting of a proposal starts.
NOTE: While this function returns a u64 value, timepoints must fit into u48 according to the EIP-6372 specification. Consequently this value must fit in a u48 (when added to the current clock).
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::voting_delay
fn voting_delay(self: T) -> Result<u64, Array<felt252>>
voting_period
Delay between the vote start and vote end. The unit this duration is expressed in depends on the clock (see ERC-6372) this contract uses.
NOTE: The voting_delay can delay the start of the vote. This must be considered when
setting the voting duration compared to the voting delay.
NOTE: This value is stored when the proposal is submitted so that possible changes to the value do not affect proposals that have already been submitted.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::voting_period
fn voting_period(self: T) -> Result<u64, Array<felt252>>
quorum
Minimum number of cast voted required for a proposal to be successful.
NOTE: The timepoint parameter corresponds to the snapshot used for counting vote. This
allows the quorum to scale depending on values such as the total supply of a token at this
timepoint.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::quorum
fn quorum(self: T, timepoint: u64) -> Result<u256, Array<felt252>>
get_votes
Voting power of an account at a specific timepoint.
NOTE: This can be implemented in a number of ways, for example by reading the delegated
balance from one (or multiple) ERC20Votes tokens.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::get_votes
fn get_votes(self: T, account: ContractAddress, timepoint: u64) -> Result<u256, Array<felt252>>
get_votes_with_params
Voting power of an account at a specific timepoint given additional encoded parameters.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::get_votes_with_params
fn get_votes_with_params(
self: T, account: ContractAddress, timepoint: u64, params: Span<felt252>,
) -> Result<u256, Array<felt252>>
has_voted
Returns whether account has cast a vote on proposal_id.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::has_voted
fn has_voted(
self: T, proposal_id: felt252, account: ContractAddress,
) -> Result<bool, Array<felt252>>
propose
Creates a new proposal. Vote start after a delay specified by voting_delay and
lasts for a duration specified by voting_period.
NOTE: The state of the Governor and targets may change between the proposal creation and its execution. This may be the result of third party actions on the targeted contracts, or other governor proposals. For example, the balance of this contract could be updated or its access control permissions may be modified, possibly compromising the proposal’s ability to execute successfully (e.g. the governor doesn’t have enough value to cover a proposal with multiple transfers).
Returns the id of the proposal.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::propose
fn propose(self: T, calls: Span<Call>, description: ByteArray) -> Result<felt252, Array<felt252>>
queue
Queue a proposal. Some governors require this step to be performed before execution can happen. If queuing is not necessary, this function may revert. Queuing a proposal requires the quorum to be reached, the vote to be successful, and the deadline to be reached.
Returns the id of the proposal.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::queue
fn queue(self: T, calls: Span<Call>, description_hash: felt252) -> Result<felt252, Array<felt252>>
execute
Execute a successful proposal. This requires the quorum to be reached, the vote to be successful, and the deadline to be reached. Depending on the governor it might also be required that the proposal was queued and that some delay passed.
NOTE: Some modules can modify the requirements for execution, for example by adding an
additional timelock (See timelock_controller).
Returns the id of the proposal.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::execute
fn execute(self: T, calls: Span<Call>, description_hash: felt252) -> Result<felt252, Array<felt252>>
cancel
Cancel a proposal. A proposal is cancellable by the proposer, but only while it is Pending state, i.e. before the vote starts.
Returns the id of the proposal.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::cancel
fn cancel(self: T, calls: Span<Call>, description_hash: felt252) -> Result<felt252, Array<felt252>>
cast_vote
Cast a vote.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::cast_vote
fn cast_vote(self: T, proposal_id: felt252, support: u8) -> Result<u256, Array<felt252>>
cast_vote_with_reason
Cast a vote with a reason.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::cast_vote_with_reason
fn cast_vote_with_reason(
self: T, proposal_id: felt252, support: u8, reason: ByteArray,
) -> Result<u256, Array<felt252>>
cast_vote_with_reason_and_params
Cast a vote with a reason and additional serialized params.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::cast_vote_with_reason_and_params
fn cast_vote_with_reason_and_params(
self: T, proposal_id: felt252, support: u8, reason: ByteArray, params: Span<felt252>,
) -> Result<u256, Array<felt252>>
cast_vote_by_sig
Cast a vote using the voter’s signature.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::cast_vote_by_sig
fn cast_vote_by_sig(
self: T, proposal_id: felt252, support: u8, voter: ContractAddress, signature: Span<felt252>,
) -> Result<u256, Array<felt252>>
cast_vote_with_reason_and_params_by_sig
Cast a vote with a reason and additional serialized params using the voter’s
signature.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::cast_vote_with_reason_and_params_by_sig
fn cast_vote_with_reason_and_params_by_sig(
self: T,
proposal_id: felt252,
support: u8,
voter: ContractAddress,
reason: ByteArray,
params: Span<felt252>,
signature: Span<felt252>,
) -> Result<u256, Array<felt252>>
nonces
Returns the next unused nonce for an address.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::nonces
fn nonces(self: T, voter: ContractAddress) -> Result<felt252, Array<felt252>>
relay
Relays a transaction or function call to an arbitrary target.
In cases where the governance executor is some contract other than the governor itself, like when using a timelock, this function can be invoked in a governance proposal to recover tokens that were sent to the governor contract by mistake.
NOTE: If the executor is simply the governor itself, use of relay is redundant.
Fully qualified path: openzeppelin_interfaces::governance::governor::IGovernorSafeDispatcherTrait::relay
fn relay(self: T, call: Call) -> Result<(), Array<felt252>>
IMultisigDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait
Part of the group: dispatchers
pub trait IMultisigDispatcherTrait<T>
Trait functions
get_quorum
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::get_quorum
fn get_quorum(self: T) -> u32
is_signer
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::is_signer
fn is_signer(self: T, signer: ContractAddress) -> bool
get_signers
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::get_signers
fn get_signers(self: T) -> Span<ContractAddress>
is_confirmed
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::is_confirmed
fn is_confirmed(self: T, id: felt252) -> bool
is_confirmed_by
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::is_confirmed_by
fn is_confirmed_by(self: T, id: felt252, signer: ContractAddress) -> bool
is_executed
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::is_executed
fn is_executed(self: T, id: felt252) -> bool
get_submitted_block
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::get_submitted_block
fn get_submitted_block(self: T, id: felt252) -> u64
get_transaction_state
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::get_transaction_state
fn get_transaction_state(self: T, id: felt252) -> TransactionState
get_transaction_confirmations
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::get_transaction_confirmations
fn get_transaction_confirmations(self: T, id: felt252) -> u32
hash_transaction
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::hash_transaction
fn hash_transaction(
self: T, to: ContractAddress, selector: felt252, calldata: Span<felt252>, salt: felt252,
) -> felt252
hash_transaction_batch
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::hash_transaction_batch
fn hash_transaction_batch(self: T, calls: Span<Call>, salt: felt252) -> felt252
add_signers
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::add_signers
fn add_signers(self: T, new_quorum: u32, signers_to_add: Span<ContractAddress>)
remove_signers
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::remove_signers
fn remove_signers(self: T, new_quorum: u32, signers_to_remove: Span<ContractAddress>)
replace_signer
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::replace_signer
fn replace_signer(self: T, signer_to_remove: ContractAddress, signer_to_add: ContractAddress)
change_quorum
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::change_quorum
fn change_quorum(self: T, new_quorum: u32)
submit_transaction
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::submit_transaction
fn submit_transaction(
self: T, to: ContractAddress, selector: felt252, calldata: Span<felt252>, salt: felt252,
) -> felt252
submit_transaction_batch
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::submit_transaction_batch
fn submit_transaction_batch(self: T, calls: Span<Call>, salt: felt252) -> felt252
confirm_transaction
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::confirm_transaction
fn confirm_transaction(self: T, id: felt252)
revoke_confirmation
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::revoke_confirmation
fn revoke_confirmation(self: T, id: felt252)
execute_transaction
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::execute_transaction
fn execute_transaction(
self: T, to: ContractAddress, selector: felt252, calldata: Span<felt252>, salt: felt252,
)
execute_transaction_batch
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigDispatcherTrait::execute_transaction_batch
fn execute_transaction_batch(self: T, calls: Span<Call>, salt: felt252)
IMultisigSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait
Part of the group: dispatchers
pub trait IMultisigSafeDispatcherTrait<T>
Trait functions
get_quorum
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::get_quorum
fn get_quorum(self: T) -> Result<u32, Array<felt252>>
is_signer
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::is_signer
fn is_signer(self: T, signer: ContractAddress) -> Result<bool, Array<felt252>>
get_signers
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::get_signers
fn get_signers(self: T) -> Result<Span<ContractAddress>, Array<felt252>>
is_confirmed
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::is_confirmed
fn is_confirmed(self: T, id: felt252) -> Result<bool, Array<felt252>>
is_confirmed_by
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::is_confirmed_by
fn is_confirmed_by(self: T, id: felt252, signer: ContractAddress) -> Result<bool, Array<felt252>>
is_executed
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::is_executed
fn is_executed(self: T, id: felt252) -> Result<bool, Array<felt252>>
get_submitted_block
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::get_submitted_block
fn get_submitted_block(self: T, id: felt252) -> Result<u64, Array<felt252>>
get_transaction_state
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::get_transaction_state
fn get_transaction_state(self: T, id: felt252) -> Result<TransactionState, Array<felt252>>
get_transaction_confirmations
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::get_transaction_confirmations
fn get_transaction_confirmations(self: T, id: felt252) -> Result<u32, Array<felt252>>
hash_transaction
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::hash_transaction
fn hash_transaction(
self: T, to: ContractAddress, selector: felt252, calldata: Span<felt252>, salt: felt252,
) -> Result<felt252, Array<felt252>>
hash_transaction_batch
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::hash_transaction_batch
fn hash_transaction_batch(
self: T, calls: Span<Call>, salt: felt252,
) -> Result<felt252, Array<felt252>>
add_signers
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::add_signers
fn add_signers(
self: T, new_quorum: u32, signers_to_add: Span<ContractAddress>,
) -> Result<(), Array<felt252>>
remove_signers
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::remove_signers
fn remove_signers(
self: T, new_quorum: u32, signers_to_remove: Span<ContractAddress>,
) -> Result<(), Array<felt252>>
replace_signer
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::replace_signer
fn replace_signer(
self: T, signer_to_remove: ContractAddress, signer_to_add: ContractAddress,
) -> Result<(), Array<felt252>>
change_quorum
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::change_quorum
fn change_quorum(self: T, new_quorum: u32) -> Result<(), Array<felt252>>
submit_transaction
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::submit_transaction
fn submit_transaction(
self: T, to: ContractAddress, selector: felt252, calldata: Span<felt252>, salt: felt252,
) -> Result<felt252, Array<felt252>>
submit_transaction_batch
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::submit_transaction_batch
fn submit_transaction_batch(
self: T, calls: Span<Call>, salt: felt252,
) -> Result<felt252, Array<felt252>>
confirm_transaction
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::confirm_transaction
fn confirm_transaction(self: T, id: felt252) -> Result<(), Array<felt252>>
revoke_confirmation
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::revoke_confirmation
fn revoke_confirmation(self: T, id: felt252) -> Result<(), Array<felt252>>
execute_transaction
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::execute_transaction
fn execute_transaction(
self: T, to: ContractAddress, selector: felt252, calldata: Span<felt252>, salt: felt252,
) -> Result<(), Array<felt252>>
execute_transaction_batch
Fully qualified path: openzeppelin_interfaces::governance::multisig::IMultisigSafeDispatcherTrait::execute_transaction_batch
fn execute_transaction_batch(
self: T, calls: Span<Call>, salt: felt252,
) -> Result<(), Array<felt252>>
ITimelockDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcherTrait
Part of the group: dispatchers
pub trait ITimelockDispatcherTrait<T>
Trait functions
is_operation
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcherTrait::is_operation
fn is_operation(self: T, id: felt252) -> bool
is_operation_pending
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcherTrait::is_operation_pending
fn is_operation_pending(self: T, id: felt252) -> bool
is_operation_ready
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcherTrait::is_operation_ready
fn is_operation_ready(self: T, id: felt252) -> bool
is_operation_done
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcherTrait::is_operation_done
fn is_operation_done(self: T, id: felt252) -> bool
get_timestamp
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcherTrait::get_timestamp
fn get_timestamp(self: T, id: felt252) -> u64
get_operation_state
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcherTrait::get_operation_state
fn get_operation_state(self: T, id: felt252) -> OperationState
get_min_delay
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcherTrait::get_min_delay
fn get_min_delay(self: T) -> u64
hash_operation
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcherTrait::hash_operation
fn hash_operation(self: T, call: Call, predecessor: felt252, salt: felt252) -> felt252
hash_operation_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcherTrait::hash_operation_batch
fn hash_operation_batch(self: T, calls: Span<Call>, predecessor: felt252, salt: felt252) -> felt252
schedule
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcherTrait::schedule
fn schedule(self: T, call: Call, predecessor: felt252, salt: felt252, delay: u64)
schedule_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcherTrait::schedule_batch
fn schedule_batch(self: T, calls: Span<Call>, predecessor: felt252, salt: felt252, delay: u64)
cancel
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcherTrait::cancel
fn cancel(self: T, id: felt252)
execute
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcherTrait::execute
fn execute(self: T, call: Call, predecessor: felt252, salt: felt252)
execute_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcherTrait::execute_batch
fn execute_batch(self: T, calls: Span<Call>, predecessor: felt252, salt: felt252)
update_delay
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockDispatcherTrait::update_delay
fn update_delay(self: T, new_delay: u64)
ITimelockSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcherTrait
Part of the group: dispatchers
pub trait ITimelockSafeDispatcherTrait<T>
Trait functions
is_operation
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcherTrait::is_operation
fn is_operation(self: T, id: felt252) -> Result<bool, Array<felt252>>
is_operation_pending
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcherTrait::is_operation_pending
fn is_operation_pending(self: T, id: felt252) -> Result<bool, Array<felt252>>
is_operation_ready
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcherTrait::is_operation_ready
fn is_operation_ready(self: T, id: felt252) -> Result<bool, Array<felt252>>
is_operation_done
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcherTrait::is_operation_done
fn is_operation_done(self: T, id: felt252) -> Result<bool, Array<felt252>>
get_timestamp
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcherTrait::get_timestamp
fn get_timestamp(self: T, id: felt252) -> Result<u64, Array<felt252>>
get_operation_state
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcherTrait::get_operation_state
fn get_operation_state(self: T, id: felt252) -> Result<OperationState, Array<felt252>>
get_min_delay
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcherTrait::get_min_delay
fn get_min_delay(self: T) -> Result<u64, Array<felt252>>
hash_operation
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcherTrait::hash_operation
fn hash_operation(
self: T, call: Call, predecessor: felt252, salt: felt252,
) -> Result<felt252, Array<felt252>>
hash_operation_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcherTrait::hash_operation_batch
fn hash_operation_batch(
self: T, calls: Span<Call>, predecessor: felt252, salt: felt252,
) -> Result<felt252, Array<felt252>>
schedule
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcherTrait::schedule
fn schedule(
self: T, call: Call, predecessor: felt252, salt: felt252, delay: u64,
) -> Result<(), Array<felt252>>
schedule_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcherTrait::schedule_batch
fn schedule_batch(
self: T, calls: Span<Call>, predecessor: felt252, salt: felt252, delay: u64,
) -> Result<(), Array<felt252>>
cancel
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcherTrait::cancel
fn cancel(self: T, id: felt252) -> Result<(), Array<felt252>>
execute
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcherTrait::execute
fn execute(self: T, call: Call, predecessor: felt252, salt: felt252) -> Result<(), Array<felt252>>
execute_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcherTrait::execute_batch
fn execute_batch(
self: T, calls: Span<Call>, predecessor: felt252, salt: felt252,
) -> Result<(), Array<felt252>>
update_delay
Fully qualified path: openzeppelin_interfaces::governance::timelock::ITimelockSafeDispatcherTrait::update_delay
fn update_delay(self: T, new_delay: u64) -> Result<(), Array<felt252>>
TimelockABIDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait
Part of the group: dispatchers
pub trait TimelockABIDispatcherTrait<T>
Trait functions
is_operation
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::is_operation
fn is_operation(self: T, id: felt252) -> bool
is_operation_pending
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::is_operation_pending
fn is_operation_pending(self: T, id: felt252) -> bool
is_operation_ready
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::is_operation_ready
fn is_operation_ready(self: T, id: felt252) -> bool
is_operation_done
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::is_operation_done
fn is_operation_done(self: T, id: felt252) -> bool
get_timestamp
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::get_timestamp
fn get_timestamp(self: T, id: felt252) -> u64
get_operation_state
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::get_operation_state
fn get_operation_state(self: T, id: felt252) -> OperationState
get_min_delay
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::get_min_delay
fn get_min_delay(self: T) -> u64
hash_operation
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::hash_operation
fn hash_operation(self: T, call: Call, predecessor: felt252, salt: felt252) -> felt252
hash_operation_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::hash_operation_batch
fn hash_operation_batch(self: T, calls: Span<Call>, predecessor: felt252, salt: felt252) -> felt252
schedule
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::schedule
fn schedule(self: T, call: Call, predecessor: felt252, salt: felt252, delay: u64)
schedule_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::schedule_batch
fn schedule_batch(self: T, calls: Span<Call>, predecessor: felt252, salt: felt252, delay: u64)
cancel
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::cancel
fn cancel(self: T, id: felt252)
execute
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::execute
fn execute(self: T, call: Call, predecessor: felt252, salt: felt252)
execute_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::execute_batch
fn execute_batch(self: T, calls: Span<Call>, predecessor: felt252, salt: felt252)
update_delay
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::update_delay
fn update_delay(self: T, new_delay: u64)
supports_interface
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> bool
has_role
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::has_role
fn has_role(self: T, role: felt252, account: ContractAddress) -> bool
get_role_admin
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::get_role_admin
fn get_role_admin(self: T, role: felt252) -> felt252
grant_role
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::grant_role
fn grant_role(self: T, role: felt252, account: ContractAddress)
revoke_role
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::revoke_role
fn revoke_role(self: T, role: felt252, account: ContractAddress)
renounce_role
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::renounce_role
fn renounce_role(self: T, role: felt252, account: ContractAddress)
hasRole
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::hasRole
fn hasRole(self: T, role: felt252, account: ContractAddress) -> bool
getRoleAdmin
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::getRoleAdmin
fn getRoleAdmin(self: T, role: felt252) -> felt252
grantRole
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::grantRole
fn grantRole(self: T, role: felt252, account: ContractAddress)
revokeRole
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::revokeRole
fn revokeRole(self: T, role: felt252, account: ContractAddress)
renounceRole
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABIDispatcherTrait::renounceRole
fn renounceRole(self: T, role: felt252, account: ContractAddress)
TimelockABISafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait
Part of the group: dispatchers
pub trait TimelockABISafeDispatcherTrait<T>
Trait functions
is_operation
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::is_operation
fn is_operation(self: T, id: felt252) -> Result<bool, Array<felt252>>
is_operation_pending
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::is_operation_pending
fn is_operation_pending(self: T, id: felt252) -> Result<bool, Array<felt252>>
is_operation_ready
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::is_operation_ready
fn is_operation_ready(self: T, id: felt252) -> Result<bool, Array<felt252>>
is_operation_done
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::is_operation_done
fn is_operation_done(self: T, id: felt252) -> Result<bool, Array<felt252>>
get_timestamp
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::get_timestamp
fn get_timestamp(self: T, id: felt252) -> Result<u64, Array<felt252>>
get_operation_state
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::get_operation_state
fn get_operation_state(self: T, id: felt252) -> Result<OperationState, Array<felt252>>
get_min_delay
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::get_min_delay
fn get_min_delay(self: T) -> Result<u64, Array<felt252>>
hash_operation
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::hash_operation
fn hash_operation(
self: T, call: Call, predecessor: felt252, salt: felt252,
) -> Result<felt252, Array<felt252>>
hash_operation_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::hash_operation_batch
fn hash_operation_batch(
self: T, calls: Span<Call>, predecessor: felt252, salt: felt252,
) -> Result<felt252, Array<felt252>>
schedule
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::schedule
fn schedule(
self: T, call: Call, predecessor: felt252, salt: felt252, delay: u64,
) -> Result<(), Array<felt252>>
schedule_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::schedule_batch
fn schedule_batch(
self: T, calls: Span<Call>, predecessor: felt252, salt: felt252, delay: u64,
) -> Result<(), Array<felt252>>
cancel
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::cancel
fn cancel(self: T, id: felt252) -> Result<(), Array<felt252>>
execute
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::execute
fn execute(self: T, call: Call, predecessor: felt252, salt: felt252) -> Result<(), Array<felt252>>
execute_batch
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::execute_batch
fn execute_batch(
self: T, calls: Span<Call>, predecessor: felt252, salt: felt252,
) -> Result<(), Array<felt252>>
update_delay
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::update_delay
fn update_delay(self: T, new_delay: u64) -> Result<(), Array<felt252>>
supports_interface
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> Result<bool, Array<felt252>>
has_role
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::has_role
fn has_role(self: T, role: felt252, account: ContractAddress) -> Result<bool, Array<felt252>>
get_role_admin
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::get_role_admin
fn get_role_admin(self: T, role: felt252) -> Result<felt252, Array<felt252>>
grant_role
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::grant_role
fn grant_role(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
revoke_role
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::revoke_role
fn revoke_role(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
renounce_role
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::renounce_role
fn renounce_role(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
hasRole
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::hasRole
fn hasRole(self: T, role: felt252, account: ContractAddress) -> Result<bool, Array<felt252>>
getRoleAdmin
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::getRoleAdmin
fn getRoleAdmin(self: T, role: felt252) -> Result<felt252, Array<felt252>>
grantRole
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::grantRole
fn grantRole(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
revokeRole
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::revokeRole
fn revokeRole(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
renounceRole
Fully qualified path: openzeppelin_interfaces::governance::timelock::TimelockABISafeDispatcherTrait::renounceRole
fn renounceRole(self: T, role: felt252, account: ContractAddress) -> Result<(), Array<felt252>>
IVotesDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesDispatcherTrait
Part of the group: dispatchers
pub trait IVotesDispatcherTrait<T>
Trait functions
get_votes
Returns the current amount of votes that account has.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesDispatcherTrait::get_votes
fn get_votes(self: T, account: ContractAddress) -> u256
get_past_votes
Returns the amount of votes that account had at a specific moment in the past.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesDispatcherTrait::get_past_votes
fn get_past_votes(self: T, account: ContractAddress, timepoint: u64) -> u256
get_past_total_supply
Returns the total supply of votes available at a specific moment in the past.
NOTE: This value is the sum of all available votes, which is not necessarily the sum of all delegated votes. Votes that have not been delegated are still part of total supply, even though they would not participate in a vote.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesDispatcherTrait::get_past_total_supply
fn get_past_total_supply(self: T, timepoint: u64) -> u256
delegates
Returns the delegate that account has chosen.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesDispatcherTrait::delegates
fn delegates(self: T, account: ContractAddress) -> ContractAddress
delegate
Delegates votes from the sender to delegatee.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesDispatcherTrait::delegate
fn delegate(self: T, delegatee: ContractAddress)
delegate_by_sig
Delegates votes from delegator to delegatee.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesDispatcherTrait::delegate_by_sig
fn delegate_by_sig(
self: T,
delegator: ContractAddress,
delegatee: ContractAddress,
nonce: felt252,
expiry: u64,
signature: Span<felt252>,
)
clock
Returns the current timepoint determined by the contract’s operational mode, intended for use in time-sensitive logic. See https://eips.ethereum.org/EIPS/eip-6372#clock.
Requirements:
- This function MUST always be non-decreasing.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesDispatcherTrait::clock
fn clock(self: T) -> u64
CLOCK_MODE
Returns a description of the clock the contract is operating in. See https://eips.ethereum.org/EIPS/eip-6372#clock_mode.
Requirements:
- The output MUST be formatted like a URL query string, decodable in standard JavaScript.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesDispatcherTrait::CLOCK_MODE
fn CLOCK_MODE(self: T) -> ByteArray
IVotesSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesSafeDispatcherTrait
Part of the group: dispatchers
pub trait IVotesSafeDispatcherTrait<T>
Trait functions
get_votes
Returns the current amount of votes that account has.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesSafeDispatcherTrait::get_votes
fn get_votes(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
get_past_votes
Returns the amount of votes that account had at a specific moment in the past.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesSafeDispatcherTrait::get_past_votes
fn get_past_votes(self: T, account: ContractAddress, timepoint: u64) -> Result<u256, Array<felt252>>
get_past_total_supply
Returns the total supply of votes available at a specific moment in the past.
NOTE: This value is the sum of all available votes, which is not necessarily the sum of all delegated votes. Votes that have not been delegated are still part of total supply, even though they would not participate in a vote.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesSafeDispatcherTrait::get_past_total_supply
fn get_past_total_supply(self: T, timepoint: u64) -> Result<u256, Array<felt252>>
delegates
Returns the delegate that account has chosen.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesSafeDispatcherTrait::delegates
fn delegates(self: T, account: ContractAddress) -> Result<ContractAddress, Array<felt252>>
delegate
Delegates votes from the sender to delegatee.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesSafeDispatcherTrait::delegate
fn delegate(self: T, delegatee: ContractAddress) -> Result<(), Array<felt252>>
delegate_by_sig
Delegates votes from delegator to delegatee.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesSafeDispatcherTrait::delegate_by_sig
fn delegate_by_sig(
self: T,
delegator: ContractAddress,
delegatee: ContractAddress,
nonce: felt252,
expiry: u64,
signature: Span<felt252>,
) -> Result<(), Array<felt252>>
clock
Returns the current timepoint determined by the contract’s operational mode, intended for use in time-sensitive logic. See https://eips.ethereum.org/EIPS/eip-6372#clock.
Requirements:
- This function MUST always be non-decreasing.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesSafeDispatcherTrait::clock
fn clock(self: T) -> Result<u64, Array<felt252>>
CLOCK_MODE
Returns a description of the clock the contract is operating in. See https://eips.ethereum.org/EIPS/eip-6372#clock_mode.
Requirements:
- The output MUST be formatted like a URL query string, decodable in standard JavaScript.
Fully qualified path: openzeppelin_interfaces::governance::votes::IVotesSafeDispatcherTrait::CLOCK_MODE
fn CLOCK_MODE(self: T) -> Result<ByteArray, Array<felt252>>
VotesABIDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABIDispatcherTrait
Part of the group: dispatchers
pub trait VotesABIDispatcherTrait<T>
Trait functions
get_votes
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABIDispatcherTrait::get_votes
fn get_votes(self: T, account: ContractAddress) -> u256
get_past_votes
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABIDispatcherTrait::get_past_votes
fn get_past_votes(self: T, account: ContractAddress, timepoint: u64) -> u256
get_past_total_supply
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABIDispatcherTrait::get_past_total_supply
fn get_past_total_supply(self: T, timepoint: u64) -> u256
delegates
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABIDispatcherTrait::delegates
fn delegates(self: T, account: ContractAddress) -> ContractAddress
delegate
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABIDispatcherTrait::delegate
fn delegate(self: T, delegatee: ContractAddress)
delegate_by_sig
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABIDispatcherTrait::delegate_by_sig
fn delegate_by_sig(
self: T,
delegator: ContractAddress,
delegatee: ContractAddress,
nonce: felt252,
expiry: u64,
signature: Span<felt252>,
)
nonces
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABIDispatcherTrait::nonces
fn nonces(self: T, owner: ContractAddress) -> felt252
clock
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABIDispatcherTrait::clock
fn clock(self: T) -> u64
CLOCK_MODE
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABIDispatcherTrait::CLOCK_MODE
fn CLOCK_MODE(self: T) -> ByteArray
VotesABISafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABISafeDispatcherTrait
Part of the group: dispatchers
pub trait VotesABISafeDispatcherTrait<T>
Trait functions
get_votes
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABISafeDispatcherTrait::get_votes
fn get_votes(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
get_past_votes
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABISafeDispatcherTrait::get_past_votes
fn get_past_votes(self: T, account: ContractAddress, timepoint: u64) -> Result<u256, Array<felt252>>
get_past_total_supply
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABISafeDispatcherTrait::get_past_total_supply
fn get_past_total_supply(self: T, timepoint: u64) -> Result<u256, Array<felt252>>
delegates
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABISafeDispatcherTrait::delegates
fn delegates(self: T, account: ContractAddress) -> Result<ContractAddress, Array<felt252>>
delegate
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABISafeDispatcherTrait::delegate
fn delegate(self: T, delegatee: ContractAddress) -> Result<(), Array<felt252>>
delegate_by_sig
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABISafeDispatcherTrait::delegate_by_sig
fn delegate_by_sig(
self: T,
delegator: ContractAddress,
delegatee: ContractAddress,
nonce: felt252,
expiry: u64,
signature: Span<felt252>,
) -> Result<(), Array<felt252>>
nonces
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABISafeDispatcherTrait::nonces
fn nonces(self: T, owner: ContractAddress) -> Result<felt252, Array<felt252>>
clock
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABISafeDispatcherTrait::clock
fn clock(self: T) -> Result<u64, Array<felt252>>
CLOCK_MODE
Fully qualified path: openzeppelin_interfaces::governance::votes::VotesABISafeDispatcherTrait::CLOCK_MODE
fn CLOCK_MODE(self: T) -> Result<ByteArray, Array<felt252>>
ISRC5DispatcherTrait
Fully qualified path: openzeppelin_interfaces::introspection::ISRC5DispatcherTrait
Part of the group: dispatchers
pub trait ISRC5DispatcherTrait<T>
Trait functions
supports_interface
Fully qualified path: openzeppelin_interfaces::introspection::ISRC5DispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> bool
ISRC5SafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::introspection::ISRC5SafeDispatcherTrait
Part of the group: dispatchers
pub trait ISRC5SafeDispatcherTrait<T>
Trait functions
supports_interface
Fully qualified path: openzeppelin_interfaces::introspection::ISRC5SafeDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> Result<bool, Array<felt252>>
IInitializableDispatcherTrait
Fully qualified path: openzeppelin_interfaces::security::initializable::IInitializableDispatcherTrait
Part of the group: dispatchers
pub trait IInitializableDispatcherTrait<T>
Trait functions
is_initialized
Fully qualified path: openzeppelin_interfaces::security::initializable::IInitializableDispatcherTrait::is_initialized
fn is_initialized(self: T) -> bool
IInitializableSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::security::initializable::IInitializableSafeDispatcherTrait
Part of the group: dispatchers
pub trait IInitializableSafeDispatcherTrait<T>
Trait functions
is_initialized
Fully qualified path: openzeppelin_interfaces::security::initializable::IInitializableSafeDispatcherTrait::is_initialized
fn is_initialized(self: T) -> Result<bool, Array<felt252>>
IPausableDispatcherTrait
Fully qualified path: openzeppelin_interfaces::security::pausable::IPausableDispatcherTrait
Part of the group: dispatchers
pub trait IPausableDispatcherTrait<T>
Trait functions
is_paused
Fully qualified path: openzeppelin_interfaces::security::pausable::IPausableDispatcherTrait::is_paused
fn is_paused(self: T) -> bool
IPausableSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::security::pausable::IPausableSafeDispatcherTrait
Part of the group: dispatchers
pub trait IPausableSafeDispatcherTrait<T>
Trait functions
is_paused
Fully qualified path: openzeppelin_interfaces::security::pausable::IPausableSafeDispatcherTrait::is_paused
fn is_paused(self: T) -> Result<bool, Array<felt252>>
IERC1155DispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155DispatcherTrait
Part of the group: dispatchers
pub trait IERC1155DispatcherTrait<T>
Trait functions
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155DispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress, token_id: u256) -> u256
balance_of_batch
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155DispatcherTrait::balance_of_batch
fn balance_of_batch(self: T, accounts: Span<ContractAddress>, token_ids: Span<u256>) -> Span<u256>
safe_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155DispatcherTrait::safe_transfer_from
fn safe_transfer_from(
self: T,
from: ContractAddress,
to: ContractAddress,
token_id: u256,
value: u256,
data: Span<felt252>,
)
safe_batch_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155DispatcherTrait::safe_batch_transfer_from
fn safe_batch_transfer_from(
self: T,
from: ContractAddress,
to: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
)
is_approved_for_all
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155DispatcherTrait::is_approved_for_all
fn is_approved_for_all(self: T, owner: ContractAddress, operator: ContractAddress) -> bool
set_approval_for_all
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155DispatcherTrait::set_approval_for_all
fn set_approval_for_all(self: T, operator: ContractAddress, approved: bool)
IERC1155SafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155SafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC1155SafeDispatcherTrait<T>
Trait functions
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155SafeDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress, token_id: u256) -> Result<u256, Array<felt252>>
balance_of_batch
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155SafeDispatcherTrait::balance_of_batch
fn balance_of_batch(
self: T, accounts: Span<ContractAddress>, token_ids: Span<u256>,
) -> Result<Span<u256>, Array<felt252>>
safe_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155SafeDispatcherTrait::safe_transfer_from
fn safe_transfer_from(
self: T,
from: ContractAddress,
to: ContractAddress,
token_id: u256,
value: u256,
data: Span<felt252>,
) -> Result<(), Array<felt252>>
safe_batch_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155SafeDispatcherTrait::safe_batch_transfer_from
fn safe_batch_transfer_from(
self: T,
from: ContractAddress,
to: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> Result<(), Array<felt252>>
is_approved_for_all
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155SafeDispatcherTrait::is_approved_for_all
fn is_approved_for_all(
self: T, owner: ContractAddress, operator: ContractAddress,
) -> Result<bool, Array<felt252>>
set_approval_for_all
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155SafeDispatcherTrait::set_approval_for_all
fn set_approval_for_all(
self: T, operator: ContractAddress, approved: bool,
) -> Result<(), Array<felt252>>
IERC1155MetadataURIDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155MetadataURIDispatcherTrait
Part of the group: dispatchers
pub trait IERC1155MetadataURIDispatcherTrait<T>
Trait functions
uri
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155MetadataURIDispatcherTrait::uri
fn uri(self: T, token_id: u256) -> ByteArray
IERC1155MetadataURISafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155MetadataURISafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC1155MetadataURISafeDispatcherTrait<T>
Trait functions
uri
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155MetadataURISafeDispatcherTrait::uri
fn uri(self: T, token_id: u256) -> Result<ByteArray, Array<felt252>>
IERC1155CamelDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelDispatcherTrait
Part of the group: dispatchers
pub trait IERC1155CamelDispatcherTrait<T>
Trait functions
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress, tokenId: u256) -> u256
balanceOfBatch
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelDispatcherTrait::balanceOfBatch
fn balanceOfBatch(self: T, accounts: Span<ContractAddress>, tokenIds: Span<u256>) -> Span<u256>
safeTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelDispatcherTrait::safeTransferFrom
fn safeTransferFrom(
self: T,
from: ContractAddress,
to: ContractAddress,
tokenId: u256,
value: u256,
data: Span<felt252>,
)
safeBatchTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelDispatcherTrait::safeBatchTransferFrom
fn safeBatchTransferFrom(
self: T,
from: ContractAddress,
to: ContractAddress,
tokenIds: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
)
isApprovedForAll
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelDispatcherTrait::isApprovedForAll
fn isApprovedForAll(self: T, owner: ContractAddress, operator: ContractAddress) -> bool
setApprovalForAll
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelDispatcherTrait::setApprovalForAll
fn setApprovalForAll(self: T, operator: ContractAddress, approved: bool)
IERC1155CamelSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelSafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC1155CamelSafeDispatcherTrait<T>
Trait functions
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelSafeDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress, tokenId: u256) -> Result<u256, Array<felt252>>
balanceOfBatch
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelSafeDispatcherTrait::balanceOfBatch
fn balanceOfBatch(
self: T, accounts: Span<ContractAddress>, tokenIds: Span<u256>,
) -> Result<Span<u256>, Array<felt252>>
safeTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelSafeDispatcherTrait::safeTransferFrom
fn safeTransferFrom(
self: T,
from: ContractAddress,
to: ContractAddress,
tokenId: u256,
value: u256,
data: Span<felt252>,
) -> Result<(), Array<felt252>>
safeBatchTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelSafeDispatcherTrait::safeBatchTransferFrom
fn safeBatchTransferFrom(
self: T,
from: ContractAddress,
to: ContractAddress,
tokenIds: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> Result<(), Array<felt252>>
isApprovedForAll
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelSafeDispatcherTrait::isApprovedForAll
fn isApprovedForAll(
self: T, owner: ContractAddress, operator: ContractAddress,
) -> Result<bool, Array<felt252>>
setApprovalForAll
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155CamelSafeDispatcherTrait::setApprovalForAll
fn setApprovalForAll(
self: T, operator: ContractAddress, approved: bool,
) -> Result<(), Array<felt252>>
ERC1155ABIDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABIDispatcherTrait
Part of the group: dispatchers
pub trait ERC1155ABIDispatcherTrait<T>
Trait functions
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABIDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress, token_id: u256) -> u256
balance_of_batch
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABIDispatcherTrait::balance_of_batch
fn balance_of_batch(self: T, accounts: Span<ContractAddress>, token_ids: Span<u256>) -> Span<u256>
safe_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABIDispatcherTrait::safe_transfer_from
fn safe_transfer_from(
self: T,
from: ContractAddress,
to: ContractAddress,
token_id: u256,
value: u256,
data: Span<felt252>,
)
safe_batch_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABIDispatcherTrait::safe_batch_transfer_from
fn safe_batch_transfer_from(
self: T,
from: ContractAddress,
to: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
)
is_approved_for_all
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABIDispatcherTrait::is_approved_for_all
fn is_approved_for_all(self: T, owner: ContractAddress, operator: ContractAddress) -> bool
set_approval_for_all
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABIDispatcherTrait::set_approval_for_all
fn set_approval_for_all(self: T, operator: ContractAddress, approved: bool)
supports_interface
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABIDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> bool
uri
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABIDispatcherTrait::uri
fn uri(self: T, token_id: u256) -> ByteArray
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABIDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress, tokenId: u256) -> u256
balanceOfBatch
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABIDispatcherTrait::balanceOfBatch
fn balanceOfBatch(self: T, accounts: Span<ContractAddress>, tokenIds: Span<u256>) -> Span<u256>
safeTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABIDispatcherTrait::safeTransferFrom
fn safeTransferFrom(
self: T,
from: ContractAddress,
to: ContractAddress,
tokenId: u256,
value: u256,
data: Span<felt252>,
)
safeBatchTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABIDispatcherTrait::safeBatchTransferFrom
fn safeBatchTransferFrom(
self: T,
from: ContractAddress,
to: ContractAddress,
tokenIds: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
)
isApprovedForAll
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABIDispatcherTrait::isApprovedForAll
fn isApprovedForAll(self: T, owner: ContractAddress, operator: ContractAddress) -> bool
setApprovalForAll
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABIDispatcherTrait::setApprovalForAll
fn setApprovalForAll(self: T, operator: ContractAddress, approved: bool)
ERC1155ABISafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeDispatcherTrait
Part of the group: dispatchers
pub trait ERC1155ABISafeDispatcherTrait<T>
Trait functions
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress, token_id: u256) -> Result<u256, Array<felt252>>
balance_of_batch
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeDispatcherTrait::balance_of_batch
fn balance_of_batch(
self: T, accounts: Span<ContractAddress>, token_ids: Span<u256>,
) -> Result<Span<u256>, Array<felt252>>
safe_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeDispatcherTrait::safe_transfer_from
fn safe_transfer_from(
self: T,
from: ContractAddress,
to: ContractAddress,
token_id: u256,
value: u256,
data: Span<felt252>,
) -> Result<(), Array<felt252>>
safe_batch_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeDispatcherTrait::safe_batch_transfer_from
fn safe_batch_transfer_from(
self: T,
from: ContractAddress,
to: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> Result<(), Array<felt252>>
is_approved_for_all
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeDispatcherTrait::is_approved_for_all
fn is_approved_for_all(
self: T, owner: ContractAddress, operator: ContractAddress,
) -> Result<bool, Array<felt252>>
set_approval_for_all
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeDispatcherTrait::set_approval_for_all
fn set_approval_for_all(
self: T, operator: ContractAddress, approved: bool,
) -> Result<(), Array<felt252>>
supports_interface
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> Result<bool, Array<felt252>>
uri
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeDispatcherTrait::uri
fn uri(self: T, token_id: u256) -> Result<ByteArray, Array<felt252>>
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress, tokenId: u256) -> Result<u256, Array<felt252>>
balanceOfBatch
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeDispatcherTrait::balanceOfBatch
fn balanceOfBatch(
self: T, accounts: Span<ContractAddress>, tokenIds: Span<u256>,
) -> Result<Span<u256>, Array<felt252>>
safeTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeDispatcherTrait::safeTransferFrom
fn safeTransferFrom(
self: T,
from: ContractAddress,
to: ContractAddress,
tokenId: u256,
value: u256,
data: Span<felt252>,
) -> Result<(), Array<felt252>>
safeBatchTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeDispatcherTrait::safeBatchTransferFrom
fn safeBatchTransferFrom(
self: T,
from: ContractAddress,
to: ContractAddress,
tokenIds: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> Result<(), Array<felt252>>
isApprovedForAll
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeDispatcherTrait::isApprovedForAll
fn isApprovedForAll(
self: T, owner: ContractAddress, operator: ContractAddress,
) -> Result<bool, Array<felt252>>
setApprovalForAll
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ABISafeDispatcherTrait::setApprovalForAll
fn setApprovalForAll(
self: T, operator: ContractAddress, approved: bool,
) -> Result<(), Array<felt252>>
IERC1155ReceiverDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverDispatcherTrait
Part of the group: dispatchers
pub trait IERC1155ReceiverDispatcherTrait<T>
Trait functions
on_erc1155_received
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverDispatcherTrait::on_erc1155_received
fn on_erc1155_received(
self: T,
operator: ContractAddress,
from: ContractAddress,
token_id: u256,
value: u256,
data: Span<felt252>,
) -> felt252
on_erc1155_batch_received
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverDispatcherTrait::on_erc1155_batch_received
fn on_erc1155_batch_received(
self: T,
operator: ContractAddress,
from: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> felt252
IERC1155ReceiverSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverSafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC1155ReceiverSafeDispatcherTrait<T>
Trait functions
on_erc1155_received
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverSafeDispatcherTrait::on_erc1155_received
fn on_erc1155_received(
self: T,
operator: ContractAddress,
from: ContractAddress,
token_id: u256,
value: u256,
data: Span<felt252>,
) -> Result<felt252, Array<felt252>>
on_erc1155_batch_received
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverSafeDispatcherTrait::on_erc1155_batch_received
fn on_erc1155_batch_received(
self: T,
operator: ContractAddress,
from: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> Result<felt252, Array<felt252>>
IERC1155ReceiverCamelDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverCamelDispatcherTrait
Part of the group: dispatchers
pub trait IERC1155ReceiverCamelDispatcherTrait<T>
Trait functions
onERC1155Received
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverCamelDispatcherTrait::onERC1155Received
fn onERC1155Received(
self: T,
operator: ContractAddress,
from: ContractAddress,
tokenId: u256,
value: u256,
data: Span<felt252>,
) -> felt252
onERC1155BatchReceived
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverCamelDispatcherTrait::onERC1155BatchReceived
fn onERC1155BatchReceived(
self: T,
operator: ContractAddress,
from: ContractAddress,
tokenIds: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> felt252
IERC1155ReceiverCamelSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverCamelSafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC1155ReceiverCamelSafeDispatcherTrait<T>
Trait functions
onERC1155Received
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverCamelSafeDispatcherTrait::onERC1155Received
fn onERC1155Received(
self: T,
operator: ContractAddress,
from: ContractAddress,
tokenId: u256,
value: u256,
data: Span<felt252>,
) -> Result<felt252, Array<felt252>>
onERC1155BatchReceived
Fully qualified path: openzeppelin_interfaces::token::erc1155::IERC1155ReceiverCamelSafeDispatcherTrait::onERC1155BatchReceived
fn onERC1155BatchReceived(
self: T,
operator: ContractAddress,
from: ContractAddress,
tokenIds: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> Result<felt252, Array<felt252>>
ERC1155ReceiverABIDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABIDispatcherTrait
Part of the group: dispatchers
pub trait ERC1155ReceiverABIDispatcherTrait<T>
Trait functions
on_erc1155_received
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABIDispatcherTrait::on_erc1155_received
fn on_erc1155_received(
self: T,
operator: ContractAddress,
from: ContractAddress,
token_id: u256,
value: u256,
data: Span<felt252>,
) -> felt252
on_erc1155_batch_received
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABIDispatcherTrait::on_erc1155_batch_received
fn on_erc1155_batch_received(
self: T,
operator: ContractAddress,
from: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> felt252
onERC1155Received
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABIDispatcherTrait::onERC1155Received
fn onERC1155Received(
self: T,
operator: ContractAddress,
from: ContractAddress,
tokenId: u256,
value: u256,
data: Span<felt252>,
) -> felt252
onERC1155BatchReceived
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABIDispatcherTrait::onERC1155BatchReceived
fn onERC1155BatchReceived(
self: T,
operator: ContractAddress,
from: ContractAddress,
tokenIds: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> felt252
supports_interface
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABIDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> bool
ERC1155ReceiverABISafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABISafeDispatcherTrait
Part of the group: dispatchers
pub trait ERC1155ReceiverABISafeDispatcherTrait<T>
Trait functions
on_erc1155_received
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABISafeDispatcherTrait::on_erc1155_received
fn on_erc1155_received(
self: T,
operator: ContractAddress,
from: ContractAddress,
token_id: u256,
value: u256,
data: Span<felt252>,
) -> Result<felt252, Array<felt252>>
on_erc1155_batch_received
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABISafeDispatcherTrait::on_erc1155_batch_received
fn on_erc1155_batch_received(
self: T,
operator: ContractAddress,
from: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> Result<felt252, Array<felt252>>
onERC1155Received
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABISafeDispatcherTrait::onERC1155Received
fn onERC1155Received(
self: T,
operator: ContractAddress,
from: ContractAddress,
tokenId: u256,
value: u256,
data: Span<felt252>,
) -> Result<felt252, Array<felt252>>
onERC1155BatchReceived
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABISafeDispatcherTrait::onERC1155BatchReceived
fn onERC1155BatchReceived(
self: T,
operator: ContractAddress,
from: ContractAddress,
tokenIds: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> Result<felt252, Array<felt252>>
supports_interface
Fully qualified path: openzeppelin_interfaces::token::erc1155::ERC1155ReceiverABISafeDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> Result<bool, Array<felt252>>
IERC20DispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20DispatcherTrait
Part of the group: dispatchers
pub trait IERC20DispatcherTrait<T>
Trait functions
total_supply
Returns the total supply of tokens.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20DispatcherTrait::total_supply
fn total_supply(self: T) -> u256
balance_of
Returns the amount of tokens owned by account.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20DispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress) -> u256
allowance
Returns the remaining number of tokens that spender will be allowed to spend on behalf of
owner through transfer_from.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20DispatcherTrait::allowance
fn allowance(self: T, owner: ContractAddress, spender: ContractAddress) -> u256
transfer
Moves amount tokens from the caller’s account to recipient.
Returns a boolean value indicating whether the operation succeeded.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20DispatcherTrait::transfer
fn transfer(self: T, recipient: ContractAddress, amount: u256) -> bool
transfer_from
Moves amount tokens from sender to recipient using the allowance mechanism.
Returns a boolean value indicating whether the operation succeeded.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20DispatcherTrait::transfer_from
fn transfer_from(self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256) -> bool
approve
Sets amount as the allowance of spender over the caller’s tokens.
Returns a boolean value indicating whether the operation succeeded.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20DispatcherTrait::approve
fn approve(self: T, spender: ContractAddress, amount: u256) -> bool
IERC20SafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20SafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC20SafeDispatcherTrait<T>
Trait functions
total_supply
Returns the total supply of tokens.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20SafeDispatcherTrait::total_supply
fn total_supply(self: T) -> Result<u256, Array<felt252>>
balance_of
Returns the amount of tokens owned by account.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20SafeDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
allowance
Returns the remaining number of tokens that spender will be allowed to spend on behalf of
owner through transfer_from.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20SafeDispatcherTrait::allowance
fn allowance(
self: T, owner: ContractAddress, spender: ContractAddress,
) -> Result<u256, Array<felt252>>
transfer
Moves amount tokens from the caller’s account to recipient.
Returns a boolean value indicating whether the operation succeeded.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20SafeDispatcherTrait::transfer
fn transfer(self: T, recipient: ContractAddress, amount: u256) -> Result<bool, Array<felt252>>
transfer_from
Moves amount tokens from sender to recipient using the allowance mechanism.
Returns a boolean value indicating whether the operation succeeded.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20SafeDispatcherTrait::transfer_from
fn transfer_from(
self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> Result<bool, Array<felt252>>
approve
Sets amount as the allowance of spender over the caller’s tokens.
Returns a boolean value indicating whether the operation succeeded.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20SafeDispatcherTrait::approve
fn approve(self: T, spender: ContractAddress, amount: u256) -> Result<bool, Array<felt252>>
IERC20MetadataDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MetadataDispatcherTrait
Part of the group: dispatchers
pub trait IERC20MetadataDispatcherTrait<T>
Trait functions
name
Returns the name of the token.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MetadataDispatcherTrait::name
fn name(self: T) -> ByteArray
symbol
Returns the symbol of the token.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MetadataDispatcherTrait::symbol
fn symbol(self: T) -> ByteArray
decimals
Returns the number of decimals used to get its user representation.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MetadataDispatcherTrait::decimals
fn decimals(self: T) -> u8
IERC20MetadataSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MetadataSafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC20MetadataSafeDispatcherTrait<T>
Trait functions
name
Returns the name of the token.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MetadataSafeDispatcherTrait::name
fn name(self: T) -> Result<ByteArray, Array<felt252>>
symbol
Returns the symbol of the token.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MetadataSafeDispatcherTrait::symbol
fn symbol(self: T) -> Result<ByteArray, Array<felt252>>
decimals
Returns the number of decimals used to get its user representation.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MetadataSafeDispatcherTrait::decimals
fn decimals(self: T) -> Result<u8, Array<felt252>>
IERC20CamelDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelDispatcherTrait
Part of the group: dispatchers
pub trait IERC20CamelDispatcherTrait<T>
Trait functions
totalSupply
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelDispatcherTrait::totalSupply
fn totalSupply(self: T) -> u256
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> u256
allowance
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelDispatcherTrait::allowance
fn allowance(self: T, owner: ContractAddress, spender: ContractAddress) -> u256
transfer
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelDispatcherTrait::transfer
fn transfer(self: T, recipient: ContractAddress, amount: u256) -> bool
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelDispatcherTrait::transferFrom
fn transferFrom(self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256) -> bool
approve
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelDispatcherTrait::approve
fn approve(self: T, spender: ContractAddress, amount: u256) -> bool
IERC20CamelSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelSafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC20CamelSafeDispatcherTrait<T>
Trait functions
totalSupply
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelSafeDispatcherTrait::totalSupply
fn totalSupply(self: T) -> Result<u256, Array<felt252>>
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelSafeDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
allowance
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelSafeDispatcherTrait::allowance
fn allowance(
self: T, owner: ContractAddress, spender: ContractAddress,
) -> Result<u256, Array<felt252>>
transfer
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelSafeDispatcherTrait::transfer
fn transfer(self: T, recipient: ContractAddress, amount: u256) -> Result<bool, Array<felt252>>
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelSafeDispatcherTrait::transferFrom
fn transferFrom(
self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> Result<bool, Array<felt252>>
approve
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelSafeDispatcherTrait::approve
fn approve(self: T, spender: ContractAddress, amount: u256) -> Result<bool, Array<felt252>>
IERC20CamelOnlyDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnlyDispatcherTrait
Part of the group: dispatchers
pub trait IERC20CamelOnlyDispatcherTrait<T>
Trait functions
totalSupply
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnlyDispatcherTrait::totalSupply
fn totalSupply(self: T) -> u256
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnlyDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> u256
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnlyDispatcherTrait::transferFrom
fn transferFrom(self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256) -> bool
IERC20CamelOnlySafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnlySafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC20CamelOnlySafeDispatcherTrait<T>
Trait functions
totalSupply
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnlySafeDispatcherTrait::totalSupply
fn totalSupply(self: T) -> Result<u256, Array<felt252>>
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnlySafeDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20CamelOnlySafeDispatcherTrait::transferFrom
fn transferFrom(
self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> Result<bool, Array<felt252>>
IERC20MixinDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinDispatcherTrait
Part of the group: dispatchers
pub trait IERC20MixinDispatcherTrait<T>
Trait functions
total_supply
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinDispatcherTrait::total_supply
fn total_supply(self: T) -> u256
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress) -> u256
allowance
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinDispatcherTrait::allowance
fn allowance(self: T, owner: ContractAddress, spender: ContractAddress) -> u256
transfer
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinDispatcherTrait::transfer
fn transfer(self: T, recipient: ContractAddress, amount: u256) -> bool
transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinDispatcherTrait::transfer_from
fn transfer_from(self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256) -> bool
approve
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinDispatcherTrait::approve
fn approve(self: T, spender: ContractAddress, amount: u256) -> bool
name
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinDispatcherTrait::name
fn name(self: T) -> ByteArray
symbol
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinDispatcherTrait::symbol
fn symbol(self: T) -> ByteArray
decimals
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinDispatcherTrait::decimals
fn decimals(self: T) -> u8
totalSupply
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinDispatcherTrait::totalSupply
fn totalSupply(self: T) -> u256
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> u256
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinDispatcherTrait::transferFrom
fn transferFrom(self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256) -> bool
IERC20MixinSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinSafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC20MixinSafeDispatcherTrait<T>
Trait functions
total_supply
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinSafeDispatcherTrait::total_supply
fn total_supply(self: T) -> Result<u256, Array<felt252>>
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinSafeDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
allowance
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinSafeDispatcherTrait::allowance
fn allowance(
self: T, owner: ContractAddress, spender: ContractAddress,
) -> Result<u256, Array<felt252>>
transfer
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinSafeDispatcherTrait::transfer
fn transfer(self: T, recipient: ContractAddress, amount: u256) -> Result<bool, Array<felt252>>
transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinSafeDispatcherTrait::transfer_from
fn transfer_from(
self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> Result<bool, Array<felt252>>
approve
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinSafeDispatcherTrait::approve
fn approve(self: T, spender: ContractAddress, amount: u256) -> Result<bool, Array<felt252>>
name
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinSafeDispatcherTrait::name
fn name(self: T) -> Result<ByteArray, Array<felt252>>
symbol
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinSafeDispatcherTrait::symbol
fn symbol(self: T) -> Result<ByteArray, Array<felt252>>
decimals
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinSafeDispatcherTrait::decimals
fn decimals(self: T) -> Result<u8, Array<felt252>>
totalSupply
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinSafeDispatcherTrait::totalSupply
fn totalSupply(self: T) -> Result<u256, Array<felt252>>
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinSafeDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20MixinSafeDispatcherTrait::transferFrom
fn transferFrom(
self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> Result<bool, Array<felt252>>
IERC20PermitDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20PermitDispatcherTrait
Part of the group: dispatchers
pub trait IERC20PermitDispatcherTrait<T>
Trait functions
permit
Sets amount as the allowance of spender over owner’s tokens, given the signature.
Requirements:
deadlinemust be a timestamp in the future.signaturemust be a valid secp256k1 signature fromownerover the EIP712-formatted function arguments.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20PermitDispatcherTrait::permit
fn permit(
self: T,
owner: ContractAddress,
spender: ContractAddress,
amount: u256,
deadline: u64,
signature: Span<felt252>,
)
nonces
Returns the current nonce for owner.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20PermitDispatcherTrait::nonces
fn nonces(self: T, owner: ContractAddress) -> felt252
DOMAIN_SEPARATOR
Returns the domain separator used in the encoding of the signatures for permit.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20PermitDispatcherTrait::DOMAIN_SEPARATOR
fn DOMAIN_SEPARATOR(self: T) -> felt252
IERC20PermitSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20PermitSafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC20PermitSafeDispatcherTrait<T>
Trait functions
permit
Sets amount as the allowance of spender over owner’s tokens, given the signature.
Requirements:
deadlinemust be a timestamp in the future.signaturemust be a valid secp256k1 signature fromownerover the EIP712-formatted function arguments.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20PermitSafeDispatcherTrait::permit
fn permit(
self: T,
owner: ContractAddress,
spender: ContractAddress,
amount: u256,
deadline: u64,
signature: Span<felt252>,
) -> Result<(), Array<felt252>>
nonces
Returns the current nonce for owner.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20PermitSafeDispatcherTrait::nonces
fn nonces(self: T, owner: ContractAddress) -> Result<felt252, Array<felt252>>
DOMAIN_SEPARATOR
Returns the domain separator used in the encoding of the signatures for permit.
Fully qualified path: openzeppelin_interfaces::token::erc20::IERC20PermitSafeDispatcherTrait::DOMAIN_SEPARATOR
fn DOMAIN_SEPARATOR(self: T) -> Result<felt252, Array<felt252>>
ERC20ABIDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcherTrait
Part of the group: dispatchers
pub trait ERC20ABIDispatcherTrait<T>
Trait functions
total_supply
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcherTrait::total_supply
fn total_supply(self: T) -> u256
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress) -> u256
allowance
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcherTrait::allowance
fn allowance(self: T, owner: ContractAddress, spender: ContractAddress) -> u256
transfer
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcherTrait::transfer
fn transfer(self: T, recipient: ContractAddress, amount: u256) -> bool
transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcherTrait::transfer_from
fn transfer_from(self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256) -> bool
approve
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcherTrait::approve
fn approve(self: T, spender: ContractAddress, amount: u256) -> bool
name
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcherTrait::name
fn name(self: T) -> ByteArray
symbol
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcherTrait::symbol
fn symbol(self: T) -> ByteArray
decimals
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcherTrait::decimals
fn decimals(self: T) -> u8
totalSupply
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcherTrait::totalSupply
fn totalSupply(self: T) -> u256
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> u256
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcherTrait::transferFrom
fn transferFrom(self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256) -> bool
permit
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcherTrait::permit
fn permit(
self: T,
owner: ContractAddress,
spender: ContractAddress,
amount: u256,
deadline: u64,
signature: Span<felt252>,
)
nonces
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcherTrait::nonces
fn nonces(self: T, owner: ContractAddress) -> felt252
DOMAIN_SEPARATOR
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcherTrait::DOMAIN_SEPARATOR
fn DOMAIN_SEPARATOR(self: T) -> felt252
snip12_metadata
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABIDispatcherTrait::snip12_metadata
fn snip12_metadata(self: T) -> (felt252, felt252)
ERC20ABISafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcherTrait
Part of the group: dispatchers
pub trait ERC20ABISafeDispatcherTrait<T>
Trait functions
total_supply
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcherTrait::total_supply
fn total_supply(self: T) -> Result<u256, Array<felt252>>
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
allowance
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcherTrait::allowance
fn allowance(
self: T, owner: ContractAddress, spender: ContractAddress,
) -> Result<u256, Array<felt252>>
transfer
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcherTrait::transfer
fn transfer(self: T, recipient: ContractAddress, amount: u256) -> Result<bool, Array<felt252>>
transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcherTrait::transfer_from
fn transfer_from(
self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> Result<bool, Array<felt252>>
approve
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcherTrait::approve
fn approve(self: T, spender: ContractAddress, amount: u256) -> Result<bool, Array<felt252>>
name
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcherTrait::name
fn name(self: T) -> Result<ByteArray, Array<felt252>>
symbol
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcherTrait::symbol
fn symbol(self: T) -> Result<ByteArray, Array<felt252>>
decimals
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcherTrait::decimals
fn decimals(self: T) -> Result<u8, Array<felt252>>
totalSupply
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcherTrait::totalSupply
fn totalSupply(self: T) -> Result<u256, Array<felt252>>
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcherTrait::transferFrom
fn transferFrom(
self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> Result<bool, Array<felt252>>
permit
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcherTrait::permit
fn permit(
self: T,
owner: ContractAddress,
spender: ContractAddress,
amount: u256,
deadline: u64,
signature: Span<felt252>,
) -> Result<(), Array<felt252>>
nonces
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcherTrait::nonces
fn nonces(self: T, owner: ContractAddress) -> Result<felt252, Array<felt252>>
DOMAIN_SEPARATOR
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcherTrait::DOMAIN_SEPARATOR
fn DOMAIN_SEPARATOR(self: T) -> Result<felt252, Array<felt252>>
snip12_metadata
Fully qualified path: openzeppelin_interfaces::token::erc20::ERC20ABISafeDispatcherTrait::snip12_metadata
fn snip12_metadata(self: T) -> Result<(felt252, felt252), Array<felt252>>
IERC2981DispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981DispatcherTrait
Part of the group: dispatchers
pub trait IERC2981DispatcherTrait<T>
Trait functions
royalty_info
Returns how much royalty is owed and to whom, based on a sale price that may be denominated in any unit of exchange. The royalty amount is denominated and should be paid in that same unit of exchange.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981DispatcherTrait::royalty_info
fn royalty_info(self: T, token_id: u256, sale_price: u256) -> (ContractAddress, u256)
IERC2981SafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981SafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC2981SafeDispatcherTrait<T>
Trait functions
royalty_info
Returns how much royalty is owed and to whom, based on a sale price that may be denominated in any unit of exchange. The royalty amount is denominated and should be paid in that same unit of exchange.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981SafeDispatcherTrait::royalty_info
fn royalty_info(
self: T, token_id: u256, sale_price: u256,
) -> Result<(ContractAddress, u256), Array<felt252>>
IERC2981InfoDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981InfoDispatcherTrait
Part of the group: dispatchers
pub trait IERC2981InfoDispatcherTrait<T>
Trait functions
default_royalty
Returns the royalty information that all ids in this contract will default to.
The returned tuple contains:
t.0: The receiver of the royalty payment.t.1: The numerator of the royalty fraction.t.2: The denominator of the royalty fraction.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981InfoDispatcherTrait::default_royalty
fn default_royalty(self: T) -> (ContractAddress, u128, u128)
token_royalty
Returns the royalty information specific to a token. If no specific royalty information is set for the token, the default is returned.
The returned tuple contains:
t.0: The receiver of the royalty payment.t.1: The numerator of the royalty fraction.t.2: The denominator of the royalty fraction.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981InfoDispatcherTrait::token_royalty
fn token_royalty(self: T, token_id: u256) -> (ContractAddress, u128, u128)
IERC2981InfoSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981InfoSafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC2981InfoSafeDispatcherTrait<T>
Trait functions
default_royalty
Returns the royalty information that all ids in this contract will default to.
The returned tuple contains:
t.0: The receiver of the royalty payment.t.1: The numerator of the royalty fraction.t.2: The denominator of the royalty fraction.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981InfoSafeDispatcherTrait::default_royalty
fn default_royalty(self: T) -> Result<(ContractAddress, u128, u128), Array<felt252>>
token_royalty
Returns the royalty information specific to a token. If no specific royalty information is set for the token, the default is returned.
The returned tuple contains:
t.0: The receiver of the royalty payment.t.1: The numerator of the royalty fraction.t.2: The denominator of the royalty fraction.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981InfoSafeDispatcherTrait::token_royalty
fn token_royalty(self: T, token_id: u256) -> Result<(ContractAddress, u128, u128), Array<felt252>>
IERC2981AdminDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminDispatcherTrait
Part of the group: dispatchers
pub trait IERC2981AdminDispatcherTrait<T>
Trait functions
set_default_royalty
Sets the royalty information that all ids in this contract will default to.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminDispatcherTrait::set_default_royalty
fn set_default_royalty(self: T, receiver: ContractAddress, fee_numerator: u128)
delete_default_royalty
Sets the default royalty percentage and receiver to zero.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminDispatcherTrait::delete_default_royalty
fn delete_default_royalty(self: T)
set_token_royalty
Sets the royalty information for a specific token id that takes precedence over the global default.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminDispatcherTrait::set_token_royalty
fn set_token_royalty(self: T, token_id: u256, receiver: ContractAddress, fee_numerator: u128)
reset_token_royalty
Resets royalty information for the token id back to unset.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminDispatcherTrait::reset_token_royalty
fn reset_token_royalty(self: T, token_id: u256)
IERC2981AdminSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminSafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC2981AdminSafeDispatcherTrait<T>
Trait functions
set_default_royalty
Sets the royalty information that all ids in this contract will default to.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminSafeDispatcherTrait::set_default_royalty
fn set_default_royalty(
self: T, receiver: ContractAddress, fee_numerator: u128,
) -> Result<(), Array<felt252>>
delete_default_royalty
Sets the default royalty percentage and receiver to zero.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminSafeDispatcherTrait::delete_default_royalty
fn delete_default_royalty(self: T) -> Result<(), Array<felt252>>
set_token_royalty
Sets the royalty information for a specific token id that takes precedence over the global default.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminSafeDispatcherTrait::set_token_royalty
fn set_token_royalty(
self: T, token_id: u256, receiver: ContractAddress, fee_numerator: u128,
) -> Result<(), Array<felt252>>
reset_token_royalty
Resets royalty information for the token id back to unset.
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981AdminSafeDispatcherTrait::reset_token_royalty
fn reset_token_royalty(self: T, token_id: u256) -> Result<(), Array<felt252>>
IERC2981ABIDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABIDispatcherTrait
Part of the group: dispatchers
pub trait IERC2981ABIDispatcherTrait<T>
Trait functions
royalty_info
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABIDispatcherTrait::royalty_info
fn royalty_info(self: T, token_id: u256, sale_price: u256) -> (ContractAddress, u256)
default_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABIDispatcherTrait::default_royalty
fn default_royalty(self: T) -> (ContractAddress, u128, u128)
token_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABIDispatcherTrait::token_royalty
fn token_royalty(self: T, token_id: u256) -> (ContractAddress, u128, u128)
set_default_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABIDispatcherTrait::set_default_royalty
fn set_default_royalty(self: T, receiver: ContractAddress, fee_numerator: u128)
delete_default_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABIDispatcherTrait::delete_default_royalty
fn delete_default_royalty(self: T)
set_token_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABIDispatcherTrait::set_token_royalty
fn set_token_royalty(self: T, token_id: u256, receiver: ContractAddress, fee_numerator: u128)
reset_token_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABIDispatcherTrait::reset_token_royalty
fn reset_token_royalty(self: T, token_id: u256)
IERC2981ABISafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABISafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC2981ABISafeDispatcherTrait<T>
Trait functions
royalty_info
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABISafeDispatcherTrait::royalty_info
fn royalty_info(
self: T, token_id: u256, sale_price: u256,
) -> Result<(ContractAddress, u256), Array<felt252>>
default_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABISafeDispatcherTrait::default_royalty
fn default_royalty(self: T) -> Result<(ContractAddress, u128, u128), Array<felt252>>
token_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABISafeDispatcherTrait::token_royalty
fn token_royalty(self: T, token_id: u256) -> Result<(ContractAddress, u128, u128), Array<felt252>>
set_default_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABISafeDispatcherTrait::set_default_royalty
fn set_default_royalty(
self: T, receiver: ContractAddress, fee_numerator: u128,
) -> Result<(), Array<felt252>>
delete_default_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABISafeDispatcherTrait::delete_default_royalty
fn delete_default_royalty(self: T) -> Result<(), Array<felt252>>
set_token_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABISafeDispatcherTrait::set_token_royalty
fn set_token_royalty(
self: T, token_id: u256, receiver: ContractAddress, fee_numerator: u128,
) -> Result<(), Array<felt252>>
reset_token_royalty
Fully qualified path: openzeppelin_interfaces::token::erc2981::IERC2981ABISafeDispatcherTrait::reset_token_royalty
fn reset_token_royalty(self: T, token_id: u256) -> Result<(), Array<felt252>>
IERC4626DispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait
Part of the group: dispatchers
pub trait IERC4626DispatcherTrait<T>
Trait functions
asset
Returns the address of the underlying token used for the Vault for accounting, depositing, and withdrawing.
Requirements:
- MUST be an ERC20 token contract.
- MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::asset
fn asset(self: T) -> ContractAddress
total_assets
Returns the total amount of the underlying asset that is “managed” by Vault.
Requirements:
- SHOULD include any compounding that occurs from yield.
- MUST be inclusive of any fees that are charged against assets in the Vault.
- MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::total_assets
fn total_assets(self: T) -> u256
convert_to_shares
Returns the amount of shares that the Vault would exchange for the amount of assets provided irrespective of slippage or fees.
Requirements:
- MUST NOT be inclusive of any fees that are charged against assets in the Vault.
- MUST NOT show any variations depending on the caller.
- MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange.
- MUST NOT panic unless due to integer overflow caused by an unreasonably large input.
- MUST round down towards 0.
NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and from.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::convert_to_shares
fn convert_to_shares(self: T, assets: u256) -> u256
convert_to_assets
Returns the amount of assets that the Vault would exchange for the amount of shares provided irrespective of slippage or fees.
Requirements:
- MUST NOT be inclusive of any fees that are charged against assets in the Vault.
- MUST NOT show any variations depending on the caller.
- MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange.
- MUST NOT panic unless due to integer overflow caused by an unreasonably large input.
- MUST round down towards 0.
NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and from.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::convert_to_assets
fn convert_to_assets(self: T, shares: u256) -> u256
max_deposit
Returns the maximum amount of the underlying asset that can be deposited into the Vault for
receiver, through a deposit call.
Requirements:
- MUST return a limited value if receiver is subject to some deposit limit.
- MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of assets that may be deposited.
- MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::max_deposit
fn max_deposit(self: T, receiver: ContractAddress) -> u256
preview_deposit
Allows an on-chain or off-chain user to simulate the effects of their deposit at the current block, given current on-chain conditions.
Requirements:
- MUST return as close to and no more than the exact amount of Vault shares that would be
minted in a deposit call in the same transaction i.e. deposit should return the same or
more shares as
preview_depositif called in the same transaction. - MUST NOT account for deposit limits like those returned from
max_depositand should always act as though the deposit would be accepted, regardless if the user has enough tokens approved, etc. - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
- MUST NOT panic.
NOTE: Any unfavorable discrepancy between convert_to_shares and preview_deposit
SHOULD be considered slippage in share price or some other type of condition, meaning the
depositor will lose assets by depositing.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::preview_deposit
fn preview_deposit(self: T, assets: u256) -> u256
deposit
Mints Vault shares to receiver by depositing exactly amount of assets.
Requirements:
- MUST emit the Deposit event.
- MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the deposit execution, and are accounted for during deposit.
- MUST panic if all of assets cannot be deposited (due to deposit limit being reached, slippage, the user not approving enough underlying tokens to the Vault contract, etc).
NOTE: Most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::deposit
fn deposit(self: T, assets: u256, receiver: ContractAddress) -> u256
max_mint
Returns the maximum amount of the Vault shares that can be minted for the receiver, through a mint call.
Requirements:
- MUST return a limited value if receiver is subject to some mint limit.
- MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of shares that may be minted.
- MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::max_mint
fn max_mint(self: T, receiver: ContractAddress) -> u256
preview_mint
Allows an on-chain or off-chain user to simulate the effects of their mint at the current block, given current on-chain conditions.
Requirements:
- MUST return as close to and no fewer than the exact amount of assets that would be
deposited in a
mintcall in the same transaction. I.e.mintshould return the same or fewer assets aspreview_mintif called in the same transaction. - MUST NOT account for mint limits like those returned from
max_mintand should always act as though the mint would be accepted, regardless if the user has enough tokens approved, etc. - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
- MUST NOT panic.
NOTE: Any unfavorable discrepancy between convertToAssets and previewMint SHOULD be considered slippage in share price or some other type of condition, meaning the depositor will lose assets by minting.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::preview_mint
fn preview_mint(self: T, shares: u256) -> u256
mint
Mints exactly shares Vault shares to receiver by depositing amount of underlying tokens.
Requirements:
- MUST emit the
Depositevent. - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the mint execution, and are accounted for during mint.
- MUST panic if all of shares cannot be minted (due to deposit limit being reached, slippage, the user not approving enough underlying tokens to the Vault contract, etc).
NOTE: Most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::mint
fn mint(self: T, shares: u256, receiver: ContractAddress) -> u256
max_withdraw
Returns the maximum amount of the underlying asset that can be withdrawn from the owner balance in the Vault, through a withdraw call.
Requirements:
- MUST return a limited value if owner is subject to some withdrawal limit or timelock.
- MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::max_withdraw
fn max_withdraw(self: T, owner: ContractAddress) -> u256
preview_withdraw
Allows an on-chain or off-chain user to simulate the effects of their withdrawal at the current block, given current on-chain conditions.
Requirements:
- MUST return as close to and no fewer than the exact amount of Vault shares that would be burned in a withdraw call in the same transaction i.e. withdraw should return the same or fewer shares as preview_withdraw if called in the same transaction.
- MUST NOT account for withdrawal limits like those returned from max_withdraw and should always act as though the withdrawal would be accepted, regardless if the user has enough shares, etc.
- MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
- MUST not panic.
NOTE: Any unfavorable discrepancy between convert_to_shares and preview_withdraw
SHOULD be considered slippage in share price or some other type of condition, meaning the
depositor will lose assets by depositing.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::preview_withdraw
fn preview_withdraw(self: T, assets: u256) -> u256
withdraw
Burns shares from owner and sends exactly assets of underlying tokens to receiver.
Requirements:
- MUST emit the
Withdrawevent. - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the withdraw execution, and are accounted for during withdraw.
- MUST revert if all of assets cannot be withdrawn (due to withdrawal limit being reached, slippage, the owner not having enough shares, etc).
NOTE: Some implementations will require pre-requesting to the Vault before a withdrawal may be performed. Those methods should be performed separately.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::withdraw
fn withdraw(self: T, assets: u256, receiver: ContractAddress, owner: ContractAddress) -> u256
max_redeem
Returns the maximum amount of Vault shares that can be redeemed from the owner balance in the Vault, through a redeem call.
Requirements:
- MUST return a limited value if owner is subject to some withdrawal limit or timelock.
- MUST return
ERC20::balance_of(owner)ifowneris not subject to any withdrawal limit or timelock. - MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::max_redeem
fn max_redeem(self: T, owner: ContractAddress) -> u256
preview_redeem
Allows an on-chain or off-chain user to simulate the effects of their redemption at the current block, given current on-chain conditions.
Requirements:
- MUST return as close to and no more than the exact amount of assets that would be withdrawn in a redeem call in the same transaction i.e. redeem should return the same or more assets as preview_redeem if called in the same transaction.
- MUST NOT account for redemption limits like those returned from max_redeem and should always act as though the redemption would be accepted, regardless if the user has enough shares, etc.
- MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
- MUST NOT panic.
NOTE: Any unfavorable discrepancy between convert_to_assets and preview_redeem SHOULD be
considered slippage in share price or some other type of condition, meaning the depositor
will lose assets by redeeming.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::preview_redeem
fn preview_redeem(self: T, shares: u256) -> u256
redeem
Burns exactly shares from owner and sends assets of underlying tokens to receiver.
Requirements:
- MUST emit the
Withdrawevent. - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the redeem execution, and are accounted for during redeem.
- MUST revert if all of shares cannot be redeemed (due to withdrawal limit being reached, slippage, the owner not having enough shares, etc).
NOTE: Some implementations will require pre-requesting to the Vault before a withdrawal may be performed. Those methods should be performed separately.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626DispatcherTrait::redeem
fn redeem(self: T, shares: u256, receiver: ContractAddress, owner: ContractAddress) -> u256
IERC4626SafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC4626SafeDispatcherTrait<T>
Trait functions
asset
Returns the address of the underlying token used for the Vault for accounting, depositing, and withdrawing.
Requirements:
- MUST be an ERC20 token contract.
- MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcherTrait::asset
fn asset(self: T) -> Result<ContractAddress, Array<felt252>>
total_assets
Returns the total amount of the underlying asset that is “managed” by Vault.
Requirements:
- SHOULD include any compounding that occurs from yield.
- MUST be inclusive of any fees that are charged against assets in the Vault.
- MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcherTrait::total_assets
fn total_assets(self: T) -> Result<u256, Array<felt252>>
convert_to_shares
Returns the amount of shares that the Vault would exchange for the amount of assets provided irrespective of slippage or fees.
Requirements:
- MUST NOT be inclusive of any fees that are charged against assets in the Vault.
- MUST NOT show any variations depending on the caller.
- MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange.
- MUST NOT panic unless due to integer overflow caused by an unreasonably large input.
- MUST round down towards 0.
NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and from.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcherTrait::convert_to_shares
fn convert_to_shares(self: T, assets: u256) -> Result<u256, Array<felt252>>
convert_to_assets
Returns the amount of assets that the Vault would exchange for the amount of shares provided irrespective of slippage or fees.
Requirements:
- MUST NOT be inclusive of any fees that are charged against assets in the Vault.
- MUST NOT show any variations depending on the caller.
- MUST NOT reflect slippage or other on-chain conditions, when performing the actual exchange.
- MUST NOT panic unless due to integer overflow caused by an unreasonably large input.
- MUST round down towards 0.
NOTE: This calculation MAY NOT reflect the “per-user” price-per-share, and instead should reflect the “average-user’s” price-per-share, meaning what the average user should expect to see when exchanging to and from.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcherTrait::convert_to_assets
fn convert_to_assets(self: T, shares: u256) -> Result<u256, Array<felt252>>
max_deposit
Returns the maximum amount of the underlying asset that can be deposited into the Vault for
receiver, through a deposit call.
Requirements:
- MUST return a limited value if receiver is subject to some deposit limit.
- MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of assets that may be deposited.
- MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcherTrait::max_deposit
fn max_deposit(self: T, receiver: ContractAddress) -> Result<u256, Array<felt252>>
preview_deposit
Allows an on-chain or off-chain user to simulate the effects of their deposit at the current block, given current on-chain conditions.
Requirements:
- MUST return as close to and no more than the exact amount of Vault shares that would be
minted in a deposit call in the same transaction i.e. deposit should return the same or
more shares as
preview_depositif called in the same transaction. - MUST NOT account for deposit limits like those returned from
max_depositand should always act as though the deposit would be accepted, regardless if the user has enough tokens approved, etc. - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
- MUST NOT panic.
NOTE: Any unfavorable discrepancy between convert_to_shares and preview_deposit
SHOULD be considered slippage in share price or some other type of condition, meaning the
depositor will lose assets by depositing.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcherTrait::preview_deposit
fn preview_deposit(self: T, assets: u256) -> Result<u256, Array<felt252>>
deposit
Mints Vault shares to receiver by depositing exactly amount of assets.
Requirements:
- MUST emit the Deposit event.
- MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the deposit execution, and are accounted for during deposit.
- MUST panic if all of assets cannot be deposited (due to deposit limit being reached, slippage, the user not approving enough underlying tokens to the Vault contract, etc).
NOTE: Most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcherTrait::deposit
fn deposit(self: T, assets: u256, receiver: ContractAddress) -> Result<u256, Array<felt252>>
max_mint
Returns the maximum amount of the Vault shares that can be minted for the receiver, through a mint call.
Requirements:
- MUST return a limited value if receiver is subject to some mint limit.
- MUST return 2 ** 256 - 1 if there is no limit on the maximum amount of shares that may be minted.
- MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcherTrait::max_mint
fn max_mint(self: T, receiver: ContractAddress) -> Result<u256, Array<felt252>>
preview_mint
Allows an on-chain or off-chain user to simulate the effects of their mint at the current block, given current on-chain conditions.
Requirements:
- MUST return as close to and no fewer than the exact amount of assets that would be
deposited in a
mintcall in the same transaction. I.e.mintshould return the same or fewer assets aspreview_mintif called in the same transaction. - MUST NOT account for mint limits like those returned from
max_mintand should always act as though the mint would be accepted, regardless if the user has enough tokens approved, etc. - MUST be inclusive of deposit fees. Integrators should be aware of the existence of deposit fees.
- MUST NOT panic.
NOTE: Any unfavorable discrepancy between convertToAssets and previewMint SHOULD be considered slippage in share price or some other type of condition, meaning the depositor will lose assets by minting.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcherTrait::preview_mint
fn preview_mint(self: T, shares: u256) -> Result<u256, Array<felt252>>
mint
Mints exactly shares Vault shares to receiver by depositing amount of underlying tokens.
Requirements:
- MUST emit the
Depositevent. - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the mint execution, and are accounted for during mint.
- MUST panic if all of shares cannot be minted (due to deposit limit being reached, slippage, the user not approving enough underlying tokens to the Vault contract, etc).
NOTE: Most implementations will require pre-approval of the Vault with the Vault’s underlying asset token.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcherTrait::mint
fn mint(self: T, shares: u256, receiver: ContractAddress) -> Result<u256, Array<felt252>>
max_withdraw
Returns the maximum amount of the underlying asset that can be withdrawn from the owner balance in the Vault, through a withdraw call.
Requirements:
- MUST return a limited value if owner is subject to some withdrawal limit or timelock.
- MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcherTrait::max_withdraw
fn max_withdraw(self: T, owner: ContractAddress) -> Result<u256, Array<felt252>>
preview_withdraw
Allows an on-chain or off-chain user to simulate the effects of their withdrawal at the current block, given current on-chain conditions.
Requirements:
- MUST return as close to and no fewer than the exact amount of Vault shares that would be burned in a withdraw call in the same transaction i.e. withdraw should return the same or fewer shares as preview_withdraw if called in the same transaction.
- MUST NOT account for withdrawal limits like those returned from max_withdraw and should always act as though the withdrawal would be accepted, regardless if the user has enough shares, etc.
- MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
- MUST not panic.
NOTE: Any unfavorable discrepancy between convert_to_shares and preview_withdraw
SHOULD be considered slippage in share price or some other type of condition, meaning the
depositor will lose assets by depositing.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcherTrait::preview_withdraw
fn preview_withdraw(self: T, assets: u256) -> Result<u256, Array<felt252>>
withdraw
Burns shares from owner and sends exactly assets of underlying tokens to receiver.
Requirements:
- MUST emit the
Withdrawevent. - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the withdraw execution, and are accounted for during withdraw.
- MUST revert if all of assets cannot be withdrawn (due to withdrawal limit being reached, slippage, the owner not having enough shares, etc).
NOTE: Some implementations will require pre-requesting to the Vault before a withdrawal may be performed. Those methods should be performed separately.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcherTrait::withdraw
fn withdraw(
self: T, assets: u256, receiver: ContractAddress, owner: ContractAddress,
) -> Result<u256, Array<felt252>>
max_redeem
Returns the maximum amount of Vault shares that can be redeemed from the owner balance in the Vault, through a redeem call.
Requirements:
- MUST return a limited value if owner is subject to some withdrawal limit or timelock.
- MUST return
ERC20::balance_of(owner)ifowneris not subject to any withdrawal limit or timelock. - MUST NOT panic.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcherTrait::max_redeem
fn max_redeem(self: T, owner: ContractAddress) -> Result<u256, Array<felt252>>
preview_redeem
Allows an on-chain or off-chain user to simulate the effects of their redemption at the current block, given current on-chain conditions.
Requirements:
- MUST return as close to and no more than the exact amount of assets that would be withdrawn in a redeem call in the same transaction i.e. redeem should return the same or more assets as preview_redeem if called in the same transaction.
- MUST NOT account for redemption limits like those returned from max_redeem and should always act as though the redemption would be accepted, regardless if the user has enough shares, etc.
- MUST be inclusive of withdrawal fees. Integrators should be aware of the existence of withdrawal fees.
- MUST NOT panic.
NOTE: Any unfavorable discrepancy between convert_to_assets and preview_redeem SHOULD be
considered slippage in share price or some other type of condition, meaning the depositor
will lose assets by redeeming.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcherTrait::preview_redeem
fn preview_redeem(self: T, shares: u256) -> Result<u256, Array<felt252>>
redeem
Burns exactly shares from owner and sends assets of underlying tokens to receiver.
Requirements:
- MUST emit the
Withdrawevent. - MAY support an additional flow in which the underlying tokens are owned by the Vault contract before the redeem execution, and are accounted for during redeem.
- MUST revert if all of shares cannot be redeemed (due to withdrawal limit being reached, slippage, the owner not having enough shares, etc).
NOTE: Some implementations will require pre-requesting to the Vault before a withdrawal may be performed. Those methods should be performed separately.
Fully qualified path: openzeppelin_interfaces::token::erc4626::IERC4626SafeDispatcherTrait::redeem
fn redeem(
self: T, shares: u256, receiver: ContractAddress, owner: ContractAddress,
) -> Result<u256, Array<felt252>>
ERC4626ABIDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait
Part of the group: dispatchers
pub trait ERC4626ABIDispatcherTrait<T>
Trait functions
asset
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::asset
fn asset(self: T) -> ContractAddress
total_assets
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::total_assets
fn total_assets(self: T) -> u256
convert_to_shares
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::convert_to_shares
fn convert_to_shares(self: T, assets: u256) -> u256
convert_to_assets
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::convert_to_assets
fn convert_to_assets(self: T, shares: u256) -> u256
max_deposit
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::max_deposit
fn max_deposit(self: T, receiver: ContractAddress) -> u256
preview_deposit
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::preview_deposit
fn preview_deposit(self: T, assets: u256) -> u256
deposit
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::deposit
fn deposit(self: T, assets: u256, receiver: ContractAddress) -> u256
max_mint
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::max_mint
fn max_mint(self: T, receiver: ContractAddress) -> u256
preview_mint
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::preview_mint
fn preview_mint(self: T, shares: u256) -> u256
mint
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::mint
fn mint(self: T, shares: u256, receiver: ContractAddress) -> u256
max_withdraw
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::max_withdraw
fn max_withdraw(self: T, owner: ContractAddress) -> u256
preview_withdraw
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::preview_withdraw
fn preview_withdraw(self: T, assets: u256) -> u256
withdraw
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::withdraw
fn withdraw(self: T, assets: u256, receiver: ContractAddress, owner: ContractAddress) -> u256
max_redeem
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::max_redeem
fn max_redeem(self: T, owner: ContractAddress) -> u256
preview_redeem
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::preview_redeem
fn preview_redeem(self: T, shares: u256) -> u256
redeem
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::redeem
fn redeem(self: T, shares: u256, receiver: ContractAddress, owner: ContractAddress) -> u256
total_supply
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::total_supply
fn total_supply(self: T) -> u256
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress) -> u256
allowance
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::allowance
fn allowance(self: T, owner: ContractAddress, spender: ContractAddress) -> u256
transfer
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::transfer
fn transfer(self: T, recipient: ContractAddress, amount: u256) -> bool
transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::transfer_from
fn transfer_from(self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256) -> bool
approve
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::approve
fn approve(self: T, spender: ContractAddress, amount: u256) -> bool
name
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::name
fn name(self: T) -> ByteArray
symbol
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::symbol
fn symbol(self: T) -> ByteArray
decimals
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::decimals
fn decimals(self: T) -> u8
totalSupply
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::totalSupply
fn totalSupply(self: T) -> u256
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> u256
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABIDispatcherTrait::transferFrom
fn transferFrom(self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256) -> bool
ERC4626ABISafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait
Part of the group: dispatchers
pub trait ERC4626ABISafeDispatcherTrait<T>
Trait functions
asset
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::asset
fn asset(self: T) -> Result<ContractAddress, Array<felt252>>
total_assets
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::total_assets
fn total_assets(self: T) -> Result<u256, Array<felt252>>
convert_to_shares
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::convert_to_shares
fn convert_to_shares(self: T, assets: u256) -> Result<u256, Array<felt252>>
convert_to_assets
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::convert_to_assets
fn convert_to_assets(self: T, shares: u256) -> Result<u256, Array<felt252>>
max_deposit
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::max_deposit
fn max_deposit(self: T, receiver: ContractAddress) -> Result<u256, Array<felt252>>
preview_deposit
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::preview_deposit
fn preview_deposit(self: T, assets: u256) -> Result<u256, Array<felt252>>
deposit
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::deposit
fn deposit(self: T, assets: u256, receiver: ContractAddress) -> Result<u256, Array<felt252>>
max_mint
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::max_mint
fn max_mint(self: T, receiver: ContractAddress) -> Result<u256, Array<felt252>>
preview_mint
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::preview_mint
fn preview_mint(self: T, shares: u256) -> Result<u256, Array<felt252>>
mint
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::mint
fn mint(self: T, shares: u256, receiver: ContractAddress) -> Result<u256, Array<felt252>>
max_withdraw
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::max_withdraw
fn max_withdraw(self: T, owner: ContractAddress) -> Result<u256, Array<felt252>>
preview_withdraw
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::preview_withdraw
fn preview_withdraw(self: T, assets: u256) -> Result<u256, Array<felt252>>
withdraw
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::withdraw
fn withdraw(
self: T, assets: u256, receiver: ContractAddress, owner: ContractAddress,
) -> Result<u256, Array<felt252>>
max_redeem
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::max_redeem
fn max_redeem(self: T, owner: ContractAddress) -> Result<u256, Array<felt252>>
preview_redeem
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::preview_redeem
fn preview_redeem(self: T, shares: u256) -> Result<u256, Array<felt252>>
redeem
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::redeem
fn redeem(
self: T, shares: u256, receiver: ContractAddress, owner: ContractAddress,
) -> Result<u256, Array<felt252>>
total_supply
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::total_supply
fn total_supply(self: T) -> Result<u256, Array<felt252>>
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
allowance
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::allowance
fn allowance(
self: T, owner: ContractAddress, spender: ContractAddress,
) -> Result<u256, Array<felt252>>
transfer
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::transfer
fn transfer(self: T, recipient: ContractAddress, amount: u256) -> Result<bool, Array<felt252>>
transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::transfer_from
fn transfer_from(
self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> Result<bool, Array<felt252>>
approve
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::approve
fn approve(self: T, spender: ContractAddress, amount: u256) -> Result<bool, Array<felt252>>
name
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::name
fn name(self: T) -> Result<ByteArray, Array<felt252>>
symbol
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::symbol
fn symbol(self: T) -> Result<ByteArray, Array<felt252>>
decimals
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::decimals
fn decimals(self: T) -> Result<u8, Array<felt252>>
totalSupply
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::totalSupply
fn totalSupply(self: T) -> Result<u256, Array<felt252>>
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc4626::ERC4626ABISafeDispatcherTrait::transferFrom
fn transferFrom(
self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> Result<bool, Array<felt252>>
IERC721DispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721DispatcherTrait
Part of the group: dispatchers
pub trait IERC721DispatcherTrait<T>
Trait functions
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721DispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress) -> u256
owner_of
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721DispatcherTrait::owner_of
fn owner_of(self: T, token_id: u256) -> ContractAddress
safe_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721DispatcherTrait::safe_transfer_from
fn safe_transfer_from(
self: T, from: ContractAddress, to: ContractAddress, token_id: u256, data: Span<felt252>,
)
transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721DispatcherTrait::transfer_from
fn transfer_from(self: T, from: ContractAddress, to: ContractAddress, token_id: u256)
approve
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721DispatcherTrait::approve
fn approve(self: T, to: ContractAddress, token_id: u256)
set_approval_for_all
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721DispatcherTrait::set_approval_for_all
fn set_approval_for_all(self: T, operator: ContractAddress, approved: bool)
get_approved
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721DispatcherTrait::get_approved
fn get_approved(self: T, token_id: u256) -> ContractAddress
is_approved_for_all
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721DispatcherTrait::is_approved_for_all
fn is_approved_for_all(self: T, owner: ContractAddress, operator: ContractAddress) -> bool
IERC721SafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721SafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC721SafeDispatcherTrait<T>
Trait functions
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721SafeDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
owner_of
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721SafeDispatcherTrait::owner_of
fn owner_of(self: T, token_id: u256) -> Result<ContractAddress, Array<felt252>>
safe_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721SafeDispatcherTrait::safe_transfer_from
fn safe_transfer_from(
self: T, from: ContractAddress, to: ContractAddress, token_id: u256, data: Span<felt252>,
) -> Result<(), Array<felt252>>
transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721SafeDispatcherTrait::transfer_from
fn transfer_from(
self: T, from: ContractAddress, to: ContractAddress, token_id: u256,
) -> Result<(), Array<felt252>>
approve
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721SafeDispatcherTrait::approve
fn approve(self: T, to: ContractAddress, token_id: u256) -> Result<(), Array<felt252>>
set_approval_for_all
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721SafeDispatcherTrait::set_approval_for_all
fn set_approval_for_all(
self: T, operator: ContractAddress, approved: bool,
) -> Result<(), Array<felt252>>
get_approved
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721SafeDispatcherTrait::get_approved
fn get_approved(self: T, token_id: u256) -> Result<ContractAddress, Array<felt252>>
is_approved_for_all
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721SafeDispatcherTrait::is_approved_for_all
fn is_approved_for_all(
self: T, owner: ContractAddress, operator: ContractAddress,
) -> Result<bool, Array<felt252>>
IERC721MetadataDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataDispatcherTrait
Part of the group: dispatchers
pub trait IERC721MetadataDispatcherTrait<T>
Trait functions
name
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataDispatcherTrait::name
fn name(self: T) -> ByteArray
symbol
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataDispatcherTrait::symbol
fn symbol(self: T) -> ByteArray
token_uri
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataDispatcherTrait::token_uri
fn token_uri(self: T, token_id: u256) -> ByteArray
IERC721MetadataSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataSafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC721MetadataSafeDispatcherTrait<T>
Trait functions
name
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataSafeDispatcherTrait::name
fn name(self: T) -> Result<ByteArray, Array<felt252>>
symbol
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataSafeDispatcherTrait::symbol
fn symbol(self: T) -> Result<ByteArray, Array<felt252>>
token_uri
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataSafeDispatcherTrait::token_uri
fn token_uri(self: T, token_id: u256) -> Result<ByteArray, Array<felt252>>
IERC721CamelOnlyDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlyDispatcherTrait
Part of the group: dispatchers
pub trait IERC721CamelOnlyDispatcherTrait<T>
Trait functions
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlyDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> u256
ownerOf
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlyDispatcherTrait::ownerOf
fn ownerOf(self: T, tokenId: u256) -> ContractAddress
safeTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlyDispatcherTrait::safeTransferFrom
fn safeTransferFrom(
self: T, from: ContractAddress, to: ContractAddress, tokenId: u256, data: Span<felt252>,
)
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlyDispatcherTrait::transferFrom
fn transferFrom(self: T, from: ContractAddress, to: ContractAddress, tokenId: u256)
setApprovalForAll
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlyDispatcherTrait::setApprovalForAll
fn setApprovalForAll(self: T, operator: ContractAddress, approved: bool)
getApproved
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlyDispatcherTrait::getApproved
fn getApproved(self: T, tokenId: u256) -> ContractAddress
isApprovedForAll
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlyDispatcherTrait::isApprovedForAll
fn isApprovedForAll(self: T, owner: ContractAddress, operator: ContractAddress) -> bool
IERC721CamelOnlySafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlySafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC721CamelOnlySafeDispatcherTrait<T>
Trait functions
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlySafeDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
ownerOf
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlySafeDispatcherTrait::ownerOf
fn ownerOf(self: T, tokenId: u256) -> Result<ContractAddress, Array<felt252>>
safeTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlySafeDispatcherTrait::safeTransferFrom
fn safeTransferFrom(
self: T, from: ContractAddress, to: ContractAddress, tokenId: u256, data: Span<felt252>,
) -> Result<(), Array<felt252>>
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlySafeDispatcherTrait::transferFrom
fn transferFrom(
self: T, from: ContractAddress, to: ContractAddress, tokenId: u256,
) -> Result<(), Array<felt252>>
setApprovalForAll
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlySafeDispatcherTrait::setApprovalForAll
fn setApprovalForAll(
self: T, operator: ContractAddress, approved: bool,
) -> Result<(), Array<felt252>>
getApproved
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlySafeDispatcherTrait::getApproved
fn getApproved(self: T, tokenId: u256) -> Result<ContractAddress, Array<felt252>>
isApprovedForAll
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721CamelOnlySafeDispatcherTrait::isApprovedForAll
fn isApprovedForAll(
self: T, owner: ContractAddress, operator: ContractAddress,
) -> Result<bool, Array<felt252>>
IERC721MetadataCamelOnlyDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataCamelOnlyDispatcherTrait
Part of the group: dispatchers
pub trait IERC721MetadataCamelOnlyDispatcherTrait<T>
Trait functions
tokenURI
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataCamelOnlyDispatcherTrait::tokenURI
fn tokenURI(self: T, tokenId: u256) -> ByteArray
IERC721MetadataCamelOnlySafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataCamelOnlySafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC721MetadataCamelOnlySafeDispatcherTrait<T>
Trait functions
tokenURI
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721MetadataCamelOnlySafeDispatcherTrait::tokenURI
fn tokenURI(self: T, tokenId: u256) -> Result<ByteArray, Array<felt252>>
ERC721ABIDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait
Part of the group: dispatchers
pub trait ERC721ABIDispatcherTrait<T>
Trait functions
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress) -> u256
owner_of
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::owner_of
fn owner_of(self: T, token_id: u256) -> ContractAddress
safe_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::safe_transfer_from
fn safe_transfer_from(
self: T, from: ContractAddress, to: ContractAddress, token_id: u256, data: Span<felt252>,
)
transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::transfer_from
fn transfer_from(self: T, from: ContractAddress, to: ContractAddress, token_id: u256)
approve
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::approve
fn approve(self: T, to: ContractAddress, token_id: u256)
set_approval_for_all
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::set_approval_for_all
fn set_approval_for_all(self: T, operator: ContractAddress, approved: bool)
get_approved
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::get_approved
fn get_approved(self: T, token_id: u256) -> ContractAddress
is_approved_for_all
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::is_approved_for_all
fn is_approved_for_all(self: T, owner: ContractAddress, operator: ContractAddress) -> bool
supports_interface
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> bool
name
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::name
fn name(self: T) -> ByteArray
symbol
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::symbol
fn symbol(self: T) -> ByteArray
token_uri
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::token_uri
fn token_uri(self: T, token_id: u256) -> ByteArray
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> u256
ownerOf
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::ownerOf
fn ownerOf(self: T, tokenId: u256) -> ContractAddress
safeTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::safeTransferFrom
fn safeTransferFrom(
self: T, from: ContractAddress, to: ContractAddress, tokenId: u256, data: Span<felt252>,
)
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::transferFrom
fn transferFrom(self: T, from: ContractAddress, to: ContractAddress, tokenId: u256)
setApprovalForAll
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::setApprovalForAll
fn setApprovalForAll(self: T, operator: ContractAddress, approved: bool)
getApproved
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::getApproved
fn getApproved(self: T, tokenId: u256) -> ContractAddress
isApprovedForAll
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::isApprovedForAll
fn isApprovedForAll(self: T, owner: ContractAddress, operator: ContractAddress) -> bool
tokenURI
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABIDispatcherTrait::tokenURI
fn tokenURI(self: T, tokenId: u256) -> ByteArray
ERC721ABISafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait
Part of the group: dispatchers
pub trait ERC721ABISafeDispatcherTrait<T>
Trait functions
balance_of
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
owner_of
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::owner_of
fn owner_of(self: T, token_id: u256) -> Result<ContractAddress, Array<felt252>>
safe_transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::safe_transfer_from
fn safe_transfer_from(
self: T, from: ContractAddress, to: ContractAddress, token_id: u256, data: Span<felt252>,
) -> Result<(), Array<felt252>>
transfer_from
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::transfer_from
fn transfer_from(
self: T, from: ContractAddress, to: ContractAddress, token_id: u256,
) -> Result<(), Array<felt252>>
approve
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::approve
fn approve(self: T, to: ContractAddress, token_id: u256) -> Result<(), Array<felt252>>
set_approval_for_all
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::set_approval_for_all
fn set_approval_for_all(
self: T, operator: ContractAddress, approved: bool,
) -> Result<(), Array<felt252>>
get_approved
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::get_approved
fn get_approved(self: T, token_id: u256) -> Result<ContractAddress, Array<felt252>>
is_approved_for_all
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::is_approved_for_all
fn is_approved_for_all(
self: T, owner: ContractAddress, operator: ContractAddress,
) -> Result<bool, Array<felt252>>
supports_interface
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> Result<bool, Array<felt252>>
name
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::name
fn name(self: T) -> Result<ByteArray, Array<felt252>>
symbol
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::symbol
fn symbol(self: T) -> Result<ByteArray, Array<felt252>>
token_uri
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::token_uri
fn token_uri(self: T, token_id: u256) -> Result<ByteArray, Array<felt252>>
balanceOf
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
ownerOf
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::ownerOf
fn ownerOf(self: T, tokenId: u256) -> Result<ContractAddress, Array<felt252>>
safeTransferFrom
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::safeTransferFrom
fn safeTransferFrom(
self: T, from: ContractAddress, to: ContractAddress, tokenId: u256, data: Span<felt252>,
) -> Result<(), Array<felt252>>
transferFrom
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::transferFrom
fn transferFrom(
self: T, from: ContractAddress, to: ContractAddress, tokenId: u256,
) -> Result<(), Array<felt252>>
setApprovalForAll
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::setApprovalForAll
fn setApprovalForAll(
self: T, operator: ContractAddress, approved: bool,
) -> Result<(), Array<felt252>>
getApproved
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::getApproved
fn getApproved(self: T, tokenId: u256) -> Result<ContractAddress, Array<felt252>>
isApprovedForAll
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::isApprovedForAll
fn isApprovedForAll(
self: T, owner: ContractAddress, operator: ContractAddress,
) -> Result<bool, Array<felt252>>
tokenURI
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ABISafeDispatcherTrait::tokenURI
fn tokenURI(self: T, tokenId: u256) -> Result<ByteArray, Array<felt252>>
IERC721ReceiverDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverDispatcherTrait
Part of the group: dispatchers
pub trait IERC721ReceiverDispatcherTrait<T>
Trait functions
on_erc721_received
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverDispatcherTrait::on_erc721_received
fn on_erc721_received(
self: T, operator: ContractAddress, from: ContractAddress, token_id: u256, data: Span<felt252>,
) -> felt252
IERC721ReceiverSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverSafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC721ReceiverSafeDispatcherTrait<T>
Trait functions
on_erc721_received
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverSafeDispatcherTrait::on_erc721_received
fn on_erc721_received(
self: T, operator: ContractAddress, from: ContractAddress, token_id: u256, data: Span<felt252>,
) -> Result<felt252, Array<felt252>>
IERC721ReceiverCamelDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverCamelDispatcherTrait
Part of the group: dispatchers
pub trait IERC721ReceiverCamelDispatcherTrait<T>
Trait functions
onERC721Received
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverCamelDispatcherTrait::onERC721Received
fn onERC721Received(
self: T, operator: ContractAddress, from: ContractAddress, tokenId: u256, data: Span<felt252>,
) -> felt252
IERC721ReceiverCamelSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverCamelSafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC721ReceiverCamelSafeDispatcherTrait<T>
Trait functions
onERC721Received
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721ReceiverCamelSafeDispatcherTrait::onERC721Received
fn onERC721Received(
self: T, operator: ContractAddress, from: ContractAddress, tokenId: u256, data: Span<felt252>,
) -> Result<felt252, Array<felt252>>
ERC721ReceiverMixinDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixinDispatcherTrait
Part of the group: dispatchers
pub trait ERC721ReceiverMixinDispatcherTrait<T>
Trait functions
on_erc721_received
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixinDispatcherTrait::on_erc721_received
fn on_erc721_received(
self: T, operator: ContractAddress, from: ContractAddress, token_id: u256, data: Span<felt252>,
) -> felt252
onERC721Received
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixinDispatcherTrait::onERC721Received
fn onERC721Received(
self: T, operator: ContractAddress, from: ContractAddress, tokenId: u256, data: Span<felt252>,
) -> felt252
supports_interface
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixinDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> bool
ERC721ReceiverMixinSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixinSafeDispatcherTrait
Part of the group: dispatchers
pub trait ERC721ReceiverMixinSafeDispatcherTrait<T>
Trait functions
on_erc721_received
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixinSafeDispatcherTrait::on_erc721_received
fn on_erc721_received(
self: T, operator: ContractAddress, from: ContractAddress, token_id: u256, data: Span<felt252>,
) -> Result<felt252, Array<felt252>>
onERC721Received
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixinSafeDispatcherTrait::onERC721Received
fn onERC721Received(
self: T, operator: ContractAddress, from: ContractAddress, tokenId: u256, data: Span<felt252>,
) -> Result<felt252, Array<felt252>>
supports_interface
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721ReceiverMixinSafeDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> Result<bool, Array<felt252>>
IERC721EnumerableDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721EnumerableDispatcherTrait
Part of the group: dispatchers
pub trait IERC721EnumerableDispatcherTrait<T>
Trait functions
total_supply
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721EnumerableDispatcherTrait::total_supply
fn total_supply(self: T) -> u256
token_by_index
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721EnumerableDispatcherTrait::token_by_index
fn token_by_index(self: T, index: u256) -> u256
token_of_owner_by_index
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721EnumerableDispatcherTrait::token_of_owner_by_index
fn token_of_owner_by_index(self: T, owner: ContractAddress, index: u256) -> u256
IERC721EnumerableSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721EnumerableSafeDispatcherTrait
Part of the group: dispatchers
pub trait IERC721EnumerableSafeDispatcherTrait<T>
Trait functions
total_supply
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721EnumerableSafeDispatcherTrait::total_supply
fn total_supply(self: T) -> Result<u256, Array<felt252>>
token_by_index
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721EnumerableSafeDispatcherTrait::token_by_index
fn token_by_index(self: T, index: u256) -> Result<u256, Array<felt252>>
token_of_owner_by_index
Fully qualified path: openzeppelin_interfaces::token::erc721::IERC721EnumerableSafeDispatcherTrait::token_of_owner_by_index
fn token_of_owner_by_index(
self: T, owner: ContractAddress, index: u256,
) -> Result<u256, Array<felt252>>
ERC721EnumerableABIDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABIDispatcherTrait
Part of the group: dispatchers
pub trait ERC721EnumerableABIDispatcherTrait<T>
Trait functions
total_supply
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABIDispatcherTrait::total_supply
fn total_supply(self: T) -> u256
token_by_index
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABIDispatcherTrait::token_by_index
fn token_by_index(self: T, index: u256) -> u256
token_of_owner_by_index
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABIDispatcherTrait::token_of_owner_by_index
fn token_of_owner_by_index(self: T, owner: ContractAddress, index: u256) -> u256
all_tokens_of_owner
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABIDispatcherTrait::all_tokens_of_owner
fn all_tokens_of_owner(self: T, owner: ContractAddress) -> Span<u256>
ERC721EnumerableABISafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABISafeDispatcherTrait
Part of the group: dispatchers
pub trait ERC721EnumerableABISafeDispatcherTrait<T>
Trait functions
total_supply
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABISafeDispatcherTrait::total_supply
fn total_supply(self: T) -> Result<u256, Array<felt252>>
token_by_index
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABISafeDispatcherTrait::token_by_index
fn token_by_index(self: T, index: u256) -> Result<u256, Array<felt252>>
token_of_owner_by_index
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABISafeDispatcherTrait::token_of_owner_by_index
fn token_of_owner_by_index(
self: T, owner: ContractAddress, index: u256,
) -> Result<u256, Array<felt252>>
all_tokens_of_owner
Fully qualified path: openzeppelin_interfaces::token::erc721::ERC721EnumerableABISafeDispatcherTrait::all_tokens_of_owner
fn all_tokens_of_owner(self: T, owner: ContractAddress) -> Result<Span<u256>, Array<felt252>>
IUpgradeableDispatcherTrait
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeableDispatcherTrait
Part of the group: dispatchers
pub trait IUpgradeableDispatcherTrait<T>
Trait functions
upgrade
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeableDispatcherTrait::upgrade
fn upgrade(self: T, new_class_hash: ClassHash)
IUpgradeableSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeableSafeDispatcherTrait
Part of the group: dispatchers
pub trait IUpgradeableSafeDispatcherTrait<T>
Trait functions
upgrade
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeableSafeDispatcherTrait::upgrade
fn upgrade(self: T, new_class_hash: ClassHash) -> Result<(), Array<felt252>>
IUpgradeAndCallDispatcherTrait
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeAndCallDispatcherTrait
Part of the group: dispatchers
pub trait IUpgradeAndCallDispatcherTrait<T>
Trait functions
upgrade_and_call
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeAndCallDispatcherTrait::upgrade_and_call
fn upgrade_and_call(
self: T, new_class_hash: ClassHash, selector: felt252, calldata: Span<felt252>,
) -> Span<felt252>
IUpgradeAndCallSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeAndCallSafeDispatcherTrait
Part of the group: dispatchers
pub trait IUpgradeAndCallSafeDispatcherTrait<T>
Trait functions
upgrade_and_call
Fully qualified path: openzeppelin_interfaces::upgrades::IUpgradeAndCallSafeDispatcherTrait::upgrade_and_call
fn upgrade_and_call(
self: T, new_class_hash: ClassHash, selector: felt252, calldata: Span<felt252>,
) -> Result<Span<felt252>, Array<felt252>>
IUniversalDeployerDispatcherTrait
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerDispatcherTrait
Part of the group: dispatchers
pub trait IUniversalDeployerDispatcherTrait<T>
Trait functions
deploy_contract
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerDispatcherTrait::deploy_contract
fn deploy_contract(
self: T, class_hash: ClassHash, salt: felt252, not_from_zero: bool, calldata: Span<felt252>,
) -> ContractAddress
IUniversalDeployerSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerSafeDispatcherTrait
Part of the group: dispatchers
pub trait IUniversalDeployerSafeDispatcherTrait<T>
Trait functions
deploy_contract
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerSafeDispatcherTrait::deploy_contract
fn deploy_contract(
self: T, class_hash: ClassHash, salt: felt252, not_from_zero: bool, calldata: Span<felt252>,
) -> Result<ContractAddress, Array<felt252>>
IUniversalDeployerCamelDispatcherTrait
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerCamelDispatcherTrait
Part of the group: dispatchers
pub trait IUniversalDeployerCamelDispatcherTrait<T>
Trait functions
deployContract
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerCamelDispatcherTrait::deployContract
fn deployContract(
self: T, classHash: ClassHash, salt: felt252, notFromZero: bool, calldata: Span<felt252>,
) -> ContractAddress
IUniversalDeployerCamelSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerCamelSafeDispatcherTrait
Part of the group: dispatchers
pub trait IUniversalDeployerCamelSafeDispatcherTrait<T>
Trait functions
deployContract
Fully qualified path: openzeppelin_interfaces::utils::deployments::IUniversalDeployerCamelSafeDispatcherTrait::deployContract
fn deployContract(
self: T, classHash: ClassHash, salt: felt252, notFromZero: bool, calldata: Span<felt252>,
) -> Result<ContractAddress, Array<felt252>>
UniversalDeployerABIDispatcherTrait
Fully qualified path: openzeppelin_interfaces::utils::deployments::UniversalDeployerABIDispatcherTrait
Part of the group: dispatchers
pub trait UniversalDeployerABIDispatcherTrait<T>
Trait functions
deploy_contract
Fully qualified path: openzeppelin_interfaces::utils::deployments::UniversalDeployerABIDispatcherTrait::deploy_contract
fn deploy_contract(
self: T, class_hash: ClassHash, salt: felt252, not_from_zero: bool, calldata: Span<felt252>,
) -> ContractAddress
deployContract
Fully qualified path: openzeppelin_interfaces::utils::deployments::UniversalDeployerABIDispatcherTrait::deployContract
fn deployContract(
self: T, classHash: ClassHash, salt: felt252, notFromZero: bool, calldata: Span<felt252>,
) -> ContractAddress
UniversalDeployerABISafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::utils::deployments::UniversalDeployerABISafeDispatcherTrait
Part of the group: dispatchers
pub trait UniversalDeployerABISafeDispatcherTrait<T>
Trait functions
deploy_contract
Fully qualified path: openzeppelin_interfaces::utils::deployments::UniversalDeployerABISafeDispatcherTrait::deploy_contract
fn deploy_contract(
self: T, class_hash: ClassHash, salt: felt252, not_from_zero: bool, calldata: Span<felt252>,
) -> Result<ContractAddress, Array<felt252>>
deployContract
Fully qualified path: openzeppelin_interfaces::utils::deployments::UniversalDeployerABISafeDispatcherTrait::deployContract
fn deployContract(
self: T, classHash: ClassHash, salt: felt252, notFromZero: bool, calldata: Span<felt252>,
) -> Result<ContractAddress, Array<felt252>>
INoncesDispatcherTrait
Fully qualified path: openzeppelin_interfaces::utils::nonces::INoncesDispatcherTrait
Part of the group: dispatchers
pub trait INoncesDispatcherTrait<T>
Trait functions
nonces
Fully qualified path: openzeppelin_interfaces::utils::nonces::INoncesDispatcherTrait::nonces
fn nonces(self: T, owner: ContractAddress) -> felt252
INoncesSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::utils::nonces::INoncesSafeDispatcherTrait
Part of the group: dispatchers
pub trait INoncesSafeDispatcherTrait<T>
Trait functions
nonces
Fully qualified path: openzeppelin_interfaces::utils::nonces::INoncesSafeDispatcherTrait::nonces
fn nonces(self: T, owner: ContractAddress) -> Result<felt252, Array<felt252>>
ISNIP12MetadataDispatcherTrait
Fully qualified path: openzeppelin_interfaces::utils::snip12::ISNIP12MetadataDispatcherTrait
Part of the group: dispatchers
pub trait ISNIP12MetadataDispatcherTrait<T>
Trait functions
snip12_metadata
Fully qualified path: openzeppelin_interfaces::utils::snip12::ISNIP12MetadataDispatcherTrait::snip12_metadata
fn snip12_metadata(self: T) -> (felt252, felt252)
ISNIP12MetadataSafeDispatcherTrait
Fully qualified path: openzeppelin_interfaces::utils::snip12::ISNIP12MetadataSafeDispatcherTrait
Part of the group: dispatchers
pub trait ISNIP12MetadataSafeDispatcherTrait<T>
Trait functions
snip12_metadata
Fully qualified path: openzeppelin_interfaces::utils::snip12::ISNIP12MetadataSafeDispatcherTrait::snip12_metadata
fn snip12_metadata(self: T) -> Result<(felt252, felt252), Array<felt252>>
AccountUpgradeableABIDispatcherTrait
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABIDispatcherTrait
Part of the group: dispatchers
pub trait AccountUpgradeableABIDispatcherTrait<T>
Trait functions
execute
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABIDispatcherTrait::execute
fn __execute__(self: T, calls: Array<Call>)
validate
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABIDispatcherTrait::validate
fn __validate__(self: T, calls: Array<Call>) -> felt252
is_valid_signature
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABIDispatcherTrait::is_valid_signature
fn is_valid_signature(self: T, hash: felt252, signature: Array<felt252>) -> felt252
supports_interface
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABIDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> bool
execute_from_outside_v2
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABIDispatcherTrait::execute_from_outside_v2
fn execute_from_outside_v2(
self: T, outside_execution: OutsideExecution, signature: Span<felt252>,
) -> Array<Span<felt252>>
is_valid_outside_execution_nonce
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABIDispatcherTrait::is_valid_outside_execution_nonce
fn is_valid_outside_execution_nonce(self: T, nonce: felt252) -> bool
validate_declare
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABIDispatcherTrait::validate_declare
fn __validate_declare__(self: T, class_hash: felt252) -> felt252
validate_deploy
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABIDispatcherTrait::validate_deploy
fn __validate_deploy__(
self: T, class_hash: felt252, contract_address_salt: felt252, public_key: felt252,
) -> felt252
get_public_key
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABIDispatcherTrait::get_public_key
fn get_public_key(self: T) -> felt252
set_public_key
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABIDispatcherTrait::set_public_key
fn set_public_key(self: T, new_public_key: felt252, signature: Span<felt252>)
isValidSignature
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABIDispatcherTrait::isValidSignature
fn isValidSignature(self: T, hash: felt252, signature: Array<felt252>) -> felt252
getPublicKey
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABIDispatcherTrait::getPublicKey
fn getPublicKey(self: T) -> felt252
setPublicKey
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABIDispatcherTrait::setPublicKey
fn setPublicKey(self: T, newPublicKey: felt252, signature: Span<felt252>)
upgrade
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABIDispatcherTrait::upgrade
fn upgrade(self: T, new_class_hash: ClassHash)
ERC1155UpgradeableABIDispatcherTrait
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait
Part of the group: dispatchers
pub trait ERC1155UpgradeableABIDispatcherTrait<T>
Trait functions
balance_of
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress, token_id: u256) -> u256
balance_of_batch
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::balance_of_batch
fn balance_of_batch(self: T, accounts: Span<ContractAddress>, token_ids: Span<u256>) -> Span<u256>
safe_transfer_from
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::safe_transfer_from
fn safe_transfer_from(
self: T,
from: ContractAddress,
to: ContractAddress,
token_id: u256,
value: u256,
data: Span<felt252>,
)
safe_batch_transfer_from
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::safe_batch_transfer_from
fn safe_batch_transfer_from(
self: T,
from: ContractAddress,
to: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
)
is_approved_for_all
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::is_approved_for_all
fn is_approved_for_all(self: T, owner: ContractAddress, operator: ContractAddress) -> bool
set_approval_for_all
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::set_approval_for_all
fn set_approval_for_all(self: T, operator: ContractAddress, approved: bool)
supports_interface
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> bool
uri
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::uri
fn uri(self: T, token_id: u256) -> ByteArray
balanceOf
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress, tokenId: u256) -> u256
balanceOfBatch
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::balanceOfBatch
fn balanceOfBatch(self: T, accounts: Span<ContractAddress>, tokenIds: Span<u256>) -> Span<u256>
safeTransferFrom
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::safeTransferFrom
fn safeTransferFrom(
self: T,
from: ContractAddress,
to: ContractAddress,
tokenId: u256,
value: u256,
data: Span<felt252>,
)
safeBatchTransferFrom
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::safeBatchTransferFrom
fn safeBatchTransferFrom(
self: T,
from: ContractAddress,
to: ContractAddress,
tokenIds: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
)
isApprovedForAll
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::isApprovedForAll
fn isApprovedForAll(self: T, owner: ContractAddress, operator: ContractAddress) -> bool
setApprovalForAll
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::setApprovalForAll
fn setApprovalForAll(self: T, operator: ContractAddress, approved: bool)
owner
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::owner
fn owner(self: T) -> ContractAddress
transfer_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::transfer_ownership
fn transfer_ownership(self: T, new_owner: ContractAddress)
renounce_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::renounce_ownership
fn renounce_ownership(self: T)
transferOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::transferOwnership
fn transferOwnership(self: T, newOwner: ContractAddress)
renounceOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::renounceOwnership
fn renounceOwnership(self: T)
upgrade
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABIDispatcherTrait::upgrade
fn upgrade(self: T, new_class_hash: ClassHash)
ERC20UpgradeableABIDispatcherTrait
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait
Part of the group: dispatchers
pub trait ERC20UpgradeableABIDispatcherTrait<T>
Trait functions
total_supply
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::total_supply
fn total_supply(self: T) -> u256
balance_of
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress) -> u256
allowance
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::allowance
fn allowance(self: T, owner: ContractAddress, spender: ContractAddress) -> u256
transfer
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::transfer
fn transfer(self: T, recipient: ContractAddress, amount: u256) -> bool
transfer_from
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::transfer_from
fn transfer_from(self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256) -> bool
approve
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::approve
fn approve(self: T, spender: ContractAddress, amount: u256) -> bool
name
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::name
fn name(self: T) -> ByteArray
symbol
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::symbol
fn symbol(self: T) -> ByteArray
decimals
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::decimals
fn decimals(self: T) -> u8
totalSupply
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::totalSupply
fn totalSupply(self: T) -> u256
balanceOf
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> u256
transferFrom
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::transferFrom
fn transferFrom(self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256) -> bool
owner
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::owner
fn owner(self: T) -> ContractAddress
transfer_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::transfer_ownership
fn transfer_ownership(self: T, new_owner: ContractAddress)
renounce_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::renounce_ownership
fn renounce_ownership(self: T)
transferOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::transferOwnership
fn transferOwnership(self: T, newOwner: ContractAddress)
renounceOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::renounceOwnership
fn renounceOwnership(self: T)
upgrade
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABIDispatcherTrait::upgrade
fn upgrade(self: T, new_class_hash: ClassHash)
ERC721UpgradeableABIDispatcherTrait
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait
Part of the group: dispatchers
pub trait ERC721UpgradeableABIDispatcherTrait<T>
Trait functions
balance_of
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress) -> u256
owner_of
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::owner_of
fn owner_of(self: T, token_id: u256) -> ContractAddress
safe_transfer_from
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::safe_transfer_from
fn safe_transfer_from(
self: T, from: ContractAddress, to: ContractAddress, token_id: u256, data: Span<felt252>,
)
transfer_from
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::transfer_from
fn transfer_from(self: T, from: ContractAddress, to: ContractAddress, token_id: u256)
approve
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::approve
fn approve(self: T, to: ContractAddress, token_id: u256)
set_approval_for_all
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::set_approval_for_all
fn set_approval_for_all(self: T, operator: ContractAddress, approved: bool)
get_approved
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::get_approved
fn get_approved(self: T, token_id: u256) -> ContractAddress
is_approved_for_all
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::is_approved_for_all
fn is_approved_for_all(self: T, owner: ContractAddress, operator: ContractAddress) -> bool
supports_interface
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> bool
name
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::name
fn name(self: T) -> ByteArray
symbol
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::symbol
fn symbol(self: T) -> ByteArray
token_uri
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::token_uri
fn token_uri(self: T, token_id: u256) -> ByteArray
balanceOf
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> u256
ownerOf
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::ownerOf
fn ownerOf(self: T, tokenId: u256) -> ContractAddress
safeTransferFrom
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::safeTransferFrom
fn safeTransferFrom(
self: T, from: ContractAddress, to: ContractAddress, tokenId: u256, data: Span<felt252>,
)
transferFrom
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::transferFrom
fn transferFrom(self: T, from: ContractAddress, to: ContractAddress, tokenId: u256)
setApprovalForAll
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::setApprovalForAll
fn setApprovalForAll(self: T, operator: ContractAddress, approved: bool)
getApproved
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::getApproved
fn getApproved(self: T, tokenId: u256) -> ContractAddress
isApprovedForAll
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::isApprovedForAll
fn isApprovedForAll(self: T, owner: ContractAddress, operator: ContractAddress) -> bool
tokenURI
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::tokenURI
fn tokenURI(self: T, tokenId: u256) -> ByteArray
owner
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::owner
fn owner(self: T) -> ContractAddress
transfer_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::transfer_ownership
fn transfer_ownership(self: T, new_owner: ContractAddress)
renounce_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::renounce_ownership
fn renounce_ownership(self: T)
transferOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::transferOwnership
fn transferOwnership(self: T, newOwner: ContractAddress)
renounceOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::renounceOwnership
fn renounceOwnership(self: T)
upgrade
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABIDispatcherTrait::upgrade
fn upgrade(self: T, new_class_hash: ClassHash)
EthAccountUpgradeableABIDispatcherTrait
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABIDispatcherTrait
Part of the group: dispatchers
pub trait EthAccountUpgradeableABIDispatcherTrait<T>
Trait functions
execute
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABIDispatcherTrait::execute
fn __execute__(self: T, calls: Array<Call>)
validate
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABIDispatcherTrait::validate
fn __validate__(self: T, calls: Array<Call>) -> felt252
is_valid_signature
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABIDispatcherTrait::is_valid_signature
fn is_valid_signature(self: T, hash: felt252, signature: Array<felt252>) -> felt252
supports_interface
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABIDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> bool
execute_from_outside_v2
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABIDispatcherTrait::execute_from_outside_v2
fn execute_from_outside_v2(
self: T, outside_execution: OutsideExecution, signature: Span<felt252>,
) -> Array<Span<felt252>>
is_valid_outside_execution_nonce
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABIDispatcherTrait::is_valid_outside_execution_nonce
fn is_valid_outside_execution_nonce(self: T, nonce: felt252) -> bool
validate_declare
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABIDispatcherTrait::validate_declare
fn __validate_declare__(self: T, class_hash: felt252) -> felt252
validate_deploy
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABIDispatcherTrait::validate_deploy
fn __validate_deploy__(
self: T, class_hash: felt252, contract_address_salt: felt252, public_key: Secp256k1Point,
) -> felt252
get_public_key
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABIDispatcherTrait::get_public_key
fn get_public_key(self: T) -> Secp256k1Point
set_public_key
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABIDispatcherTrait::set_public_key
fn set_public_key(self: T, new_public_key: Secp256k1Point, signature: Span<felt252>)
isValidSignature
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABIDispatcherTrait::isValidSignature
fn isValidSignature(self: T, hash: felt252, signature: Array<felt252>) -> felt252
getPublicKey
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABIDispatcherTrait::getPublicKey
fn getPublicKey(self: T) -> Secp256k1Point
setPublicKey
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABIDispatcherTrait::setPublicKey
fn setPublicKey(self: T, newPublicKey: Secp256k1Point, signature: Span<felt252>)
upgrade
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABIDispatcherTrait::upgrade
fn upgrade(self: T, new_class_hash: ClassHash)
MetaTransactionV0ABIDispatcherTrait
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::MetaTransactionV0ABIDispatcherTrait
Part of the group: dispatchers
pub trait MetaTransactionV0ABIDispatcherTrait<T>
Trait functions
execute_meta_tx_v0
Wrapper around the meta_tx_v0_syscall function.
Invokes the given entry point as a v0 meta transaction.
- The signature is replaced with the given signature.
- The caller is the OS (address 0).
- The transaction version is replaced by 0.
- The transaction hash is replaced by the corresponding version-0 transaction hash.
The context changes apply to the called contract and the inner contracts it calls, except for the caller, which is updated appropriately in subcalls.
NOTE: This syscall should only be used to allow support for old version-0 bound accounts, and should not be used for other purposes.
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::MetaTransactionV0ABIDispatcherTrait::execute_meta_tx_v0
fn execute_meta_tx_v0(
self: T,
target: ContractAddress,
entry_point_selector: felt252,
calldata: Span<felt252>,
signature: Span<felt252>,
) -> Result<Span<felt252>, Array<felt252>>
VestingWalletABIDispatcherTrait
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABIDispatcherTrait
Part of the group: dispatchers
pub trait VestingWalletABIDispatcherTrait<T>
Trait functions
start
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABIDispatcherTrait::start
fn start(self: T) -> u64
cliff
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABIDispatcherTrait::cliff
fn cliff(self: T) -> u64
duration
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABIDispatcherTrait::duration
fn duration(self: T) -> u64
end
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABIDispatcherTrait::end
fn end(self: T) -> u64
released
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABIDispatcherTrait::released
fn released(self: T, token: ContractAddress) -> u256
releasable
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABIDispatcherTrait::releasable
fn releasable(self: T, token: ContractAddress) -> u256
vested_amount
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABIDispatcherTrait::vested_amount
fn vested_amount(self: T, token: ContractAddress, timestamp: u64) -> u256
release
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABIDispatcherTrait::release
fn release(self: T, token: ContractAddress) -> u256
owner
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABIDispatcherTrait::owner
fn owner(self: T) -> ContractAddress
transfer_ownership
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABIDispatcherTrait::transfer_ownership
fn transfer_ownership(self: T, new_owner: ContractAddress)
renounce_ownership
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABIDispatcherTrait::renounce_ownership
fn renounce_ownership(self: T)
transferOwnership
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABIDispatcherTrait::transferOwnership
fn transferOwnership(self: T, newOwner: ContractAddress)
renounceOwnership
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABIDispatcherTrait::renounceOwnership
fn renounceOwnership(self: T)
AccountUpgradeableABISafeDispatcherTrait
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeDispatcherTrait
Part of the group: dispatchers
pub trait AccountUpgradeableABISafeDispatcherTrait<T>
Trait functions
execute
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeDispatcherTrait::execute
fn __execute__(self: T, calls: Array<Call>) -> Result<(), Array<felt252>>
validate
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeDispatcherTrait::validate
fn __validate__(self: T, calls: Array<Call>) -> Result<felt252, Array<felt252>>
is_valid_signature
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeDispatcherTrait::is_valid_signature
fn is_valid_signature(
self: T, hash: felt252, signature: Array<felt252>,
) -> Result<felt252, Array<felt252>>
supports_interface
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> Result<bool, Array<felt252>>
execute_from_outside_v2
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeDispatcherTrait::execute_from_outside_v2
fn execute_from_outside_v2(
self: T, outside_execution: OutsideExecution, signature: Span<felt252>,
) -> Result<Array<Span<felt252>>, Array<felt252>>
is_valid_outside_execution_nonce
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeDispatcherTrait::is_valid_outside_execution_nonce
fn is_valid_outside_execution_nonce(self: T, nonce: felt252) -> Result<bool, Array<felt252>>
validate_declare
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeDispatcherTrait::validate_declare
fn __validate_declare__(self: T, class_hash: felt252) -> Result<felt252, Array<felt252>>
validate_deploy
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeDispatcherTrait::validate_deploy
fn __validate_deploy__(
self: T, class_hash: felt252, contract_address_salt: felt252, public_key: felt252,
) -> Result<felt252, Array<felt252>>
get_public_key
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeDispatcherTrait::get_public_key
fn get_public_key(self: T) -> Result<felt252, Array<felt252>>
set_public_key
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeDispatcherTrait::set_public_key
fn set_public_key(
self: T, new_public_key: felt252, signature: Span<felt252>,
) -> Result<(), Array<felt252>>
isValidSignature
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeDispatcherTrait::isValidSignature
fn isValidSignature(
self: T, hash: felt252, signature: Array<felt252>,
) -> Result<felt252, Array<felt252>>
getPublicKey
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeDispatcherTrait::getPublicKey
fn getPublicKey(self: T) -> Result<felt252, Array<felt252>>
setPublicKey
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeDispatcherTrait::setPublicKey
fn setPublicKey(
self: T, newPublicKey: felt252, signature: Span<felt252>,
) -> Result<(), Array<felt252>>
upgrade
Fully qualified path: openzeppelin_presets::interfaces::account::AccountUpgradeableABISafeDispatcherTrait::upgrade
fn upgrade(self: T, new_class_hash: ClassHash) -> Result<(), Array<felt252>>
ERC1155UpgradeableABISafeDispatcherTrait
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait
Part of the group: dispatchers
pub trait ERC1155UpgradeableABISafeDispatcherTrait<T>
Trait functions
balance_of
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress, token_id: u256) -> Result<u256, Array<felt252>>
balance_of_batch
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::balance_of_batch
fn balance_of_batch(
self: T, accounts: Span<ContractAddress>, token_ids: Span<u256>,
) -> Result<Span<u256>, Array<felt252>>
safe_transfer_from
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::safe_transfer_from
fn safe_transfer_from(
self: T,
from: ContractAddress,
to: ContractAddress,
token_id: u256,
value: u256,
data: Span<felt252>,
) -> Result<(), Array<felt252>>
safe_batch_transfer_from
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::safe_batch_transfer_from
fn safe_batch_transfer_from(
self: T,
from: ContractAddress,
to: ContractAddress,
token_ids: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> Result<(), Array<felt252>>
is_approved_for_all
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::is_approved_for_all
fn is_approved_for_all(
self: T, owner: ContractAddress, operator: ContractAddress,
) -> Result<bool, Array<felt252>>
set_approval_for_all
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::set_approval_for_all
fn set_approval_for_all(
self: T, operator: ContractAddress, approved: bool,
) -> Result<(), Array<felt252>>
supports_interface
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> Result<bool, Array<felt252>>
uri
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::uri
fn uri(self: T, token_id: u256) -> Result<ByteArray, Array<felt252>>
balanceOf
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress, tokenId: u256) -> Result<u256, Array<felt252>>
balanceOfBatch
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::balanceOfBatch
fn balanceOfBatch(
self: T, accounts: Span<ContractAddress>, tokenIds: Span<u256>,
) -> Result<Span<u256>, Array<felt252>>
safeTransferFrom
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::safeTransferFrom
fn safeTransferFrom(
self: T,
from: ContractAddress,
to: ContractAddress,
tokenId: u256,
value: u256,
data: Span<felt252>,
) -> Result<(), Array<felt252>>
safeBatchTransferFrom
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::safeBatchTransferFrom
fn safeBatchTransferFrom(
self: T,
from: ContractAddress,
to: ContractAddress,
tokenIds: Span<u256>,
values: Span<u256>,
data: Span<felt252>,
) -> Result<(), Array<felt252>>
isApprovedForAll
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::isApprovedForAll
fn isApprovedForAll(
self: T, owner: ContractAddress, operator: ContractAddress,
) -> Result<bool, Array<felt252>>
setApprovalForAll
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::setApprovalForAll
fn setApprovalForAll(
self: T, operator: ContractAddress, approved: bool,
) -> Result<(), Array<felt252>>
owner
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::owner
fn owner(self: T) -> Result<ContractAddress, Array<felt252>>
transfer_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::transfer_ownership
fn transfer_ownership(self: T, new_owner: ContractAddress) -> Result<(), Array<felt252>>
renounce_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::renounce_ownership
fn renounce_ownership(self: T) -> Result<(), Array<felt252>>
transferOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::transferOwnership
fn transferOwnership(self: T, newOwner: ContractAddress) -> Result<(), Array<felt252>>
renounceOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::renounceOwnership
fn renounceOwnership(self: T) -> Result<(), Array<felt252>>
upgrade
Fully qualified path: openzeppelin_presets::interfaces::erc1155::ERC1155UpgradeableABISafeDispatcherTrait::upgrade
fn upgrade(self: T, new_class_hash: ClassHash) -> Result<(), Array<felt252>>
ERC20UpgradeableABISafeDispatcherTrait
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait
Part of the group: dispatchers
pub trait ERC20UpgradeableABISafeDispatcherTrait<T>
Trait functions
total_supply
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::total_supply
fn total_supply(self: T) -> Result<u256, Array<felt252>>
balance_of
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
allowance
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::allowance
fn allowance(
self: T, owner: ContractAddress, spender: ContractAddress,
) -> Result<u256, Array<felt252>>
transfer
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::transfer
fn transfer(self: T, recipient: ContractAddress, amount: u256) -> Result<bool, Array<felt252>>
transfer_from
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::transfer_from
fn transfer_from(
self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> Result<bool, Array<felt252>>
approve
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::approve
fn approve(self: T, spender: ContractAddress, amount: u256) -> Result<bool, Array<felt252>>
name
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::name
fn name(self: T) -> Result<ByteArray, Array<felt252>>
symbol
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::symbol
fn symbol(self: T) -> Result<ByteArray, Array<felt252>>
decimals
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::decimals
fn decimals(self: T) -> Result<u8, Array<felt252>>
totalSupply
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::totalSupply
fn totalSupply(self: T) -> Result<u256, Array<felt252>>
balanceOf
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
transferFrom
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::transferFrom
fn transferFrom(
self: T, sender: ContractAddress, recipient: ContractAddress, amount: u256,
) -> Result<bool, Array<felt252>>
owner
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::owner
fn owner(self: T) -> Result<ContractAddress, Array<felt252>>
transfer_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::transfer_ownership
fn transfer_ownership(self: T, new_owner: ContractAddress) -> Result<(), Array<felt252>>
renounce_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::renounce_ownership
fn renounce_ownership(self: T) -> Result<(), Array<felt252>>
transferOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::transferOwnership
fn transferOwnership(self: T, newOwner: ContractAddress) -> Result<(), Array<felt252>>
renounceOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::renounceOwnership
fn renounceOwnership(self: T) -> Result<(), Array<felt252>>
upgrade
Fully qualified path: openzeppelin_presets::interfaces::erc20::ERC20UpgradeableABISafeDispatcherTrait::upgrade
fn upgrade(self: T, new_class_hash: ClassHash) -> Result<(), Array<felt252>>
ERC721UpgradeableABISafeDispatcherTrait
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait
Part of the group: dispatchers
pub trait ERC721UpgradeableABISafeDispatcherTrait<T>
Trait functions
balance_of
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::balance_of
fn balance_of(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
owner_of
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::owner_of
fn owner_of(self: T, token_id: u256) -> Result<ContractAddress, Array<felt252>>
safe_transfer_from
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::safe_transfer_from
fn safe_transfer_from(
self: T, from: ContractAddress, to: ContractAddress, token_id: u256, data: Span<felt252>,
) -> Result<(), Array<felt252>>
transfer_from
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::transfer_from
fn transfer_from(
self: T, from: ContractAddress, to: ContractAddress, token_id: u256,
) -> Result<(), Array<felt252>>
approve
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::approve
fn approve(self: T, to: ContractAddress, token_id: u256) -> Result<(), Array<felt252>>
set_approval_for_all
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::set_approval_for_all
fn set_approval_for_all(
self: T, operator: ContractAddress, approved: bool,
) -> Result<(), Array<felt252>>
get_approved
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::get_approved
fn get_approved(self: T, token_id: u256) -> Result<ContractAddress, Array<felt252>>
is_approved_for_all
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::is_approved_for_all
fn is_approved_for_all(
self: T, owner: ContractAddress, operator: ContractAddress,
) -> Result<bool, Array<felt252>>
supports_interface
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> Result<bool, Array<felt252>>
name
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::name
fn name(self: T) -> Result<ByteArray, Array<felt252>>
symbol
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::symbol
fn symbol(self: T) -> Result<ByteArray, Array<felt252>>
token_uri
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::token_uri
fn token_uri(self: T, token_id: u256) -> Result<ByteArray, Array<felt252>>
balanceOf
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::balanceOf
fn balanceOf(self: T, account: ContractAddress) -> Result<u256, Array<felt252>>
ownerOf
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::ownerOf
fn ownerOf(self: T, tokenId: u256) -> Result<ContractAddress, Array<felt252>>
safeTransferFrom
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::safeTransferFrom
fn safeTransferFrom(
self: T, from: ContractAddress, to: ContractAddress, tokenId: u256, data: Span<felt252>,
) -> Result<(), Array<felt252>>
transferFrom
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::transferFrom
fn transferFrom(
self: T, from: ContractAddress, to: ContractAddress, tokenId: u256,
) -> Result<(), Array<felt252>>
setApprovalForAll
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::setApprovalForAll
fn setApprovalForAll(
self: T, operator: ContractAddress, approved: bool,
) -> Result<(), Array<felt252>>
getApproved
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::getApproved
fn getApproved(self: T, tokenId: u256) -> Result<ContractAddress, Array<felt252>>
isApprovedForAll
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::isApprovedForAll
fn isApprovedForAll(
self: T, owner: ContractAddress, operator: ContractAddress,
) -> Result<bool, Array<felt252>>
tokenURI
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::tokenURI
fn tokenURI(self: T, tokenId: u256) -> Result<ByteArray, Array<felt252>>
owner
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::owner
fn owner(self: T) -> Result<ContractAddress, Array<felt252>>
transfer_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::transfer_ownership
fn transfer_ownership(self: T, new_owner: ContractAddress) -> Result<(), Array<felt252>>
renounce_ownership
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::renounce_ownership
fn renounce_ownership(self: T) -> Result<(), Array<felt252>>
transferOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::transferOwnership
fn transferOwnership(self: T, newOwner: ContractAddress) -> Result<(), Array<felt252>>
renounceOwnership
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::renounceOwnership
fn renounceOwnership(self: T) -> Result<(), Array<felt252>>
upgrade
Fully qualified path: openzeppelin_presets::interfaces::erc721::ERC721UpgradeableABISafeDispatcherTrait::upgrade
fn upgrade(self: T, new_class_hash: ClassHash) -> Result<(), Array<felt252>>
EthAccountUpgradeableABISafeDispatcherTrait
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeDispatcherTrait
Part of the group: dispatchers
pub trait EthAccountUpgradeableABISafeDispatcherTrait<T>
Trait functions
execute
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeDispatcherTrait::execute
fn __execute__(self: T, calls: Array<Call>) -> Result<(), Array<felt252>>
validate
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeDispatcherTrait::validate
fn __validate__(self: T, calls: Array<Call>) -> Result<felt252, Array<felt252>>
is_valid_signature
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeDispatcherTrait::is_valid_signature
fn is_valid_signature(
self: T, hash: felt252, signature: Array<felt252>,
) -> Result<felt252, Array<felt252>>
supports_interface
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeDispatcherTrait::supports_interface
fn supports_interface(self: T, interface_id: felt252) -> Result<bool, Array<felt252>>
execute_from_outside_v2
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeDispatcherTrait::execute_from_outside_v2
fn execute_from_outside_v2(
self: T, outside_execution: OutsideExecution, signature: Span<felt252>,
) -> Result<Array<Span<felt252>>, Array<felt252>>
is_valid_outside_execution_nonce
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeDispatcherTrait::is_valid_outside_execution_nonce
fn is_valid_outside_execution_nonce(self: T, nonce: felt252) -> Result<bool, Array<felt252>>
validate_declare
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeDispatcherTrait::validate_declare
fn __validate_declare__(self: T, class_hash: felt252) -> Result<felt252, Array<felt252>>
validate_deploy
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeDispatcherTrait::validate_deploy
fn __validate_deploy__(
self: T, class_hash: felt252, contract_address_salt: felt252, public_key: Secp256k1Point,
) -> Result<felt252, Array<felt252>>
get_public_key
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeDispatcherTrait::get_public_key
fn get_public_key(self: T) -> Result<Secp256k1Point, Array<felt252>>
set_public_key
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeDispatcherTrait::set_public_key
fn set_public_key(
self: T, new_public_key: Secp256k1Point, signature: Span<felt252>,
) -> Result<(), Array<felt252>>
isValidSignature
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeDispatcherTrait::isValidSignature
fn isValidSignature(
self: T, hash: felt252, signature: Array<felt252>,
) -> Result<felt252, Array<felt252>>
getPublicKey
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeDispatcherTrait::getPublicKey
fn getPublicKey(self: T) -> Result<Secp256k1Point, Array<felt252>>
setPublicKey
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeDispatcherTrait::setPublicKey
fn setPublicKey(
self: T, newPublicKey: Secp256k1Point, signature: Span<felt252>,
) -> Result<(), Array<felt252>>
upgrade
Fully qualified path: openzeppelin_presets::interfaces::eth_account::EthAccountUpgradeableABISafeDispatcherTrait::upgrade
fn upgrade(self: T, new_class_hash: ClassHash) -> Result<(), Array<felt252>>
MetaTransactionV0ABISafeDispatcherTrait
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::MetaTransactionV0ABISafeDispatcherTrait
Part of the group: dispatchers
pub trait MetaTransactionV0ABISafeDispatcherTrait<T>
Trait functions
execute_meta_tx_v0
Wrapper around the meta_tx_v0_syscall function.
Invokes the given entry point as a v0 meta transaction.
- The signature is replaced with the given signature.
- The caller is the OS (address 0).
- The transaction version is replaced by 0.
- The transaction hash is replaced by the corresponding version-0 transaction hash.
The context changes apply to the called contract and the inner contracts it calls, except for the caller, which is updated appropriately in subcalls.
NOTE: This syscall should only be used to allow support for old version-0 bound accounts, and should not be used for other purposes.
Fully qualified path: openzeppelin_presets::interfaces::meta_tx_v0::MetaTransactionV0ABISafeDispatcherTrait::execute_meta_tx_v0
fn execute_meta_tx_v0(
self: T,
target: ContractAddress,
entry_point_selector: felt252,
calldata: Span<felt252>,
signature: Span<felt252>,
) -> Result<Result<Span<felt252>, Array<felt252>>, Array<felt252>>
VestingWalletABISafeDispatcherTrait
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeDispatcherTrait
Part of the group: dispatchers
pub trait VestingWalletABISafeDispatcherTrait<T>
Trait functions
start
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeDispatcherTrait::start
fn start(self: T) -> Result<u64, Array<felt252>>
cliff
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeDispatcherTrait::cliff
fn cliff(self: T) -> Result<u64, Array<felt252>>
duration
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeDispatcherTrait::duration
fn duration(self: T) -> Result<u64, Array<felt252>>
end
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeDispatcherTrait::end
fn end(self: T) -> Result<u64, Array<felt252>>
released
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeDispatcherTrait::released
fn released(self: T, token: ContractAddress) -> Result<u256, Array<felt252>>
releasable
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeDispatcherTrait::releasable
fn releasable(self: T, token: ContractAddress) -> Result<u256, Array<felt252>>
vested_amount
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeDispatcherTrait::vested_amount
fn vested_amount(self: T, token: ContractAddress, timestamp: u64) -> Result<u256, Array<felt252>>
release
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeDispatcherTrait::release
fn release(self: T, token: ContractAddress) -> Result<u256, Array<felt252>>
owner
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeDispatcherTrait::owner
fn owner(self: T) -> Result<ContractAddress, Array<felt252>>
transfer_ownership
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeDispatcherTrait::transfer_ownership
fn transfer_ownership(self: T, new_owner: ContractAddress) -> Result<(), Array<felt252>>
renounce_ownership
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeDispatcherTrait::renounce_ownership
fn renounce_ownership(self: T) -> Result<(), Array<felt252>>
transferOwnership
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeDispatcherTrait::transferOwnership
fn transferOwnership(self: T, newOwner: ContractAddress) -> Result<(), Array<felt252>>
renounceOwnership
Fully qualified path: openzeppelin_presets::interfaces::vesting::VestingWalletABISafeDispatcherTrait::renounceOwnership
fn renounceOwnership(self: T) -> Result<(), Array<felt252>>