api.procedures.createAsset.CreateAssetParams

Interface: CreateAssetParams

api/procedures/createAsset.CreateAssetParams

Hierarchy

• CreateAssetParams

  ↳ CreateAssetWithTickerParams

Table of contents

Properties

• assetType
• documents
• fundingRound
• initialSupply
• isDivisible
• name
• requireInvestorUniqueness
• securityIdentifiers

Properties

assetType

• assetType: string

type of security that the Asset represents (i.e. Equity, Debt, Commodity, etc). 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

api/procedures/createAsset.ts:45

---

documents

• Optional documents: AssetDocument[]

Defined in

api/procedures/createAsset.ts:54

---

fundingRound

• Optional fundingRound: string

(optional) funding round in which the Asset currently is (Series A, Series B, etc)

Defined in

api/procedures/createAsset.ts:53

---

initialSupply

• Optional initialSupply: BigNumber

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

Defined in

api/procedures/createAsset.ts:35

---

isDivisible

• isDivisible: boolean

whether a single Asset token can be divided into decimal parts

Defined in

api/procedures/createAsset.ts:39

---

name

• name: string

Defined in

api/procedures/createAsset.ts:31

---

requireInvestorUniqueness

• requireInvestorUniqueness: boolean

whether this asset requires investors to have a Investor Uniqueness Claim in order to hold it. More information about Investor Uniqueness and PUIS here

Defined in

api/procedures/createAsset.ts:59

---

securityIdentifiers

• Optional securityIdentifiers: SecurityIdentifier[]

array of domestic or international alphanumeric security identifiers for the Asset (ISIN, CUSIP, FIGI, etc)

Defined in

api/procedures/createAsset.ts:49