dojo

Fully qualified path: dojo

Modules

Modules

Modules

contract

Fully qualified path: dojo::contract

Modules

Re-exports:

• Structs

• Traits

Groups:

dispatchers

• Structs

• Traits

Modules

Modules

interface

Fully qualified path: dojo::contract::interface

Modules

Traits

Groups:

dispatchers

• Structs

• Traits

Modules

Modules

__external_IContractForwardImpl

Fully qualified path: dojo::contract::interface::__external_IContractForwardImpl

__l1_handler_IContractForwardImpl

Fully qualified path: dojo::contract::interface::__l1_handler_IContractForwardImpl

__constructor_IContractForwardImpl

Fully qualified path: dojo::contract::interface::__constructor_IContractForwardImpl

__external_ILibraryForwardImpl

Fully qualified path: dojo::contract::interface::__external_ILibraryForwardImpl

__l1_handler_ILibraryForwardImpl

Fully qualified path: dojo::contract::interface::__l1_handler_ILibraryForwardImpl

__constructor_ILibraryForwardImpl

Fully qualified path: dojo::contract::interface::__constructor_ILibraryForwardImpl

Traits

Traits

IContract

Fully qualified path: dojo::contract::interface::IContract

pub trait IContract<T>

ILibrary

Fully qualified path: dojo::contract::interface::ILibrary

pub trait ILibrary<T>

UnsafeNewContractStateTraitForIContractForwardImpl

Fully qualified path: dojo::contract::interface::UnsafeNewContractStateTraitForIContractForwardImpl

pub trait UnsafeNewContractStateTraitForIContractForwardImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: dojo::contract::interface::UnsafeNewContractStateTraitForIContractForwardImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

UnsafeNewContractStateTraitForILibraryForwardImpl

Fully qualified path: dojo::contract::interface::UnsafeNewContractStateTraitForILibraryForwardImpl

pub trait UnsafeNewContractStateTraitForILibraryForwardImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: dojo::contract::interface::UnsafeNewContractStateTraitForILibraryForwardImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

components

Fully qualified path: dojo::contract::components

Modules

Modules

Modules

upgradeable

Fully qualified path: dojo::contract::components::upgradeable

Modules

Traits

Groups:

dispatchers

• Structs

• Traits

Modules

Modules

upgradeable_cpt

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt

Modules

Free functions

Structs

Enums

Traits

Modules

Modules

Errors

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::Errors

Constants

Constants

Constants

INVALID_CLASS

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::Errors::INVALID_CLASS

pub const INVALID_CLASS: felt252 = 624090558047339724222917448946231719296404662567931163800175;

INVALID_CLASS_CONTENT

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::Errors::INVALID_CLASS_CONTENT

pub const INVALID_CLASS_CONTENT: felt252 =
    2680448536555713735339089457894821564698468915003290616835807725577076;

INVALID_CALLER

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::Errors::INVALID_CALLER

pub const INVALID_CALLER: felt252 = 10484069504843620783117914822889090570483853581985410148;

INVALID_WORLD_ADDRESS

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::Errors::INVALID_WORLD_ADDRESS

pub const INVALID_WORLD_ADDRESS: felt252 = 154088300879251175208531552724051232493855893189491;

__external_UpgradeableImpl

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::__external_UpgradeableImpl

__l1_handler_UpgradeableImpl

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::__l1_handler_UpgradeableImpl

__constructor_UpgradeableImpl

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::__constructor_UpgradeableImpl

Free functions

Free functions

unsafe_new_component_state

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::unsafe_new_component_state

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

Structs

Structs

Storage

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::Storage

[storage]
pub struct Storage {}

Upgraded

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::Upgraded

[derive(Drop, starknet::Event)]
pub struct Upgraded {
    pub class_hash: ClassHash,
}

Members

class_hash

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::Upgraded::class_hash

pub class_hash: ClassHash

ComponentState

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::ComponentState

pub struct ComponentState<TContractState> {}

Enums

Enums

Event

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::Event

pub enum Event {
    Upgraded: Upgraded,
}

Variants

Upgraded

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::Event::Upgraded

Upgraded: Upgraded

Traits

Traits

HasComponent

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::HasComponent

pub trait HasComponent<TContractState>

Trait functions

get_component

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::HasComponent::get_component

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

get_component_mut

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::HasComponent::get_component_mut

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

get_contract

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::HasComponent::get_contract

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

get_contract_mut

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::HasComponent::get_contract_mut

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

emit

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::HasComponent::emit

fn emit<S, impl IntoImp: Into<S, dojo::contract::components::upgradeable::upgradeable_cpt::Event>>(
    ref self: ComponentState<TContractState>, event: S,
)

UnsafeNewContractStateTraitForUpgradeableImpl

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::UnsafeNewContractStateTraitForUpgradeableImpl

pub trait UnsafeNewContractStateTraitForUpgradeableImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: dojo::contract::components::upgradeable::upgradeable_cpt::UnsafeNewContractStateTraitForUpgradeableImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

__external_IUpgradeableForwardImpl

Fully qualified path: dojo::contract::components::upgradeable::__external_IUpgradeableForwardImpl

__l1_handler_IUpgradeableForwardImpl

Fully qualified path: dojo::contract::components::upgradeable::__l1_handler_IUpgradeableForwardImpl

__constructor_IUpgradeableForwardImpl

Fully qualified path: dojo::contract::components::upgradeable::__constructor_IUpgradeableForwardImpl

Traits

Traits

IUpgradeable

Fully qualified path: dojo::contract::components::upgradeable::IUpgradeable

pub trait IUpgradeable<T>

Trait functions

upgrade

Fully qualified path: dojo::contract::components::upgradeable::IUpgradeable::upgrade

fn upgrade(ref self: T, new_class_hash: ClassHash)

UnsafeNewContractStateTraitForIUpgradeableForwardImpl

Fully qualified path: dojo::contract::components::upgradeable::UnsafeNewContractStateTraitForIUpgradeableForwardImpl

pub trait UnsafeNewContractStateTraitForIUpgradeableForwardImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: dojo::contract::components::upgradeable::UnsafeNewContractStateTraitForIUpgradeableForwardImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

world_provider

Fully qualified path: dojo::contract::components::world_provider

Modules

Traits

Groups:

dispatchers

• Structs

• Traits

Modules

Modules

world_provider_cpt

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt

Modules

Free functions

Structs

Enums

Traits

Impls

Modules

Modules

__external_WorldProviderImpl

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::__external_WorldProviderImpl

__l1_handler_WorldProviderImpl

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::__l1_handler_WorldProviderImpl

__constructor_WorldProviderImpl

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::__constructor_WorldProviderImpl

Free functions

Free functions

unsafe_new_component_state

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::unsafe_new_component_state

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

Structs

Structs

Storage

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::Storage

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

ComponentState

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::ComponentState

pub struct ComponentState<TContractState> {}

Enums

Enums

Event

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::Event

pub enum Event {}

Traits

Traits

HasComponent

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::HasComponent

pub trait HasComponent<TContractState>

Trait functions

get_component

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::HasComponent::get_component

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

get_component_mut

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::HasComponent::get_component_mut

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

get_contract

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::HasComponent::get_contract

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

