Struct polymesh_api::polymesh::api::asset::AssetCallApi

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

Implementations

impl<'api> AssetCallApi<'api>

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

Registers a new ticker or extends validity of an existing ticker. NB: Ticker validity does not get carry forward when renewing ticker.

Arguments

• origin It contains the secondary key of the caller (i.e. who signed the transaction to execute this function).
• ticker ticker to register.

Permissions

• Asset

pub fn accept_ticker_transfer(&self, auth_id: u64) -> Result<WrappedCall<'api>>

Accepts a ticker transfer.

Consumes the authorization auth_id (see pallet_identity::consume_auth). NB: To reject the transfer, call remove auth function in identity module.

Arguments

• origin It contains the secondary key of the caller (i.e. who signed the transaction to execute this function).
• auth_id Authorization ID of ticker transfer authorization.

Errors

• AuthorizationError::BadType if auth_id is not a valid ticket transfer authorization.

pub fn accept_asset_ownership_transfer( &self, auth_id: u64 ) -> Result<WrappedCall<'api>>

This function is used to accept a token ownership transfer. NB: To reject the transfer, call remove auth function in identity module.

Arguments

• origin It contains the secondary key of the caller (i.e. who signed the transaction to execute this function).
• auth_id Authorization ID of the token ownership transfer authorization.

pub fn create_asset( &self, name: AssetName, ticker: Ticker, divisible: bool, asset_type: AssetType, identifiers: Vec<AssetIdentifier>, funding_round: Option<FundingRoundName> ) -> Result<WrappedCall<'api>>

Initializes a new security token, with the initiating account as its owner. The total supply will initially be zero. To mint tokens, use issue.

Arguments

• origin - contains the secondary key of the caller (i.e. who signed the transaction to execute this function).
• name - the name of the token.
• ticker - the ticker symbol of the token.
• divisible - a boolean to identify the divisibility status of the token.
• asset_type - the asset type.
• identifiers - a vector of asset identifiers.
• funding_round - name of the funding round.

Errors

• InvalidAssetIdentifier if any of identifiers are invalid.
• MaxLengthOfAssetNameExceeded if name’s length exceeds T::AssetNameMaxLength.
• FundingRoundNameMaxLengthExceeded if the name of the funding round is longer that T::FundingRoundNameMaxLength.
• AssetAlreadyCreated if asset was already created.
• TickerTooLong if ticker’s length is greater than config.max_ticker_length chain parameter.
• TickerNotAlphanumeric if ticker is not yet registered, and contains non-alphanumeric characters or any character after first occurrence of \0.

Permissions

• Portfolio

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

Freezes transfers and minting of a given token.

Arguments

• origin - the secondary key of the sender.
• ticker - the ticker of the token.

Errors

• AlreadyFrozen if ticker is already frozen.

Permissions

• Asset

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

Unfreezes transfers and minting of a given token.

Arguments

• origin - the secondary key of the sender.
• ticker - the ticker of the frozen token.

Errors

• NotFrozen if ticker is not frozen yet.

Permissions

• Asset

pub fn rename_asset( &self, ticker: Ticker, name: AssetName ) -> Result<WrappedCall<'api>>

Renames a given token.

Arguments

• origin - the secondary key of the sender.
• ticker - the ticker of the token.
• name - the new name of the token.

Errors

• MaxLengthOfAssetNameExceeded if length of name is greater than T::AssetNameMaxLength.

Permissions

• Asset

pub fn issue( &self, ticker: Ticker, amount: u128, portfolio_kind: PortfolioKind ) -> Result<WrappedCall<'api>>

Issue, or mint, new tokens to the caller, which must be an authorized external agent.

Arguments

• origin - A signer that has permissions to act as an agent of ticker.
• ticker - The [Ticker] of the token.
• amount - The amount of tokens that will be issued.
• portfolio_kind - The [PortfolioKind] of the portfolio that will receive the minted tokens.

Permissions

• Asset
• Portfolio

pub fn redeem(&self, ticker: Ticker, value: u128) -> Result<WrappedCall<'api>>

Redeems existing tokens by reducing the balance of the caller’s default portfolio and the total supply of the token

Arguments

• origin is a signer that has permissions to act as an agent of ticker.
• ticker Ticker of the token.
• value Amount of tokens to redeem.

Errors

• Unauthorized If called by someone without the appropriate external agent permissions
• InvalidGranularity If the amount is not divisible by 10^6 for non-divisible tokens
• InsufficientPortfolioBalance If the caller’s default portfolio doesn’t have enough free balance

Permissions

• Asset
• Portfolio

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

Makes an indivisible token divisible.

Arguments

• origin is a signer that has permissions to act as an agent of ticker.
• ticker Ticker of the token.

Errors

• AssetAlreadyDivisible if ticker is already divisible.

Permissions

• Asset

pub fn add_documents( &self, docs: Vec<Document>, ticker: Ticker ) -> Result<WrappedCall<'api>>

