Struct Pallet 

pub struct Pallet<T>(/* private fields */);

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

Implementations

impl<T: Config> Pallet<T>

pub fn add_well_known_node( origin: OriginFor<T>, node: PeerId, owner: <<T as Config>::Lookup as StaticLookup>::Source, ) -> DispatchResult

Add a node to the set of well known nodes. If the node is already claimed, the owner will be updated and keep the existing additional connection unchanged.

May only be called from T::AddOrigin.

• node: identifier of the node.

pub fn remove_well_known_node( origin: OriginFor<T>, node: PeerId, ) -> DispatchResult

Remove a node from the set of well known nodes. The ownership and additional connections of the node will also be removed.

May only be called from T::RemoveOrigin.

• node: identifier of the node.

pub fn swap_well_known_node( origin: OriginFor<T>, remove: PeerId, add: PeerId, ) -> DispatchResult

Swap a well known node to another. Both the ownership and additional connections stay untouched.

May only be called from T::SwapOrigin.

• remove: the node which will be moved out from the list.
• add: the node which will be put in the list.

pub fn reset_well_known_nodes( origin: OriginFor<T>, nodes: Vec<(PeerId, T::AccountId)>, ) -> DispatchResult

Reset all the well known nodes. This will not remove the ownership and additional connections for the removed nodes. The node owner can perform further cleaning if they decide to leave the network.

May only be called from T::ResetOrigin.

• nodes: the new nodes for the allow list.

pub fn claim_node(origin: OriginFor<T>, node: PeerId) -> DispatchResult

A given node can be claimed by anyone. The owner should be the first to know its PeerId, so claim it right away!

• node: identifier of the node.

pub fn remove_claim(origin: OriginFor<T>, node: PeerId) -> DispatchResult

A claim can be removed by its owner and get back the reservation. The additional connections are also removed. You can’t remove a claim on well known nodes, as it needs to reach consensus among the network participants.

• node: identifier of the node.

pub fn transfer_node( origin: OriginFor<T>, node: PeerId, owner: <<T as Config>::Lookup as StaticLookup>::Source, ) -> DispatchResult

A node can be transferred to a new owner.

• node: identifier of the node.
• owner: new owner of the node.

pub fn add_connections( origin: OriginFor<T>, node: PeerId, connections: Vec<PeerId>, ) -> DispatchResult

Add additional connections to a given node.

• node: identifier of the node.
• connections: additional nodes from which the connections are allowed.

pub fn remove_connections( origin: OriginFor<T>, node: PeerId, connections: Vec<PeerId>, ) -> DispatchResult

Remove additional connections of a given node.

• node: identifier of the node.
• connections: additional nodes from which the connections are not allowed anymore.

impl<T: Config> Pallet<T>

pub fn well_known_nodes() -> BTreeSet<PeerId>

An auto-generated getter for WellKnownNodes.

impl<T: Config> Pallet<T>

pub fn owners<KArg>(k: KArg) -> Option<T::AccountId>

where KArg: EncodeLike<PeerId>,

An auto-generated getter for Owners.

impl<T: Config> Pallet<T>

pub fn additional_connection<KArg>(k: KArg) -> BTreeSet<PeerId>

where KArg: EncodeLike<PeerId>,

An auto-generated getter for AdditionalConnections.

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

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a duplicate 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 offchain_worker(now: BlockNumberFor<T>)

Set reserved node every block. It may not be enabled depends on the offchain worker settings when starting the node.

fn on_initialize(_n: BlockNumber) -> 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 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.

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

fn storage_info() -> Vec<StorageInfo>

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>