api.procedures.types.CreateNftCollectionParams

Interface: CreateNftCollectionParams

api/procedures/types.CreateNftCollectionParams

Table of contents

Properties

• assetId
• collectionKeys
• documents
• fundingRound
• name
• nftType
• securityIdentifiers
• ticker

Properties

assetId

• Optional assetId: string

The ID of the asset to be used to create the collection. If no assetId is provided, a new asset with NonFungible asset type will be created

Note

for spec version before 7.x, this value is overwritten by ticker value

Defined in

api/procedures/types.ts:738

---

collectionKeys

• collectionKeys: CollectionKeyInput[]

The required metadata values each NFT in the collection will have

Note

Images — Most Polymesh networks (mainnet, testnet, etc.) have global metadata keys registered to help standardize displaying images If imageUri is specified as a collection key, then each token will need to be issued with an image URI.

Defined in

api/procedures/types.ts:767

---

documents

• Optional documents: AssetDocument[]

Links to off chain documents related to the NftCollection

Defined in

api/procedures/types.ts:771

---

fundingRound

• Optional fundingRound: string

A optional field that can be used to provide information about the funding state of the asset

Defined in

api/procedures/types.ts:776

---

name

• Optional name: string

The collection name. defaults to ticker

Defined in

api/procedures/types.ts:751

---

nftType

• nftType: string | BigNumber

Throws

if provided string that does not have a custom type

Throws

if provided a BigNumber that does not correspond to a custom type

Defined in

api/procedures/types.ts:756

---

securityIdentifiers

• Optional securityIdentifiers: SecurityIdentifier[]

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

Defined in

api/procedures/types.ts:760

---

ticker

• Optional ticker: string

The primary identifier for the collection. The ticker must either be free, or the signer has appropriate permissions if reserved.

Since spec version 7.x, this value (if provided) is then linked to assetId asset

Note

This value is mandatory for spec version before 7.x

Defined in

api/procedures/types.ts:747