Struct pallet_dkg_metadata::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_signature_threshold( origin: OriginFor<T>, new_threshold: u16 ) -> DispatchResultWithPostInfo

Set the pending signature threshold for the session following the next session.

We cannot assume that the next DKG has not already completed keygen. After all, if we are in a new session the next DKG may have already completed. Therefore, when we update the thresholds we are updating a threshold that will become the next threshold after the next session update.

• origin - The account origin.
• new_threshold - The new signature threshold for the DKG.

pub fn set_keygen_threshold( origin: OriginFor<T>, new_threshold: u16 ) -> DispatchResultWithPostInfo

Set the pending keygen threshold for the session following the next session.

We cannot assume that the next DKG has not already completed keygen. After all, if we are in a new session the next DKG may have already completed. Therefore, when we update the thresholds we are updating a threshold that will become the next threshold after the next session update.

• origin - The account origin.
• new_threshold - The new keygen threshold for the DKG.

pub fn submit_public_key( origin: OriginFor<T>, keys_and_signatures: AggregatedPublicKeys ) -> DispatchResultWithPostInfo

Submits and stores the active public key for the genesis session into the on-chain storage. This is primarily used to separate the genesis public key submission from non-genesis rounds.

Can only be submitted by the current authorities. It is also required that a SignatureThreshold of submissions is reached in order to successfully store the public key on-chain.

• origin - The account origin.
• keys_and_signatures - The aggregated public keys and signatures for possible current DKG public keys.

pub fn submit_next_public_key( origin: OriginFor<T>, keys_and_signatures: AggregatedPublicKeys ) -> DispatchResultWithPostInfo

Submits and stores the next public key for the next session into the on-chain storage.

Can only be submitted by the next authorities. It is also required that a NextSignatureThreshold of submissions is reached in order to successfully store the public key on-chain.

• origin - The account origin.
• keys_and_signatures - The aggregated public keys and signatures for possible next DKG public keys.

pub fn submit_misbehaviour_reports( origin: OriginFor<T>, reports: AggregatedMisbehaviourReports<T::DKGId, T::MaxSignatureLength, T::MaxReporters> ) -> DispatchResultWithPostInfo

Submits misbehaviour reports on chain. Signatures of the offending authority are verified against the current or next authorities depending on the type of misbehaviour.

• Keygen: Verifies against the next authorities, since they are doing keygen.
• Signing: Verifies against the current authorities, since they are doing signing.

Verifies the reports against the respective thresholds and if enough reports are met begins to jail and decrease the reputation of the offending authority.

The misbehaviour reputation update is: AUTHORITY_REPUTATION = DECAY_PERCENTAGE * AUTHORITY_REPUTATION

If there are not enough unjailed keygen authorities to perform a keygen after the next session, then we deduct the pending keygen threshold (and pending signing threshold) accordingly.

• origin - The account origin.
• reports - The aggregated misbehaviour reports containing signatures of an offending authority

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

Attempts to remove an authority from all possible jails (keygen & signing). This can only be called by the controller of the authority in jail. The origin must map directly to the authority in jail.

The authority’s jail sentence for either keygen or signing must be elapsed for the authority to be removed from the jail.

• origin - The account origin.

pub fn force_unjail_keygen( origin: OriginFor<T>, authority: T::DKGId ) -> DispatchResultWithPostInfo

Force removes an authority from keygen jail.

Can only be called by DKG

• origin - The account origin.
• authority - The authority to be removed from the keygen jail.

pub fn force_unjail_signing( origin: OriginFor<T>, authority: T::DKGId ) -> DispatchResultWithPostInfo

Force removes an authority from signing jail.

Can only be called by the root origin.

• origin - The account origin.
• authority - The authority to be removed from the signing jail.

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

Forcefully rotate the DKG

This forces the next authorities into the current authority spot and automatically increments the authority ID. It uses change_authorities to execute the rotation forcefully.

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

Triggers an Emergency Keygen Protocol.