Add documents for a given token.

Arguments

• origin is a signer that has permissions to act as an agent of ticker.
• ticker Ticker of the token.
• docs Documents to be attached to ticker.

Permissions

• Asset

pub fn remove_documents( &self, ids: Vec<DocumentId>, ticker: Ticker ) -> Result<WrappedCall<'api>>

Remove documents for a given token.

Arguments

• origin is a signer that has permissions to act as an agent of ticker.
• ticker Ticker of the token.
• ids Documents ids to be removed from ticker.

Permissions

• Asset

pub fn set_funding_round( &self, ticker: Ticker, name: FundingRoundName ) -> Result<WrappedCall<'api>>

Sets the name of the current funding round.

Arguments

• origin - a signer that has permissions to act as an agent of ticker.
• ticker - the ticker of the token.
• name - the desired name of the current funding round.

Errors

• FundingRoundNameMaxLengthExceeded if length of name is greater than T::FundingRoundNameMaxLength.

Permissions

• Asset

pub fn update_identifiers( &self, ticker: Ticker, identifiers: Vec<AssetIdentifier> ) -> Result<WrappedCall<'api>>

Updates the asset identifiers.

Arguments

• origin - a signer that has permissions to act as an agent of ticker.
• ticker - the ticker of the token.
• identifiers - the asset identifiers to be updated in the form of a vector of pairs of IdentifierType and AssetIdentifier value.

Errors

• InvalidAssetIdentifier if identifiers contains any invalid identifier.

Permissions

• Asset

pub fn controller_transfer( &self, ticker: Ticker, value: u128, from_portfolio: PortfolioId ) -> Result<WrappedCall<'api>>

Forces a transfer of token from from_portfolio to the caller’s default portfolio.

Arguments

• origin Must be an external agent with appropriate permissions for a given ticker.
• ticker Ticker symbol of the asset.
• value Amount of tokens need to force transfer.
• from_portfolio From whom portfolio tokens gets transferred.

pub fn register_custom_asset_type( &self, ty: Vec<u8> ) -> Result<WrappedCall<'api>>

Registers a custom asset type.

The provided ty will be bound to an ID in storage. The ID can then be used in AssetType::Custom. Should the ty already exist in storage, no second ID is assigned to it.

Arguments

• origin who called the extrinsic.
• ty contains the string representation of the asset type.

pub fn create_asset_with_custom_type( &self, name: AssetName, ticker: Ticker, divisible: bool, custom_asset_type: Vec<u8>, identifiers: Vec<AssetIdentifier>, funding_round: Option<FundingRoundName> ) -> Result<WrappedCall<'api>>

Utility extrinsic to batch create_asset and register_custom_asset_type.

pub fn set_asset_metadata( &self, ticker: Ticker, key: AssetMetadataKey, value: AssetMetadataValue, detail: Option<AssetMetadataValueDetail<u64>> ) -> Result<WrappedCall<'api>>

Set asset metadata value.

Arguments

• origin is a signer that has permissions to act as an agent of ticker.
• ticker Ticker of the token.
• key Metadata key.
• value Metadata value.
• details Optional Metadata value details (expire, lock status).

Errors

• AssetMetadataKeyIsMissing if the metadata type key doesn’t exist.
• AssetMetadataValueIsLocked if the metadata value for key is locked.
• AssetMetadataValueMaxLengthExceeded if the metadata value exceeds the maximum length.

Permissions

• Agent
• Asset

pub fn set_asset_metadata_details( &self, ticker: Ticker, key: AssetMetadataKey, detail: AssetMetadataValueDetail<u64> ) -> Result<WrappedCall<'api>>

Set asset metadata value details (expire, lock status).

Arguments

• origin is a signer that has permissions to act as an agent of ticker.
• ticker Ticker of the token.
• key Metadata key.
• details Metadata value details (expire, lock status).

Errors

• AssetMetadataKeyIsMissing if the metadata type key doesn’t exist.
• AssetMetadataValueIsLocked if the metadata value for key is locked.

Permissions

• Agent
• Asset

pub fn register_and_set_local_asset_metadata( &self, ticker: Ticker, name: AssetMetadataName, spec: AssetMetadataSpec, value: AssetMetadataValue, detail: Option<AssetMetadataValueDetail<u64>> ) -> Result<WrappedCall<'api>>

Registers and set local asset metadata.

Arguments

• origin is a signer that has permissions to act as an agent of ticker.
• ticker Ticker of the token.
• name Metadata name.
• spec Metadata type definition.
• value Metadata value.
• details Optional Metadata value details (expire, lock status).

Errors

• AssetMetadataLocalKeyAlreadyExists if a local metadata type with name already exists for ticker.
• AssetMetadataNameMaxLengthExceeded if the metadata name exceeds the maximum length.
• AssetMetadataTypeDefMaxLengthExceeded if the metadata spec type definition exceeds the maximum length.
• AssetMetadataValueMaxLengthExceeded if the metadata value exceeds the maximum length.

