Struct PipsQueryApi 

pub struct PipsQueryApi<'api> { /* private fields */ }

Implementations

impl<'api> PipsQueryApi<'api>

pub async fn prune_historical_pips(&self) -> Result<bool>

Set to true if historical PIPs data must be removed.

pub async fn minimum_proposal_deposit(&self) -> Result<u128>

The minimum amount to be used as a deposit for community PIP creation.

pub async fn default_enactment_period(&self) -> Result<u32>

Default enactment period that will be use after a proposal is accepted by GC.

pub async fn pending_pip_expiry(&self) -> Result<MaybeBlock<u32>>

Number of blocks it will take, after a Pending PIP expires, assuming it has not transitioned to another ProposalState.

pub async fn max_pip_skip_count(&self) -> Result<u8>

Maximum times a PIP can be skipped before triggering CannotSkipPip in enact_snapshot_results.

pub async fn active_pip_limit(&self) -> Result<u32>

The maximum allowed number for active PIPs. Once reached, new PIPs cannot be proposed by community members.

pub async fn pip_id_sequence(&self) -> Result<PipId>

Proposal’s identifier.

pub async fn snapshot_id_sequence(&self) -> Result<SnapshotId>

Snaphot’s identifier.

pub async fn active_pip_count(&self) -> Result<u32>

Total count of pending or scheduled PIPs.

pub async fn proposal_metadata( &self, key_0: PipId, ) -> Result<Option<PipsMetadata<u32>>>

The [PipsMetadata] for each proposal ([PipId]).

pub async fn deposits( &self, key_0: PipId, key_1: AccountId, ) -> Result<Option<DepositInfo<AccountId>>>

All locked [DepositInfo] per [PipId] for each account.

pub async fn proposals( &self, key_0: PipId, ) -> Result<Option<Pip<RuntimeCall, AccountId>>>

The [Pip] for each proposal ([PipId]).

pub async fn proposal_result(&self, key_0: PipId) -> Result<VotingResult>

The [VotingResult] for each proposal ([PipId]).

pub async fn proposal_votes( &self, key_0: PipId, key_1: AccountId, ) -> Result<Option<Vote>>

The Votes ([Vote]) for each proposal ([PipId]) per account.

pub async fn pip_to_schedule(&self, key_0: PipId) -> Result<Option<u32>>

Maps PIPs to the block at which they will be executed.

pub async fn live_queue(&self) -> Result<Vec<SnapshottedPip>>

A live priority queue (lowest priority at index 0) of pending PIPs up to the active limit. Priority is defined by the weight in the SnapshottedPip.

Unlike SnapshotQueue, this queue is live, getting updated with each vote cast. The snapshot is therefore essentially a point-in-time clone of this queue.

pub async fn snapshot_queue(&self) -> Result<Vec<SnapshottedPip>>

The priority queue (lowest priority at index 0) of PIPs at the point of snapshotting. Priority is defined by the weight in the SnapshottedPip.

A queued PIP can be skipped. Doing so bumps the pip_skip_count. Once a (configurable) threshhold is exceeded, a PIP cannot be skipped again.

pub async fn snapshot_meta( &self, ) -> Result<Option<SnapshotMetadata<u32, AccountId>>>

The [SnapshotMetadata].

pub async fn pip_skip_count(&self, key_0: PipId) -> Result<u8>

The number of times a certain PIP has been skipped. Once a (configurable) threshhold is exceeded, a PIP cannot be skipped again.

pub async fn committee_pips(&self) -> Result<Vec<PipId>>

All existing PIPs where the proposer is a committee. This list is a cache of all ids in Proposals with Proposer::Committee(_).

pub async fn proposal_states( &self, key_0: PipId, ) -> Result<Option<ProposalState>>

The ([ProposalState]) of a given PIP ([PipId]).

pub async fn pending_refunds(&self, key_0: PipId) -> Result<Option<bool>>

All PIPs that still require refunds.

pub async fn votes_to_be_pruned(&self, key_0: PipId) -> Result<Option<bool>>

All PIPs that still require votes to be pruned.

pub async fn storage_version(&self) -> Result<Version>

Storage version.

Trait Implementations

impl<'api> Clone for PipsQueryApi<'api>

fn clone(&self) -> PipsQueryApi<'api>

Returns a duplicate of the value.

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

Performs copy-assignment from source.