The keygen protocol will then be executed and the result will be stored in the off chain storage, which will be picked up by the on chain worker and stored on chain.

Note that, this will clear the next public key and its signature, if any.

impl<T: Config> Pallet<T>

pub fn deposit_event(event: Event<T>)

impl<T: Config> Pallet<T>

pub fn used_signatures( ) -> BoundedVec<BoundedVec<u8, T::MaxSignatureLength>, T::MaxSignatureLength>

An auto-generated getter for UsedSignatures.

impl<T: Config> Pallet<T>

pub fn refresh_nonce() -> u32

An auto-generated getter for RefreshNonce.

impl<T: Config> Pallet<T>

pub fn next_unsigned_at() -> BlockNumberFor<T>

An auto-generated getter for NextUnsignedAt.

impl<T: Config> Pallet<T>

pub fn refresh_in_progress() -> bool

An auto-generated getter for RefreshInProgress.

impl<T: Config> Pallet<T>

pub fn should_execute_new_keygen() -> (bool, bool)

An auto-generated getter for ShouldExecuteNewKeygen.

impl<T: Config> Pallet<T>

pub fn should_submit_proposer_vote() -> bool

An auto-generated getter for ShouldSubmitProposerVote.

impl<T: Config> Pallet<T>

pub fn next_dkg_public_key( ) -> Option<(AuthoritySetId, BoundedVec<u8, T::MaxKeyLength>)>

An auto-generated getter for NextDKGPublicKey.

impl<T: Config> Pallet<T>

pub fn next_public_key_signature( ) -> Option<BoundedVec<u8, T::MaxSignatureLength>>

An auto-generated getter for NextPublicKeySignature.

impl<T: Config> Pallet<T>

pub fn dkg_public_key() -> (AuthoritySetId, BoundedVec<u8, T::MaxKeyLength>)

An auto-generated getter for DKGPublicKey.

impl<T: Config> Pallet<T>

pub fn public_key_signature() -> BoundedVec<u8, T::MaxSignatureLength>

An auto-generated getter for DKGPublicKeySignature.

impl<T: Config> Pallet<T>

pub fn previous_public_key( ) -> (AuthoritySetId, BoundedVec<u8, T::MaxKeyLength>)

An auto-generated getter for PreviousPublicKey.

impl<T: Config> Pallet<T>

pub fn historical_rounds<KArg>( k: KArg ) -> RoundMetadata<T::MaxKeyLength, T::MaxSignatureLength>where KArg: EncodeLike<AuthoritySetId>,

An auto-generated getter for HistoricalRounds.

impl<T: Config> Pallet<T>

pub fn signature_threshold() -> u16

An auto-generated getter for SignatureThreshold.

impl<T: Config> Pallet<T>

pub fn keygen_threshold() -> u16

An auto-generated getter for KeygenThreshold.

impl<T: Config> Pallet<T>

pub fn next_signature_threshold() -> u16

An auto-generated getter for NextSignatureThreshold.

impl<T: Config> Pallet<T>

pub fn next_keygen_threshold() -> u16

An auto-generated getter for NextKeygenThreshold.

impl<T: Config> Pallet<T>

pub fn pending_signature_threshold() -> u16

An auto-generated getter for PendingSignatureThreshold.

impl<T: Config> Pallet<T>

pub fn pending_keygen_threshold() -> u16

An auto-generated getter for PendingKeygenThreshold.

impl<T: Config> Pallet<T>

pub fn authorities() -> BoundedVec<T::DKGId, T::MaxAuthorities>

An auto-generated getter for Authorities.

impl<T: Config> Pallet<T>

pub fn authority_set_id() -> AuthoritySetId

An auto-generated getter for AuthoritySetId.

impl<T: Config> Pallet<T>

pub fn next_authority_set_id() -> AuthoritySetId

An auto-generated getter for NextAuthoritySetId.

impl<T: Config> Pallet<T>

pub fn next_authorities() -> BoundedVec<T::DKGId, T::MaxAuthorities>

An auto-generated getter for NextAuthorities.

