@startupdotdev/forever721 v1.0.4

Forever721

Tool to analyze NFT metadata.

Why this tool?

While the NFTs themselves may be permanently stored on the blockchain, there are many cases where NFT metadata content can change.

For example: some NFTs' metadata point to random private HTTP URLs and servers which could change the contents or go down at any time. Other NFTs point to IPFS URLs, which is much better but there is still risk of that content becoming unpinned and being discarded from IPFS as well.

This tool analyzes NFT metadata and gives a letter grade (A-F) to its durability as well as the reasons for that grade.

Usage

Basic Usage

import { analyzeTokenUri } from '@startupdotdev/forever721';

let metaData : JSON | ipfs url | url;
analyzeTokenUri(metaData);

Handled metadata structures:

• Top-level IPFS
• Top-level IPFS pinning service
• Top-level base64 encoded json
• Top-level some random server
• Top-level JSON

Within each top-level data structure, handles:

• Base64 on-chain

• IPFS

  • Image stored on another IPFS
  • Image stored on rando server

• Http

  • Image stored on IPFS
  • Image stored on HTTP

Development

Node version

Note: this project uses the experimental native fetch in Node 17.

$ nvm install 17.8.0 --experimental-fetch

$ npm i
$ npm test

Questions

• Can we know if an IPFS item is pinned?

Future development

Some extra edge cases to handle:

• IPFS top-level metadtaa

  • Image stored on that IPFS hash

• Http top-level metadata

  • Image stored as base64

• JSON top-level metadata

  • Image stored as base64
  • Image stored on IPFS
  • Image stored on HTTP

Contributing

Submit a PR (with tests!) for formats/edge cases we're missing!