Interface: CreateNftCollectionParams
Defined in: src/api/procedures/types.ts:727
Properties
assetId?
optionalassetId:string
Defined in: src/api/procedures/types.ts:734
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
collectionKeys
collectionKeys:
CollectionKeyInput[]
Defined in: src/api/procedures/types.ts:763
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?
optionaldocuments:AssetDocument[]
Defined in: src/api/procedures/types.ts:767
Links to off chain documents related to the NftCollection
fundingRound?
optionalfundingRound:string
Defined in: src/api/procedures/types.ts:772
A optional field that can be used to provide information about the funding state of the asset
name?
optionalname:string
Defined in: src/api/procedures/types.ts:747
The collection name. defaults to ticker
nftType
nftType:
string|BigNumber
Defined in: src/api/procedures/types.ts:752
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?
optionalsecurityIdentifiers:SecurityIdentifier[]
Defined in: src/api/procedures/types.ts:756
array of domestic or international alphanumeric security identifiers for the Asset (e.g. ISIN, CUSIP, FIGI)
ticker?
optionalticker:string
Defined in: src/api/procedures/types.ts:743
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