get_contract_mut

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::HasComponent::get_contract_mut

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

emit

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::HasComponent::emit

fn emit<
    S, impl IntoImp: Into<S, dojo::contract::components::world_provider::world_provider_cpt::Event>,
>(
    ref self: ComponentState<TContractState>, event: S,
)

InternalTrait

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::InternalTrait

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

Trait functions

initializer

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::InternalTrait::initializer

fn initializer(ref self: ComponentState<TContractState>)

UnsafeNewContractStateTraitForWorldProviderImpl

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::UnsafeNewContractStateTraitForWorldProviderImpl

pub trait UnsafeNewContractStateTraitForWorldProviderImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::UnsafeNewContractStateTraitForWorldProviderImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

Impls

Impls

WorldProvider

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::WorldProvider

pub impl WorldProvider<
    TContractState, +HasComponent<TContractState>,
> of IWorldProvider<ComponentState<TContractState>>;

Impl functions

world_dispatcher

Fully qualified path: dojo::contract::components::world_provider::world_provider_cpt::WorldProvider::world_dispatcher

fn world_dispatcher(self: @ComponentState<TContractState>) -> IWorldDispatcher

__external_IWorldProviderForwardImpl

Fully qualified path: dojo::contract::components::world_provider::__external_IWorldProviderForwardImpl

__l1_handler_IWorldProviderForwardImpl

Fully qualified path: dojo::contract::components::world_provider::__l1_handler_IWorldProviderForwardImpl

__constructor_IWorldProviderForwardImpl

Fully qualified path: dojo::contract::components::world_provider::__constructor_IWorldProviderForwardImpl

Traits

Traits

IWorldProvider

Fully qualified path: dojo::contract::components::world_provider::IWorldProvider

pub trait IWorldProvider<T>

Trait functions

world_dispatcher

Fully qualified path: dojo::contract::components::world_provider::IWorldProvider::world_dispatcher

fn world_dispatcher(self: @T) -> IWorldDispatcher

UnsafeNewContractStateTraitForIWorldProviderForwardImpl

Fully qualified path: dojo::contract::components::world_provider::UnsafeNewContractStateTraitForIWorldProviderForwardImpl

pub trait UnsafeNewContractStateTraitForIWorldProviderForwardImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: dojo::contract::components::world_provider::UnsafeNewContractStateTraitForIWorldProviderForwardImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

event

Fully qualified path: dojo::event

Modules

Re-exports:

• Structs

• Traits

Groups:

dispatchers

• Structs

• Traits

Modules

Modules

component

Fully qualified path: dojo::event::component

Modules

Traits

Modules

Modules

__external_IDeployedEventImpl

Fully qualified path: dojo::event::component::__external_IDeployedEventImpl

__l1_handler_IDeployedEventImpl

Fully qualified path: dojo::event::component::__l1_handler_IDeployedEventImpl

__constructor_IDeployedEventImpl

Fully qualified path: dojo::event::component::__constructor_IDeployedEventImpl

__external_IStoredEventImpl

Fully qualified path: dojo::event::component::__external_IStoredEventImpl

__l1_handler_IStoredEventImpl

Fully qualified path: dojo::event::component::__l1_handler_IStoredEventImpl

__constructor_IStoredEventImpl

Fully qualified path: dojo::event::component::__constructor_IStoredEventImpl

__external_IEventImpl

Fully qualified path: dojo::event::component::__external_IEventImpl

__l1_handler_IEventImpl

Fully qualified path: dojo::event::component::__l1_handler_IEventImpl

__constructor_IEventImpl

Fully qualified path: dojo::event::component::__constructor_IEventImpl

Traits

Traits

UnsafeNewContractStateTraitForIDeployedEventImpl

Fully qualified path: dojo::event::component::UnsafeNewContractStateTraitForIDeployedEventImpl

pub trait UnsafeNewContractStateTraitForIDeployedEventImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: dojo::event::component::UnsafeNewContractStateTraitForIDeployedEventImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

UnsafeNewContractStateTraitForIStoredEventImpl

Fully qualified path: dojo::event::component::UnsafeNewContractStateTraitForIStoredEventImpl

pub trait UnsafeNewContractStateTraitForIStoredEventImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: dojo::event::component::UnsafeNewContractStateTraitForIStoredEventImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

UnsafeNewContractStateTraitForIEventImpl

Fully qualified path: dojo::event::component::UnsafeNewContractStateTraitForIEventImpl

pub trait UnsafeNewContractStateTraitForIEventImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: dojo::event::component::UnsafeNewContractStateTraitForIEventImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

event

Fully qualified path: dojo::event::event

Structs

Traits

Structs

Structs

EventDef

Fully qualified path: dojo::event::event::EventDef

#[derive(Drop, Serde, Debug, PartialEq)]
pub struct EventDef {
    pub name: ByteArray,
    pub layout: Layout,
    pub schema: Struct,
}

Members

name

Fully qualified path: dojo::event::event::EventDef::name

pub name: ByteArray

layout

Fully qualified path: dojo::event::event::EventDef::layout

pub layout: Layout

schema

Fully qualified path: dojo::event::event::EventDef::schema

pub schema: Struct

Traits

Traits

EventDefinition

Fully qualified path: dojo::event::event::EventDefinition

pub trait EventDefinition<E>

Trait functions

name

Fully qualified path: dojo::event::event::EventDefinition::name

fn name() -> ByteArray

Event

Fully qualified path: dojo::event::event::Event

pub trait Event<T>

Trait functions

name

Fully qualified path: dojo::event::event::Event::name

fn name() -> ByteArray

definition

Fully qualified path: dojo::event::event::Event::definition

fn definition() -> EventDef

layout

Fully qualified path: dojo::event::event::Event::layout

fn layout() -> Layout

schema

Fully qualified path: dojo::event::event::Event::schema

fn schema() -> Struct

serialized_keys

Fully qualified path: dojo::event::event::Event::serialized_keys

fn serialized_keys(self: @T) -> Span<felt252>

serialized_values

Fully qualified path: dojo::event::event::Event::serialized_values

fn serialized_values(self: @T) -> Span<felt252>

selector

Returns the selector of the event computed for the given namespace hash.

Fully qualified path: dojo::event::event::Event::selector

fn selector(namespace_hash: felt252) -> felt252

interface

Fully qualified path: dojo::event::interface

Modules

Traits

Groups:

dispatchers

• Structs

• Traits

Modules

Modules

__external_IEventForwardImpl

Fully qualified path: dojo::event::interface::__external_IEventForwardImpl

__l1_handler_IEventForwardImpl

Fully qualified path: dojo::event::interface::__l1_handler_IEventForwardImpl

__constructor_IEventForwardImpl

Fully qualified path: dojo::event::interface::__constructor_IEventForwardImpl

Traits

Traits

IEvent

Fully qualified path: dojo::event::interface::IEvent

pub trait IEvent<T>

Trait functions

definition

Fully qualified path: dojo::event::interface::IEvent::definition

fn definition(self: @T) -> EventDef

UnsafeNewContractStateTraitForIEventForwardImpl

Fully qualified path: dojo::event::interface::UnsafeNewContractStateTraitForIEventForwardImpl

pub trait UnsafeNewContractStateTraitForIEventForwardImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: dojo::event::interface::UnsafeNewContractStateTraitForIEventForwardImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

storage

Fully qualified path: dojo::event::storage

Traits

Traits

Traits

EventStorage

A EventStorage trait that abstracts where the storage is and how events are emitted.

Fully qualified path: dojo::event::storage::EventStorage

pub trait EventStorage<S, E>

Trait functions

emit_event

Fully qualified path: dojo::event::storage::EventStorage::emit_event

fn emit_event(ref self: S, event: @E)

EventStorageTest

Fully qualified path: dojo::event::storage::EventStorageTest

pub trait EventStorageTest<S, E>

Trait functions

emit_event_test

Fully qualified path: dojo::event::storage::EventStorageTest::emit_event_test

fn emit_event_test(ref self: S, event: @E)

meta

Fully qualified path: dojo::meta

Modules

Re-exports:

• Structs

• Enums

• Traits

Groups:

dispatchers

• Structs

• Traits

Modules

Modules

interface

Fully qualified path: dojo::meta::interface

Modules

Traits

Groups:

dispatchers

• Structs

• Traits

Modules

Modules

__external_IDeployedResourceForwardImpl

Fully qualified path: dojo::meta::interface::__external_IDeployedResourceForwardImpl

__l1_handler_IDeployedResourceForwardImpl

Fully qualified path: dojo::meta::interface::__l1_handler_IDeployedResourceForwardImpl

__constructor_IDeployedResourceForwardImpl

Fully qualified path: dojo::meta::interface::__constructor_IDeployedResourceForwardImpl

__external_IStoredResourceForwardImpl

Fully qualified path: dojo::meta::interface::__external_IStoredResourceForwardImpl

__l1_handler_IStoredResourceForwardImpl

Fully qualified path: dojo::meta::interface::__l1_handler_IStoredResourceForwardImpl

__constructor_IStoredResourceForwardImpl

Fully qualified path: dojo::meta::interface::__constructor_IStoredResourceForwardImpl

Traits

Traits

IDeployedResource

The IDeployedResource starknet interface.

This is the interface used by offchain components and other contracts to get some info such Dojo name from a deployed resource.

Fully qualified path: dojo::meta::interface::IDeployedResource

pub trait IDeployedResource<T>

Trait functions

dojo_name

Fully qualified path: dojo::meta::interface::IDeployedResource::dojo_name

fn dojo_name(self: @T) -> ByteArray

IStoredResource

The IStoredResource starknet interface.

This is the interface used by offchain components and other contracts to access to storage related data of a deployed resource.

Fully qualified path: dojo::meta::interface::IStoredResource

pub trait IStoredResource<T>

Trait functions

layout

Fully qualified path: dojo::meta::interface::IStoredResource::layout

fn layout(self: @T) -> Layout

schema

Fully qualified path: dojo::meta::interface::IStoredResource::schema

fn schema(self: @T) -> Struct

UnsafeNewContractStateTraitForIDeployedResourceForwardImpl

Fully qualified path: dojo::meta::interface::UnsafeNewContractStateTraitForIDeployedResourceForwardImpl

pub trait UnsafeNewContractStateTraitForIDeployedResourceForwardImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: dojo::meta::interface::UnsafeNewContractStateTraitForIDeployedResourceForwardImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

UnsafeNewContractStateTraitForIStoredResourceForwardImpl

Fully qualified path: dojo::meta::interface::UnsafeNewContractStateTraitForIStoredResourceForwardImpl

pub trait UnsafeNewContractStateTraitForIStoredResourceForwardImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: dojo::meta::interface::UnsafeNewContractStateTraitForIStoredResourceForwardImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

introspect

Fully qualified path: dojo::meta::introspect

Structs

Enums

Traits

Impls

Structs

Structs

Struct

Fully qualified path: dojo::meta::introspect::Struct

[derive(Copy, Drop, Serde, Debug, PartialEq)]
pub struct Struct {
    pub name: felt252,
    pub attrs: Span<felt252>,
    pub children: Span<Member>,
}

Members

name

Fully qualified path: dojo::meta::introspect::Struct::name

pub name: felt252

attrs

Fully qualified path: dojo::meta::introspect::Struct::attrs

pub attrs: Span<felt252>

children

Fully qualified path: dojo::meta::introspect::Struct::children

pub children: Span<Member>

Enum

Fully qualified path: dojo::meta::introspect::Enum

[derive(Copy, Drop, Serde, Debug, PartialEq)]
pub struct Enum {
    pub name: felt252,
    pub attrs: Span<felt252>,
    pub children: Span<(felt252, Ty)>,
}

Members

name

Fully qualified path: dojo::meta::introspect::Enum::name

pub name: felt252

attrs

Fully qualified path: dojo::meta::introspect::Enum::attrs

pub attrs: Span<felt252>

children

Fully qualified path: dojo::meta::introspect::Enum::children

pub children: Span<(felt252, Ty)>

Member

Fully qualified path: dojo::meta::introspect::Member

#[derive(Copy, Drop, Serde, Debug, PartialEq)]
pub struct Member {
    pub name: felt252,
    pub attrs: Span<felt252>,
    pub ty: Ty,
}

Members

name

Fully qualified path: dojo::meta::introspect::Member::name

pub name: felt252

attrs

Fully qualified path: dojo::meta::introspect::Member::attrs

pub attrs: Span<felt252>

ty

Fully qualified path: dojo::meta::introspect::Member::ty

pub ty: Ty

Enums

Enums

Ty

Note that for Array and FixedArray we can’t directly use Ty as it will cause infinite recursion, so we decided to use a Span with one item only. Note also that, now, Torii uses this Span for specific processing on its side, so it cannot be changed directly by a Box.

Fully qualified path: dojo::meta::introspect::Ty

pub enum Ty {
    Primitive: felt252,
    Struct: Struct,
    Enum: Enum,
    Tuple: Span<Ty>,
    Array: Span<Ty>,
    ByteArray,
    FixedArray: (Span<Ty>, u32),
}

Variants

Primitive

Fully qualified path: dojo::meta::introspect::Ty::Primitive

Primitive: felt252

Struct

Fully qualified path: dojo::meta::introspect::Ty::Struct

Struct: Struct

Enum

Fully qualified path: dojo::meta::introspect::Ty::Enum

Enum: Enum

Tuple

Fully qualified path: dojo::meta::introspect::Ty::Tuple

Tuple: Span<Ty>

Array

Fully qualified path: dojo::meta::introspect::Ty::Array

Array: Span<Ty>

ByteArray

Fully qualified path: dojo::meta::introspect::Ty::ByteArray

ByteArray

FixedArray

Fully qualified path: dojo::meta::introspect::Ty::FixedArray

FixedArray: (Span<Ty>, u32)

Traits

Traits

TyCompareTrait

Fully qualified path: dojo::meta::introspect::TyCompareTrait

pub trait TyCompareTrait<T>

Trait functions

is_a_key_upgrade_of

Fully qualified path: dojo::meta::introspect::TyCompareTrait::is_a_key_upgrade_of

fn is_a_key_upgrade_of(self: @T, old: @T) -> bool

