Struct Pallet

pub struct Pallet<T>(PhantomData<T>);

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

Tuple Fields

0: PhantomData<T>

Implementations

impl<T: Config> Pallet<T>

pub fn commit( origin: OriginFor<T>, shard_id: ShardId, commitment: Commitment, proof_of_knowledge: ProofOfKnowledge, ) -> DispatchResult

Allows a member to submit a commitment to a shard.

Flow

1. Ensure the origin is a signed transaction and the sender is a member of the shard.
2. Validate the commitment length against the shard threshold.
3. Validate each commitment element.
4. Verify the proof of knowledge using the peer ID of the member.
5. Update the status of the member to Committed and store the commitment.
6. If all members have committed, update the state of the shards to Committed and store the group commitment.
7. Emit the Event::ShardCommitted event.

pub fn ready(origin: OriginFor<T>, shard_id: ShardId) -> DispatchResult

Marks a shard as ready when a member indicates readiness after commitment.

Flow

1. Ensure the origin is a signed transaction and the sender has committed.
2. Retrieve the network and commitment of the shard.
3. Update the status of the shard to Ready.
4. If all members are ready, update the state of the shard to Online and emit the Event::ShardOnline event.
5. Notify the task scheduler that the shard is online.

pub fn force_shard_offline( origin: OriginFor<T>, shard_id: ShardId, ) -> DispatchResult

Forces a shard to go offline, used primarily by the root.

Flow

1. Ensure the origin is the root.
2. Call the internal remove_shards_offline function to handle the shard offline process.

impl<T: Config> Pallet<T>

fn execute_commit( member: AccountId, shard_id: ShardId, commitment: Commitment, proof_of_knowledge: ProofOfKnowledge, ) -> DispatchResult

fn execute_ready(member: AccountId, shard_id: ShardId) -> DispatchResult

fn remove_shards_offline(shards: Vec<ShardId>)

Handles the internal logic for removing shards and setting state to offline. Sets shards’ statuses to offline and keeps shards’ public keys if already submitted

Flow

1. Update the state of the shard to Offline.
2. Remove the threshold of the shard.
3. Notify the task scheduler and elections module that the shard is offline.
4. Drain the members of the shard and remove their corresponding entries.
5. Emit the Event::ShardsOffline event.

pub(crate) fn timeout_dkgs(n: BlockNumberFor<T>) -> Weight

Checks for DKG timeouts and handles shard state transitions accordingly.

Flow

1. Iterate over the DkgTimeout storage.
2. Check if the DKG process of any shard has timed out.
3. For timed-out shards, update their status to offline and emit the Event::ShardsOffline event.
4. Remove DKG timeout entries for shards that are no longer in Created or Committed states.

pub fn shards(account: &AccountId) -> Vec<ShardId>

Fetches all shards associated with a given account.

Flow

1. Iterate over ShardMembers storage to find all shards the account is a member of.
2. Collect and return the shard IDs.

pub fn shard_members(shard_id: ShardId) -> Vec<(AccountId, MemberStatus)>

Retrieves all members of a specified shard.

Flow

1. Iterate over ShardMembers storage for the given shard ID.
2. Collect and return the member statuses.

pub fn shard_threshold(shard_id: ShardId) -> u16

Retrieves the threshold value of a specified shard.

Flow

1. Retrieve and return the threshold value from ShardThreshold storage.

pub fn shard_status(shard_id: ShardId) -> ShardStatus

Retrieves the current status of a specified shard.

Flow

1. Retrieve and return the status from ShardState storage.

pub fn shard_commitment(shard_id: ShardId) -> Option<Commitment>

Retrieves the commitment of a specified shard, if available.

Flow

1. Retrieve and return the commitment from ShardCommitment storage.

impl<T: Config> Pallet<T>

pub(crate) fn deposit_event(event: Event<T>)

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

where T: Config + Config + Config,

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark( extrinsic: &[u8], c: &[(BenchmarkParameter, u32)], whitelist: &[TrackedStorageKey], verify: bool, internal_repeats: u32, ) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

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

fn dispatch_view_function<O: Output>( id: &ViewFunctionId, input: &mut &[u8], output: &mut O, ) -> Result<(), ViewFunctionDispatchError>

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

type InCodeStorageVersion = NoStorageVersionSet

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(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_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 try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<Vec<u8>, DispatchError>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade.

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.

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

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See [Hooks::pre_upgrade].

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See [Hooks::post_upgrade].

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration.

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn member_online(id: &AccountId, _network: NetworkId)

Updates shard state when a member comes online.

Flow

1. Retrieves the shard_id associated with the member id.
2. Retrieves the current old_status of the shard.
3. Increments the count of online members ShardMembersOnline.
4. Updates ShardState to Offline if the previous status was Created or Committed.

fn is_shard_online(shard_id: ShardId) -> bool

Checks if a specified shard is currently online.

Flow

1. Retrieves the ShardState for the given shard_id.
2. Returns true if the shard status is [Some(ShardStatus::Online)], indicating the shard is online; otherwise, returns false.

fn is_shard_member(member: &AccountId) -> bool

Checks if a specified account is a member of any shard.

Flow

1. Retrieves the shard ID associated with the member account from MemberShard.
2. Returns true if the shard ID is present (Some), indicating the account is a member; otherwise, returns false.

fn shard_network(shard_id: ShardId) -> Option<NetworkId>

Retrieves the network identifier associated with a specified shard.

Flow

1. Retrieves and returns the network ID stored in ShardNetwork for the given shard_id.

fn shard_members(shard_id: ShardId) -> Vec<AccountId>

Retrieves the list of account identifiers that are members of a specified shard.

Flow

1. Iterates over ShardMembers entries with the prefix shard_id.
2. Collects and returns the list of account identifiers (AccountId) associated with the shard.

fn create_shard( network: NetworkId, members: Vec<AccountId>, threshold: u16, ) -> Result<ShardId, DispatchError>

Creates a new shard with specified network, members, and threshold, initializing its state and storing relevant data.

Flow

1. Generates a new shard_id using ShardIdCounter.
2. Stores the network ID in ShardNetwork for the shard_id.
3. Initializes the ShardState to ShardStatus::Created.
4. Sets the creation time in DkgTimeout.
5. Stores the threshold in ShardThreshold.
6. Inserts each member into ShardMembers and associates them with MemberStatus::Added.
7. Registers each member in MemberShard with the shard_id.
8. Emits a Event::ShardCreated event with the shard_id and network.

fn tss_public_key(shard_id: ShardId) -> Option<TssPublicKey>

Retrieves the TSS public key associated with the specified shard, if available.

Flow

1. Retrieves the commitment Vec<TssPublicKey> associated with the shard_id from ShardCommitment.
2. Returns the first element of the commitment TssPublicKey if it exists; otherwise, returns None.

fn members_offline(members: Vec<AccountId>)

fn num_sessions(shard_id: ShardId) -> Option<u16>

fn force_shard_offline(shard_id: ShardId)

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

fn storage_info() -> Vec<StorageInfo>

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

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

impl<T: Config> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect, ) -> Result<(), TryRuntimeError>

Execute the state checks.

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

fn prefix() -> [u8; 16]

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>