Type Alias moonbeam_runtime::Referenda

pub type Referenda = Pallet<Runtime>;

Aliased Type

struct Referenda(/* private fields */);

Implementations

impl<T, I> Pallet<T, I>

where T: Config<I>, I: 'static,

pub fn submit( origin: <T as Config>::RuntimeOrigin, proposal_origin: Box<<<T as Config>::RuntimeOrigin as OriginTrait>::PalletsOrigin>, proposal: Bounded<<T as Config<I>>::RuntimeCall, <T as Config>::Hashing>, enactment_moment: DispatchTime<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> ) -> Result<(), DispatchError>

Propose a referendum on a privileged action.

• origin: must be SubmitOrigin and the account must have SubmissionDeposit funds available.
• proposal_origin: The origin from which the proposal should be executed.
• proposal: The proposal.
• enactment_moment: The moment that the proposal should be enacted.

Emits Submitted.

pub fn place_decision_deposit( origin: <T as Config>::RuntimeOrigin, index: u32 ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Post the Decision Deposit for a referendum.

• origin: must be Signed and the account must have funds available for the referendum’s track’s Decision Deposit.
• index: The index of the submitted referendum whose Decision Deposit is yet to be posted.

Emits DecisionDepositPlaced.

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

Refund the Decision Deposit for a closed referendum back to the depositor.

• origin: must be Signed or Root.
• index: The index of a closed referendum whose Decision Deposit has not yet been refunded.

Emits DecisionDepositRefunded.

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

Cancel an ongoing referendum.

• origin: must be the CancelOrigin.
• index: The index of the referendum to be cancelled.

Emits Cancelled.

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

Cancel an ongoing referendum and slash the deposits.

• origin: must be the KillOrigin.
• index: The index of the referendum to be cancelled.

Emits Killed and DepositSlashed.

pub fn nudge_referendum( origin: <T as Config>::RuntimeOrigin, index: u32 ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Advance a referendum onto its next logical state. Only used internally.

• origin: must be Root.
• index: the referendum to be advanced.

pub fn one_fewer_deciding( origin: <T as Config>::RuntimeOrigin, track: <<T as Config<I>>::Tracks as TracksInfo<<<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>>::Id ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Advance a track onto its next logical state. Only used internally.

• origin: must be Root.
• track: the track to be advanced.

Action item for when there is now one fewer referendum in the deciding phase and the DecidingCount is not yet updated. This means that we should either:

• begin deciding another referendum (and leave DecidingCount alone); or
• decrement DecidingCount.

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

Refund the Submission Deposit for a closed referendum back to the depositor.

• origin: must be Signed or Root.
• index: The index of a closed referendum whose Submission Deposit has not yet been refunded.

Emits SubmissionDepositRefunded.

pub fn set_metadata( origin: <T as Config>::RuntimeOrigin, index: u32, maybe_hash: Option<<T as Config>::Hash> ) -> Result<(), DispatchError>

Set or clear metadata of a referendum.

Parameters:

• origin: Must be Signed by a creator of a referendum or by anyone to clear a metadata of a finished referendum.
• index: The index of a referendum to set or clear metadata for.
• maybe_hash: The hash of an on-chain stored preimage. None to clear a metadata.

impl<T, I> Pallet<T, I>

where T: Config<I>, I: 'static,

pub fn ensure_ongoing( index: u32 ) -> Result<ReferendumStatus<<<T as Config<I>>::Tracks as TracksInfo<<<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>>::Id, <<T as Config>::RuntimeOrigin as OriginTrait>::PalletsOrigin, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, Bounded<<T as Config<I>>::RuntimeCall, <T as Config>::Hashing>, <<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance, <T as Config<I>>::Tally, <T as Config>::AccountId, <<T as Config<I>>::Scheduler as Anon<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, <T as Config<I>>::RuntimeCall, <<T as Config>::RuntimeOrigin as OriginTrait>::PalletsOrigin>>::Address>, DispatchError>

Check that referendum index is in the Ongoing state and return the ReferendumStatus value, or Err otherwise.

pub fn is_referendum_passing(ref_index: u32) -> Result<bool, DispatchError>

Returns whether the referendum is passing. Referendum must be ongoing and its track must exist.

Trait Implementations

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

where T: Config<I>, I: 'static,

fn integrity_test()

Check the integrity of this pallet’s configuration.

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

impl<T, I> IntegrityTest for Pallet<T, I>

where T: Config<I>, I: 'static,

fn integrity_test()

See [Hooks::integrity_test].

impl<T, I> BeforeAllRuntimeMigrations for Pallet<T, I>

where T: Config<I>, I: 'static,

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

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

where T: Config<I>, I: 'static,

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

See [Hooks::on_idle].

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

where T: Config<I>, I: 'static,

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

impl<T, I> Debug for Pallet<T, I>

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

Formats the value using the given formatter.

impl<T, I> OnGenesis for Pallet<T, I>

where T: Config<I>, I: 'static,

fn on_genesis()

Something that should happen at genesis.

impl<T, I> Polling<<T as Config<I>>::Tally> for Pallet<T, I>

where T: Config<I>, I: 'static,

type Index = u32

type Votes = <T as Config<I>>::Votes

type Moment = <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number

type Class = <<T as Config<I>>::Tracks as TracksInfo<<<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>>::Id

fn classes() -> Vec<<Pallet<T, I> as Polling<<T as Config<I>>::Tally>>::Class>

Provides a vec of values that T may take.

fn access_poll<R>( index: <Pallet<T, I> as Polling<<T as Config<I>>::Tally>>::Index, f: impl FnOnce(PollStatus<&mut <T as Config<I>>::Tally, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, <<T as Config<I>>::Tracks as TracksInfo<<<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>>::Id>) -> R ) -> R

fn try_access_poll<R>( index: <Pallet<T, I> as Polling<<T as Config<I>>::Tally>>::Index, f: impl FnOnce(PollStatus<&mut <T as Config<I>>::Tally, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, <<T as Config<I>>::Tracks as TracksInfo<<<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>>::Id>) -> Result<R, DispatchError> ) -> Result<R, DispatchError>

fn as_ongoing( index: <Pallet<T, I> as Polling<<T as Config<I>>::Tally>>::Index ) -> Option<(<T as Config<I>>::Tally, <<T as Config<I>>::Tracks as TracksInfo<<<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance, <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>>::Id)>

Some if the referendum index can be voted on, along with the tally and class of referendum.

impl<T, I> StorageInfoTrait for Pallet<T, I>

where T: Config<I>, I: 'static,

fn storage_info() -> Vec<StorageInfo>

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

where T: Config<I>, I: 'static,

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

See [Hooks::on_initialize].

impl<T, I> PalletsInfoAccess for Pallet<T, I>

where T: Config<I>, I: 'static,

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, I> OnRuntimeUpgrade for Pallet<T, I>

where T: Config<I>, I: 'static,

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

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

where T: Config<I>, I: 'static,

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

See [Hooks::on_finalize].

impl<T, I> Callable<T> for Pallet<T, I>

where T: Config<I>, I: 'static,

type RuntimeCall = Call<T, I>

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

where T: Config<I>, I: 'static,

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.

impl<T, I> WhitelistedStorageKeys for Pallet<T, I>

where T: Config<I>, I: 'static,

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, I> GetStorageVersion for Pallet<T, I>

where T: Config<I>, I: 'static,

type InCodeStorageVersion = StorageVersion

This type is generated by the pallet macro.

fn in_code_storage_version( ) -> <Pallet<T, I> 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.

impl<T, I> PartialEq for Pallet<T, I>

fn eq(&self, other: &Pallet<T, I>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, I> Eq for Pallet<T, I>

impl<T, I> PalletInfoAccess for Pallet<T, I>

where T: Config<I>, I: 'static,

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, I> Clone for Pallet<T, I>

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

Returns a copy of the value.

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

Performs copy-assignment from source.