Struct polymesh_api::polymesh::api::settlement::SettlementQueryApi

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

Implementations

impl<'api> SettlementQueryApi<'api>

pub async fn venue_info(&self, key_0: VenueId) -> Result<Option<Venue>>

Info about a venue. venue_id -> venue

pub async fn details(&self, key_0: VenueId) -> Result<VenueDetails>

Free-form text about a venue. venue_id -> VenueDetails Only needed for the UI.

pub async fn venue_instructions( &self, key_0: VenueId, key_1: InstructionId ) -> Result<()>

Instructions under a venue. Only needed for the UI.

venue_id -> instruction_id -> ()

pub async fn venue_signers( &self, key_0: VenueId, key_1: AccountId ) -> Result<bool>

Signers allowed by the venue. (venue_id, signer) -> bool

pub async fn user_venues(&self, key_0: IdentityId, key_1: VenueId) -> Result<()>

Array of venues created by an identity. Only needed for the UI. IdentityId -> Vec<venue_id> Venues create by an identity. Only needed for the UI.

identity -> venue_id ()

pub async fn instruction_details( &self, key_0: InstructionId ) -> Result<Instruction<u64, u32>>

Details about an instruction. instruction_id -> instruction_details

pub async fn instruction_leg_status( &self, key_0: InstructionId, key_1: LegId ) -> Result<LegStatus<AccountId>>

Status of a leg under an instruction. (instruction_id, leg_id) -> LegStatus

pub async fn instruction_affirms_pending( &self, key_0: InstructionId ) -> Result<u64>

Number of affirmations pending before instruction is executed. instruction_id -> affirm_pending

pub async fn affirms_received( &self, key_0: InstructionId, key_1: PortfolioId ) -> Result<AffirmationStatus>

Tracks affirmations received for an instruction. (instruction_id, counter_party) -> AffirmationStatus

pub async fn user_affirmations( &self, key_0: PortfolioId, key_1: InstructionId ) -> Result<AffirmationStatus>

Helps a user track their pending instructions and affirmations (only needed for UI). (counter_party, instruction_id) -> AffirmationStatus

pub async fn receipts_used(&self, key_0: AccountId, key_1: u64) -> Result<bool>

Tracks redemption of receipts. (signer, receipt_uid) -> receipt_used

pub async fn venue_filtering(&self, key_0: Ticker) -> Result<bool>

Tracks if a token has enabled filtering venues that can create instructions involving their token. Ticker -> filtering_enabled

pub async fn venue_allow_list( &self, key_0: Ticker, key_1: VenueId ) -> Result<bool>

Venues that are allowed to create instructions involving a particular ticker. Only used if filtering is enabled. (ticker, venue_id) -> allowed

pub async fn venue_counter(&self) -> Result<VenueId>

Number of venues in the system (It’s one more than the actual number)

pub async fn instruction_counter(&self) -> Result<InstructionId>

Number of instructions in the system (It’s one more than the actual number)

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

Storage version.

pub async fn instruction_memos( &self, key_0: InstructionId ) -> Result<Option<Memo>>

Instruction memo

pub async fn instruction_statuses( &self, key_0: InstructionId ) -> Result<InstructionStatus<u32>>

Instruction statuses. instruction_id -> InstructionStatus

pub async fn instruction_legs( &self, key_0: InstructionId, key_1: LegId ) -> Result<Option<Leg>>

Legs under an instruction. (instruction_id, leg_id) -> Leg

pub async fn off_chain_affirmations( &self, key_0: InstructionId, key_1: LegId ) -> Result<AffirmationStatus>

Tracks the affirmation status for offchain legs in a instruction. [(InstructionId, LegId)] -> [AffirmationStatus]

Trait Implementations

impl<'api> Clone for SettlementQueryApi<'api>

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

Returns a copy of the value.

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

Performs copy-assignment from source.