ElvClient/NFT

Methods for creating and managing NFTs

Source:

Methods

static CollectionTransactions({
tenantId,
collectionId,
filterOptionsoptional
})

Retrieve information about transactions for the specified collection

Returns:

Promise<Array> - A list of transactions matching the specified filters.

Parameters:
Name Type Attributes Default Description
tenantId string

The ID of the tenant
collectionId string

The ID of the NFT collection containing the NFT
filterOptions Object <optional>
 {}

Options for filtering transactions

Properties
Name Type Attributes Description
email string <optional>

Filter transactions by email.
transactionId string <optional>

Filter transactions by transaction ID.
max string <optional>

The maximum number of transactions to return. Default is 500.
status string <optional>
  • Filter transactions by status. Allowed statuses are 'complete', 'failed' and (empty), meaning unprocessed.
fromOrdinal string <optional>

The internal transaction ordinal to start from. Note that negative values are supported and are interpreted as meaning 'from the last current transaction'. Default is 0 - i.e. the beginning.
Source:

static MintNFT({
tenantId,
addressoptional,
marketplaceId,
items,
extraDataoptional
})

Mint NFTs for the specified user

Returns:

Promise - An object containing the address for whom the NFT was minted and the transactionId of the minting request.

Parameters:
Name Type Attributes Default Description
tenantId string

The ID of the tenant
address string <optional>

The address of the NFT recipient
marketplaceId string

The ID of the marketplace containing the NFT
items Array.<Object>

List of items

Properties
Name Type Attributes Default Description
sku string

SKU of the NFT
quantity number <optional>
 1

Number to mint
tokenId string | Array.<string> <optional>

Custom token IDs for these items (must be unique).
extraData Object <optional>
 {}

Additional data to put in the transaction
extraData Object <optional>
 {}

Additional data to put in the transaction
Source: