Struct pallet_gear_program::pallet::Pallet

pub struct Pallet<T>(/* private fields */);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Trait Implementations

impl<T: Config> Callable<T> for Pallet<T>

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Config> CodeStorage for Pallet<T>

type InstrumentedCodeStorage = CodeStorageWrap<T>

type InstrumentedLenStorage = CodeLenStorageWrap<T>

type MetadataStorage = MetadataStorageWrap<T>

type OriginalCodeStorage = OriginalCodeStorageWrap<T>

fn reset()

Attempt to remove all items from all the associated maps.

fn add_code(code_and_id: CodeAndId, metadata: CodeMetadata) -> Result<(), Error>

fn update_code(code_and_id: InstrumentedCodeAndId)

Update the corresponding code in the storage.

fn exists(code_id: CodeId) -> bool

fn remove_code(code_id: CodeId) -> bool

Returns true if the code associated with given id was removed.

fn get_code(code_id: CodeId) -> Option<InstrumentedCode>

fn get_code_len(code_id: CodeId) -> Option<u32>

fn get_original_code(code_id: CodeId) -> Option<Vec<u8>>

fn get_metadata(code_id: CodeId) -> Option<CodeMetadata>

impl<T> Debug for Pallet<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config> GetStorageVersion for Pallet<T>

type CurrentStorageVersion = StorageVersion

This will be filled out by the pallet macro.

fn current_storage_version() -> Self::CurrentStorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]).

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by FRAME.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main wasm runtime.

fn integrity_test()

Check the integrity of this pallet’s configuration.

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config> IterableMap<(ProgramId, Program<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>)> for Pallet<T>

type DrainIter = PrefixIterator<(ProgramId, Program<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>)>

Removal iterator type.

type Iter = PrefixIterator<(ProgramId, Program<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>)>

Getting iterator type.

fn drain() -> Self::DrainIter

Creates the removal iterator over map Items.

fn iter() -> Self::Iter

Creates the getting iterator over map Items.

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq for Pallet<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config> PausedProgramStorage for Pallet<T>

type PausedProgramMap = PausedProgramStorageWrap<T>

type CodeStorage = Pallet<T>

type NonceStorage = ResumeSessionsNonceWrap<T>

type ResumeSessions = ResumeSessionsWrap<T>

fn reset()

Attempt to remove all items from all the associated maps.

fn paused_program_exists(program_id: &ProgramId) -> bool

Does the paused program (explicitly) exist in storage?

fn pause_program( program_id: ProgramId, block_number: Self::BlockNumber ) -> Result<BTreeMap<ReservationId, GasReservationSlot>, Self::Error>

Pause an active program with the given key program_id.

fn resume_session_init( user: Self::AccountId, end_block: Self::BlockNumber, program_id: ProgramId, allocations: BTreeSet<Page<gear_core::::pages::WasmPage::{constant#0}>>, code_hash: CodeId ) -> Result<u32, Self::Error>

Create a session for program resume. Returns the session id on success.

fn resume_session_page_count(session_id: &u32) -> Option<u32>

Get the count of uploaded memory pages of the specified session.

fn resume_session_push( session_id: u32, user: Self::AccountId, memory_pages: Vec<(Page<gear_core::::pages::GearPage::{constant#0}>, PageBuf)> ) -> Result<(), Self::Error>

Append program memory pages to the session data.

fn resume_session_commit( session_id: u32, user: Self::AccountId, expiration_block: Self::BlockNumber ) -> Result<ResumeResult<Self::BlockNumber>, Self::Error>

Finish program resume session with the given key session_id.

fn remove_resume_session(session_id: u32) -> Result<(), Self::Error>

Remove all data created by a call to resume_session_init.

impl<T: Config> ProgramStorage for Pallet<T>

type InternalError = Error<T>

type Error = DispatchError

type BlockNumber = <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number

type AccountId = <T as Config>::AccountId

type ProgramMap = ProgramStorageWrap<T>

type MemoryPageMap = MemoryPageStorageWrap<T>

fn pages_final_prefix() -> [u8; 32]

Final full prefix that prefixes all keys of memory pages.

fn reset()

Attempt to remove all items from all the associated maps.

fn add_program( program_id: ProgramId, program: ActiveProgram<Self::BlockNumber> ) -> Result<(), Self::Error>

Store a program to be associated with the given key program_id from the map.

fn get_program(program_id: ProgramId) -> Option<Program<Self::BlockNumber>>

Load the program associated with the given key program_id from the map.

fn program_exists(program_id: ProgramId) -> bool

Does the program (explicitly) exist in storage?

fn update_active_program<F, ReturnType>( program_id: ProgramId, update_action: F ) -> Result<ReturnType, Self::Error>

where F: FnOnce(&mut ActiveProgram<Self::BlockNumber>) -> ReturnType,

Update the active program under the given key program_id.

fn update_program_if_active<F, ReturnType>( program_id: ProgramId, update_action: F ) -> Result<ReturnType, Self::Error>

where F: FnOnce(&mut Program<Self::BlockNumber>, Self::BlockNumber) -> ReturnType,

Update the program under the given key program_id only if the stored program is an active one.

fn get_program_data_for_pages<'a>( program_id: ProgramId, memory_infix: MemoryInfix, pages: impl Iterator<Item = &'a Page<gear_core::::pages::GearPage::{constant#0}>> ) -> Result<BTreeMap<Page<gear_core::::pages::GearPage::{constant#0}>, PageBuf>, Self::Error>

Return program data for each page from pages.

fn set_program_page_data( program_id: ProgramId, memory_infix: MemoryInfix, page: Page<gear_core::::pages::GearPage::{constant#0}>, page_buf: PageBuf )

Store a memory page buffer to be associated with the given keys program_id, memory_infix and page from the map.

fn remove_program_page_data( program_id: ProgramId, memory_infix: MemoryInfix, page_num: Page<gear_core::::pages::GearPage::{constant#0}> )

Remove a memory page buffer under the given keys program_id, memory_infix and page.

fn remove_program_pages(program_id: ProgramId, memory_infix: MemoryInfix)

Remove all memory page buffers under the given keys program_id and memory_infix.

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>