Struct pallet_referenda::pallet::Pallet

pub struct Pallet<T, I = ()>(_);

The pallet implementing the on-chain logic.

Implementations

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

pub fn submit( origin: OriginFor<T>, proposal_origin: Box<PalletsOriginOf<T>>, proposal: BoundedCallOf<T, I>, enactment_moment: DispatchTime<T::BlockNumber> ) -> 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.

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

type RuntimeCall = Call<T, I>

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config<I>, I: 'static> Hooks<<T as Config>::BlockNumber> for Pallet<T, I>

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_initialize(_n: BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

fn integrity_test()

Run integrity test.

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

fn integrity_test()

Run integrity test.

impl<T: Config<I>, I: 'static> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T, I>

fn offchain_worker(n: <T as Config>::BlockNumber)

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

impl<T: Config<I>, I: 'static> OnFinalize<<T as Config>::BlockNumber> for Pallet<T, I>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config<I>, I: 'static> OnIdle<<T as Config>::BlockNumber> for Pallet<T, I>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config<I>, I: 'static> OnInitialize<<T as Config>::BlockNumber> for Pallet<T, I>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

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

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

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

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

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

type Index = u32

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

type Moment = <T as Config>::BlockNumber

type Class = <<T as Config<I>>::Tracks as TracksInfo<<<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance, <T as Config>::BlockNumber>>::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, T::BlockNumber, TrackIdOf<T, I>>) -> R ) -> R

fn try_access_poll<R>( index: Self::Index, f: impl FnOnce(PollStatus<&mut T::Tally, T::BlockNumber, 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.

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

fn storage_info() -> Vec<StorageInfo>

impl<T: Config<I>, 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>