pub type AuthorMapping = Pallet<Runtime>;

Aliased Type§

struct AuthorMapping(/* private fields */);

Implementations

§

impl<T> Pallet<T>
where T: Config,

pub fn add_association( origin: <T as Config>::RuntimeOrigin, nimbus_id: Public ) -> Result<(), DispatchError>

Register your NimbusId onchain so blocks you author are associated with your account.

Users who have been (or will soon be) elected active collators in staking, should submit this extrinsic to have their blocks accepted and earn rewards.

pub fn update_association( origin: <T as Config>::RuntimeOrigin, old_nimbus_id: Public, new_nimbus_id: Public ) -> Result<(), DispatchError>

Change your Mapping.

This is useful for normal key rotation or for when switching from one physical collator machine to another. No new security deposit is required. This sets keys to new_nimbus_id.into() by default.

pub fn clear_association( origin: <T as Config>::RuntimeOrigin, nimbus_id: Public ) -> Result<(), DispatchError>

Clear your Mapping.

This is useful when you are no longer an author and would like to re-claim your security deposit.

pub fn remove_keys( origin: <T as Config>::RuntimeOrigin ) -> Result<(), DispatchError>

Remove your Mapping.

This is useful when you are no longer an author and would like to re-claim your security deposit.

pub fn set_keys( origin: <T as Config>::RuntimeOrigin, keys: Vec<u8> ) -> Result<(), DispatchError>

Set association and session keys at once.

This is useful for key rotation to update Nimbus and VRF keys in one call. No new security deposit is required. Will replace update_association which is kept now for backwards compatibility reasons.

§

impl<T> Pallet<T>
where T: Config,

pub fn enact_registration( nimbus_id: &Public, account_id: &<T as Config>::AccountId, keys: <T as Config>::Keys ) -> Result<(), DispatchError>

§

impl<T> Pallet<T>
where T: Config,

pub fn account_id_of(nimbus_id: &Public) -> Option<<T as Config>::AccountId>

A helper function to lookup the account id associated with the given author id. This is the primary lookup that this pallet is responsible for.

pub fn keys_of(nimbus_id: &Public) -> Option<<T as Config>::Keys>

A helper function to lookup the keys associated with the given author id.

pub fn nimbus_id_of(account_id: &<T as Config>::AccountId) -> Option<Public>

A helper function to lookup NimbusId associated with a given AccountId

§

impl<T> Pallet<T>
where T: Config,

pub fn account_and_deposit_of<KArg>(k: KArg) -> Option<RegistrationInfo<T>>
where KArg: EncodeLike<Public>,

An auto-generated getter for [MappingWithDeposit].

§

impl<T> Pallet<T>
where T: Config,

pub fn nimbus_lookup<KArg>(k: KArg) -> Option<Public>
where KArg: EncodeLike<<T as Config>::AccountId>,

An auto-generated getter for [NimbusLookup].

Trait Implementations

§

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

§

fn integrity_test()

See [Hooks::integrity_test].
§

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

§

fn storage_info() -> Vec<StorageInfo>

§

impl<T> PalletInfoAccess for Pallet<T>
where T: Config,

§

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

§

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
§

impl<T> WhitelistedStorageKeys for Pallet<T>
where T: Config,

§

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> GetStorageVersion for Pallet<T>
where T: Config,

§

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro. Read more
§

fn in_code_storage_version( ) -> <Pallet<T> as GetStorageVersion>::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. Read more
§

impl<T> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
where T: Config,

§

fn offchain_worker( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number )

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

impl<T> OnRuntimeUpgrade for Pallet<T>
where T: Config,

§

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].
§

impl<T> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
where T: Config,

§

fn on_idle( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, remaining_weight: Weight ) -> Weight

See [Hooks::on_idle].
§

impl<T> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
where T: Config,

§

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution. Read more
§

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution. Read more
§

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]). Read more
§

fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application. Read more
§

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by the FRAME Executive pallet. Read more
§

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. Read more
§

fn integrity_test()

Check the integrity of this pallet’s configuration. Read more
§

impl<T> PalletsInfoAccess for Pallet<T>
where T: Config,

§

fn count() -> usize

The number of pallets’ information that this type represents. Read more
§

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.
§

impl<T> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
where T: Config,

§

fn on_initialize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number ) -> Weight

See [Hooks::on_initialize].
§

impl<T> KeysLookup<Public, <T as Config>::Keys> for Pallet<T>
where T: Config,

§

fn lookup_keys(author: &Public) -> Option<<T as Config>::Keys>

§

impl<T> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
where T: Config,

§

fn on_finalize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number )

See [Hooks::on_finalize].
§

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

§

type RuntimeCall = Call<T>

§

impl<T> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
where T: Config,

§

fn on_poll( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, weight: &mut WeightMeter )

Code to execute every now and then at the beginning of the block after inherent application. Read more
§

impl<T> OnGenesis for Pallet<T>
where T: Config,

§

fn on_genesis()

Something that should happen at genesis.
§

impl<T> PartialEq for Pallet<T>

§

fn eq(&self, other: &Pallet<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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> AccountLookup<<T as Config>::AccountId> for Pallet<T>
where T: Config,

§

fn lookup_account(author: &Public) -> Option<<T as Config>::AccountId>

§

impl<T> Eq for Pallet<T>

§

impl<T> Clone for Pallet<T>

§

fn clone(&self) -> Pallet<T>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
§

impl<T> BeforeAllRuntimeMigrations for Pallet<T>
where T: Config,

§

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.