is_an_upgrade_of

Fully qualified path: dojo::meta::introspect::TyCompareTrait::is_an_upgrade_of

fn is_an_upgrade_of(self: @T, old: @T) -> bool

Introspect

Fully qualified path: dojo::meta::introspect::Introspect

pub trait Introspect<T>

Trait functions

size

Fully qualified path: dojo::meta::introspect::Introspect::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect::ty

fn ty() -> Ty

Impls

Impls

Introspect_felt252

Fully qualified path: dojo::meta::introspect::Introspect_felt252

pub impl Introspect_felt252 of Introspect<felt252>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_felt252::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_felt252::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_felt252::ty

fn ty() -> Ty

Introspect_bytes31

Fully qualified path: dojo::meta::introspect::Introspect_bytes31

pub impl Introspect_bytes31 of Introspect<bytes31>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_bytes31::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_bytes31::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_bytes31::ty

fn ty() -> Ty

Introspect_bool

Fully qualified path: dojo::meta::introspect::Introspect_bool

pub impl Introspect_bool of Introspect<bool>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_bool::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_bool::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_bool::ty

fn ty() -> Ty

Introspect_u8

Fully qualified path: dojo::meta::introspect::Introspect_u8

pub impl Introspect_u8 of Introspect<u8>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_u8::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_u8::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_u8::ty

fn ty() -> Ty

Introspect_u16

Fully qualified path: dojo::meta::introspect::Introspect_u16

pub impl Introspect_u16 of Introspect<u16>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_u16::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_u16::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_u16::ty

fn ty() -> Ty

Introspect_u32

Fully qualified path: dojo::meta::introspect::Introspect_u32

pub impl Introspect_u32 of Introspect<u32>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_u32::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_u32::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_u32::ty

fn ty() -> Ty

Introspect_u64

Fully qualified path: dojo::meta::introspect::Introspect_u64

pub impl Introspect_u64 of Introspect<u64>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_u64::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_u64::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_u64::ty

fn ty() -> Ty

Introspect_u128

Fully qualified path: dojo::meta::introspect::Introspect_u128

pub impl Introspect_u128 of Introspect<u128>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_u128::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_u128::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_u128::ty

fn ty() -> Ty

Introspect_u256

Fully qualified path: dojo::meta::introspect::Introspect_u256

pub impl Introspect_u256 of Introspect<u256>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_u256::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_u256::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_u256::ty

fn ty() -> Ty

Introspect_i8

Fully qualified path: dojo::meta::introspect::Introspect_i8

pub impl Introspect_i8 of Introspect<i8>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_i8::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_i8::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_i8::ty

fn ty() -> Ty

Introspect_i16

Fully qualified path: dojo::meta::introspect::Introspect_i16

pub impl Introspect_i16 of Introspect<i16>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_i16::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_i16::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_i16::ty

fn ty() -> Ty

Introspect_i32

Fully qualified path: dojo::meta::introspect::Introspect_i32

pub impl Introspect_i32 of Introspect<i32>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_i32::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_i32::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_i32::ty

fn ty() -> Ty

Introspect_i64

Fully qualified path: dojo::meta::introspect::Introspect_i64

pub impl Introspect_i64 of Introspect<i64>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_i64::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_i64::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_i64::ty

fn ty() -> Ty

Introspect_i128

Fully qualified path: dojo::meta::introspect::Introspect_i128

pub impl Introspect_i128 of Introspect<i128>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_i128::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_i128::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_i128::ty

fn ty() -> Ty

Introspect_address

Fully qualified path: dojo::meta::introspect::Introspect_address

pub impl Introspect_address of Introspect<ContractAddress>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_address::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_address::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_address::ty

fn ty() -> Ty

Introspect_classhash

Fully qualified path: dojo::meta::introspect::Introspect_classhash

pub impl Introspect_classhash of Introspect<ClassHash>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_classhash::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_classhash::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_classhash::ty

fn ty() -> Ty

Introspect_ethaddress

Fully qualified path: dojo::meta::introspect::Introspect_ethaddress

pub impl Introspect_ethaddress of Introspect<EthAddress>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_ethaddress::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_ethaddress::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_ethaddress::ty

fn ty() -> Ty

Introspect_bytearray

Fully qualified path: dojo::meta::introspect::Introspect_bytearray

pub impl Introspect_bytearray of Introspect<ByteArray>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_bytearray::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_bytearray::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_bytearray::ty

fn ty() -> Ty

Introspect_option

Fully qualified path: dojo::meta::introspect::Introspect_option

pub impl Introspect_option<T, +Introspect<T>> of Introspect<Option<T>>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_option::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_option::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_option::ty

fn ty() -> Ty

Introspect_array

Fully qualified path: dojo::meta::introspect::Introspect_array

pub impl Introspect_array<T, +Introspect<T>> of Introspect<Array<T>>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_array::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_array::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_array::ty

fn ty() -> Ty

Introspect_span

Fully qualified path: dojo::meta::introspect::Introspect_span

pub impl Introspect_span<T, +Introspect<T>> of Introspect<Span<T>>;

Impl functions

size

Fully qualified path: dojo::meta::introspect::Introspect_span::size

fn size() -> Option<u32>

layout

Fully qualified path: dojo::meta::introspect::Introspect_span::layout

fn layout() -> Layout

ty

Fully qualified path: dojo::meta::introspect::Introspect_span::ty

fn ty() -> Ty

layout

Fully qualified path: dojo::meta::layout

Free functions

Structs

Enums

Traits

Impls

Free functions

Free functions

compute_packed_size

Compute the full size in bytes of a layout, when all the fields are bit-packed. Could be None if at least a field has a dynamic size.

Fully qualified path: dojo::meta::layout::compute_packed_size

pub fn compute_packed_size(layout: Layout) -> Option<u32>

build_legacy_layout

With the new Dojo storage management (DojoStore trait), variants start from 1, while they were started from 0 in the legacy Dojo storage system. To still support legacy Dojo models, we have to rebuild the legacy storage layout from the new storage layout, meaning that variant selectors have to be decremented by one.

Fully qualified path: dojo::meta::layout::build_legacy_layout

pub fn build_legacy_layout(layout: Layout) -> Layout

Structs

Structs

FieldLayout

Fully qualified path: dojo::meta::layout::FieldLayout

#[derive(Copy, Drop, Serde, Debug, PartialEq)]
pub struct FieldLayout {
    pub selector: felt252,
    pub layout: Layout,
}

Members

selector

Fully qualified path: dojo::meta::layout::FieldLayout::selector

pub selector: felt252

layout

Fully qualified path: dojo::meta::layout::FieldLayout::layout

pub layout: Layout

Enums

Enums

Layout

Fully qualified path: dojo::meta::layout::Layout

pub enum Layout {
    Fixed: Span<u8>,
    Struct: Span<FieldLayout>,
    Tuple: Span<Layout>,
    Array: Span<Layout>,
    ByteArray,
    Enum: Span<FieldLayout>,
    FixedArray: (Span<Layout>, u32),
}

Variants

Fixed

Fully qualified path: dojo::meta::layout::Layout::Fixed

Fixed: Span<u8>

Struct

Fully qualified path: dojo::meta::layout::Layout::Struct

