Enum polymesh_api::polymesh::types::pallet_asset::Call

pub enum Call {
    register_ticker {
        ticker: Ticker,
    },
    accept_ticker_transfer {
        auth_id: u64,
    },
    accept_asset_ownership_transfer {
        auth_id: u64,
    },
    create_asset {
        name: AssetName,
        ticker: Ticker,
        divisible: bool,
        asset_type: AssetType,
        identifiers: Vec<AssetIdentifier>,
        funding_round: Option<FundingRoundName>,
        disable_iu: bool,
    },
    freeze {
        ticker: Ticker,
    },
    unfreeze {
        ticker: Ticker,
    },
    rename_asset {
        ticker: Ticker,
        name: AssetName,
    },
    issue {
        ticker: Ticker,
        amount: u128,
    },
    redeem {
        ticker: Ticker,
        value: u128,
    },
    make_divisible {
        ticker: Ticker,
    },
    add_documents {
        docs: Vec<Document>,
        ticker: Ticker,
    },
    remove_documents {
        ids: Vec<DocumentId>,
        ticker: Ticker,
    },
    set_funding_round {
        ticker: Ticker,
        name: FundingRoundName,
    },
    update_identifiers {
        ticker: Ticker,
        identifiers: Vec<AssetIdentifier>,
    },
    claim_classic_ticker {
        ticker: Ticker,
        ethereum_signature: EcdsaSignature,
    },
    reserve_classic_ticker {
        classic_ticker_import: ClassicTickerImport,
        contract_did: IdentityId,
        config: TickerRegistrationConfig<u64>,
    },
    controller_transfer {
        ticker: Ticker,
        value: u128,
        from_portfolio: PortfolioId,
    },
    register_custom_asset_type {
        ty: Vec<u8>,
    },
    create_asset_with_custom_type {
        name: AssetName,
        ticker: Ticker,
        divisible: bool,
        custom_asset_type: Vec<u8>,
        identifiers: Vec<AssetIdentifier>,
        funding_round: Option<FundingRoundName>,
        disable_iu: bool,
    },
    set_asset_metadata {
        ticker: Ticker,
        key: AssetMetadataKey,
        value: AssetMetadataValue,
        detail: Option<AssetMetadataValueDetail<u64>>,
    },
    set_asset_metadata_details {
        ticker: Ticker,
        key: AssetMetadataKey,
        detail: AssetMetadataValueDetail<u64>,
    },
    register_and_set_local_asset_metadata {
        ticker: Ticker,
        name: AssetMetadataName,
        spec: AssetMetadataSpec,
        value: AssetMetadataValue,
        detail: Option<AssetMetadataValueDetail<u64>>,
    },
    register_asset_metadata_local_type {
        ticker: Ticker,
        name: AssetMetadataName,
        spec: AssetMetadataSpec,
    },
    register_asset_metadata_global_type {
        name: AssetMetadataName,
        spec: AssetMetadataSpec,
    },
    redeem_from_portfolio {
        ticker: Ticker,
        value: u128,
        portfolio: PortfolioKind,
    },
    update_asset_type {
        ticker: Ticker,
        asset_type: AssetType,
    },
}

Dispatchable calls.

Each variant of this enum maps to a dispatchable function from the associated module.

Variants

register_ticker

Fields

ticker: Ticker

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

accept_ticker_transfer

Fields

auth_id: u64

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.

accept_asset_ownership_transfer

Fields

auth_id: u64

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.

create_asset

Fields

name: AssetName

ticker: Ticker

divisible: bool

asset_type: AssetType

identifiers: Vec<AssetIdentifier>

funding_round: Option<FundingRoundName>

disable_iu: bool

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.
• disable_iu - whether or not investor uniqueness enforcement should be disabled. This cannot be changed after creating the asset.

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.
• TickerNotAscii if ticker is not yet registered, and contains non-ascii printable characters (from code 32 to 126) or any character after first occurrence of \0.

Permissions

• Portfolio

freeze

Fields

ticker: Ticker

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

unfreeze

Fields

ticker: Ticker

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

rename_asset

Fields

ticker: Ticker

name: AssetName

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

issue

Fields

ticker: Ticker

amount: u128

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

Arguments

• origin is a signer that has permissions to act as an agent of ticker.
• ticker of the token.
• amount of tokens that get issued.

Permissions

• Asset
• Portfolio

redeem

Fields

ticker: Ticker

value: u128

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

