api.procedures.types.CreateNftCollectionParams

Interface: CreateNftCollectionParams

api/procedures/types.CreateNftCollectionParams

Table of contents

Properties

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

Properties

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

---

documents

• Optional documents: AssetDocument[]

Links to off chain documents related to the NftCollection

Defined in

api/procedures/types.ts:706

---

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

---

name

• Optional name: string

The collection name. defaults to ticker

Defined in

api/procedures/types.ts:686

---

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

---

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

---

ticker

• ticker: string

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

Defined in

api/procedures/types.ts:682