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_allocator( origin: OriginFor<T>, key: <T as Config>::AccountId, ) -> DispatchResult

Adds a new allocator to the list. Only available for the root key.

pub fn remove_allocator( origin: OriginFor<T>, key: <T as Config>::AccountId, ) -> DispatchResult

Removes an existing allocator from the list. Only available for the root key.

pub fn add_to_whitelist( origin: OriginFor<T>, key: <T as Config>::AccountId, ) -> DispatchResult

Forcefully adds a new agent to the whitelist. Only available for the root key or curators.

pub fn remove_from_whitelist( origin: OriginFor<T>, key: <T as Config>::AccountId, ) -> DispatchResult

Forcefully removes an agent from the whitelist. Only available for the root key or curators.

pub fn accept_application( origin: OriginFor<T>, application_id: u32, ) -> DispatchResult

Accepts an agent application. Only available for the root key or curators.

pub fn deny_application( origin: OriginFor<T>, application_id: u32, ) -> DispatchResult

Denies an agent application. Only available for the root key or curators.

pub fn penalize_agent( origin: OriginFor<T>, agent_key: <T as Config>::AccountId, percentage: u8, ) -> DispatchResult

Sets a penalty factor to the given agent emissions. Only available for the root key or curators.

pub fn submit_application( origin: OriginFor<T>, agent_key: <T as Config>::AccountId, metadata: Vec<u8>, removing: bool, ) -> DispatchResult

Submits a new agent application on behalf of a given key.

pub fn add_global_params_proposal( origin: OriginFor<T>, data: GlobalParamsData<T>, metadata: Vec<u8>, ) -> DispatchResult

Creates a new global parameters proposal.

pub fn add_global_custom_proposal( origin: OriginFor<T>, metadata: Vec<u8>, ) -> DispatchResult

Creates a new custom global proposal.

pub fn add_dao_treasury_transfer_proposal( origin: OriginFor<T>, value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, destination_key: <T as Config>::AccountId, data: Vec<u8>, ) -> DispatchResult

Creates a proposal moving funds from the treasury account to the given key.

pub fn vote_proposal( origin: OriginFor<T>, proposal_id: u64, agree: bool, ) -> DispatchResult

Casts a vote for an open proposal.

pub fn remove_vote_proposal( origin: OriginFor<T>, proposal_id: u64, ) -> DispatchResult

Removes a casted vote for an open proposal.

pub fn enable_vote_delegation(origin: OriginFor<T>) -> DispatchResult

Enables vote power delegation.

pub fn disable_vote_delegation(origin: OriginFor<T>) -> DispatchResult

Disables vote power delegation.

pub fn add_emission_proposal( origin: OriginFor<T>, recycling_percentage: Percent, treasury_percentage: Percent, incentives_ratio: Percent, data: Vec<u8>, ) -> DispatchResult

Creates a new emission percentage proposal.

pub fn set_emission_params( origin: OriginFor<T>, recycling_percentage: Percent, treasury_percentage: Percent, ) -> DispatchResult

Forcefully sets emission percentages. Only available for the root key.

pub fn toggle_agent_freezing(origin: OriginFor<T>) -> DispatchResult

pub fn toggle_namespace_freezing(origin: OriginFor<T>) -> DispatchResult

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

type InCodeStorageVersion = StorageVersion

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> GovernanceApi<<T as Config>::AccountId> for Pallet<T>

fn dao_treasury_address() -> T::AccountId

fn treasury_emission_fee() -> Percent

fn is_whitelisted(key: &T::AccountId) -> bool

fn ensure_allocator(key: &T::AccountId) -> DispatchResult

fn get_allocators() -> impl Iterator<Item = T::AccountId>

fn set_allocator(key: &T::AccountId)

fn can_create_namespace(key: &T::AccountId) -> bool

fn can_register_agent(key: &T::AccountId) -> bool

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

fn on_initialize(block_number: 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 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].

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