Struct Pallet

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

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

Implementations

impl<T: Config> Pallet<T>

pub fn claim(origin: OriginFor<T>) -> DispatchResult

Claim thawed balances.

Events

• Event::Claimed

pub fn transfer( origin: OriginFor<T>, dest: <T::Lookup as StaticLookup>::Source, schedule: ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>, ) -> DispatchResult

Add a new release schedule for an account.

Events

• `Event::ReleaseScheduleAdded

Errors

• `Error::InsufficientBalanceToFreeze - Insufficient amount of balance to freeze.
• `Error::MaxReleaseSchedulesExceeded - Failed because the maximum release schedules was exceeded-
• [`ArithmeticError::Overflow] - Failed because of an overflow.

pub fn update_release_schedules( origin: OriginFor<T>, who: <T::Lookup as StaticLookup>::Source, release_schedules: Vec<ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>>, ) -> DispatchResult

Update all release schedules under an account, root origin required.

Events

• `Event::ReleaseSchedulesUpdated - Updated release schedules.

Errors

• `Error::InsufficientBalanceToFreeze - Insufficient amount of balance to freeze.
• `Error::MaxReleaseSchedulesExceeded - Failed because the maximum release schedules was exceeded-
• [`ArithmeticError::Overflow] - Failed because of an overflow.

pub fn claim_for( origin: OriginFor<T>, dest: <T::Lookup as StaticLookup>::Source, ) -> DispatchResult

Claim thawed balances on behalf for an account.

Events

• Event::Claimed

pub fn schedule_named_transfer( origin: OriginFor<T>, id: ScheduleName, dest: <T::Lookup as StaticLookup>::Source, schedule: ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>, when: BlockNumberFor<T>, ) -> DispatchResult

This function schedules a transfer by calling the Scheduler pallet’s schedule function. The transfer will be executed at the specified block number.

• Error::InsufficientBalanceToFreeze - Insufficient amount of balance to freeze.
• Error::MaxReleaseSchedulesExceeded - Failed because the maximum release schedules was exceeded-
• [`ArithmeticError::Overflow] - Failed because of an overflow.

pub fn cancel_scheduled_named_transfer( origin: OriginFor<T>, id: ScheduleName, ) -> DispatchResult

Cancels a scheduled transfer by its unique identifier. Releases any funds held for the specified transfer.

pub fn execute_scheduled_named_transfer( origin: OriginFor<T>, id: ScheduleName, dest: <T::Lookup as StaticLookup>::Source, schedule: ReleaseSchedule<BlockNumberFor<T>, <<T as Config>::Currency as InspectFungible<<T as Config>::AccountId>>::Balance>, ) -> DispatchResult

Execute a scheduled transfer

This function is called to execute a transfer that was previously scheduled. It ensures that the origin is valid, the destination account exists, and the release schedule is valid. It then finalizes the vesting transfer from the hold balance and emits an event indicating that the release schedule was added.

Arguments

• origin - The origin of the call, which must be the TimeRelease origin.
• dest - The destination account to which the funds will be transferred.
• schedule - The release schedule that specifies the amount and timing of the transfer.

Errors

• [ArithmeticError::Overflow] - If the total amount in the schedule overflows.
• Error::InsufficientBalanceToFreeze - If the hold balance is insufficient.
• Error::ZeroReleasePeriod - If the release period is zero.
• Error::ZeroReleasePeriodCount - If the release period count is zero.
• Error::AmountLow - If the total amount is below the minimum release transfer amount.

Events

• Event::ReleaseScheduleAdded - Indicates that a new release schedule was added.

Trait Implementations

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

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

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> Debug for Pallet<T>

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

Formats the value using the given formatter.

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

fn dispatch_view_function<O: Output>( id: &ViewFunctionId, input: &mut &[u8], output: &mut O, ) -> Result<(), ViewFunctionDispatchError>

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

type InCodeStorageVersion = StorageVersion

This type is generated by the pallet macro.

fn in_code_storage_version() -> Self::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or [NoStorageVersionSet] if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use [Self::current_storage_version] instead.

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_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

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

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 blockchain execution.

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> 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> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

Code to execute every now and then at the beginning of the block after inherent application.

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 name_hash() -> [u8; 16]

Two128 hash of name.

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

fn storage_info() -> Vec<StorageInfo>

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

fn prefix() -> [u8; 16]

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>