Skip to main content
Version: 24.2.x

Interface: CreateAssetWithTickerParams

api/procedures/types.CreateAssetWithTickerParams

Hierarchy

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:621


documents

Optional documents: AssetDocument[]

Inherited from

CreateAssetParams.documents

Defined in

api/procedures/types.ts:630


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:629


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

Inherited from

CreateAssetParams.initialStatistics

Defined in

api/procedures/types.ts:644


initialSupply

Optional initialSupply: BigNumber

amount of Asset tokens that will be minted on creation (optional, default doesn't mint)

Inherited from

CreateAssetParams.initialSupply

Defined in

api/procedures/types.ts:607


isDivisible

isDivisible: boolean

whether a single Asset token can be divided into decimal parts

Inherited from

CreateAssetParams.isDivisible

Defined in

api/procedures/types.ts:615


name

name: string

Inherited from

CreateAssetParams.name

Defined in

api/procedures/types.ts:603


portfolioId

Optional portfolioId: BigNumber

portfolio to which the Asset tokens will be issued on creation (optional, default is the default portfolio)

Inherited from

CreateAssetParams.portfolioId

Defined in

api/procedures/types.ts:611


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

api/procedures/types.ts:625


ticker

ticker: string

Defined in

api/procedures/types.ts:648