Struct polymesh_api::polymesh::api::pips::QueryApi

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

Implementations

impl<'api> QueryApi<'api>

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

Determines whether historical PIP data is persisted or 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>>

How many blocks will it 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 ActivePipCount. Once reached, new PIPs cannot be proposed by community members.

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

Proposals so far. id can be used to keep track of PIPs off-chain.

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

Snapshots so far. id can be used to keep track of snapshots off-chain.

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

Total count of current pending or scheduled PIPs.

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

The metadata of the active proposals.

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

Those who have locked a deposit. proposal (id, proposer) -> deposit

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

Actual proposal for a given id, if it’s current. proposal id -> proposal

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

PolymeshVotes on a given proposal, if it is ongoing. proposal id -> vote count

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

Votes per Proposal and account. Used to avoid double vote issue. (proposal id, account) -> Vote

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

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

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 metadata of the snapshot, if there is one.

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

Proposal state for a given id. proposal id -> proposalState

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

Trait Implementations

impl<'api> Clone for QueryApi<'api>

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

Returns a copy of the value.

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

Performs copy-assignment from source.