Struct PortfolioQueryApi

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

Implementations

impl<'api> PortfolioQueryApi<'api>

pub async fn next_portfolio_number( &self, key_0: IdentityId, ) -> Result<PortfolioNumber>

The next portfolio sequence number of an identity.

pub async fn portfolios( &self, key_0: IdentityId, key_1: PortfolioNumber, ) -> Result<Option<PortfolioName>>

The set of existing portfolios with their names. If a certain pair of a DID and portfolio number maps to None then such a portfolio doesn’t exist. Conversely, if a pair maps to Some(name) then such a portfolio exists and is called name.

pub async fn name_to_number( &self, key_0: IdentityId, key_1: PortfolioName, ) -> Result<Option<PortfolioNumber>>

Inverse map of Portfolios used to ensure bijectivitiy, and uniqueness of names in Portfolios.

pub async fn portfolio_asset_count(&self, key_0: PortfolioId) -> Result<u64>

How many assets with non-zero balance this portfolio contains.

pub async fn portfolio_asset_balances( &self, key_0: PortfolioId, key_1: AssetId, ) -> Result<u128>

The asset balances of portfolios.

pub async fn portfolio_locked_assets( &self, key_0: PortfolioId, key_1: AssetId, ) -> Result<u128>

Amount of assets locked in a portfolio. These assets show up in portfolio balance but can not be transferred away.

pub async fn portfolio_custodian( &self, key_0: PortfolioId, ) -> Result<Option<IdentityId>>

The custodian of a particular portfolio. None implies that the identity owner is the custodian.

pub async fn portfolios_in_custody( &self, key_0: IdentityId, key_1: PortfolioId, ) -> Result<bool>

Tracks all the portfolios in custody of a particular identity. Only used by the UIs. When true is stored as the value for a given (did, pid), it means that pid is in custody of did. false values are never explicitly stored in the map, and are instead inferred by the absence of a key.

pub async fn portfolio_nft( &self, key_0: PortfolioId, key_1: (AssetId, NFTId), ) -> Result<bool>

The nft associated to the portfolio.

pub async fn portfolio_locked_nft( &self, key_0: PortfolioId, key_1: (AssetId, NFTId), ) -> Result<bool>

All locked nft for a given portfolio.

pub async fn pre_approved_portfolios( &self, key_0: PortfolioId, key_1: AssetId, ) -> Result<bool>

All portfolios that don’t need to affirm the receivement of a given [AssetId].

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

Custodians allowed to create and take custody of portfolios on an id’s behalf.

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

Storage version.

Trait Implementations

impl<'api> Clone for PortfolioQueryApi<'api>

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

Returns a copy of the value.

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

Performs copy-assignment from source.