Struct polymesh_api::polymesh::api::settlement::SettlementCallApi

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

Implementations

impl<'api> SettlementCallApi<'api>

pub fn create_venue( &self, details: VenueDetails, signers: Vec<AccountId>, typ: VenueType ) -> Result<WrappedCall<'api>>

Registers a new venue.

• details - Extra details about a venue
• signers - Array of signers that are allowed to sign receipts for this venue
• typ - Type of venue being created

pub fn update_venue_details( &self, id: VenueId, details: VenueDetails ) -> Result<WrappedCall<'api>>

Edit a venue’s details.

• id specifies the ID of the venue to edit.
• details specifies the updated venue details.

pub fn update_venue_type( &self, id: VenueId, typ: VenueType ) -> Result<WrappedCall<'api>>

Edit a venue’s type.

• id specifies the ID of the venue to edit.
• type specifies the new type of the venue.

pub fn affirm_with_receipts( &self, id: InstructionId, receipt_details: Vec<ReceiptDetails<AccountId, MultiSignature>>, portfolios: Vec<PortfolioId> ) -> Result<WrappedCall<'api>>

Accepts an instruction and claims a signed receipt.

Arguments

• id - Target instruction id.
• leg_id - Target leg id for the receipt
• receipt_uid - Receipt ID generated by the signer.
• signer - Signer of the receipt.
• signed_data - Signed receipt.
• portfolios - Portfolios that the sender controls and wants to accept this instruction with.

Permissions

• Portfolio

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

Enables or disabled venue filtering for a token.

Arguments

• ticker - Ticker of the token in question.
• enabled - Boolean that decides if the filtering should be enabled.

Permissions

• Asset

pub fn allow_venues( &self, ticker: Ticker, venues: Vec<VenueId> ) -> Result<WrappedCall<'api>>

Allows additional venues to create instructions involving an asset.

• ticker - Ticker of the token in question.
• venues - Array of venues that are allowed to create instructions for the token in question.

Permissions

• Asset

pub fn disallow_venues( &self, ticker: Ticker, venues: Vec<VenueId> ) -> Result<WrappedCall<'api>>

Revokes permission given to venues for creating instructions involving a particular asset.

• ticker - Ticker of the token in question.
• venues - Array of venues that are no longer allowed to create instructions for the token in question.

Permissions

• Asset

pub fn update_venue_signers( &self, id: VenueId, signers: Vec<AccountId>, add_signers: bool ) -> Result<WrappedCall<'api>>

Edit a venue’s signers.

• id specifies the ID of the venue to edit.
• signers specifies the signers to add/remove.
• add_signers specifies the update type add/remove of venue where add is true and remove is false.

pub fn execute_manual_instruction( &self, id: InstructionId, portfolio: Option<PortfolioId>, fungible_transfers: u32, nfts_transfers: u32, offchain_transfers: u32, weight_limit: Option<Weight> ) -> Result<WrappedCall<'api>>

Manually executes an instruction.

Arguments

• id: The [InstructionId] of the instruction to be executed.
• portfolio: One of the caller’s [PortfolioId] which is also a counter patry in the instruction. If None, the caller must be the venue creator or a counter party in a [Leg::OffChain].
• fungible_transfers: The number of fungible legs in the instruction.
• nfts_transfers: The number of nfts being transferred in the instruction.
• offchain_transfers: The number of offchain legs in the instruction.
• weight_limit: An optional maximum [Weight] value to be charged for executing the instruction. If the weight_limit is less than the required amount, the instruction will fail execution.

Note: calling the rpc method get_execute_instruction_info returns an instance of [ExecuteInstructionInfo], which contains the count parameters.

pub fn add_instruction( &self, venue_id: VenueId, settlement_type: SettlementType<u32>, trade_date: Option<u64>, value_date: Option<u64>, legs: Vec<Leg>, instruction_memo: Option<Memo> ) -> Result<WrappedCall<'api>>

Adds a new instruction.

Arguments

• venue_id - ID of the venue this instruction belongs to.
• settlement_type - Defines if the instruction should be settled in the next block, after receiving all affirmations or waiting till a specific block.
• trade_date - Optional date from which people can interact with this instruction.
• value_date - Optional date after which the instruction should be settled (not enforced)
• legs - Legs included in this instruction.
• memo - Memo field for this instruction.

Weight

950_000_000 + 1_000_000 * legs.len()

pub fn add_and_affirm_instruction( &self, venue_id: VenueId, settlement_type: SettlementType<u32>, trade_date: Option<u64>, value_date: Option<u64>, legs: Vec<Leg>, portfolios: Vec<PortfolioId>, instruction_memo: Option<Memo> ) -> Result<WrappedCall<'api>>

Adds and affirms a new instruction.

Arguments

• venue_id - ID of the venue this instruction belongs to.
• settlement_type - Defines if the instruction should be settled in the next block, after receiving all affirmations or waiting till a specific block.
• trade_date - Optional date from which people can interact with this instruction.
• value_date - Optional date after which the instruction should be settled (not enforced)
• legs - Legs included in this instruction.
• portfolios - Portfolios that the sender controls and wants to use in this affirmations.
• instruction_memo - Memo field for this instruction.

Permissions

• Portfolio

pub fn affirm_instruction( &self, id: InstructionId, portfolios: Vec<PortfolioId> ) -> Result<WrappedCall<'api>>

Provide affirmation to an existing instruction.

Arguments

• id - The InstructionId of the instruction to be affirmed.
• portfolios - Portfolios that the sender controls and wants to affirm this instruction.

Permissions

• Portfolio

pub fn withdraw_affirmation( &self, id: InstructionId, portfolios: Vec<PortfolioId> ) -> Result<WrappedCall<'api>>

Withdraw an affirmation for a given instruction.

Arguments

• id - Instruction id for that affirmation get withdrawn.
• portfolios - Portfolios that the sender controls and wants to withdraw affirmation.

Permissions

• Portfolio

pub fn reject_instruction( &self, id: InstructionId, portfolio: PortfolioId ) -> Result<WrappedCall<'api>>

Rejects an existing instruction.

Arguments

• id - Instruction id to reject.
• portfolio - Portfolio to reject the instruction.

Permissions

• Portfolio

pub fn execute_scheduled_instruction( &self, id: InstructionId, weight_limit: Weight ) -> Result<WrappedCall<'api>>

Root callable extrinsic, used as an internal call to execute a scheduled settlement instruction.

Trait Implementations

impl<'api> Clone for SettlementCallApi<'api>

fn clone(&self) -> SettlementCallApi<'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 SettlementCallApi<'api>

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

Converts to this type from the input type.