@polymeshassociation/polymesh-sdk / api/entities/Asset/NonFungible/NftCollection

Defined in: api/entities/Asset/NonFungible/NftCollection.ts:74

Class used to manage NFT functionality

• BaseAsset

assetHolders: AssetHolders

Defined in: api/entities/Asset/NonFungible/NftCollection.ts:75

compliance: Compliance

Defined in: api/entities/Asset/Base/BaseAsset.ts:71

BaseAsset.compliance

documents: Documents

Defined in: api/entities/Asset/Base/BaseAsset.ts:72

BaseAsset.documents

id: string

Defined in: api/entities/Asset/Base/BaseAsset.ts:79

Unique ID of the Asset in UUID format

BaseAsset.id

metadata: Metadata

Defined in: api/entities/Asset/Base/BaseAsset.ts:73

BaseAsset.metadata

permissions: Permissions

Defined in: api/entities/Asset/Base/BaseAsset.ts:74

BaseAsset.permissions

settlements: NonFungibleSettlements

Defined in: api/entities/Asset/NonFungible/NftCollection.ts:76

uuid: string

Defined in: api/entities/Entity.ts:46

BaseAsset.uuid

get rawId(): string

Defined in: api/entities/Asset/Base/BaseAsset.ts:86

Unique ID of the Asset in hex format

Although UUID format is the usual representation of asset IDs, generic polkadot/substrate tools usually expect it in hex format

string

BaseAsset.rawId

