Manage NFT

Methods related to NFTs data collection.

Retrieve owned NFTs for a user

Retrieve the NFTs owned by a user in the wallet associated.

Method

wallet.smartAsset.getOwned(onlyFromBrands?, i18nStrategy?:useLanguages)
ParameterTypeRequiredDescription
languageen-US, fr-FR...❌Language(s) returned in order of preference.
onlyFromBrandsString[]❌Allows to return NFTs owned by the user and issued by the issuer's identity only.

Return Payload

promise returns an array with the NFT's information.

ParameterDescription
ArianeeProductCertificateI18NNFT Schema.
BlockchainEvent[]Gathering of transaction events of the token recorded on the blockchain.
Event[]Event Schema.
[
	{
    data: {
      certificateId: '58824256',
      content: ArianeeProductCertificateI18N,
      rawContent: ArianeeProductCertificateI18N,
      blockchainEvents: BlockchainEvent[],
      imprint: '0xce917f8d652187e7bf162b2c05d4b5439cef04142795eb6e5d2283b6193b8e88',
      isAuthentic: true,
      isRequestable: false,
      issuer: '0x90d181a3e977E8CcD7822B711Bb3A83E79beaEFF',
      owner: '0xa9bc90d24d0b8495043ab5857455444630028caf',
      protocol: { name: "testnet"; chainId: 77 }
    },
    arianeeEvents: Event[]
  }
]

Retrieve NFT from ID

Retrieve a specific NFT.

Method

wallet.smartAsset.get(protocol, {id: nftId, passphrase?: passphrase}, i18nStrategy?:useLanguages)
ParameterTypeRequiredDescription
nftIdNumberβœ…Identification number of the NFT.
passphraseString❌A passphrase of the NFT.
Param optional is you are the owner of the NFT.
protocolmainnet or testnetβœ…Blockchain network of the NFT ID.
languageen-US, fr-FR...❌Language(s) returned in order of preference.

Result: promise returns an object with the NFT information.

ParameterDescription
ArianeeProductCertificateI18NNFT Schema.
BlockchainEvent[]Gathering of transaction events of the token recorded on the blockchain.
Event[]Event Schema.
{
    data: {
      certificateId: '58824256',
      content: ArianeeProductCertificateI18N,
      rawContent: ArianeeProductCertificateI18N,
      blockchainEvents: BlockchainEvent[],
      imprint: '0xce917f8d652187e7bf162b2c05d4b5439cef04142795eb6e5d2283b6193b8e88',
      isAuthentic: true,
      isRequestable: false,
      issuer: '0x90d181a3e977E8CcD7822B711Bb3A83E79beaEFF',
      owner: '0xa9bc90d24d0b8495043ab5857455444630028caf',
      protocol: { name: "testnet"; chainId: 77 }
    },
    arianeeEvents: Event[]
  }

Retrieve NFT from the link

Retrieve the content and data from the deep link of a specific NFT.

Method

wallet.smartAsset.getFromLink(link, resolveFinalNft?, i18nStrategy?)
ParameterTypeRequiredDescription
linkStringβœ…Deeplink of the NFT β†’ https://arian.ee/tokenId,passphrase
resolveFinalNftBooleanβœ…- true: try to add the Arianee Access Token in the request.

- false: get the landing NFT.
languageen-US, fr-FR...❌Language(s) returned in order of preference.

Return Payload

promise returns an object with the NFT information.

ParameterDescription
ArianeeProductCertificateI18NNFT Schema.
BlockchainEvent[]Gathering of transaction events of the token recorded on the blockchain.
Event[]Event Schema.
{
    data: {
      certificateId: '58824256',
      content: ArianeeProductCertificateI18N,
      rawContent: ArianeeProductCertificateI18N,
      blockchainEvents: BlockchainEvent[],
      imprint: '0xce917f8d652187e7bf162b2c05d4b5439cef04142795eb6e5d2283b6193b8e88',
      isAuthentic: true,
      isRequestable: false,
      issuer: '0x90d181a3e977E8CcD7822B711Bb3A83E79beaEFF',
      owner: '0xa9bc90d24d0b8495043ab5857455444630028caf',
      protocol: { name: "testnet"; chainId: 77 }
    },
    arianeeEvents: Event[]
  }

Create ownership request link

Method

wallet.smartAsset.createRequestLink(network, tokenId, passphrase?)
ParameterTypeRequiredDescription
networkStringβœ…Network of the NFT.
tokenIdNumberβœ…Arianee token ID of the NFT.
passphraseStringβœ…Token request passphrase.
This param is optional if you are the NFT owner.
const wallet = new Wallet({ chainType: 'mainnet' });
const nft = await wallet.smartAsset.getOwned();
const proofLink = await nft[0].createProofLink();

Return Payload

The ownership link is returned.


Claim NFT

Method

wallet.smartAsset.claim(network, tokenId, passphrase, receiver?)
ParameterTypeRequiredDescription
networkStringβœ…Network of the NFT.
tokenIdNumberβœ…Arianee token ID of the NFT.
passphraseStringβœ…Token request passphrase.
This param is optional if you are the NFT owner.
receiverString❌Recipient wallet of the NFT.
const wallet = new Wallet({ chainType: 'mainnet' });
const nft = await wallet.smartAsset.getFromLink("https://test.arian.ee/762482926,bnj9vdx3kbhj");
await nft.claim();

Return Payload

The transaction request is sent to the blockchain.

Get started with Arianee's recipe πŸš€


Transfer NFT

Transfer an NFT from the owner's wallet to another.

Method

wallet.smartAsset.transfer(receiver: string)
ParameterTypeRequiredDescription
receiverStringβœ…The wallet address of the receiver.

Return Payload

promise returns the transaction receipt.