Interface: CreateNftCollectionParams
api/procedures/types.CreateNftCollectionParams
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
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
documents
• Optional documents: AssetDocument[]
Links to off chain documents related to the NftCollection
Defined in
fundingRound
• Optional fundingRound: string
A optional field that can be used to provide information about the funding state of the asset
Defined in
name
• Optional name: string
The collection name. defaults to ticker
Defined in
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
securityIdentifiers
• Optional securityIdentifiers: SecurityIdentifier[]
array of domestic or international alphanumeric security identifiers for the Asset (e.g. ISIN, CUSIP, FIGI)
Defined in
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