Interface: CreateNftCollectionParams

Defined in: src/api/procedures/types.ts:871

Properties

assetId?

optional assetId?: string

Defined in: src/api/procedures/types.ts:876

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

---

collectionKeys

collectionKeys: CollectionKeyInput[]

Defined in: src/api/procedures/types.ts:903

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.

---

documents?

optional documents?: AssetDocument[]

Defined in: src/api/procedures/types.ts:907

Links to off chain documents related to the NftCollection

---

fundingRound?

optional fundingRound?: string

Defined in: src/api/procedures/types.ts:912

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

---

name?

optional name?: string

Defined in: src/api/procedures/types.ts:887

The collection name. defaults to ticker

---

nftType

nftType: string | BigNumber

Defined in: src/api/procedures/types.ts:892

Throws

if provided string that does not have a custom type

Throws

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

---

securityIdentifiers?

optional securityIdentifiers?: SecurityIdentifier[]

Defined in: src/api/procedures/types.ts:896

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

---

ticker?

optional ticker?: string

Defined in: src/api/procedures/types.ts:883

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

This value (if provided) is then linked to the assetId asset.