pub struct QueryApi<'api> { /* private fields */ }Implementations
sourceimpl<'api> QueryApi<'api>
impl<'api> QueryApi<'api>
sourcepub async fn prune_historical_pips(&self) -> Result<bool>
pub async fn prune_historical_pips(&self) -> Result<bool>
Determines whether historical PIP data is persisted or removed
sourcepub async fn minimum_proposal_deposit(&self) -> Result<u128>
pub async fn minimum_proposal_deposit(&self) -> Result<u128>
The minimum amount to be used as a deposit for community PIP creation.
sourcepub async fn default_enactment_period(&self) -> Result<u32>
pub async fn default_enactment_period(&self) -> Result<u32>
Default enactment period that will be use after a proposal is accepted by GC.
sourcepub async fn pending_pip_expiry(&self) -> Result<MaybeBlock<u32>>
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?
sourcepub async fn max_pip_skip_count(&self) -> Result<u8>
pub async fn max_pip_skip_count(&self) -> Result<u8>
Maximum times a PIP can be skipped before triggering CannotSkipPip in enact_snapshot_results.
sourcepub async fn active_pip_limit(&self) -> Result<u32>
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.
sourcepub async fn pip_id_sequence(&self) -> Result<PipId>
pub async fn pip_id_sequence(&self) -> Result<PipId>
Proposals so far. id can be used to keep track of PIPs off-chain.
sourcepub async fn snapshot_id_sequence(&self) -> Result<SnapshotId>
pub async fn snapshot_id_sequence(&self) -> Result<SnapshotId>
Snapshots so far. id can be used to keep track of snapshots off-chain.
sourcepub async fn active_pip_count(&self) -> Result<u32>
pub async fn active_pip_count(&self) -> Result<u32>
Total count of current pending or scheduled PIPs.
sourcepub async fn proposal_metadata(
&self,
key_0: PipId
) -> Result<Option<PipsMetadata<u32>>>
pub async fn proposal_metadata(
&self,
key_0: PipId
) -> Result<Option<PipsMetadata<u32>>>
The metadata of the active proposals.
sourcepub async fn deposits(
&self,
key_0: PipId,
key_1: AccountId
) -> Result<DepositInfo<AccountId>>
pub async fn deposits(
&self,
key_0: PipId,
key_1: AccountId
) -> Result<DepositInfo<AccountId>>
Those who have locked a deposit. proposal (id, proposer) -> deposit
sourcepub async fn proposals(
&self,
key_0: PipId
) -> Result<Option<Pip<Call, AccountId>>>
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
sourcepub async fn proposal_result(&self, key_0: PipId) -> Result<VotingResult>
pub async fn proposal_result(&self, key_0: PipId) -> Result<VotingResult>
PolymeshVotes on a given proposal, if it is ongoing. proposal id -> vote count
sourcepub async fn proposal_votes(
&self,
key_0: PipId,
key_1: AccountId
) -> Result<Option<Vote>>
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
sourcepub async fn pip_to_schedule(&self, key_0: PipId) -> Result<Option<u32>>
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.
sourcepub async fn live_queue(&self) -> Result<Vec<SnapshottedPip>>
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.
sourcepub async fn snapshot_queue(&self) -> Result<Vec<SnapshottedPip>>
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.
sourcepub async fn snapshot_meta(
&self
) -> Result<Option<SnapshotMetadata<u32, AccountId>>>
pub async fn snapshot_meta(
&self
) -> Result<Option<SnapshotMetadata<u32, AccountId>>>
The metadata of the snapshot, if there is one.
sourcepub async fn pip_skip_count(&self, key_0: PipId) -> Result<u8>
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.
sourcepub async fn committee_pips(&self) -> Result<Vec<PipId>>
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(_).
sourcepub async fn proposal_states(
&self,
key_0: PipId
) -> Result<Option<ProposalState>>
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
Auto Trait Implementations
impl<'api> !RefUnwindSafe for QueryApi<'api>
impl<'api> Send for QueryApi<'api>
impl<'api> Sync for QueryApi<'api>
impl<'api> Unpin for QueryApi<'api>
impl<'api> !UnwindSafe for QueryApi<'api>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<T> CheckedConversion for T
impl<T> CheckedConversion for T
fn checked_from<T>(t: T) -> Option<Self>where
Self: TryFrom<T>,
fn checked_from<T>(t: T) -> Option<Self>where
Self: TryFrom<T>,
fn checked_into<T>(self) -> Option<T>where
Self: TryInto<T>,
fn checked_into<T>(self) -> Option<T>where
Self: TryInto<T>,
impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<W, Global>impl<W> Write for Box<W, Global>where
W: Write + ?Sized,impl<R> Read for Box<R, Global>where
R: Read + ?Sized,impl<I, A> Iterator for Box<I, A>where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;impl<F, A> Future for Box<F, A>where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<W, Global>impl<W> Write for Box<W, Global>where
W: Write + ?Sized,impl<R> Read for Box<R, Global>where
R: Read + ?Sized,impl<I, A> Iterator for Box<I, A>where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;impl<F, A> Future for Box<F, A>where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;
W: Write + ?Sized,impl<R> Read for Box<R, Global>where
R: Read + ?Sized,impl<I, A> Iterator for Box<I, A>where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;impl<F, A> Future for Box<F, A>where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read morefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read morefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s. Read morefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s. Read moresourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
sourcefn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
sourcefn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
T. Read moreimpl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
unchecked_from.sourceimpl<T, S> UniqueSaturatedInto<T> for Swhere
T: Bounded,
S: TryInto<T>,
impl<T, S> UniqueSaturatedInto<T> for Swhere
T: Bounded,
S: TryInto<T>,
sourcefn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
T.