Struct polymesh_api::polymesh::api::portfolio::PortfolioCallApi

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

Implementations

impl<'api> PortfolioCallApi<'api>

pub fn create_portfolio(&self, name: PortfolioName) -> Result<WrappedCall>

Creates a portfolio with the given name.

pub fn delete_portfolio(&self, num: PortfolioNumber) -> Result<WrappedCall>

Deletes a user portfolio. A portfolio can be deleted only if it has no funds.

Errors

• PortfolioDoesNotExist if num doesn’t reference a valid portfolio.
• PortfolioNotEmpty if the portfolio still holds any asset

Permissions

• Portfolio

pub fn rename_portfolio( &self, num: PortfolioNumber, to_name: PortfolioName ) -> Result<WrappedCall>

Renames a non-default portfolio.

Errors

• PortfolioDoesNotExist if num doesn’t reference a valid portfolio.

Permissions

• Portfolio

pub fn quit_portfolio_custody(&self, pid: PortfolioId) -> Result<WrappedCall>

When called by the custodian of portfolio_id, allows returning the custody of the portfolio to the portfolio owner unilaterally.

Errors

• UnauthorizedCustodian if the caller is not the current custodian of portfolio_id.

Permissions

• Portfolio

pub fn accept_portfolio_custody(&self, auth_id: u64) -> Result<WrappedCall>

pub fn move_portfolio_funds( &self, from: PortfolioId, to: PortfolioId, funds: Vec<Fund> ) -> Result<WrappedCall>

Moves fungigle an non-fungible tokens from one portfolio of an identity to another portfolio of the same identity. Must be called by the custodian of the sender. Funds from deleted portfolios can also be recovered via this method.

A short memo can be added to to each token amount moved.

Errors

• PortfolioDoesNotExist if one or both of the portfolios reference an invalid portfolio.
• destination_is_same_portfolio if both sender and receiver portfolio are the same
• DifferentIdentityPortfolios if the sender and receiver portfolios belong to different identities
• UnauthorizedCustodian if the caller is not the custodian of the from portfolio
• InsufficientPortfolioBalance if the sender does not have enough free balance
• NoDuplicateAssetsAllowed the same ticker can’t be repeated in the items vector.
• InvalidTransferNFTNotOwned if the caller is trying to move an NFT he doesn’t own.
• InvalidTransferNFTIsLocked if the caller is trying to move a locked NFT.

Permissions

• Portfolio

pub fn pre_approve_portfolio( &self, ticker: Ticker, portfolio_id: PortfolioId ) -> Result<WrappedCall>

Pre-approves the receivement of an asset to a portfolio.

Arguments

• origin - the secondary key of the sender.
• ticker - the [Ticker] that will be exempt from affirmation.
• portfolio_id - the [PortfolioId] that can receive ticker without affirmation.

Permissions

• Portfolio

pub fn remove_portfolio_pre_approval( &self, ticker: Ticker, portfolio_id: PortfolioId ) -> Result<WrappedCall>

Removes the pre approval of an asset to a portfolio.

Arguments

• origin - the secondary key of the sender.
• ticker - the [Ticker] that will be exempt from affirmation.
• portfolio_id - the [PortfolioId] that can receive ticker without affirmation.

Permissions

• Portfolio

pub fn allow_identity_to_create_portfolios( &self, trusted_identity: IdentityId ) -> Result<WrappedCall>

Adds an identity that will be allowed to create and take custody of a portfolio under the caller’s identity.

Arguments

• trusted_identity - the [IdentityId] that will be allowed to call create_custody_portfolio.

pub fn revoke_create_portfolios_permission( &self, identity: IdentityId ) -> Result<WrappedCall>

Removes permission of an identity to create and take custody of a portfolio under the caller’s identity.

Arguments

• identity - the [IdentityId] that will have the permissions to call create_custody_portfolio revoked.

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

Creates a portfolio under the portfolio_owner_id identity and transfers its custody to the caller’s identity.

Arguments

• portfolio_owner_id - the [IdentityId] that will own the new portfolio.
• portfolio_name - the [PortfolioName] of the new portfolio.

Trait Implementations

impl<'api> Clone for PortfolioCallApi<'api>

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

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

Converts to this type from the input type.