api.procedures.types.CreateAssetWithTickerParams - PolymeshAssociation/polymesh-sdk GitHub Wiki

Interface: CreateAssetWithTickerParams

api/procedures/types.CreateAssetWithTickerParams

Hierarchy

CreateAssetParams

↳ CreateAssetWithTickerParams

Properties

assetType

• assetType: string

type of security that the Asset represents (e.g. Equity, Debt, Commodity). Common values are included in the KnownAssetType enum, but custom values can be used as well. Custom values must be registered on-chain the first time they're used, requiring an additional transaction. They aren't tied to a specific Asset

Inherited from

CreateAssetParams.assetType

Defined in

api/procedures/types.ts:668

documents

• Optional documents: AssetDocument[]

Inherited from

CreateAssetParams.documents

Defined in

api/procedures/types.ts:677

fundingRound

• Optional fundingRound: string

(optional) funding round in which the Asset currently is (e.g. Series A, Series B)

Inherited from

CreateAssetParams.fundingRound

Defined in

api/procedures/types.ts:676

initialStatistics

• Optional initialStatistics: InputStatType[]

(optional) type of statistics that should be enabled for the Asset

Enabling statistics allows for TransferRestrictions to be made. For example the SEC requires registration for a company that has either more than 2000 investors, or more than 500 non accredited investors. To prevent crossing this limit two restrictions are needed, a Count of 2000, and a ScopedCount of non accredited with a maximum of 500. source

These restrictions require a Count and ScopedCount statistic to be created. Although they an be created after the Asset is made, it is recommended to create statistics before the Asset is circulated. Count statistics made after Asset creation need their initial value set, so it is simpler to create them before investors hold the Asset. If you do need to create a stat for an Asset after creation, you can use the enableStat method in the appropriate namespace