Type Alias Module

pub type Module<T> = Pallet<T>;

👎Deprecated: use Pallet instead

Type alias to Pallet, to be used by construct_runtime.

Generated by pallet attribute macro.

Aliased Type

struct Module<T>(/* private fields */);

Implementations

impl<T: Config> Pallet<T>

Pallet’s callable functions.

pub fn create_pool( origin: OriginFor<T>, staked_asset_id: Box<T::AssetId>, reward_asset_id: Box<T::AssetId>, reward_rate_per_block: T::Balance, expiry: DispatchTime<BlockNumberFor<T>>, admin: Option<T::AccountId>, ) -> DispatchResult

Create a new reward pool.

Parameters:

• origin: must be Config::CreatePoolOrigin;
• staked_asset_id: the asset to be staked in the pool;
• reward_asset_id: the asset to be distributed as rewards;
• reward_rate_per_block: the amount of reward tokens distributed per block;
• expiry: the block number at which the pool will cease to accumulate rewards. The [DispatchTime::After] variant evaluated at the execution time.
• admin: the account allowed to extend the pool expiration, increase the rewards rate and receive the unutilized reward tokens back after the pool completion. If None, the caller is set as an admin.

pub fn stake( origin: OriginFor<T>, pool_id: PoolId, amount: T::Balance, ) -> DispatchResult

Stake additional tokens in a pool.

A freeze is placed on the staked tokens.

pub fn unstake( origin: OriginFor<T>, pool_id: PoolId, amount: T::Balance, staker: Option<T::AccountId>, ) -> DispatchResult

Unstake tokens from a pool.

Removes the freeze on the staked tokens.

Parameters:

• origin: must be the staker if the pool is still active. Otherwise, any account.
• pool_id: the pool to unstake from.
• amount: the amount of tokens to unstake.
• staker: the account to unstake from. If None, the caller is used.

pub fn harvest_rewards( origin: OriginFor<T>, pool_id: PoolId, staker: Option<T::AccountId>, ) -> DispatchResult

Harvest unclaimed pool rewards.

Parameters:

• origin: must be the staker if the pool is still active. Otherwise, any account.
• pool_id: the pool to harvest from.
• staker: the account for which to harvest rewards. If None, the caller is used.

pub fn set_pool_reward_rate_per_block( origin: OriginFor<T>, pool_id: PoolId, new_reward_rate_per_block: T::Balance, ) -> DispatchResult

Modify a pool reward rate.

Currently the reward rate can only be increased.

Only the pool admin may perform this operation.

pub fn set_pool_admin( origin: OriginFor<T>, pool_id: PoolId, new_admin: T::AccountId, ) -> DispatchResult

Modify a pool admin.

Only the pool admin may perform this operation.

pub fn set_pool_expiry_block( origin: OriginFor<T>, pool_id: PoolId, new_expiry: DispatchTime<BlockNumberFor<T>>, ) -> DispatchResult

Set when the pool should expire.

Currently the expiry block can only be extended.

Only the pool admin may perform this operation.

pub fn deposit_reward_tokens( origin: OriginFor<T>, pool_id: PoolId, amount: T::Balance, ) -> DispatchResult

Convenience method to deposit reward tokens into a pool.

This method is not strictly necessary (tokens could be transferred directly to the pool pot address), but is provided for convenience so manual derivation of the account id is not required.

pub fn cleanup_pool(origin: OriginFor<T>, pool_id: PoolId) -> DispatchResult

Cleanup a pool.

Origin must be the pool admin.

Cleanup storage, release any associated storage cost and return the remaining reward tokens to the admin.

impl<T: Config> Pallet<T>

pub fn pool_creation_footprint() -> Footprint

The pool creation footprint.

The footprint specifically accounts for the storage footprint of the pool’s information itself, excluding any potential storage footprint related to the stakers.

pub fn pool_account_id(id: &PoolId) -> T::AccountId

Derive a pool account ID from the pool’s ID.

pub fn update_pool_and_staker_rewards( pool_info: &PoolInfoFor<T>, staker_info: &PoolStakerInfo<T::Balance>, ) -> Result<(PoolInfoFor<T>, PoolStakerInfo<T::Balance>), DispatchError>

Computes update pool and staker reward state.

Should be called prior to any operation involving a staker.

Returns the updated pool and staker info.

NOTE: this function has no side-effects. Side-effects such as storage modifications are the responsibility of the caller.

pub fn update_pool_rewards( pool_info: &PoolInfoFor<T>, reward_per_token: T::Balance, ) -> Result<PoolInfoFor<T>, DispatchError>

Computes update pool reward state.

Should be called every time the pool is adjusted, and a staker is not involved.

Returns the updated pool and staker info.

NOTE: this function has no side-effects. Side-effects such as storage modifications are the responsibility of the caller.

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

where T: Config + Config, T::Assets: Create<T::AccountId> + Mutate<T::AccountId>,

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark( extrinsic: &[u8], c: &[(BenchmarkParameter, u32)], whitelist: &[TrackedStorageKey], verify: bool, internal_repeats: u32, ) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

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 = NoStorageVersionSet

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 integrity_test()

Check the integrity of this pallet’s configuration.

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 try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<Vec<u8>, DispatchError>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade.

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.

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].

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See [Hooks::pre_upgrade].

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See [Hooks::post_upgrade].

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration.

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

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

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

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect, ) -> Result<(), TryRuntimeError>

Execute the state checks.

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>