Struct dock_staking_rewards::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn set_emission_status( origin: OriginFor<T>, status: bool ) -> DispatchResultWithPostInfo

Enable/disable emission rewards by calling this function with true or false respectively.

impl<T: Config> Pallet<T>

pub fn staking_emission_supply() -> BalanceOf<T>

Remaining emission supply. This reduces after each era as emissions happen unless emissions are disabled. Name is intentionally kept different from EmissionSupply from dock_poa module.

impl<T: Config> Pallet<T>

pub fn staking_emission_status() -> bool

Boolean flag determining whether to generate emission rewards or not. Name is intentionally kept different from EmissionStatus from dock_poa module.

impl<T: Config> Pallet<T>

pub fn high_rate_rewards() -> HighRateRewardsState

Current state of the high-rate rewards.

impl<T: Config> Pallet<T>

pub fn yearly_emission( total_staked: BalanceOf<T>, total_issuance: BalanceOf<T> ) -> BalanceOf<T>

This function can fetch total_staked and total_issuance from storage but that would make this pallet dependent on staking pallet

pub fn max_yearly_emission() -> BalanceOf<T>

pub fn reward_decay_pct() -> Percent

The percentage by which remaining emission supply decreases.

pub fn treasury_rewards_pct() -> Percent

Trait Implementations

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

type Call = 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> EraPayout<<<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance> for Pallet<T>

fn era_payout( total_staked: BalanceOf<T>, total_issuance: BalanceOf<T>, era_duration_millis: u64 ) -> (BalanceOf<T>, BalanceOf<T>)

Compute era payout for validators and treasury and reduce the remaining emission supply. It is assumed and expected that this is called only when a payout of an era has to computed and isn’t called twice for the same era as it has a side-effect (reducing remaining supply and transitioning the high-rate rewards state). Currently, it doesn’t seem possible to avoid this side effect as there is no way for this pallet to be notified if an era payout was successfully done.

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

fn current_storage_version() -> StorageVersion

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>::BlockNumber> for Pallet<T>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

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

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_initialize(_n: BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

fn integrity_test()

Run integrity test.

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

fn integrity_test()

Run integrity test.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

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

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

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

fn on_runtime_upgrade() -> Weight

Perform a module 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<Pallet<T>> 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> Eq for Pallet<T>