🗃️ Retrieve Token Type

To detect if an asset is a Token, an NFT or a Collection, we can check the value stored in the LSP4TokenType data key.

This guide show you how to retrieve the token type of a deployed token contract using the getData(...) function, passing the LSP4TokenType data key as a parameter.

We will show you example with 3 different libraries: erc725.js, web3.js and ethers.js

Introduction

Token Types are beneficial because of the wide range of asset use cases. The LSP7 and LSP8 can both be used as NFTs.

• LSP7 can be used for building NFTs where each individual items have the same metadata, and users are allowed to mint multiple NFTs at once.
• In comparison, LSP8 is mainly used for NFTs with unique properties per item (like phygitals, dynamic NFTs or unique collections like Chillwhales).

Convenience Tools

You can use the ⚒️ erc725.js library, which automatically decodes ERC725Y storage keys for you.

If you are using a regular contract instance from Ethers or Web3, you can use the data keys from the lsp-smart-contracts library by importing the ERC725YDataKeys constant.

erc725.js

npm install @erc725/erc725.js

ethers

npm install ethers @lukso/lsp-smart-contracts

web3

npm install web3 @lukso/lsp-smart-contracts

Retrieve the Token Type

After setting up the contract, retrieving its token type is as simple as making one contract call to the getData(...) function.

erc725.js

import { ERC725 } from '@erc725/erc725.js';
import lsp4Schema from '@erc725/erc725.js/schemas/LSP4DigitalAsset.json';

const myAsset = new ERC725(
  lsp4Schema,
  '<myAssetAddress>', // Your Asset Address
  'https://4201.rpc.thirdweb.com', // LUKSO Testnet RPC
  {},
);

// Retrieve the token type
const tokenType = await myAsset.getData('LSP4TokenType');
console.log(tokenType);
// 0 = Token
// 1 = NFT
// 2 = Collection

ethers

import { ethers } from 'ethers';

// Import LSP4 Token ABI. LSP4 is inherited by both LSP7 and LSP8.
// LSP4 represents the metadata storage of the token contract and contains the functions to get and set data.
// Since we are only using the `getData(...)` function, we only need the LSP4 ABI.
import LSP4Artifact from '@lukso/lsp-smart-contracts/artifacts/LSP4DigitalAssetMetadata.json';
import { ERC725YDataKeys } from '@lukso/lsp-smart-contracts';

// Connect provider to LUKSO Testnet
const provider = new ethers.JsonRpcProvider('https://4201.rpc.thirdweb.com');

// Create contract instance
const myAssetContract = new ethers.Contract(
  '<myAssetAddress>',
  LSP4Artifact.abi,
  provider,
);

// Retrieve the token type (this will be abi-encoded)
const tokenTypeEncoded = await myAssetContract.getData(
  ERC725YDataKeys.LSP4.LSP4TokenType,
);

// Decode from abi-encoded uint256 to a number
// e.g: 0x0000...0002 -> 2
const abiCoder = ethers.AbiCoder.defaultAbiCoder();

const tokenType = abiCoder.decode(['uint256'], tokenTypeEncoded);
console.log(tokenType);
// 0 = Token
// 1 = NFT
// 2 = Collection

web3

import Web3 from 'web3';

// Import LSP4 Token ABI. LSP4 is inherited by both LSP7 and LSP8.
// LSP4 represents the metadata storage of the token contract and contains the functions to get and set data.
// Since we are only using the `getData(...)` function, we only need the LSP4 ABI.
import LSP4Artifact from '@lukso/lsp-smart-contracts/artifacts/LSP4DigitalAssetMetadata.json';
import { ERC725YDataKeys } from '@lukso/lsp-smart-contracts';

// Connect provider to LUKSO Testnet
const web3 = new Web3(
  new Web3.providers.HttpProvider('https://4201.rpc.thirdweb.com'),
);

// Create contract instance
const myAssetContract = new web3.eth.Contract(
  LSP4Artifact.abi,
  '<myAssetAddress>',
);

// Retrieve the token type
const tokenTypeValue = await myAssetContract.methods.getData(
  ERC725YDataKeys.LSP4.LSP4TokenType,
);

// Decode from abi-encoded uint256 to a number
// e.g: 0x0000...0002 -> 2
const tokenType = web3.eth.abi.decodeParameter('uint256', tokenTypeValue);
console.log(tokenType);
// 0 = Token
// 1 = NFT
// 2 = Collection