Permissions

• Agent
• Asset

pub fn register_asset_metadata_local_type( &self, ticker: Ticker, name: AssetMetadataName, spec: AssetMetadataSpec ) -> Result<WrappedCall<'api>>

Registers asset metadata local type.

Arguments

• origin is a signer that has permissions to act as an agent of ticker.
• ticker Ticker of the token.
• name Metadata name.
• spec Metadata type definition.

Errors

• AssetMetadataLocalKeyAlreadyExists if a local metadata type with name already exists for ticker.
• AssetMetadataNameMaxLengthExceeded if the metadata name exceeds the maximum length.
• AssetMetadataTypeDefMaxLengthExceeded if the metadata spec type definition exceeds the maximum length.

Permissions

• Agent
• Asset

pub fn register_asset_metadata_global_type( &self, name: AssetMetadataName, spec: AssetMetadataSpec ) -> Result<WrappedCall<'api>>

Registers asset metadata global type.

Arguments

• origin is a signer that has permissions to act as an agent of ticker.
• name Metadata name.
• spec Metadata type definition.

Errors

• AssetMetadataGlobalKeyAlreadyExists if a globa metadata type with name already exists.
• AssetMetadataNameMaxLengthExceeded if the metadata name exceeds the maximum length.
• AssetMetadataTypeDefMaxLengthExceeded if the metadata spec type definition exceeds the maximum length.

pub fn redeem_from_portfolio( &self, ticker: Ticker, value: u128, portfolio: PortfolioKind ) -> Result<WrappedCall<'api>>

Redeems existing tokens by reducing the balance of the caller’s portfolio and the total supply of the token

Arguments

• origin is a signer that has permissions to act as an agent of ticker.
• ticker Ticker of the token.
• value Amount of tokens to redeem.
• portfolio From whom portfolio tokens gets transferred.

Errors

• Unauthorized If called by someone without the appropriate external agent permissions
• InvalidGranularity If the amount is not divisible by 10^6 for non-divisible tokens
• InsufficientPortfolioBalance If the caller’s portfolio doesn’t have enough free balance
• PortfolioDoesNotExist If the portfolio doesn’t exist.

Permissions

• Asset
• Portfolio

pub fn update_asset_type( &self, ticker: Ticker, asset_type: AssetType ) -> Result<WrappedCall<'api>>

Updates the type of an asset.

Arguments

• origin - the secondary key of the sender.
• ticker - the ticker of the token.
• asset_type - the new type of the token.

Errors

• InvalidCustomAssetTypeId if asset_type is of type custom and has an invalid type id.

Permissions

• Asset

pub fn remove_local_metadata_key( &self, ticker: Ticker, local_key: AssetMetadataLocalKey ) -> Result<WrappedCall<'api>>

Removes the asset metadata key and value of a local key.

Arguments

• origin - the secondary key of the sender.
• ticker - the ticker of the local metadata key.
• local_key - the local metadata key.

Errors

• SecondaryKeyNotAuthorizedForAsset - if called by someone without the appropriate external agent permissions.
• UnauthorizedAgent - if called by someone without the appropriate external agent permissions.
• AssetMetadataKeyIsMissing - if the key doens’t exist.
• AssetMetadataValueIsLocked - if the value of the key is locked.
• AssetMetadataKeyBelongsToNFTCollection - if the key is a mandatory key in an NFT collection.

Permissions

• Asset

pub fn remove_metadata_value( &self, ticker: Ticker, metadata_key: AssetMetadataKey ) -> Result<WrappedCall<'api>>

Removes the asset metadata value of a metadata key.

Arguments

• origin - the secondary key of the sender.
• ticker - the ticker of the local metadata key.
• metadata_key - the metadata key that will have its value deleted.

Errors

• SecondaryKeyNotAuthorizedForAsset - if called by someone without the appropriate external agent permissions.
• UnauthorizedAgent - if called by someone without the appropriate external agent permissions.
• AssetMetadataKeyIsMissing - if the key doens’t exist.
• AssetMetadataValueIsLocked - if the value of the key is locked.

Permissions

• Asset

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

Pre-approves the receivement of the asset for all identities.

Arguments

• origin - the secondary key of the sender.
• ticker - the [Ticker] that will be exempt from affirmation.

Permissions

• Root

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

Removes the pre-approval of the asset for all identities.

Arguments

• origin - the secondary key of the sender.
• ticker - the [Ticker] that will have its exemption removed.

Permissions

• Root

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

Pre-approves the receivement of an asset.

Arguments

• origin - the secondary key of the sender.
• ticker - the [Ticker] that will be exempt from affirmation.

Permissions

• Asset

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

Removes the pre approval of an asset.

Arguments

• origin - the secondary key of the sender.
• ticker - the [Ticker] that will have its exemption removed.

Permissions

• Asset

Trait Implementations

impl<'api> Clone for AssetCallApi<'api>

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

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

Converts to this type from the input type.