Struct PolymeshInk

pub struct PolymeshInk { /* private fields */ }

Upgradable wrapper for the Polymesh Runtime API.

Contracts can use this to maintain support accross major Polymesh releases.

Implementations

impl PolymeshInk

pub fn new() -> PolymeshResult<Self>

pub fn new_with_hash(hash: Hash) -> Self

pub fn update_code_hash(&mut self, hash: Hash)

Update code hash.

pub fn check_for_upgrade(&mut self) -> PolymeshResult<()>

pub fn system_remark(&self, remark: Vec<u8>) -> PolymeshResult<()>

Wrap the system.remark extrinsic. Only useful for testing.

pub fn create_portfolio(&self, name: Vec<u8>) -> PolymeshResult<PortfolioId>

Creates a portfolio with the given name.

pub fn accept_portfolio_custody( &self, auth_id: u64, portfolio_kind: PortfolioKind, ) -> PolymeshResult<PortfolioId>

Accepts custody of a portfolio.

pub fn quit_portfolio_custody( &self, portfolio_id: PortfolioId, ) -> PolymeshResult<()>

Quits custodianship of a portfolio returning control back to the owner.

pub fn move_portfolio_funds( &self, source_portfolio_id: PortfolioId, destination_portfolio_id: PortfolioId, funds: Vec<Fund>, ) -> PolymeshResult<()>

Moves the given funds from source_portfolio_id to destination_portfolio_id.

pub fn portfolio_asset_balances( &self, portfolio_id: PortfolioId, asset_id: AssetId, ) -> PolymeshResult<Balance>

Returns the Balance for the asset_id in the given portfolio_id.

pub fn check_portfolios_in_custody( &self, custodian_did: IdentityId, portfolio_id: PortfolioId, ) -> PolymeshResult<bool>

Returns true if portfolio_id is in custody of custodian_did, otherwise returns false.

pub fn create_venue( &self, venue_details: VenueDetails, venue_type: VenueType, ) -> PolymeshResult<VenueId>

Creates a Settlement Venue.

pub fn settlement_execute( &self, venue_id: Option<VenueId>, legs: Vec<Leg>, portfolios: BTreeSet<PortfolioId>, ) -> PolymeshResult<()>

Creates and manually executes a settlement to transfer assets.

pub fn asset_issue( &self, asset_id: AssetId, amount_to_issue: Balance, portfolio_kind: PortfolioKind, ) -> PolymeshResult<()>

Issues amount_to_issue new tokens to portfolio_kind.

pub fn asset_redeem( &self, asset_id: AssetId, amount_to_redeem: Balance, portfolio_kind: PortfolioKind, ) -> PolymeshResult<()>

Redeems amount_to_redeem tokens from portfolio_kind.

pub fn asset_create_and_issue( &self, asset_name: AssetName, asset_type: AssetType, divisible: bool, amount_to_issue: Option<Balance>, ) -> PolymeshResult<AssetId>

Creates a new asset and issues amount_to_issue tokens of that asset to the default portfolio of the caller.

pub fn asset_balance_of( &self, asset_id: AssetId, did: IdentityId, ) -> PolymeshResult<Balance>

Returns the asset_id Balance for the given did.

pub fn asset_total_supply(&self, asset_id: AssetId) -> PolymeshResult<Balance>

Returns the total supply of asset_id.

pub fn distribution_summary( &self, ca_id: CAId, ) -> PolymeshResult<Option<DistributionSummary>>

Get corporate action distribution summary.

pub fn dividend_claim(&self, ca_id: CAId) -> PolymeshResult<()>

Claims dividends from a distribution.

pub fn create_dividend(&self, dividend: SimpleDividend) -> PolymeshResult<()>

Create a simple dividend distribution.

pub fn add_and_affirm_instruction( &self, venue_id: Option<VenueId>, legs: Vec<Leg>, portfolios: BTreeSet<PortfolioId>, ) -> PolymeshResult<InstructionId>

Adds and affirms an instruction.

pub fn create_custody_portfolio( &self, portfolio_owner_id: IdentityId, portfolio_name: PortfolioName, ) -> PolymeshResult<PortfolioId>

Creates a portoflio owned by portfolio_owner_id and transfer its custody to the smart contract. Returns the PortfolioId of the new portfolio.

pub fn asset_metadata_local_name_to_key( &self, asset_id: AssetId, asset_metadata_name: AssetMetadataName, ) -> PolymeshResult<Option<AssetMetadataLocalKey>>

Returns the AssetMetadataLocalKey for the given asset_id and asset_metadata_name.

pub fn asset_metadata_value( &self, asset_id: AssetId, asset_metadata_key: AssetMetadataKey, ) -> PolymeshResult<Option<AssetMetadataValue>>

Returns the AssetMetadataValue for the given asset_id and asset_metadata_key.

pub fn nft_owner( &self, asset_id: AssetId, nft: NFTId, ) -> PolymeshResult<Option<PortfolioId>>

Returns the PortfolioId that holds the NFT.

pub fn holds_nfts( &self, portfolio_id: PortfolioId, asset_id: AssetId, nfts: Vec<NFTId>, ) -> PolymeshResult<()>

Returns Ok if portfolio_id holds all nfts. Otherwise, returns PolymeshError::NotNftOwner.

impl PolymeshInk

pub fn get_caller_did() -> PolymeshResult<IdentityId>

Get the identity of the caller.

pub fn get_our_did() -> PolymeshResult<IdentityId>

Get the identity of the contract.

pub fn get_key_did(acc: AccountId) -> PolymeshResult<IdentityId>

Get the identity of a key.

pub fn get_our_next_asset_id() -> PolymeshResult<AssetId>

Returns the next AssetId for the caller.

pub fn get_next_asset_id(account_id: AccountId) -> PolymeshResult<AssetId>

Returns the next AssetId for the given account_id.

Trait Implementations

impl Clone for PolymeshInk

fn clone(&self) -> PolymeshInk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PolymeshInk

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Decode for PolymeshInk

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Default for PolymeshInk

fn default() -> PolymeshInk

Returns the “default value” for a type.

impl Encode for PolymeshInk

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<__CodecOutputReturn, __CodecUsingEncodedCallback: FnOnce(&[u8]) -> __CodecOutputReturn>( &self, f: __CodecUsingEncodedCallback, ) -> __CodecOutputReturn

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl StorageLayout for PolymeshInk

fn layout(__key: &Key) -> Layout

Returns the static storage layout of Self.

impl TypeInfo for PolymeshInk

type Identity = PolymeshInk

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl EncodeLike for PolymeshInk