Struct pallet_attesters::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 register_attester( origin: OriginFor<T>, self_nominate_amount: BalanceOf<T>, ecdsa_key: [u8; 33], ed25519_key: [u8; 32], sr25519_key: [u8; 32], custom_commission: Option<Percent> ) -> DispatchResult

pub fn register_invulnerable_attester( origin: OriginFor<T>, self_nominate_amount: BalanceOf<T>, ecdsa_key: [u8; 33], ed25519_key: [u8; 32], sr25519_key: [u8; 32], custom_commission: Option<Percent> ) -> DispatchResult

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

pub fn remove_attestation_target( origin: OriginFor<T>, target: TargetId ) -> DispatchResult

pub fn agree_to_new_attestation_target( origin: OriginFor<T>, target: TargetId, recoverable: Vec<u8> ) -> DispatchResult

pub fn force_activate_target( origin: OriginFor<T>, target: TargetId ) -> DispatchResult

pub fn add_attestation_target( origin: OriginFor<T>, target: TargetId ) -> DispatchResult

pub fn submit_attestation( origin: OriginFor<T>, message: H256, signature: Vec<u8>, target: TargetId ) -> DispatchResult

pub fn commit_batch( origin: OriginFor<T>, target: TargetId, target_inclusion_proof_encoded: Vec<u8> ) -> DispatchResult

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

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

pub fn estimate_user_finality_fee( origin: OriginFor<T>, target: TargetId ) -> DispatchResult

pub fn nominate( origin: OriginFor<T>, attester: T::AccountId, amount: BalanceOf<T> ) -> DispatchResult

pub fn unnominate( origin: OriginFor<T>, attester: T::AccountId ) -> DispatchResult

impl<T: Config> Pallet<T>

pub fn committee_size() -> usize

pub fn apply_partial_stake_slash( attester: T::AccountId, nominations: Vec<(T::AccountId, BalanceOf<T>)>, percent_slash: Percent, percent_nominator_grace: Percent ) -> (BalanceOf<T>, Vec<(T::AccountId, BalanceOf<T>)>)

This function applies a partial slash to the stakes of an attester and its nominators. It returns the self-nomination balance of the given attester and the updated nomination balances of the nominators with an applied grace percent.

Parameters

• attester: The account ID of the attester whose stake is being slashed.
• nominations: A vector of tuples where each tuple represents a nominator and its balance.
• percent_slash: The percent of stake to slash from the attester.
• percent_nominator_grace: The percent of stake to slash from the nominators.

Returns

This function returns a tuple containing two elements:

• The first element is the self-nomination balance of the attester after the slash has been applied.
• The second element is a vector of tuples where each tuple represents a nominator and its balance after the slash has been applied.

If the attester is not found in the nominations, the function returns zero as the self-nomination balance and an empty vector as the list of nominators.

pub fn find_and_set_batch_as_committed( target: TargetId, message_hash: &H256 ) -> DispatchResult

pub fn reward_submitter( submitter: &T::AccountId, submitter_on_target: &H160, target: &TargetId, to_pay: BalanceOf<T> ) -> DispatchResult

pub fn try_activate_new_target(target: &TargetId) -> bool

pub fn is_last_transition_attested() -> bool

pub fn get_batches( target: TargetId, by_status: BatchStatus ) -> Vec<BatchMessage<BlockNumberFor<T>>>

pub fn get_batch_by_message( target: TargetId, message: Vec<u8> ) -> Option<BatchMessage<BlockNumberFor<T>>>

pub fn get_batch_by_message_hash( target: TargetId, message_hash: H256 ) -> Option<BatchMessage<BlockNumberFor<T>>>

pub fn get_batches_to_commit( target: TargetId ) -> Vec<BatchMessage<BlockNumberFor<T>>>

pub fn get_latest_batch_to_commit( target: TargetId ) -> Option<BatchMessage<BlockNumberFor<T>>>

pub fn get_all_batches_to_sign( target: TargetId ) -> Vec<BatchMessage<BlockNumberFor<T>>>

pub fn get_latest_batch_to_sign( target: TargetId ) -> Option<BatchMessage<BlockNumberFor<T>>>

pub fn get_latest_batch_to_sign_hash(target: TargetId) -> Option<H256>

pub fn get_latest_batch_to_sign_message(target: TargetId) -> Option<Vec<u8>>

pub fn do_nominate( nominator: &T::AccountId, attester: &T::AccountId, amount: BalanceOf<T> ) -> DispatchResult

pub fn get_current_committee_transition_for_target( target: &TargetId ) -> CommitteeTransition

pub fn get_current_committee_indices() -> CommitteeTransitionIndices

pub fn process_repatriations( n: BlockNumberFor<T>, aggregated_weight: Weight ) -> Weight

pub fn process_next_batch_window( n: BlockNumberFor<T>, aggregated_weight: Weight ) -> Weight

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

pub fn process_pending_unnominations( n: BlockNumberFor<T>, aggregated_weight: Weight ) -> Weight

impl<T: Config> Pallet<T>

pub fn attesters<KArg>(k: KArg) -> Option<AttesterInfo>where KArg: EncodeLike<T::AccountId>,

An auto-generated getter for Attesters.

impl<T: Config> Pallet<T>

pub fn sorted_nominated_attesters() -> Vec<(T::AccountId, BalanceOf<T>)>

An auto-generated getter for SortedNominatedAttesters.

impl<T: Config> Pallet<T>

pub fn active_set() -> Vec<T::AccountId>

An auto-generated getter for ActiveSet.

impl<T: Config> Pallet<T>

pub fn pending_slashes() -> Vec<T::AccountId>

An auto-generated getter for PermanentSlashes.

impl<T: Config> Pallet<T>

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

