v0.4.0

Version 0.4.0 - 3/8/25, 12:51 AM

Changes

Feat

• sdk: generate minimal clients from cleaned ARC56 specs (#8) (52da480) by @drichar

Docs

• sdk: enhance package README with detailed usage examples (#7) (c1ff2f1) by @drichar

Packages

• @txnlab/nfd-sdk@0.4.0

v0.3.1

Version 0.3.1 - 3/5/25, 8:46 AM

Changes

Refactor

• sdk: reorganize utility functions into public/internal (#6) (bdb9ec8) by @drichar

Docs

• fix JSON example in versioning section (#5) (54d2b1c) by @drichar
• add versioning section and fix code examples (#4) (6814e00) by @drichar
• add user-friendly examples to root README (#3) (7a32987) by @drichar

Packages

• @txnlab/nfd-sdk@0.3.1

v0.3.0

Version 0.3.0 - 3/5/25, 6:08 AM

Changes

Feat

• sdk: export NfdApiClient and enhance reverseLookup (#2) (8a06c64) by @drichar

Packages

• @txnlab/nfd-sdk@0.3.0

v0.2.0

Version 0.2.0 - 3/4/25, 3:25 PM

Changes

Feat

• sdk: add NfdManager w/ linkAddress and setMetadata (#1) (87ffbb0) by @drichar

Ci

• workflows: consolidate CI and publish workflows (b2e170f) by @drichar

Docs

• readme: add direct link to contributing guidelines (6c817eb) by @drichar
• contributing: add CONTRIBUTING.md with development guidelines (bd47705) by @drichar

Packages

• @txnlab/nfd-sdk@0.2.0

v0.1.0

@txnlab/nfd-sdk v0.1.0

We're excited to announce the first official release of the NFD SDK! This JavaScript/TypeScript SDK provides developers with a comprehensive set of tools for interacting with NFDomains (NFDs) directly on the Algorand blockchain and via API.

Overview

The NFD SDK enables seamless integration with NFDomains, Algorand's domain name service, allowing developers to resolve domain names, fetch NFD records, perform searches, and interact with NFD smart contracts.

Features

Core Functionality

• Domain Resolution: Resolve NFD names (e.g., name.algo) to their corresponding Algorand addresses and application IDs
• Record Fetching: Retrieve comprehensive NFD records with various view types (tiny, brief, or full) to optimize network requests
• NFD Minting: Support for minting new NFDs directly through the SDK
• Reverse Lookup: Find NFDs associated with specific Algorand addresses
• Search Capabilities: Search for NFDs based on various criteria including name, category, state, traits, and more
• Smart Contract Integration: Direct interaction with NFD smart contracts on the Algorand blockchain

Coming Soon

• Address Management: Link and manage Algorand addresses associated with NFDs
• Primary NFD Management: Set and manage primary NFDs for addresses
• Additional NFD Transactions: Support for field updates and marketplace operations

Technical Details

• Built with TypeScript for strong typing and developer experience
• Compatible with ESM and CommonJS module systems
• Minimal dependencies, focusing on core Algorand libraries
• Comprehensive type definitions for all NFD data structures
• Generated clients for interacting with NFD smart contracts using ARC-56 specifications

Getting Started

# Install with your preferred package manager
npm install @txnlab/nfd-sdk
# or
yarn add @txnlab/nfd-sdk
# or
pnpm add @txnlab/nfd-sdk

Basic usage:

import { NfdClient } from '@txnlab/nfd-sdk'

// Initialize the client
const client = new NfdClient()

// Resolve an NFD
const nfd = await client.resolve('example.algo')
console.log(nfd)

Examples

Check out our example applications in the repository to see the SDK in action:

• Resolve Example: A simple React application demonstrating NFD resolution
• Minting Example: Example showing how to mint new NFDs using the SDK
• More examples coming soon!

Documentation

Full API documentation website coming soon.

Packages

• @txnlab/nfd-sdk@0.1.0