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 grant_emission_permission( origin: OriginFor<T>, grantee: T::AccountId, allocation: EmissionAllocation<T>, targets: BoundedBTreeMap<T::AccountId, u16, T::MaxTargetsPerPermission>, distribution: DistributionControl<T>, duration: PermissionDuration<T>, revocation: RevocationTerms<T>, enforcement: EnforcementAuthority<T>, ) -> DispatchResult

Grant a permission for emission delegation

pub fn revoke_permission( origin: OriginFor<T>, permission_id: PermissionId, ) -> DispatchResult

Revoke a permission. The caller must met revocation constraints or be a root key.

pub fn execute_permission( origin: OriginFor<T>, permission_id: PermissionId, ) -> DispatchResult

Execute a manual distribution based on permission

pub fn toggle_permission_accumulation( origin: OriginFor<T>, permission_id: PermissionId, accumulating: bool, ) -> DispatchResult

Toggle a permission’s accumulation state (enabled/disabled) The caller must be authorized as a controller or be the root key

pub fn enforcement_execute_permission( origin: OriginFor<T>, permission_id: PermissionId, ) -> DispatchResult

Execute a permission through enforcement authority The caller must be authorized as a controller or be the root key

pub fn set_enforcement_authority( origin: OriginFor<T>, permission_id: PermissionId, enforcement: EnforcementAuthority<T>, ) -> DispatchResult

Set enforcement authority for a permission Only the grantor or root can set enforcement authority

pub fn grant_curator_permission( origin: OriginFor<T>, grantee: T::AccountId, flags: u32, cooldown: Option<BlockNumberFor<T>>, duration: PermissionDuration<T>, revocation: RevocationTerms<T>, ) -> DispatchResult

Grant a permission for curator delegation

pub fn grant_namespace_permission( origin: OriginFor<T>, grantee: T::AccountId, paths: BoundedBTreeSet<NamespacePathInner, T::MaxNamespacesPerPermission>, duration: PermissionDuration<T>, revocation: RevocationTerms<T>, ) -> DispatchResult

Grant a permission over namespaces

pub fn update_emission_permission( origin: OriginFor<T>, permission_id: PermissionId, new_targets: BoundedBTreeMap<T::AccountId, u16, T::MaxTargetsPerPermission>, new_streams: Option<BoundedBTreeMap<StreamId, Percent, T::MaxStreamsPerPermission>>, new_distribution_control: Option<DistributionControl<T>>, ) -> DispatchResult

Allows Grantor/Grantee to edit stream emission permission

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> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(current_block: BlockNumberFor<T>)

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

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning 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> Permission0Api<<T as Config>::RuntimeOrigin> for Pallet<T>

Implementation of the Permission0Api trait to be used externally

fn permission_exists(id: &PermissionId) -> bool

Check if a permission exists

fn revoke_permission( who: OriginFor<T>, permission_id: &PermissionId, ) -> DispatchResult

Revoke a permission

fn execute_permission( who: OriginFor<T>, permission_id: &PermissionId, ) -> DispatchResult

Execute a manual distribution for a permission

impl<T: Config> Permission0CuratorApi<<T as Config>::AccountId, <T as Config>::RuntimeOrigin, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn grant_curator_permission( grantor: OriginFor<T>, grantee: T::AccountId, flags: ApiCuratorPermissions, cooldown: Option<BlockNumberFor<T>>, duration: ApiPermissionDuration<BlockNumberFor<T>>, revocation: ApiRevocationTerms<T::AccountId, BlockNumberFor<T>>, ) -> Result<PermissionId, DispatchError>

Grants a curator permission, bounded by the given flags. Only available for the root key, currently.

fn ensure_curator_permission( grantee: OriginFor<T>, flags: ApiCuratorPermissions, ) -> Result<T::AccountId, DispatchError>

Verifies the grantee’s curator permission and returns the registered cooldown between actions.

fn get_curator_permission(grantee: &T::AccountId) -> Option<PermissionId>

Finds the curator permission granted to [grantee].

impl<T: Config> Permission0EmissionApi<<T as Config>::AccountId, <T as Config>::RuntimeOrigin, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::NegativeImbalance> for Pallet<T>

fn grant_emission_permission( grantor: T::AccountId, grantee: T::AccountId, allocation: ApiEmissionAllocation<BalanceOf<T>>, targets: Vec<(T::AccountId, u16)>, distribution: ApiDistributionControl<BalanceOf<T>, BlockNumberFor<T>>, duration: ApiPermissionDuration<BlockNumberFor<T>>, revocation: ApiRevocationTerms<T::AccountId, BlockNumberFor<T>>, enforcement: ApiEnforcementAuthority<T::AccountId>, ) -> Result<PermissionId, DispatchError>

Grant a permission for emission delegation

fn accumulate_emissions( agent: &T::AccountId, stream: &StreamId, amount: &mut NegativeImbalanceOf<T>, )

Accumulate emissions for an agent with permissions

fn process_auto_distributions(current_block: BlockNumberFor<T>)

Check and process automatic distributions

fn get_accumulated_amount( permission_id: &PermissionId, stream: &StreamId, ) -> BalanceOf<T>

Get the accumulated amount for a permission

impl<T: Config> Permission0NamespacesApi<<T as Config>::AccountId, NamespacePath> for Pallet<T>

fn is_delegating_namespace(grantor: &T::AccountId, path: &NamespacePath) -> bool

Wether the given grantor is delegating a permission over the namespace.

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>