make_divisible

Fields

ticker: Ticker

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

add_documents

Fields

docs: Vec<Document>

ticker: Ticker

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

remove_documents

Fields

ids: Vec<DocumentId>

ticker: Ticker

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

set_funding_round

Fields

ticker: Ticker

name: FundingRoundName

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

update_identifiers

Fields

ticker: Ticker

identifiers: Vec<AssetIdentifier>

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

claim_classic_ticker

Fields

ticker: Ticker

ethereum_signature: EcdsaSignature

Claim a systematically reserved Polymath Classic (PMC) ticker and transfer it to the origin’s identity.

To verify that the origin is in control of the Ethereum account on the books, an ethereum_signature containing the origin’s DID as the message must be provided by that Ethereum account.

Errors

• NoSuchClassicTicker if this is not a systematically reserved PMC ticker.
• TickerAlreadyRegistered if the ticker was already registered, e.g., by origin.
• TickerRegistrationExpired if the ticker’s registration has expired.
• BadOrigin if not signed.
• InvalidEthereumSignature if the ethereum_signature is not valid.
• NotAnOwner if the ethereum account is not the owner of the PMC ticker.

reserve_classic_ticker

Fields

classic_ticker_import: ClassicTickerImport

contract_did: IdentityId

config: TickerRegistrationConfig<u64>

Reserve a Polymath Classic (PMC) ticker. Must be called by root, and assigns the ticker to a systematic DID.

Arguments

• origin which must be root.
• classic_ticker_import specification for the PMC ticker.
• contract_did to reserve the ticker to if classic_ticker_import.is_contract holds.
• config to use for expiry and ticker length.

Errors

• AssetAlreadyCreated if classic_ticker_import.ticker was created as an asset.
• TickerTooLong if the config considers the classic_ticker_import.ticker too long.
• TickerAlreadyRegistered if classic_ticker_import.ticker was already registered.

controller_transfer

Fields

ticker: Ticker

value: u128

from_portfolio: PortfolioId

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.

register_custom_asset_type

Fields

ty: Vec<u8>

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.

create_asset_with_custom_type

Fields

name: AssetName

ticker: Ticker

divisible: bool

custom_asset_type: Vec<u8>

identifiers: Vec<AssetIdentifier>

funding_round: Option<FundingRoundName>

disable_iu: bool

Utility extrinsic to batch create_asset and register_custom_asset_type.

set_asset_metadata

Fields

ticker: Ticker

key: AssetMetadataKey

value: AssetMetadataValue

detail: Option<AssetMetadataValueDetail<u64>>

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

set_asset_metadata_details

Fields

ticker: Ticker

key: AssetMetadataKey

detail: AssetMetadataValueDetail<u64>

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

register_and_set_local_asset_metadata

Fields

ticker: Ticker

name: AssetMetadataName

spec: AssetMetadataSpec

value: AssetMetadataValue

detail: Option<AssetMetadataValueDetail<u64>>

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

register_asset_metadata_local_type

Fields

ticker: Ticker

name: AssetMetadataName

spec: AssetMetadataSpec

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

register_asset_metadata_global_type

Fields

name: AssetMetadataName

spec: AssetMetadataSpec

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.

redeem_from_portfolio

Fields

ticker: Ticker

value: u128

portfolio: PortfolioKind

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

update_asset_type

Fields

ticker: Ticker

asset_type: AssetType

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

Implementations

impl Call

pub fn as_static_str(&self) -> &'static str

Trait Implementations

impl Clone for Call

fn clone(&self) -> Call

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Call

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

Formats the value using the given formatter.

impl Decode for Call

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

Attempt to deserialise the value from input.

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<'de> Deserialize<'de> for Call

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encode for Call

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

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

fn size_hint(&self) -> usize

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

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

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    F: FnOnce(&[u8]) -> R,

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

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl EnumInfo for Call

fn as_name(&self) -> &'static str

fn as_docs(&self) -> &'static [&'static str]

fn as_short_doc(&self) -> &'static str

impl From<&Call> for &'static str

fn from(v: &Call) -> Self

Converts to this type from the input type.

impl From<Call> for &'static str

fn from(v: Call) -> Self

Converts to this type from the input type.

impl PartialEq<Call> for Call

fn eq(&self, other: &Call) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Call

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl EncodeLike<Call> for Call

impl Eq for Call

impl StructuralEq for Call

impl StructuralPartialEq for Call