addRequiredMediators(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Asset/Base/BaseAsset.ts:218

Add required mediators. Mediators must approve any trades involving the asset

Parameter	Type
args	AssetMediatorParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

this method is of type ProcedureMethod, which means you can call addRequiredMediators.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

BaseAsset.addRequiredMediators

batchIssue(args, opts?): Promise<GenericPolymeshTransaction<Nft[], Nft[]>>

Defined in: api/entities/Asset/NonFungible/NftCollection.ts:89

Issues mulitple NFTs for the collection

Parameter	Type
args	BatchIssueNftParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<Nft[], Nft[]>>

Each NFT requires metadata for each value returned by collectionKeys. The SDK and chain only validate the presence of these fields. Additional validation may be needed to ensure each value complies with the specification.

this method is of type ProcedureMethod, which means you can call batchIssue.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

collectionKeys(): Promise<CollectionKey[]>

Defined in: api/entities/Asset/NonFungible/NftCollection.ts:202

Retrieve the metadata that defines the NFT collection. Every issue call for this collection must provide a value for each element returned

Promise<CollectionKey[]>

Each NFT must have an entry for each value, it should comply with the spec. In other words, the SDK only validates the presence of metadata keys, additional validation should be used when issuing

controllerTransfer(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Asset/NonFungible/NftCollection.ts:94

Force a transfer from the origin portfolio to one of the caller's portfolios

Parameter	Type
args	NftControllerTransferParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

this method is of type ProcedureMethod, which means you can call controllerTransfer.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

createdAt(): Promise<EventIdentifier | null>

Defined in: api/entities/Asset/NonFungible/NftCollection.ts:291

Retrieve the identifier data (block number, date and event index) of the event that was emitted when the token was created

Promise<EventIdentifier | null>

uses the middlewareV2

there is a possibility that the data is not ready by the time it is requested. In that case, null is returned

currentFundingRound(): Promise<string | null>

Defined in: api/entities/Asset/Base/BaseAsset.ts:505

Retrieve the Asset's funding round

Promise<string | null>

Promise that resolves to the current funding round name or null if not set

BaseAsset.currentFundingRound

currentFundingRound(callback): Promise<UnsubCallback>

Defined in: api/entities/Asset/Base/BaseAsset.ts:515

Retrieve the Asset's funding round

Parameter	Type	Description
callback	SubCallback<string | null>	Callback function that receives funding round updates

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

can be subscribed to, if connected to node using a web socket

BaseAsset.currentFundingRound

details(): Promise<AssetDetails>

Defined in: api/entities/Asset/NonFungible/NftCollection.ts:143

Retrieve the NftCollection's data

Promise<AssetDetails>

Promise that resolves to the NftCollection details

BaseAsset.details

details(callback): Promise<UnsubCallback>

Defined in: api/entities/Asset/NonFungible/NftCollection.ts:153

Retrieve the NftCollection's data

Parameter	Type	Description
callback	SubCallback<AssetDetails>	Callback function that receives NftCollection details updates

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

can be subscribed to, if connected to node using a web socket

BaseAsset.details

exists(): Promise<boolean>

Defined in: api/entities/Asset/NonFungible/NftCollection.ts:314

Determine whether this NftCollection exists on chain

Promise<boolean>

BaseAsset.exists

freeze(opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Asset/Base/BaseAsset.ts:208

Freeze transfers of the Asset

Parameter	Type
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

this method is of type NoArgsProcedureMethod, which means you can call freeze.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

BaseAsset.freeze

getCollectionId(): Promise<BigNumber>

Defined in: api/entities/Asset/NonFungible/NftCollection.ts:333

Returns the collection's on chain numeric ID. Used primarily to access NFT specific storage values

Promise<BigNumber>

getIdentifiers(): Promise<SecurityIdentifier[]>

Defined in: api/entities/Asset/Base/BaseAsset.ts:247

Retrieve the Asset's identifiers list

Promise<SecurityIdentifier[]>

Promise that resolves to the list of security identifiers

BaseAsset.getIdentifiers

getIdentifiers(callback?): Promise<UnsubCallback>

Defined in: api/entities/Asset/Base/BaseAsset.ts:257

Retrieve the Asset's identifiers list

Parameter	Type	Description
callback?	SubCallback<SecurityIdentifier[]>	Callback function that receives identifier updates

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

can be subscribed to, if connected to node using a web socket

BaseAsset.getIdentifiers

getIssuedInFundingRound(fundingRound): Promise<BigNumber>

Defined in: api/entities/Asset/Base/BaseAsset.ts:551

Retrieve the total amount of the Asset issued in the given funding round

Parameter	Type	Description
fundingRound	string	name of the funding round to query

Promise<BigNumber>

BaseAsset.getIssuedInFundingRound

getNft(args): Promise<Nft>

Defined in: api/entities/Asset/NonFungible/NftCollection.ts:267

Get an NFT belonging to this collection

Parameter	Type
args	{ id: BigNumber; }
args.id	BigNumber

Promise<Nft>

if the given NFT does not exist

getRequiredMediators(): Promise<Identity[]>

Defined in: api/entities/Asset/Base/BaseAsset.ts:450

Get required Asset mediators. These Identities must approve any Instruction involving the asset

Promise<Identity[]>

BaseAsset.getRequiredMediators

getTransactionHistory(opts): Promise<ResultSet<HistoricNftTransaction>>

Defined in: api/entities/Asset/NonFungible/NftCollection.ts:360

Retrieve this Collection's transaction history

Parameter	Type
opts	{ size?: BigNumber; start?: BigNumber; }
opts.size?	BigNumber
opts.start?	BigNumber

Promise<ResultSet<HistoricNftTransaction>>

uses the middlewareV2

getVenueFilteringDetails(): Promise<VenueFilteringDetails>

Defined in: api/entities/Asset/Base/BaseAsset.ts:470

Get venue filtering details

Promise<VenueFilteringDetails>

BaseAsset.getVenueFilteringDetails

investorCount(): Promise<BigNumber>

Defined in: api/entities/Asset/NonFungible/NftCollection.ts:245

Retrieve the amount of unique investors that hold this Nft

Promise<BigNumber>

isEqual(entity): boolean

Defined in: api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameter	Type
entity	Entity<unknown, unknown>

boolean

BaseAsset.isEqual

isFrozen(): Promise<boolean>

Defined in: api/entities/Asset/Base/BaseAsset.ts:295

Check whether transfers are frozen for the Asset

Promise<boolean>

Promise that resolves to true if transfers are frozen, false otherwise

BaseAsset.isFrozen

isFrozen(callback): Promise<UnsubCallback>

Defined in: api/entities/Asset/Base/BaseAsset.ts:305

Check whether transfers are frozen for the Asset

Parameter	Type	Description
callback	SubCallback<boolean>	Callback function that receives frozen status updates

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

can be subscribed to, if connected to node using a web socket

BaseAsset.isFrozen

issue(args, opts?): Promise<GenericPolymeshTransaction<Nft[], Nft>>

Defined in: api/entities/Asset/NonFungible/NftCollection.ts:82

Issues a new NFT for the collection

Parameter	Type
args	IssueNftParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<Nft[], Nft>>

Each NFT requires metadata for each value returned by collectionKeys. The SDK and chain only validate the presence of these fields. Additional validation may be needed to ensure each value complies with the specification.

this method is of type ProcedureMethod, which means you can call issue.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

linkTicker(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Asset/Base/BaseAsset.ts:231

Link ticker to the asset

Parameter	Type
args	LinkTickerToAssetParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

if ticker is already reserved, then required role:

• Ticker Owner

this method is of type ProcedureMethod, which means you can call linkTicker.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

BaseAsset.linkTicker

modify(args, opts?): Promise<GenericPolymeshTransaction<Asset, Asset>>

Defined in: api/entities/Asset/Base/BaseAsset.ts:127

Modify some properties of the Asset

Parameter	Type
args	ModifyAssetParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<Asset, Asset>>

if the passed values result in no changes being made to the Asset

if the passed assetType is not a known asset type or a custom type that has not been created on the chain

if trying to modify an NftCollection's assetType

this method is of type ProcedureMethod, which means you can call modify.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

BaseAsset.modify

removeRequiredMediators(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Asset/Base/BaseAsset.ts:223

Remove required mediators

Parameter	Type
args	AssetMediatorParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

this method is of type ProcedureMethod, which means you can call removeRequiredMediators.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

BaseAsset.removeRequiredMediators

setVenueFiltering(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Asset/Base/BaseAsset.ts:108

Enable/disable venue filtering for this Asset and/or set allowed/disallowed venues

Parameter	Type
args	SetVenueFilteringParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

this method is of type ProcedureMethod, which means you can call setVenueFiltering.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

BaseAsset.setVenueFiltering

toHuman(): string

Defined in: api/entities/Asset/Base/BaseAsset.ts:594

Return the BaseAsset's ID

string

BaseAsset.toHuman

transferOwnership(args, opts?): Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>

Defined in: api/entities/Asset/Base/BaseAsset.ts:103

Transfer ownership of the Asset to another Identity. This generates an authorization request that must be accepted by the recipient

Parameter	Type
args	TransferAssetOwnershipParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>

the signing Identity must be an agent of this Asset holding asset.acceptAssetOwnershipTransfer permission — granted by TxGroup.AdvancedAssetManagement or PermissionGroupType.Full. The chain checks this when the target accepts, against the Identity that created the Authorization Request, so an offer sent without it can never be accepted

this will create Authorization Request which has to be accepted by the target Identity. An api/entities/Account!Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived. Also, an Account or Identity can directly fetch the details of an Authorization Request by calling authorizations.getOne

this method is of type ProcedureMethod, which means you can call transferOwnership.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

BaseAsset.transferOwnership

unfreeze(opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Asset/Base/BaseAsset.ts:213

Unfreeze transfers of the Asset

Parameter	Type
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

this method is of type NoArgsProcedureMethod, which means you can call unfreeze.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

BaseAsset.unfreeze

unlinkTicker(opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Asset/Base/BaseAsset.ts:240

Unlink ticker from the Asset

Parameter	Type
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

Only the ticker owner is allowed to unlink the Asset

if there is no ticker to unlink

this method is of type NoArgsProcedureMethod, which means you can call unlinkTicker.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

BaseAsset.unlinkTicker

static generateUuid<Identifiers>(identifiers): string

Defined in: api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type Parameter
Identifiers

Parameter	Type	Description
identifiers	Identifiers	-

string

BaseAsset.generateUuid

static unserialize<Identifiers>(serialized): Identifiers

Defined in: api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type Parameter
Identifiers

Parameter	Type	Description
serialized	string	UUID to unserialize

Identifiers

BaseAsset.unserialize