Interface: CreateAssetWithTickerParams
api/procedures/types.CreateAssetWithTickerParams
Hierarchy
-
↳
CreateAssetWithTickerParams
Properties
assetType
• assetType: string | BigNumber
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. If using a custom type, it can be provided as a string (representing name) or a BigNumber (representing the custom type ID).
Inherited from
Defined in
documents
• Optional documents: AssetDocument[]
Inherited from
Defined in
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
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 can 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 need to create a stat for an Asset after creation, you can use the TransferRestrictions.setStats method in the TransferRestrictions namespace.
Inherited from
CreateAssetParams.initialStatistics
Defined in
initialSupply
• Optional initialSupply: BigNumber
Amount of Asset tokens to be minted on creation (optional; by default, no tokens are minted).
Inherited from
CreateAssetParams.initialSupply
Defined in
isDivisible
• isDivisible: boolean
Whether a single Asset token can be divided into decimal parts.
Inherited from
Defined in
name
• name: string
Inherited from
Defined in
portfolioId
• Optional portfolioId: BigNumber
Portfolio to which the Asset tokens will be issued on creation (optional; defaults to the default portfolio).
Inherited from
Defined in
securityIdentifiers
• Optional securityIdentifiers: SecurityIdentifier[]
Array of domestic or international alphanumeric security identifiers for the Asset (e.g., ISIN, CUSIP, FIGI).
Inherited from
CreateAssetParams.securityIdentifiers
Defined in
ticker
• Optional ticker: string
(optional) ticker to be linked with the Asset
Note
from 7.x chain, ticker has been made optional. For 6.x chain, it is still mandatory.