Struct polymesh_api::polymesh::api::checkpoint::CallApi

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

Implementations

impl<'api> CallApi<'api>

pub fn create_checkpoint(&self, ticker: Ticker) -> Result<WrappedCall<'api>>

Creates a single checkpoint at the current time.

Arguments

• origin is a signer that has permissions to act as an agent of ticker.
• ticker to create the checkpoint for.

Errors

• UnauthorizedAgent if the DID of origin isn’t a permissioned agent for ticker.
• CounterOverflow if the total checkpoint counter would overflow.

pub fn set_schedules_max_complexity(
    &self,
    max_complexity: u64
) -> Result<WrappedCall<'api>>

Sets the max complexity of a schedule set for an arbitrary ticker to max_complexity. The new maximum is not enforced retroactively, and only applies once new schedules are made.

Must be called as a PIP (requires “root”).

Arguments

• origin is the root origin.
• max_complexity allowed for an arbitrary ticker’s schedule set.

pub fn create_schedule(
    &self,
    ticker: Ticker,
    schedule: ScheduleSpec
) -> Result<WrappedCall<'api>>

Creates a schedule generating checkpoints in the future at either a fixed time or at intervals.

The schedule starts out with strong_ref_count(schedule_id) <- 0.

Arguments

• origin is a signer that has permissions to act as owner of ticker.
• ticker to create the schedule for.
• schedule that will generate checkpoints.

Errors

• UnauthorizedAgent if the DID of origin isn’t a permissioned agent for ticker.
• ScheduleDurationTooShort if the schedule duration is too short.
• InsufficientAccountBalance if the protocol fee could not be charged.
• CounterOverflow if the schedule ID or total checkpoint counters would overflow.
• FailedToComputeNextCheckpoint if the next checkpoint for schedule is in the past.

Permissions

• Asset

pub fn remove_schedule(
    &self,
    ticker: Ticker,
    id: ScheduleId
) -> Result<WrappedCall<'api>>

Removes the checkpoint schedule of an asset identified by id.

Arguments

• origin is a signer that has permissions to act as owner of ticker.
• ticker to remove the schedule from.
• id of the schedule, when it was created by created_schedule.

Errors

• UnauthorizedAgent if the DID of origin isn’t a permissioned agent for ticker.
• NoCheckpointSchedule if id does not identify a schedule for this ticker.
• ScheduleNotRemovable if id exists but is not removable.

Permissions

• Asset

Trait Implementations

impl<'api> Clone for CallApi<'api>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'api> From<&'api Api> for CallApi<'api>

fn from(api: &'api Api) -> Self

Converts to this type from the input type.