Struct: Span<FieldLayout>

Tuple

Fully qualified path: dojo::meta::layout::Layout::Tuple

Tuple: Span<Layout>

Array

Fully qualified path: dojo::meta::layout::Layout::Array

Array: Span<Layout>

ByteArray

Fully qualified path: dojo::meta::layout::Layout::ByteArray

ByteArray

Enum

Fully qualified path: dojo::meta::layout::Layout::Enum

Enum: Span<FieldLayout>

FixedArray

Fully qualified path: dojo::meta::layout::Layout::FixedArray

FixedArray: (Span<Layout>, u32)

Traits

Traits

LayoutCompareTrait

Fully qualified path: dojo::meta::layout::LayoutCompareTrait

pub trait LayoutCompareTrait

Trait functions

is_same_type_of

Fully qualified path: dojo::meta::layout::LayoutCompareTrait::is_same_type_of

fn is_same_type_of(self: @Layout, old: @Layout) -> bool

Impls

Impls

LayoutCompareImpl

Fully qualified path: dojo::meta::layout::LayoutCompareImpl

pub impl LayoutCompareImpl of LayoutCompareTrait;

Impl functions

is_same_type_of

Fully qualified path: dojo::meta::layout::LayoutCompareImpl::is_same_type_of

fn is_same_type_of(self: @Layout, old: @Layout) -> bool

model

Fully qualified path: dojo::model

Modules

Re-exports:

• Structs

• Enums

• Traits

Groups:

dispatchers

• Structs

• Traits

Modules

Modules

component

Fully qualified path: dojo::model::component

Modules

Traits

Modules

Modules

__external_IDeployedModelImpl

Fully qualified path: dojo::model::component::__external_IDeployedModelImpl

__l1_handler_IDeployedModelImpl

Fully qualified path: dojo::model::component::__l1_handler_IDeployedModelImpl

__constructor_IDeployedModelImpl

Fully qualified path: dojo::model::component::__constructor_IDeployedModelImpl

__external_IStoredModelImpl

Fully qualified path: dojo::model::component::__external_IStoredModelImpl

__l1_handler_IStoredModelImpl

Fully qualified path: dojo::model::component::__l1_handler_IStoredModelImpl

__constructor_IStoredModelImpl

Fully qualified path: dojo::model::component::__constructor_IStoredModelImpl

__external_IModelImpl

Fully qualified path: dojo::model::component::__external_IModelImpl

__l1_handler_IModelImpl

Fully qualified path: dojo::model::component::__l1_handler_IModelImpl

__constructor_IModelImpl

Fully qualified path: dojo::model::component::__constructor_IModelImpl

Traits

Traits

UnsafeNewContractStateTraitForIDeployedModelImpl

Fully qualified path: dojo::model::component::UnsafeNewContractStateTraitForIDeployedModelImpl

pub trait UnsafeNewContractStateTraitForIDeployedModelImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: dojo::model::component::UnsafeNewContractStateTraitForIDeployedModelImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

UnsafeNewContractStateTraitForIStoredModelImpl

Fully qualified path: dojo::model::component::UnsafeNewContractStateTraitForIStoredModelImpl

pub trait UnsafeNewContractStateTraitForIStoredModelImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: dojo::model::component::UnsafeNewContractStateTraitForIStoredModelImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

UnsafeNewContractStateTraitForIModelImpl

Fully qualified path: dojo::model::component::UnsafeNewContractStateTraitForIModelImpl

pub trait UnsafeNewContractStateTraitForIModelImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: dojo::model::component::UnsafeNewContractStateTraitForIModelImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

definition

Fully qualified path: dojo::model::definition

Structs

Enums

Traits

Structs

Structs

ModelDef

A plain struct with all the fields of a model definition.

Fully qualified path: dojo::model::definition::ModelDef

#[derive(Drop, Serde, Debug, PartialEq)]
pub struct ModelDef {
    pub name: ByteArray,
    pub layout: Layout,
    pub schema: Struct,
    pub packed_size: Option<u32>,
    pub unpacked_size: Option<u32>,
}

Members

name

Fully qualified path: dojo::model::definition::ModelDef::name

pub name: ByteArray

layout

Fully qualified path: dojo::model::definition::ModelDef::layout

pub layout: Layout

schema

Fully qualified path: dojo::model::definition::ModelDef::schema

pub schema: Struct

packed_size

Fully qualified path: dojo::model::definition::ModelDef::packed_size

pub packed_size: Option<u32>

unpacked_size

Fully qualified path: dojo::model::definition::ModelDef::unpacked_size

pub unpacked_size: Option<u32>

Enums

Enums

ModelIndex

The ModelIndex provides encapsulation for different ways to access a model’s data.

• Keys: Access by keys, where each individual key is known, and can be hashed.
• Id: Access by id, where only the id of the entity is known (keys already hashed).
• MemberId: Access by member id, where the member id and entity id are known.

Fully qualified path: dojo::model::definition::ModelIndex

pub enum ModelIndex {
    Keys: Span<felt252>,
    Id: felt252,
    MemberId: (felt252, felt252),
}

Variants

Keys

Fully qualified path: dojo::model::definition::ModelIndex::Keys

Keys: Span<felt252>

Id

Fully qualified path: dojo::model::definition::ModelIndex::Id

Id: felt252

MemberId

Fully qualified path: dojo::model::definition::ModelIndex::MemberId

MemberId: (felt252, felt252)

Traits

Traits

ModelDefinition

The ModelDefinition trait.

Definition of the model containing all the fields that makes up a model.

Fully qualified path: dojo::model::definition::ModelDefinition

pub trait ModelDefinition<T>

Trait functions

name

Fully qualified path: dojo::model::definition::ModelDefinition::name

fn name() -> ByteArray

layout

Fully qualified path: dojo::model::definition::ModelDefinition::layout

fn layout() -> Layout

use_legacy_storage

Fully qualified path: dojo::model::definition::ModelDefinition::use_legacy_storage

fn use_legacy_storage() -> bool

schema

Fully qualified path: dojo::model::definition::ModelDefinition::schema

fn schema() -> Struct

size

Fully qualified path: dojo::model::definition::ModelDefinition::size

fn size() -> Option<u32>

model

Fully qualified path: dojo::model::model

Structs

Traits

Structs

Structs

ModelPtr

Trait KeyParser defines a trait for parsing keys from a given model.

A pointer to a model, which can be expressed by an entity id.

Fully qualified path: dojo::model::model::ModelPtr

[derive(Copy, Drop, Serde, Debug, PartialEq)]
pub struct ModelPtr<M> {
    pub id: felt252,
}

Members

id

Fully qualified path: dojo::model::model::ModelPtr::id

pub id: felt252

Traits

Traits

ModelPtrsTrait

Trait that defines a method for converting a span of model pointers to a span of model indexes.

Type Parameters

• M: The type of the model.

Methods

• to_indexes(self: Span<ModelPtr<M>>) -> Span<ModelIndex>: Converts the span of model pointers to a span of model indexes.

Fully qualified path: dojo::model::model::ModelPtrsTrait

pub trait ModelPtrsTrait<M>

Trait functions

to_indexes

