⛏️fetchMetadata

Description

The fetchMetaDatafunction retrieves metadata associated with a given IPFS hash. It sends a GET request to the IPFS gateway to fetch the metadata and returns it as a response.

Parameters

Parameter
Type
Description

ipfsHash

string

The IPFS hash associated with the metadata

Response

Property
Type
Description

data

object

The metadata object retrieved from the IPFS gateway

Example Request and Response

Prerequisites

Before making requests with Nest SDK, you must have it installed.

You can install Nest SDK using either npm or yarn. Use the following commands to install Nest SDK:

npm install @nest25/storage-lib
OR
yarn add @nest25/storage-lib

Request

Here is an example of how to make a fetchMetaData request using the Nest SDK:

// import Nest SDK library
const { StorageLibrary } = require('@nest25/storage-lib');
// create an instance of the storage library
const storageLibrary = new StorageLibrary();

async function main() {
  // fetch metadata from ipfs hash and print it
  const ipfsHash = await storageLibrary.fetchMetadata('Qme6nVQjNfnrbFiZ5VFgbjvVL21xATkmH1gQWiQxtKJ6JY');
  console.log(ipfsHash);
}
main();

Response

{ res: { name: 'test', age: 30 } }

Use Cases

  • NFT Marketplaces: The function can be used by NFT marketplaces to retrieve metadata for NFTs stored on IPFS.

  • DApps: The function can be used by decentralized applications to retrieve metadata stored on IPFS.

  • DeFi Platforms: The function can be used by DeFi platforms to retrieve metadata for various assets stored on IPFS.

Last updated