impl<T: Config> Pallet<T>

pub fn current_authorities_accounts( ) -> BoundedVec<T::AccountId, T::MaxAuthorities>

An auto-generated getter for CurrentAuthoritiesAccounts.

impl<T: Config> Pallet<T>

pub fn next_authorities_accounts( ) -> BoundedVec<T::AccountId, T::MaxAuthorities>

An auto-generated getter for NextAuthoritiesAccounts.

impl<T: Config> Pallet<T>

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

An auto-generated getter for AccountToAuthority.

impl<T: Config> Pallet<T>

pub fn misbehaviour_reports<KArg>( k: KArg ) -> Option<AggregatedMisbehaviourReports<T::DKGId, T::MaxSignatureLength, T::MaxReporters>>where KArg: EncodeLike<(MisbehaviourType, AuthoritySetId, T::DKGId)>,

An auto-generated getter for MisbehaviourReports.

impl<T: Config> Pallet<T>

pub fn authority_reputations<KArg>(k: KArg) -> T::Reputationwhere KArg: EncodeLike<T::DKGId>,

An auto-generated getter for AuthorityReputations.

impl<T: Config> Pallet<T>

pub fn jailed_keygen_authorities<KArg>(k: KArg) -> BlockNumberFor<T>where KArg: EncodeLike<T::DKGId>,

An auto-generated getter for JailedKeygenAuthorities.

impl<T: Config> Pallet<T>

pub fn jailed_signing_authorities<KArg>(k: KArg) -> BlockNumberFor<T>where KArg: EncodeLike<T::DKGId>,

An auto-generated getter for JailedSigningAuthorities.

impl<T: Config> Pallet<T>

pub fn best_authorities() -> BoundedVec<(u16, T::DKGId), T::MaxAuthorities>

An auto-generated getter for BestAuthorities.

impl<T: Config> Pallet<T>

pub fn next_best_authorities() -> BoundedVec<(u16, T::DKGId), T::MaxAuthorities>

An auto-generated getter for NextBestAuthorities.

impl<T: Config> Pallet<T>

pub fn last_session_rotation_block() -> BlockNumberFor<T>

An auto-generated getter for LastSessionRotationBlock.

impl<T: Config> Pallet<T>

pub fn pending_refresh_proposal() -> Option<RefreshProposal>

An auto-generated getter for PendingRefreshProposal.

impl<T: Config> Pallet<T>

pub fn current_refresh_proposal() -> Option<RefreshProposal>

An auto-generated getter for CurrentRefreshProposal.

impl<T: Config> Pallet<T>

pub fn authority_set() -> AuthoritySet<T::DKGId, T::MaxAuthorities>

Return the current active DKG authority set.

pub fn next_authority_set() -> AuthoritySet<T::DKGId, T::MaxAuthorities>

Return the next DKG authority set.

pub fn update_signature_threshold( new_threshold: u16 ) -> DispatchResultWithPostInfo

pub fn update_keygen_threshold(new_threshold: u16) -> DispatchResultWithPostInfo

pub fn decompress_public_key( compressed: Vec<u8> ) -> Result<Vec<u8>, DispatchError>

pub fn do_refresh(pub_key: Vec<u8>)

pub fn create_refresh_proposal( pub_key: Vec<u8>, nonce: u32 ) -> Result<Proposal<T::MaxProposalLength>, DispatchError>

pub fn pre_process_for_merkleize(voters: &[T::DKGId]) -> Vec<[u8; 32]>

Returns the leaves of the voter set merkle tree.

It is expected that the size of the returned vector is a power of 2.

pub fn next_layer(curr_layer: Vec<[u8; 32]>) -> Vec<[u8; 32]>

Computes the next layer of the merkle tree by hashing the previous layer.

pub fn get_voter_set_tree_height(voter_count: usize) -> u32

pub fn get_voter_set_tree_root(voters: &[T::DKGId]) -> [u8; 32]

Computes the merkle root of the voter set tree

