api.procedures.types.CreateAssetParams - PolymeshAssociation/polymesh-sdk GitHub Wiki
Interface: CreateAssetParams
api/procedures/types.CreateAssetParams
Hierarchy
-
CreateAssetParams
Table of contents
Properties
- assetType
- documents
- fundingRound
- initialStatistics
- initialSupply
- isDivisible
- name
- portfolioId
- securityIdentifiers
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
Defined in
documents
• Optional documents: AssetDocument[]
Defined in
fundingRound
• Optional fundingRound: string
(optional) funding round in which the Asset currently is (e.g. Series A, Series B)
Defined in
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
Defined in
initialSupply
• Optional initialSupply: BigNumber
amount of Asset tokens that will be minted on creation (optional, default doesn't mint)
Defined in
isDivisible
• isDivisible: boolean
whether a single Asset token can be divided into decimal parts
Defined in
name
• name: string
Defined in
portfolioId
• Optional portfolioId: BigNumber
portfolio to which the Asset tokens will be issued on creation (optional, default is the default portfolio)
Defined in
securityIdentifiers
• Optional securityIdentifiers: SecurityIdentifier[]
array of domestic or international alphanumeric security identifiers for the Asset (e.g. ISIN, CUSIP, FIGI)