Display user inventories

At the core of all Web3 games is the concept of true asset ownership. It is therefore critical for games and marketplaces to offer users a complete and up-to-date view of the assets they own. Immutable provides a variety of tools to help with this.

Game currencies​

These are fungible tokens (ERC20) that provide a store of value and allow users to purchase other items. An example of this kind of token is $IMX.

To learn how to create these tokens, see our In-game currencies guide.

Use Checkout Wallet Widget (web-based applications)​

The Checkout Wallet Widget is a drop-in solution for web-based games and marketplaces that simplifies the process of checking wallet balances on the Immutable zkEVM and Ethereum networks. Read the docs to learn how to integrate it.

Bring your own UI​

For applications that wish to display their own custom UI for currency balances, we recommend directly querying on-chain state for the latest data. You'll need to periodically poll these balances to keep them up to date.

You will need to have an existing project, then do the following.

const passportProvider = passport.connectEvm();

const accounts = await provider.request({ method: "eth_requestAccounts" });

import { ethers } from 'ethers';

const passportProvider = passport.connectEvm();

const provider = new ethers.providers.Web3Provider(passportProvider);

const signer = provider.getSigner();
const address = await signer.getAddress();

const provider = passport.connectEvm();
const accounts = await provider.request({ method: "eth_requestAccounts" });

npm install ethers

const ethers = require('ethers'); // ethers v5

const provider = ethers.getDefaultProvider('mainnet'); // Specifying 'mainnet' allows you to query the Ethereum blockchain. Change to other network if required.

// Check if MetaMask is installed and available in the browser
if (typeof window.ethereum !== 'undefined') {
  // Use the injected provider from MetaMask
  const provider = new ethers.providers.Web3Provider(window.ethereum);

  // Create a wallet instance using MetaMask's Ethereum account
  const wallet = provider.getSigner();

  // Now you can use the 'wallet' instance to interact with the Ethereum network.
} else {
  console.log("MetaMask not detected. Please install MetaMask to interact with the Ethereum network.");
}

async function getTokenBalances() {
  // Replace 'tokenContractAddresses' with an array of ERC20 token contract addresses you want to query
  const tokenContractAddresses = ['TOKEN_1_ADDRESS', 'TOKEN_2_ADDRESS', '...'];

  for (const tokenAddress of tokenContractAddresses) {
    const tokenContract = new ethers.Contract(tokenAddress, TOKEN_ABI, provider);
    const balance = await tokenContract.balanceOf(wallet.address);
    console.log(`Token Balance for ${tokenAddress}: ${balance.toString()}`);
  }
}

getTokenBalances();

NFTs​

Most Web3 game items are unique, non-fungible tokens (NFTs). Immutable's Blockchain Data APIs indexes blockchain activity so you can do the following:

1. Query for specific data
2. Continuously poll for data on all activities

On Immutable, blockchain assets can have metadata stored both on and off chain. See our Metadata docs to learn more about this.

Query for specific data​

Check out our Blockchain Data guides for how to query different types of asset and collection data, including getting data on:

• NFTs
• ERC20 Tokens
• Collections
• Activities

Poll for activity data​

Use our Blockchain Data Activities endpoint to get data on all events in order to provide your users with the most up to date information when available.

We recommend polling at a frequency of no more than 3 seconds to avoid throttling.