An auto-generated getter for InvulnerableAttester.

impl<T: Config> Pallet<T>

pub fn attestation_targets() -> Vec<TargetId>

An auto-generated getter for AttestationTargets.

impl<T: Config> Pallet<T>

pub fn pending_attestation_targets() -> Vec<TargetId>

An auto-generated getter for PendingAttestationTargets.

impl<T: Config> Pallet<T>

pub fn attesters_agreements<KArg1, KArg2>( k1: KArg1, k2: KArg2 ) -> Option<Vec<u8>>where KArg1: EncodeLike<T::AccountId>, KArg2: EncodeLike<TargetId>,

An auto-generated getter for AttestersAgreements.

impl<T: Config> Pallet<T>

pub fn next_batches<KArg>(k: KArg) -> Option<BatchMessage<BlockNumberFor<T>>>where KArg: EncodeLike<TargetId>,

An auto-generated getter for NextBatch.

impl<T: Config> Pallet<T>

pub fn next_committee_on_target<KArg>(k: KArg) -> Option<CommitteeTransition>where KArg: EncodeLike<TargetId>,

An auto-generated getter for NextCommitteeOnTarget.

impl<T: Config> Pallet<T>

pub fn batches_to_sign<KArg>( k: KArg ) -> Option<Vec<BatchMessage<BlockNumberFor<T>>>>where KArg: EncodeLike<TargetId>,

An auto-generated getter for BatchesToSign.

impl<T: Config> Pallet<T>

pub fn batches<KArg>(k: KArg) -> Option<Vec<BatchMessage<BlockNumberFor<T>>>>where KArg: EncodeLike<TargetId>,

An auto-generated getter for Batches.

impl<T: Config> Pallet<T>

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

An auto-generated getter for PendingUnnominations.

impl<T: Config> Pallet<T>

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

An auto-generated getter for Nominations.

impl<T: Config> Pallet<T>

pub fn paid_finality_fees<KArg>(k: KArg) -> Option<Vec<BalanceOf<T>>>where KArg: EncodeLike<TargetId>,

An auto-generated getter for PaidFinalityFees.

Trait Implementations

impl<T: Config> AttestersReadApi<<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>

Finality Fee Estimation and User Base Projection

This module provides functionalities for estimating future finality fees and user base in a decentralized system, drawing inspiration from the concept of a pension scheme.

Overview

The aim of this module is to estimate future fees and user base in a way that balances the interests of all participants. This is achieved by employing methods similar to those used in pension systems, where fees paid by current participants are used to support earlier generations.

Two primary functions provided by this module are:

1. estimate_user_finality_fee
2. estimate_future_user_base

Functionality

estimate_user_finality_fee

This function estimates the finality fee for an individual user. The function considers the total fee paid in the most recent epoch and divides it by the number of users in that epoch to calculate a base user fee. An overcharge factor is then added to this base fee to account for fluctuations and provide a buffer. This calculation mirrors the process in pension systems where individual contributions are calculated based on total liabilities and the number of current contributors.

estimate_future_user_base

The estimate_future_user_base function forecasts the user base size for a future epoch. The function calculates the average growth rate of the user base over the past few epochs and applies this rate iteratively to project future growth. This function is similar to population projections in pension systems, which are critical in determining future contribution rates.

Concluding Remarks

The functions in this module draw inspiration from pension systems, projecting future conditions based on past data and current trends. While the context is different – a decentralized system instead of a pension scheme – the fundamental concepts are the same. The ability to estimate future fees and user base size contributes to system sustainability and fairness, much like in a well-managed pension scheme.

fn previous_committee() -> Vec<T::AccountId>

Getter for the current committee. Returns a Vec of AccountIds.

fn current_committee() -> Vec<T::AccountId>

Getter for the current committee. Returns a Vec of AccountIds.

fn active_set() -> Vec<T::AccountId>

Getter for the active set. Returns a Vec of AccountIds.

fn honest_active_set() -> Vec<T::AccountId>

Getter for the active set of ONLY those who haven’t been permanently slashed. Returns a Vec of AccountIds.

fn read_attester_info(attester: &T::AccountId) -> Option<AttesterInfo>

Getter for the info of the attester provided.

fn read_nominations( for_attester: &T::AccountId ) -> Vec<(T::AccountId, BalanceOf<T>)>

Getter for the nominations of the given attester. Returns the nominator and the balance of the nomination as a tuple (account id, balance).

fn get_activated_targets() -> Vec<TargetId>

Getter for the attestation targets.

fn read_attestation_latency(target: &TargetId) -> Option<LatencyStatus>

Getter for the latency status of the given target. Selects the oldest batch with PendingAttestation and return its LatencyStatus.

fn estimate_finality_fee(target: &TargetId) -> BalanceOf<T>

Estimation of the finality fee for the given target.

For this first version, we don’t take into account the number of users, i.e., there’s no batching factor.

fn estimate_finality_reward( target: &TargetId, blocks_delay: BlockNumberFor<T> ) -> BalanceOf<T>

Compute, for a given target, the finality reward as a Balance

fn estimate_batching_factor(target: &TargetId) -> Option<BatchingFactor>

Estimate the batching factor for a given target.

impl<T: Config> AttestersWriteApi<<T as Config>::AccountId, DispatchError> for Pallet<T>

fn request_sfx_attestation_commit( target: TargetId, sfx_id: H256, maybe_gmp_payload: Option<H256> ) -> Result<(), DispatchError>

fn request_sfx_attestation_revert( target: TargetId, sfx_id: H256 ) -> Result<(), DispatchError>

fn request_ban_attesters_attestation( ban_attester: &T::AccountId ) -> Result<(), DispatchError>

fn request_next_committee_attestation() -> Vec<(TargetId, u32)>

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

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

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

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