Fully qualified path: dojo::model::model::ModelPtrsTrait::to_indexes

fn to_indexes(self: Span<ModelPtr<M>>) -> Span<ModelIndex>

to_member_indexes

Fully qualified path: dojo::model::model::ModelPtrsTrait::to_member_indexes

fn to_member_indexes(self: Span<ModelPtr<M>>, field_selector: felt252) -> Span<ModelIndex>

KeyParser

Fully qualified path: dojo::model::model::KeyParser

pub trait KeyParser<M, K>

Trait functions

parse_key

Parses the key from the given model.

Fully qualified path: dojo::model::model::KeyParser::parse_key

fn parse_key(self: @M) -> K

ModelParser

Defines a trait for parsing models, providing methods to serialize keys and values.

Fully qualified path: dojo::model::model::ModelParser

pub trait ModelParser<M>

Trait functions

deserialize

Deserializes raw keys and values into a model struct.

Fully qualified path: dojo::model::model::ModelParser::deserialize

fn deserialize(ref keys: Span<felt252>, ref values: Span<felt252>) -> Option<M>

serialize_keys

Serializes the keys of the model.

Fully qualified path: dojo::model::model::ModelParser::serialize_keys

fn serialize_keys(self: @M) -> Span<felt252>

serialize_values

Serializes the values of the model.

Fully qualified path: dojo::model::model::ModelParser::serialize_values

fn serialize_values(self: @M) -> Span<felt252>

Model

The Model trait.

It provides a standardized way to interact with models.

Fully qualified path: dojo::model::model::Model

pub trait Model<M>

Trait functions

keys

Parses the key from the given model, where K is a type containing the keys of the model.

Fully qualified path: dojo::model::model::Model::keys

fn keys<K, +KeyParser<M, K>>(self: @M) -> K

entity_id

Returns the entity id of the model.

Fully qualified path: dojo::model::model::Model::entity_id

fn entity_id(self: @M) -> felt252

serialized_keys

Returns the keys of the model.

Fully qualified path: dojo::model::model::Model::serialized_keys

fn serialized_keys(self: @M) -> Span<felt252>

serialized_values

Returns the values of the model.

Fully qualified path: dojo::model::model::Model::serialized_values

fn serialized_values(self: @M) -> Span<felt252>

from_serialized

Constructs a model from the given keys and values.

Fully qualified path: dojo::model::model::Model::from_serialized

fn from_serialized(keys: Span<felt252>, values: Span<felt252>) -> Option<M>

from_serialized_subset

Contrutcs a model subset (member or schema) from its serialized value.

Fully qualified path: dojo::model::model::Model::from_serialized_subset

fn from_serialized_subset<T, +Serde<T>, +DojoStore<T>>(value: Span<felt252>) -> Option<T>

serialized_subset

Returns the serialized value of a model subset (member or schema).

Fully qualified path: dojo::model::model::Model::serialized_subset

fn serialized_subset<T, +Serde<T>, +DojoStore<T>>(value: @T) -> Span<felt252>

name

Returns the name of the model. (TODO: internalizing the name_hash could reduce poseidon costs).

Fully qualified path: dojo::model::model::Model::name

fn name() -> ByteArray

schema

Returns the schema of the model.

Fully qualified path: dojo::model::model::Model::schema

fn schema() -> Struct

layout

Returns the memory layout of the model.

Fully qualified path: dojo::model::model::Model::layout

fn layout() -> Layout

field_layout

Returns the layout of a field in the model.

Fully qualified path: dojo::model::model::Model::field_layout

fn field_layout(field_selector: felt252) -> Option<Layout>

use_legacy_storage

Indicates if the model uses the legacy storage (true), or the new one (false).

Fully qualified path: dojo::model::model::Model::use_legacy_storage

fn use_legacy_storage() -> bool

unpacked_size

Returns the unpacked size of the model. Only applicable for fixed size models.

Fully qualified path: dojo::model::model::Model::unpacked_size

fn unpacked_size() -> Option<u32>

packed_size

Returns the packed size of the model. Only applicable for fixed size models.

Fully qualified path: dojo::model::model::Model::packed_size

fn packed_size() -> Option<u32>

instance_layout

Returns the instance selector of the model.

Fully qualified path: dojo::model::model::Model::instance_layout

fn instance_layout(self: @M) -> Layout

definition

Returns the definition of the model.

Fully qualified path: dojo::model::model::Model::definition

fn definition() -> ModelDef

selector

Returns the selector of the model computed for the given namespace hash.

Fully qualified path: dojo::model::model::Model::selector

fn selector(namespace_hash: felt252) -> felt252

ptr_from_keys

Returns the pointer to the model from the keys.

Fully qualified path: dojo::model::model::Model::ptr_from_keys

fn ptr_from_keys<K, +Serde<K>, +Drop<K>>(keys: K) -> ModelPtr<M>

ptr_from_serialized_keys

Returns the pointer to the model from the serialised keys.

Fully qualified path: dojo::model::model::Model::ptr_from_serialized_keys

fn ptr_from_serialized_keys(keys: Span<felt252>) -> ModelPtr<M>

ptr_from_id

Returns the pointer to the model from the entity id.

Fully qualified path: dojo::model::model::Model::ptr_from_id

fn ptr_from_id(entity_id: felt252) -> ModelPtr<M>

ptrs_from_keys

Returns the pointers to models from the keys.

Fully qualified path: dojo::model::model::Model::ptrs_from_keys

fn ptrs_from_keys<K, +Serde<K>, +Drop<K>>(keys: Span<K>) -> Span<ModelPtr<M>>

ptrs_from_serialized_keys

Returns the pointers to models from the serialised keys.

Fully qualified path: dojo::model::model::Model::ptrs_from_serialized_keys

fn ptrs_from_serialized_keys(keys: Span<Span<felt252>>) -> Span<ModelPtr<M>>

ptrs_from_ids

Returns the pointers to models from the entity ids.

Fully qualified path: dojo::model::model::Model::ptrs_from_ids

fn ptrs_from_ids(entity_ids: Span<felt252>) -> Span<ModelPtr<M>>

ptr

Returns the ptr of the model.

Fully qualified path: dojo::model::model::Model::ptr

fn ptr(self: @M) -> ModelPtr<M>

model_value

Fully qualified path: dojo::model::model_value

Traits

Traits

Traits

ModelValueKey

Fully qualified path: dojo::model::model_value::ModelValueKey

pub trait ModelValueKey<V, K>

ModelValueParser

Trait ModelValueParser defines the interface for parsing and serializing entities of type V.

Fully qualified path: dojo::model::model_value::ModelValueParser

pub trait ModelValueParser<V>

Trait functions

deserialize

Deserializes the values of the model into a ModelValue struct.

Fully qualified path: dojo::model::model_value::ModelValueParser::deserialize

fn deserialize(ref values: Span<felt252>) -> Option<V>

serialize_values

Serializes the values of the model and returns them as a Span<felt252>.

Fully qualified path: dojo::model::model_value::ModelValueParser::serialize_values

fn serialize_values(self: @V) -> Span<felt252>

ModelValue

The ModelValue trait defines a set of methods that must be implemented by any model value type V.

Fully qualified path: dojo::model::model_value::ModelValue

