Struct pallet_dapp_staking::pallet::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 unbond_and_unstake( origin: OriginFor<T>, _contract_id: T::SmartContract, value: Balance ) -> DispatchResult

Wrapper around legacy-like unbond_and_unstake.

Used to support legacy Ledger users so they can start the unlocking process for their funds.

pub fn withdraw_unbonded(origin: OriginFor<T>) -> DispatchResultWithPostInfo

Wrapper around legacy-like withdraw_unbonded.

Used to support legacy Ledger users so they can reclaim unlocked chunks back into their transferable free balance.

pub fn maintenance_mode(origin: OriginFor<T>, enabled: bool) -> DispatchResult

Used to enable or disable maintenance mode. Can only be called by manager origin.

pub fn register( origin: OriginFor<T>, owner: T::AccountId, smart_contract: T::SmartContract ) -> DispatchResult

Used to register a new contract for dApp staking.

If successful, smart contract will be assigned a simple, unique numerical identifier. Owner is set to be initial beneficiary & manager of the dApp.

pub fn set_dapp_reward_beneficiary( origin: OriginFor<T>, smart_contract: T::SmartContract, beneficiary: Option<T::AccountId> ) -> DispatchResult

Used to modify the reward beneficiary account for a dApp.

Caller has to be dApp owner. If set to None, rewards will be deposited to the dApp owner. After this call, all existing & future rewards will be paid out to the beneficiary.

pub fn set_dapp_owner( origin: OriginFor<T>, smart_contract: T::SmartContract, new_owner: T::AccountId ) -> DispatchResult

Used to change dApp owner.

Can be called by dApp owner or dApp staking manager origin. This is useful in two cases:

1. when the dApp owner account is compromised, manager can change the owner to a new account
2. if project wants to transfer ownership to a new account (DAO, multisig, etc.).

pub fn unregister( origin: OriginFor<T>, smart_contract: T::SmartContract ) -> DispatchResult

Unregister dApp from dApp staking protocol, making it ineligible for future rewards. This doesn’t remove the dApp completely from the system just yet, but it can no longer be used for staking.

Can be called by dApp staking manager origin.

pub fn lock(origin: OriginFor<T>, amount: Balance) -> DispatchResultWithPostInfo

Locks additional funds into dApp staking.

In case caller account doesn’t have sufficient balance to cover the specified amount, everything is locked. After adjustment, lock amount must be greater than zero and in total must be equal or greater than the minimum locked amount.

Locked amount can immediately be used for staking.

pub fn unlock(origin: OriginFor<T>, amount: Balance) -> DispatchResult

Attempts to start the unlocking process for the specified amount.

Only the amount that isn’t actively used for staking can be unlocked. If the amount is greater than the available amount for unlocking, everything is unlocked. If the remaining locked amount would take the account below the minimum locked amount, everything is unlocked.

pub fn claim_unlocked(origin: OriginFor<T>) -> DispatchResultWithPostInfo

Claims all of fully unlocked chunks, removing the lock from them.

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

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

Stake the specified amount on a smart contract. The precise amount specified must be available for staking. The total amount staked on a dApp must be greater than the minimum required value.

Depending on the period type, appropriate stake amount will be updated. During Voting subperiod, voting stake amount is updated, and same for Build&Earn subperiod.

Staked amount is only eligible for rewards from the next era onwards.

pub fn unstake( origin: OriginFor<T>, smart_contract: T::SmartContract, amount: Balance ) -> DispatchResult

Unstake the specified amount from a smart contract. The amount specified must not exceed what’s staked, otherwise the call will fail.

If unstaking the specified amount would take staker below the minimum stake threshold, everything is unstaked.

Depending on the period type, appropriate stake amount will be updated. In case amount is unstaked during Voting subperiod, the voting amount is reduced. In case amount is unstaked during Build&Earn subperiod, first the build_and_earn is reduced, and any spillover is subtracted from the voting amount.

pub fn claim_staker_rewards(origin: OriginFor<T>) -> DispatchResultWithPostInfo

Claims some staker rewards, if user has any. In the case of a successful call, at least one era will be claimed, with the possibility of multiple claims happening.

pub fn claim_bonus_reward( origin: OriginFor<T>, smart_contract: T::SmartContract ) -> DispatchResult

Used to claim bonus reward for a smart contract, if eligible.

pub fn claim_dapp_reward( origin: OriginFor<T>, smart_contract: T::SmartContract, era: EraNumber ) -> DispatchResult

Used to claim dApp reward for the specified era.

pub fn unstake_from_unregistered( origin: OriginFor<T>, smart_contract: T::SmartContract ) -> DispatchResult

Used to unstake funds from a contract that was unregistered after an account staked on it. This is required if staker wants to re-stake these funds on another active contract during the ongoing period.

pub fn cleanup_expired_entries( origin: OriginFor<T> ) -> DispatchResultWithPostInfo

Cleanup expired stake entries for the contract.

Entry is considered to be expired if:

1. It’s from a past period & the account wasn’t a loyal staker, meaning there’s no claimable bonus reward.
2. It’s from a period older than the oldest claimable period, regardless whether the account was loyal or not.

pub fn force(origin: OriginFor<T>, forcing_type: ForcingType) -> DispatchResult

Used to force a change of era or subperiod. The effect isn’t immediate but will happen on the next block.

Used for testing purposes, when we want to force an era change, or a subperiod change. Not intended to be used in production, except in case of unforeseen circumstances.

Can only be called by the root origin.

pub fn claim_staker_rewards_for( origin: OriginFor<T>, account: T::AccountId ) -> DispatchResultWithPostInfo

Claims some staker rewards for the specified account, if they have any. In the case of a successful call, at least one era will be claimed, with the possibility of multiple claims happening.

pub fn claim_bonus_reward_for( origin: OriginFor<T>, account: T::AccountId, smart_contract: T::SmartContract ) -> DispatchResult

Used to claim bonus reward for a smart contract on behalf of the specified account, if eligible.

impl<T: Config> Pallet<T>

pub fn is_staker(account: &T::AccountId) -> bool

true if the account is a staker, false otherwise.

pub fn era_reward_span_index(era: EraNumber) -> EraNumber

Calculates the EraRewardSpan index for the specified era.

pub fn unlocking_period() -> BlockNumber

Unlocking period expressed in the number of blocks.

pub fn get_dapp_tier_assignment() -> BTreeMap<DAppId, RankedTier>

Returns the dApp tier assignment for the current era, based on the current stake amounts.

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> 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(now: BlockNumberFor<T>) -> Weight

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

fn on_idle(_block: BlockNumberFor<T>, 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 integrity_test()

Check the integrity of this pallet’s configuration.

fn on_finalize(_n: BlockNumber)

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

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.

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

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