arc56-generated-txnlab-nfd-sdk

Auto-generated typed Algorand smart-contract clients for TxnLab/nfd-sdk, built from the ARC-56 specs listed below.

Generated by the Arc56Registry pipeline, using the algorandfoundation/algokit-client-generator-ts ARC-56 client generator. Do not edit these files by hand — they are regenerated automatically whenever the source ARC-56 spec changes.

Install

npm install arc56-generated-txnlab-nfd-sdk @algorandfoundation/algokit-utils algosdk

Basic usage

Each contract in this package is re-exported under its own namespace (a hash of its source URL is appended to keep multiple contracts in the same repository from colliding), containing a typed <Name>Client for interacting with an already-deployed instance of that contract, plus a <Name>Factory for deploying new instances.

import { AlgorandClient } from "@algorandfoundation/algokit-utils";
import { NFDInstance_9b7fcf89 } from "arc56-generated-txnlab-nfd-sdk";

const algorand = AlgorandClient.mainNet();
const client = new NFDInstance_9b7fcf89.NfdInstanceClient({
  algorand,
  appId: 123456789n,
});

// call a contract method, e.g.:
// const result = await client.send.someMethod({ args: [...] });

full vs minimal generator mode

Contracts in this package are generated with the client generator's full mode by default, which emits both the typed Client and a deploy/create Factory class. A small number of contracts' full-mode output has been observed to type-check against non-exported internal shapes of @algorandfoundation/algokit-utils's AlgorandClient that break across algokit-utils versions the generator doesn't itself pin against - for those specific contracts only, this package falls back to minimal mode (Client only, no Factory) instead of failing outright. The contracts table below flags any contract generated this way; every other contract includes a working Factory.

Contracts included in this package

| Namespace | Client class | Source ARC-56 spec | | --- | --- | --- | | NFDInstance_9b7fcf89 | NfdInstanceClient | https://raw.githubusercontent.com/TxnLab/nfd-sdk/HEAD/packages/sdk/src/contracts/minimal/NFDInstance.arc56.json | | NFDRegistry_7fe53358 | NfdRegistryClient | https://raw.githubusercontent.com/TxnLab/nfd-sdk/HEAD/packages/sdk/src/contracts/minimal/NFDRegistry.arc56.json | | NFDInstance_a0f592c3 | NfdInstanceClient | https://raw.githubusercontent.com/TxnLab/nfd-sdk/HEAD/packages/sdk/src/contracts/NFDInstance.arc56.json | | NFDRegistry_d60f44d8 | NfdRegistryClient | https://raw.githubusercontent.com/TxnLab/nfd-sdk/HEAD/packages/sdk/src/contracts/NFDRegistry.arc56.json |

Versioning

This package uses 1.0.<increment>.<yyyyMMddHH>-style versioning (expressed as valid semver 1.<increment>.<yyyyMMddHH>): a new version is published whenever any of the contracts above change, or whenever the client generator itself is updated. See Arc56Registry for the full generation pipeline and source ARC-56 registry.