Struct polymesh_api::polymesh::api::checkpoint::CheckpointQueryApi

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

Implementations

impl<'api> CheckpointQueryApi<'api>

pub async fn total_supply( &self, key_0: Ticker, key_1: CheckpointId ) -> Result<u128>

Total supply of the token at the checkpoint.

(ticker, checkpointId) -> total supply at given checkpoint

pub async fn balance( &self, key_0: (Ticker, CheckpointId), key_1: IdentityId ) -> Result<u128>

Balance of a DID at a checkpoint.

(ticker, did, checkpoint ID) -> Balance of a DID at a checkpoint

pub async fn checkpoint_id_sequence( &self, key_0: Ticker ) -> Result<CheckpointId>

Checkpoints ID generator sequence. ID of first checkpoint is 1 instead of 0.

(ticker) -> no. of checkpoints

pub async fn balance_updates( &self, key_0: Ticker, key_1: IdentityId ) -> Result<Vec<CheckpointId>>

Checkpoints where a DID’s balance was updated. (ticker, did) -> [checkpoint ID where user balance changed]

pub async fn timestamps( &self, key_0: Ticker, key_1: CheckpointId ) -> Result<u64>

Checkpoint timestamps.

Every schedule-originated checkpoint maps its ID to its due time. Every checkpoint manually created maps its ID to the time of recording.

(ticker) -> (checkpoint ID) -> checkpoint timestamp

pub async fn schedules_max_complexity(&self) -> Result<u64>

The maximum complexity allowed for a ticker’s schedules.

pub async fn schedule_id_sequence(&self, key_0: Ticker) -> Result<ScheduleId>

Checkpoint schedule ID sequence for tickers.

(ticker) -> schedule ID

pub async fn cached_next_checkpoints( &self, key_0: Ticker ) -> Result<Option<NextCheckpoints>>

Cached next checkpoint for each schedule.

This is used to quickly find the next checkpoint from a ticker’s schedules.

(ticker) -> next checkpoints

pub async fn scheduled_checkpoints( &self, key_0: Ticker, key_1: ScheduleId ) -> Result<Option<ScheduleCheckpoints>>

Scheduled checkpoints.

(ticker, schedule ID) -> schedule checkpoints

pub async fn schedule_ref_count( &self, key_0: Ticker, key_1: ScheduleId ) -> Result<u32>

How many “strong” references are there to a given ScheduleId?

The presence of a “strong” reference, in the sense of Rc<T>, entails that the referenced schedule cannot be removed. Thus, as long as strong_ref_count(schedule_id) > 0, remove_schedule(schedule_id) will error.

(ticker, schedule ID) -> strong ref count

pub async fn schedule_points( &self, key_0: Ticker, key_1: ScheduleId ) -> Result<Vec<CheckpointId>>

All the checkpoints a given schedule originated.

(ticker, schedule ID) -> [checkpoint ID]

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

Storage version.

Trait Implementations

impl<'api> Clone for CheckpointQueryApi<'api>

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

Returns a copy of the value.

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

Performs copy-assignment from source.