pub trait ModelValue<V>

Trait functions

serialized_values

Returns a span of values associated with the entity, every field of a model that is not a key.

Fully qualified path: dojo::model::model_value::ModelValue::serialized_values

fn serialized_values(self: @V) -> Span<felt252>

from_serialized

Constructs a model value from its identifier and values.

Fully qualified path: dojo::model::model_value::ModelValue::from_serialized

fn from_serialized(values: Span<felt252>) -> Option<V>

name

Returns the name of the model value type.

Fully qualified path: dojo::model::model_value::ModelValue::name

fn name() -> ByteArray

layout

Returns the layout of the model value type.

Fully qualified path: dojo::model::model_value::ModelValue::layout

fn layout() -> Layout

instance_layout

Returns the layout of the model value.

Fully qualified path: dojo::model::model_value::ModelValue::instance_layout

fn instance_layout(self: @V) -> Layout

selector

Returns the selector of the model value type with the given namespace hash.

Fully qualified path: dojo::model::model_value::ModelValue::selector

fn selector(namespace_hash: felt252) -> felt252

interface

Fully qualified path: dojo::model::interface

Modules

Traits

Groups:

dispatchers

• Structs

• Traits

Modules

Modules

__external_IModelForwardImpl

Fully qualified path: dojo::model::interface::__external_IModelForwardImpl

__l1_handler_IModelForwardImpl

Fully qualified path: dojo::model::interface::__l1_handler_IModelForwardImpl

__constructor_IModelForwardImpl

Fully qualified path: dojo::model::interface::__constructor_IModelForwardImpl

Traits

Traits

IModel

The IModel starknet interface.

This is the interface used by offchain components and other contracts to interact with deployed models.

Fully qualified path: dojo::model::interface::IModel

pub trait IModel<T>

Trait functions

unpacked_size

Fully qualified path: dojo::model::interface::IModel::unpacked_size

fn unpacked_size(self: @T) -> Option<u32>

packed_size

Fully qualified path: dojo::model::interface::IModel::packed_size

fn packed_size(self: @T) -> Option<u32>

definition

Fully qualified path: dojo::model::interface::IModel::definition

fn definition(self: @T) -> ModelDef

use_legacy_storage

Fully qualified path: dojo::model::interface::IModel::use_legacy_storage

fn use_legacy_storage(self: @T) -> bool

UnsafeNewContractStateTraitForIModelForwardImpl

Fully qualified path: dojo::model::interface::UnsafeNewContractStateTraitForIModelForwardImpl

pub trait UnsafeNewContractStateTraitForIModelForwardImpl<TContractState>

Trait functions

unsafe_new_contract_state

Fully qualified path: dojo::model::interface::UnsafeNewContractStateTraitForIModelForwardImpl::unsafe_new_contract_state

fn unsafe_new_contract_state() -> TContractState

metadata

ResourceMetadata model.

Fully qualified path: dojo::model::metadata

Free functions

Structs

Free functions

Free functions

resource_metadata_selector

Fully qualified path: dojo::model::metadata::resource_metadata_selector

pub fn resource_metadata_selector(default_namespace_hash: felt252) -> felt252

Structs

Structs

ResourceMetadata

Fully qualified path: dojo::model::metadata::ResourceMetadata

[derive(PartialEq, Clone, Debug)]
[dojo::model]
pub struct ResourceMetadata {
    pub resource_id: felt252,
    pub metadata_uri: ByteArray,
    pub metadata_hash: felt252,
}

Members

resource_id

Fully qualified path: dojo::model::metadata::ResourceMetadata::resource_id

pub resource_id: felt252

metadata_uri

Fully qualified path: dojo::model::metadata::ResourceMetadata::metadata_uri

pub metadata_uri: ByteArray

metadata_hash

Fully qualified path: dojo::model::metadata::ResourceMetadata::metadata_hash

pub metadata_hash: felt252

storage

Fully qualified path: dojo::model::storage

Traits

Traits

Traits

ModelStorage

A ModelStorage trait that abstracts where the storage is.

Currently it’s only world storage, but this will be useful when we have other storage solutions (micro worlds).

Fully qualified path: dojo::model::storage::ModelStorage

pub trait ModelStorage<S, M>

Trait functions

write_model

Sets a model of type M.

Fully qualified path: dojo::model::storage::ModelStorage::write_model

fn write_model(ref self: S, model: @M)

write_models

Sets multiple models of type M.

Fully qualified path: dojo::model::storage::ModelStorage::write_models

fn write_models(ref self: S, models: Span<@M>)

read_model

Retrieves a model of type M using the provided key of type K.

Fully qualified path: dojo::model::storage::ModelStorage::read_model

fn read_model<K, +Drop<K>, +Serde<K>>(self: @S, keys: K) -> M

read_models

Retrieves multiple models of type M using the provided keys of type K. Returnes an array to ensure the user can consume the models, even if the type is not copiable.

Fully qualified path: dojo::model::storage::ModelStorage::read_models

fn read_models<K, +Drop<K>, +Serde<K>>(self: @S, keys: Span<K>) -> Array<M>

erase_model

Deletes a model of type M.

Fully qualified path: dojo::model::storage::ModelStorage::erase_model

fn erase_model(ref self: S, model: @M)

erase_models

Deletes multiple models of type M.

Fully qualified path: dojo::model::storage::ModelStorage::erase_models

fn erase_models(ref self: S, models: Span<@M>)

erase_model_ptr

Deletes a model of type M using the provided entity id. The ptr is mostly used for type inferrence.

Fully qualified path: dojo::model::storage::ModelStorage::erase_model_ptr

fn erase_model_ptr(ref self: S, ptr: ModelPtr<M>)

erase_models_ptrs

Deletes a model of type M using the provided entity id. The ptr is mostly used for type inferrence.

Fully qualified path: dojo::model::storage::ModelStorage::erase_models_ptrs

fn erase_models_ptrs(ref self: S, ptrs: Span<ModelPtr<M>>)

read_member

Retrieves a single member from a model.

Fully qualified path: dojo::model::storage::ModelStorage::read_member

fn read_member<T, +Serde<T>, +DojoStore<T>>(
    self: @S, ptr: ModelPtr<M>, field_selector: felt252,
) -> T

read_member_of_models

Retrieves a single member from multiple models.

Fully qualified path: dojo::model::storage::ModelStorage::read_member_of_models

fn read_member_of_models<T, +Serde<T>, +DojoStore<T>, +Drop<T>>(
    self: @S, ptrs: Span<ModelPtr<M>>, field_selector: felt252,
) -> Array<T>

write_member

Updates a member of a model.

Fully qualified path: dojo::model::storage::ModelStorage::write_member

fn write_member<T, +Serde<T>, +DojoStore<T>, +Drop<T>>(
    ref self: S, ptr: ModelPtr<M>, field_selector: felt252, value: T,
)

write_member_of_models

Updates a member of multiple models.

Fully qualified path: dojo::model::storage::ModelStorage::write_member_of_models

fn write_member_of_models<T, +Serde<T>, +DojoStore<T>, +Drop<T>>(
    ref self: S, ptrs: Span<ModelPtr<M>>, field_selector: felt252, values: Span<T>,
)

