Struct pallet_rewards::pallet::Pallet

pub struct Pallet<T>(_);

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

Implementations

impl<T: Config> Pallet<T>

pub fn set_max_rewards_executors_kickback( origin: OriginFor<T>, new_kickback: Percent ) -> DispatchResult

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

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

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

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

pub fn claim( origin: OriginFor<T>, role_to_claim: Option<CircuitRole> ) -> DispatchResultWithPostInfo

impl<T: Config> Pallet<T>

pub fn distribute_inflation() -> Weight

pub fn distribute_attester_rewards( current_distribution: BalanceOf<T> ) -> BalanceOf<T>

pub fn distribute_collator_rewards( current_distribution: BalanceOf<T> ) -> BalanceOf<T>

pub fn distribute_executor_rewards( current_distribution: BalanceOf<T> ) -> BalanceOf<T>

pub fn process_accumulated_settlements() -> Weight

pub fn executions_this_round( ) -> Vec<(T::AccountId, Settlement<T::AccountId, BalanceOf<T>, u32>)>

pub fn author() -> Option<T::AccountId>

pub fn process_author() -> (bool, Weight)

pub fn find_inactive_authors( current_session_validators: Vec<T::AccountId> ) -> Vec<T::AccountId>

pub fn process_update_estimated_treasury_balance() -> Weight

pub fn process_authors_this_period() -> Weight

pub fn executions_proportionally_of_total_this_round( executions_this_round: Vec<(T::AccountId, BalanceOf<T>)>, total_settled_executions_this_round: BalanceOf<T> ) -> Vec<(T::AccountId, BalanceOf<T>, Perbill)>

impl<T: Config> Pallet<T>

pub fn authors() -> AuthorCount<T::AccountId>

An auto-generated getter for Authors.

impl<T: Config> Pallet<T>

pub fn authors_this_period() -> AuthorCount<T::AccountId>

An auto-generated getter for AuthorsThisPeriod.

impl<T: Config> Pallet<T>

pub fn accumulated_settlements2<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> Option<BalanceOf<T>>where KArg1: EncodeLike<T::AccountId>, KArg2: EncodeLike<AssetType<u32>>,

An auto-generated getter for AccumulatedSettlements.

impl<T: Config> Pallet<T>

pub fn estimated_treasury_balance() -> TreasuryBalanceSheet<BalanceOf<T>>

An auto-generated getter for EstimatedTreasuryBalance.

impl<T: Config> Pallet<T>

pub fn repatriation_percentage() -> Percent

An auto-generated getter for RepatriationPercentage.

impl<T: Config> Pallet<T>

pub fn get_pending_claims<KArg>( k: KArg ) -> Option<Vec<ClaimableArtifacts<T::AccountId, BalanceOf<T>>>>where KArg: EncodeLike<T::AccountId>,

An auto-generated getter for PendingClaims.

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

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_finalize(_n: BlockNumberFor<T>)

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

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

The block is being initialized. 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).

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

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

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

fn on_idle(n: BlockNumberFor<T>, 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>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> 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> RewardsWriteApi<<T as Config>::AccountId, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn repatriate_for_faulty_or_missing_attestation( sfx_id: &H256, fsx: &FullSideEffect<T::AccountId, BlockNumberFor<T>, BalanceOf<T>>, status: &CircuitStatus, requester: Option<T::AccountId> ) -> bool

This function is called by the attesters pallet to repatriate the executor of honest SFX for attesters not signing on the attestation within the acceptable time limit. The repatriation is done on the agreed percentage value of the SlashTreasury, the current percantage is available through the repatriation_percentage function. Since the percentage and the estimated slash treasury balance are known, the amount of funds to be repatriated can be calculated by executors prior to bidding for SFX on Escrow Targets, with the following formula: amount_to_be_repatriated = slash_treasury_balance * repatriation_percentage. The repatratration can’t exceed the 50% of the max_reward of SFX. Remaining funds in the SlashTreasury after repatriation are used as a base for Finality Fee, therefore land in Fee Treasury.

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>