Skip to content

Latest commit

 

History

History

README.md

NFD SDK Examples

This directory contains example applications demonstrating various features of the NFD SDK.

Available Examples

  • Resolve: Demonstrates how to resolve NFD names and application IDs
  • Lookup-only: Minimal Node script using the slim @txnlab/nfd-sdk/lookup entry for forward and on-chain reverse resolution
  • NFD Metadata: Demonstrates how to resolve avatar and banner images with IPFS support
  • API Search: Demonstrates how to use the API client to search for NFDs
  • Reverse Lookup: Demonstrates how to look up NFDs by wallet address
  • Mint: Demonstrates how to mint NFDs
  • Claim NFD: Demonstrates how to claim NFDs reserved for your wallet address
  • Link Address: Demonstrates how to link addresses to NFDs
  • Set Metadata: Demonstrates how to set metadata for NFDs
  • Set Primary NFD: Demonstrates how to set a primary NFD for an address

Getting Started

Each example is a standalone application with its own README.md file containing specific instructions.

In general, you can run any example by:

cd examples/<example-name>
pnpm install
pnpm dev