read_schema

Retrieves a subset of members in a model, matching a defined schema .

Fully qualified path: dojo::model::storage::ModelStorage::read_schema

fn read_schema<T, +Serde<T>, +DojoStore<T>, +Introspect<T>>(self: @S, ptr: ModelPtr<M>) -> T

read_schemas

Retrieves part of multiple models, matching a schema.

Fully qualified path: dojo::model::storage::ModelStorage::read_schemas

fn read_schemas<T, +Drop<T>, +Serde<T>, +DojoStore<T>, +Introspect<T>>(
    self: @S, ptrs: Span<ModelPtr<M>>,
) -> Array<T>

read_member_legacy

— legacy functions — due to the fact that the generic type T of original functions have to be constrained to Serde and DojoStore and legacy model inner structs do not implement DojoStore. Retrieves a single member from a model.

Fully qualified path: dojo::model::storage::ModelStorage::read_member_legacy

fn read_member_legacy<T, +Serde<T>>(self: @S, ptr: ModelPtr<M>, field_selector: felt252) -> T

read_member_of_models_legacy

Retrieves a single member from multiple models.

Fully qualified path: dojo::model::storage::ModelStorage::read_member_of_models_legacy

fn read_member_of_models_legacy<T, +Serde<T>, +Drop<T>>(
    self: @S, ptrs: Span<ModelPtr<M>>, field_selector: felt252,
) -> Array<T>

write_member_legacy

Updates a member of a model.

Fully qualified path: dojo::model::storage::ModelStorage::write_member_legacy

fn write_member_legacy<T, +Serde<T>, +Drop<T>>(
    ref self: S, ptr: ModelPtr<M>, field_selector: felt252, value: T,
)

write_member_of_models_legacy

Updates a member of multiple models.

Fully qualified path: dojo::model::storage::ModelStorage::write_member_of_models_legacy

fn write_member_of_models_legacy<T, +Serde<T>, +Drop<T>>(
    ref self: S, ptrs: Span<ModelPtr<M>>, field_selector: felt252, values: Span<T>,
)

read_schema_legacy

Retrieves a subset of members in a model, matching a defined schema .

Fully qualified path: dojo::model::storage::ModelStorage::read_schema_legacy

fn read_schema_legacy<T, +Serde<T>, +Introspect<T>>(self: @S, ptr: ModelPtr<M>) -> T

read_schemas_legacy

Retrieves part of multiple models, matching a schema.

Fully qualified path: dojo::model::storage::ModelStorage::read_schemas_legacy

fn read_schemas_legacy<T, +Drop<T>, +Serde<T>, +Introspect<T>>(
    self: @S, ptrs: Span<ModelPtr<M>>,
) -> Array<T>

namespace_hash

Returns the current namespace hash.

Fully qualified path: dojo::model::storage::ModelStorage::namespace_hash

fn namespace_hash(self: @S) -> felt252

ModelValueStorage

A ModelValueStorage trait that abstracts where the storage is.

Fully qualified path: dojo::model::storage::ModelValueStorage

pub trait ModelValueStorage<S, V>

Trait functions

read_value

Retrieves a model value of type V using the provided key of type K.

Fully qualified path: dojo::model::storage::ModelValueStorage::read_value

fn read_value<K, +Drop<K>, +Serde<K>, +ModelValueKey<V, K>>(self: @S, keys: K) -> V

read_values

Retrieves multiple model values of type V using the provided keys of type K.

Fully qualified path: dojo::model::storage::ModelValueStorage::read_values

fn read_values<K, +Drop<K>, +Serde<K>, +ModelValueKey<V, K>>(self: @S, keys: Span<K>) -> Array<V>

read_value_from_id

Retrieves a model value of type V using the provided entity id.

Fully qualified path: dojo::model::storage::ModelValueStorage::read_value_from_id

fn read_value_from_id(self: @S, entity_id: felt252) -> V

read_values_from_ids

Retrieves multiple model values of type V using the provided entity ids.

Fully qualified path: dojo::model::storage::ModelValueStorage::read_values_from_ids

fn read_values_from_ids(self: @S, entity_ids: Span<felt252>) -> Array<V>

write_value

Updates a model value of type V.

Fully qualified path: dojo::model::storage::ModelValueStorage::write_value

fn write_value<K, +Drop<K>, +Serde<K>, +ModelValueKey<V, K>>(ref self: S, keys: K, value: @V)

write_values

Updates multiple model values of type V.

Fully qualified path: dojo::model::storage::ModelValueStorage::write_values

fn write_values<K, +Drop<K>, +Serde<K>, +ModelValueKey<V, K>>(
    ref self: S, keys: Span<K>, values: Span<@V>,
)

write_value_from_id

Updates a model value of type V.

Fully qualified path: dojo::model::storage::ModelValueStorage::write_value_from_id

fn write_value_from_id(ref self: S, entity_id: felt252, value: @V)

write_values_from_ids

Updates multiple model values of type V.

Fully qualified path: dojo::model::storage::ModelValueStorage::write_values_from_ids

fn write_values_from_ids(ref self: S, entity_ids: Span<felt252>, values: Span<@V>)

ModelStorageTest

A ModelStorage trait that abstracts where the storage is.

Currently it’s only world storage, but this will be useful when we have other storage solutions (micro worlds).

Fully qualified path: dojo::model::storage::ModelStorageTest

pub trait ModelStorageTest<S, M>

Trait functions

write_model_test

Sets a model of type M.

Fully qualified path: dojo::model::storage::ModelStorageTest::write_model_test

fn write_model_test(ref self: S, model: @M)

write_models_test

Sets multiple models of type M.

Fully qualified path: dojo::model::storage::ModelStorageTest::write_models_test

fn write_models_test(ref self: S, models: Span<@M>)

erase_model_test

Deletes a model of type M.

Fully qualified path: dojo::model::storage::ModelStorageTest::erase_model_test

fn erase_model_test(ref self: S, model: @M)

erase_models_test

Deletes multiple models of type M.

Fully qualified path: dojo::model::storage::ModelStorageTest::erase_models_test

fn erase_models_test(ref self: S, models: Span<@M>)

erase_model_ptr_test

Deletes a model of type M using the provided entity id.

Fully qualified path: dojo::model::storage::ModelStorageTest::erase_model_ptr_test

fn erase_model_ptr_test(ref self: S, ptr: ModelPtr<M>)

erase_models_ptrs_test

Deletes multiple models of type M using the provided entity ids.

Fully qualified path: dojo::model::storage::ModelStorageTest::erase_models_ptrs_test

fn erase_models_ptrs_test(ref self: S, ptrs: Span<ModelPtr<M>>)

ModelValueStorageTest

A ModelValueStorageTest trait that abstracts where the storage is and bypass the permission checks.

Fully qualified path: dojo::model::storage::ModelValueStorageTest

pub trait ModelValueStorageTest<S, V>

Trait functions

write_value_test

Updates a model value of type V.

Fully qualified path: dojo::model::storage::ModelValueStorageTest::write_value_test

fn write_value_test<K, +Drop<K>, +Serde<K>, +ModelValueKey<V, K>>(ref self: S, keys: K, value: @V)

write_values_test

Updates multiple model values of type V.