Struct pallet_node_authorization::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn add_well_known_node(
    origin: OriginFor<T>,
    node: PeerId,
    owner: T::AccountId
) -> 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::AccountId
) -> 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: additonal 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: additonal nodes from which the connections are not allowed anymore.

impl<T: Config> Pallet<T>

pub fn well_known_nodes() -> BTreeSet<PeerId>

The set of well known nodes. This is stored sorted (just by value).

impl<T: Config> Pallet<T>

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

A map that maintains the ownership of each node.

impl<T: Config> Pallet<T>

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

The additional adapative connections of each node.

Trait Implementations

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

type Call = 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>

fn current_storage_version() -> StorageVersion

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

fn offchain_worker(now: T::BlockNumber)

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

fn on_finalize(_n: BlockNumber)

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

fn on_idle(_n: BlockNumber, _remaining_weight: u64) -> u64

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_initialize(_n: BlockNumber) -> u64

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

fn on_runtime_upgrade() -> u64

Perform a module upgrade.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

fn integrity_test()

Run integrity test.

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

fn integrity_test()

Run integrity test.

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

fn metadata() -> &'static [ErrorMetadata]

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

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

fn on_idle(n: <T as Config>::BlockNumber, 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>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> 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.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a 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.

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 !=.

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

fn storage_info() -> Vec<StorageInfo>

impl<T> Eq for Pallet<T>