pub fn process_public_key_submissions( aggregated_keys: AggregatedPublicKeys, authorities: Vec<T::DKGId> ) -> Result<BTreeMap<Vec<u8>, Vec<T::DKGId>>, DispatchError>

pub fn process_misbehaviour_reports( reports: AggregatedMisbehaviourReports<T::DKGId, T::MaxSignatureLength, T::MaxReporters>, verifying_set: Vec<T::DKGId> ) -> Vec<T::DKGId>

pub fn store_consensus_log( authority_ids: BoundedVec<T::DKGId, T::MaxAuthorities>, next_authority_ids: BoundedVec<T::DKGId, T::MaxAuthorities>, active_set_id: AuthoritySetId )

pub fn update_next_keygen_threshold(next_threshold: u16)

pub fn update_pending_keygen_threshold(next_threshold: u16)

pub fn update_next_signature_threshold(next_threshold: u16)

pub fn should_refresh(_now: BlockNumberFor<T>) -> bool

pub fn insert_historical_refresh( dkg_pub_key: &(AuthoritySetId, BoundedVec<u8, T::MaxKeyLength>), next_pub_key: &(AuthoritySetId, BoundedVec<u8, T::MaxKeyLength>), next_pub_key_signature: BoundedVec<u8, T::MaxSignatureLength> )

Inserts a successful rotation into the history

Insert historical round metadata consisting of the current round’s public key before rotation, the next round’s public key, and the refresh signature signed by the current key refreshing the next.

pub fn get_best_authorities_by_reputation( count: usize, authorities: &[T::DKGId] ) -> Vec<(u16, T::DKGId)>

pub fn get_best_authorities( count: usize, authorities: &[T::DKGId] ) -> Vec<(u16, T::DKGId)>

Trait Implementations

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

type Public = <T as Config>::DKGId

The [RuntimeAppPublic] this type is bound to.

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

fn dkg_key() -> Vec<u8>

fn previous_dkg_key() -> Vec<u8>

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 offchain_worker(block_number: BlockNumberFor<T>)

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 wasm runtime.

fn on_initialize(n: BlockNumberFor<T>) -> 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_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by FRAME.

fn integrity_test()

Check the integrity of this pallet’s configuration.

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

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config> IsMember<<T as Config>::DKGId> for Pallet<T>

fn is_member(authority_id: &T::DKGId) -> bool

Is the given MemberId a valid member?

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

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

impl<T: Config> OnSignedProposal<<T as Config>::MaxProposalLength> for Pallet<T>

fn on_signed_proposal( proposal: Proposal<T::MaxProposalLength> ) -> Result<(), DispatchError>

On a signed proposal, this method is called. It returns a result () and otherwise an error of type E.

impl<T: Config> OneSessionHandler<<T as Config>::AccountId> for Pallet<T>

type Key = <T as Config>::DKGId

The key type expected.

fn on_genesis_session<'a, I>(validators: I)where I: Iterator<Item = (&'a T::AccountId, T::DKGId)> + 'a,

The given validator set will be used for the genesis session. It is guaranteed that the given validator set will also be used for the second session, therefore the first call to on_new_session should provide the same validator set.

fn on_new_session<'a, I>(_changed: bool, validators: I, queued_validators: I)where I: Iterator<Item = (&'a T::AccountId, T::DKGId)> + 'a,

Session set has changed; act appropriately. Note that this can be called before initialization of your module.

fn on_disabled(i: u32)

A validator got disabled. Act accordingly until a new session begins.

fn on_before_session_ending()

A notification for end of the session.

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

fn validate_unsigned( source: TransactionSource, call: &Self::Call ) -> TransactionValidity

Validate unsigned call to this module.

By default unsigned transactions are disallowed, but implementing the validator here we make sure that some particular calls (the ones produced by offchain worker) are being whitelisted and marked as valid.

type Call = Call<T>

The call to validate

fn pre_dispatch(call: &Self::Call) -> Result<(), TransactionValidityError>

Validate the call right before dispatch.

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>