Struct pallet_referenda :: pallet :: Pallet Copy item path

impl<T: Config, I: 'static> Pallet<T, I>

pub fn submit( origin: OriginFor<T>, proposal_origin: Box<PalletsOriginOf<T>>, proposal: BoundedCallOf<T, I>, enactment_moment: DispatchTime<BlockNumberFor<T>>, ) -> DispatchResult

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: OriginFor<T>, index: ReferendumIndex, ) -> DispatchResultWithPostInfo

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: OriginFor<T>, index: ReferendumIndex, ) -> DispatchResult

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: OriginFor<T>, index: ReferendumIndex) -> DispatchResult

Cancel an ongoing referendum.

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

Emits Cancelled.

pub fn kill(origin: OriginFor<T>, index: ReferendumIndex) -> DispatchResult

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: OriginFor<T>, index: ReferendumIndex, ) -> DispatchResultWithPostInfo

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: OriginFor<T>, track: TrackIdOf<T, I>, ) -> DispatchResultWithPostInfo

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: OriginFor<T>, index: ReferendumIndex, ) -> DispatchResult

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: OriginFor<T>, index: ReferendumIndex, maybe_hash: Option<T::Hash>, ) -> DispatchResult

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: Config, I: 'static> Pallet<T, I>

pub fn ensure_ongoing( index: ReferendumIndex, ) -> Result<ReferendumStatusOf<T, I>, 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: ReferendumIndex, ) -> Result<bool, DispatchError>

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

Trait Implementations§

impl<T: Config, I: 'static> BeforeAllRuntimeMigrations for Pallet<T, I>

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T, I: 'static> Benchmarking for Pallet<T, I>
where T: Config + Config,

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”. Read more

fn run_benchmark( extrinsic: &[u8], c: &[(BenchmarkParameter, u32)], whitelist: &[TrackedStorageKey], verify: bool, internal_repeats: u32, ) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

impl<T: Config, I: 'static> Callable<T> for Pallet<T, I>

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

fn clone(&self) -> Self

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

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

Formats the value using the given formatter. Read more

impl<T: Config, I: 'static> GetStorageVersion for Pallet<T, I>

type InCodeStorageVersion = StorageVersion

This type is generated by the pallet macro. Read more

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

fn try_state(_n: BlockNumberFor<T>) -> Result<(), TryRuntimeError>

Execute the sanity checks of this pallet, per block. Read more

fn integrity_test()

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

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 pre_upgrade() -> Result<Vec<u8>, DispatchError>

Execute some pre-checks prior to a runtime upgrade. Read more

fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>

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

impl<T: Config, I: 'static> IntegrityTest for Pallet<T, I>

fn offchain_worker(n: BlockNumberFor<T>)

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

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

impl<T: Config, I: 'static> OnGenesis for Pallet<T, I>

fn on_genesis()

Something that should happen at genesis.

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

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

impl<T: Config, I: 'static> OnRuntimeUpgrade for Pallet<T, I>

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See [Hooks::pre_upgrade].

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See [Hooks::post_upgrade].

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration. Read more

impl<T: Config, I: 'static> PalletInfoAccess for Pallet<T, I>

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 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, I: 'static> PalletsInfoAccess for Pallet<T, I>

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

fn eq(&self, other: &Self) -> 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: Config, I: 'static> Polling<<T as Config>::Tally> for Pallet<T, I>

type Votes = <T as Config>::Votes

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

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

fn classes() -> Vec<Self::Class>

Provides a vec of values that T may take.

fn access_poll<R>( index: Self::Index, f: impl FnOnce(PollStatus<&mut T::Tally, BlockNumberFor<T>, TrackIdOf<T, I>>) -> R, ) -> R

fn try_access_poll<R>( index: Self::Index, f: impl FnOnce(PollStatus<&mut T::Tally, BlockNumberFor<T>, TrackIdOf<T, I>>) -> Result<R, DispatchError>, ) -> Result<R, DispatchError>

fn as_ongoing(index: Self::Index) -> Option<(T::Tally, TrackIdOf<T, I>)>

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

fn create_ongoing(class: Self::Class) -> Result<Self::Index, ()>

Create an ongoing majority-carries poll of given class lasting given period for the purpose of benchmarking. Read more

fn end_ongoing(index: Self::Index, approved: bool) -> Result<(), ()>

End the given ongoing poll and return the result. Read more

fn max_ongoing() -> (Self::Class, u32)

The maximum amount of ongoing polls within any single class. By default it practically unlimited (u32::max_value()).

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect, ) -> Result<(), TryRuntimeError>

Execute the state checks.

impl<T: Config, I: 'static> WhitelistedStorageKeys for Pallet<T, I>

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

Auto Trait Implementations§

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

impl<T, I> RefUnwindSafe for Pallet<T, I>
where T: RefUnwindSafe, I: RefUnwindSafe,

impl<T, I> Send for Pallet<T, I>
where T: Send, I: Send,

impl<T, I> Sync for Pallet<T, I>
where T: Sync, I: Sync,

impl<T, I> Unpin for Pallet<T, I>
where T: Unpin, I: Unpin,

impl<T, I> UnwindSafe for Pallet<T, I>
where T: UnwindSafe, I: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CheckedConversion for T

fn checked_from<T>(t: T) -> Option<Self>
where Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

fn checked_into<T>(self) -> Option<T>
where Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

impl<T> CloneToUninit for T
where T: Clone,

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more