AssetRegistry: Read and Update On-Chain Asset Metadata

import { AssetRegistry, AssetStatus } from "@ankarachain/sdk";

new AssetRegistry(adapter: IAdapter, tokenAddress: string, template: AssetTemplate | NFTAssetTemplate)

import { AssetRegistry } from "@ankarachain/sdk";

const registry = new AssetRegistry(
  factory.adapter,
  "0xYourTokenAddress",
  "farmland"
);

getName(): Promise<string>

const name = await registry.getName();
// "Kano Farmland Token"

getSymbol(): Promise<string>

getTotalSupply(): Promise<bigint>

getBalanceOf(address: string): Promise<bigint>

const balance = await registry.getBalanceOf("0xInvestorAddress");

getStatus(): Promise<AssetStatus>

import { AssetStatus } from "@ankarachain/sdk";

const status = await registry.getStatus();
if (status === AssetStatus.SUSPENDED) {
  console.warn("Token transfers are currently suspended.");
}

getCountryCode(): Promise<string>

getIdentityVerifier(): Promise<string>

getVersion(): Promise<number>

getMetadata(): Promise<AnyAssetMetadata>

import type { FarmlandMetadata } from "@ankarachain/sdk";

const meta = await registry.getMetadata() as FarmlandMetadata;
console.log("Area:", meta.areaSqMeters, "m²");
console.log("Valuation: $", meta.valuationUSD);

getValuationUSD(): Promise<bigint>

setStatus(newStatus: AssetStatus): Promise<string>

import { AssetStatus } from "@ankarachain/sdk";

const txHash = await registry.setStatus(AssetStatus.ACTIVE);

setIdentityVerifier(verifierAddress: string): Promise<string>

mint(to: string, amount: bigint): Promise<string>

pause(): Promise<string>

unpause(): Promise<string>

updateValuation(newValuationUSD: bigint): Promise<string>

// Update farmland valuation to $180,000
const txHash = await registry.updateValuation(180_000n * 10n ** 18n);

updateOccupancyStatus(newStatus: string): Promise<string>

declareRentalDistribution(amountUSD: bigint): Promise<string>

isExpired(): Promise<boolean>

markExpired(): Promise<string>

getInvoiceStatus(): Promise<InvoiceStatus>

isOverdue(): Promise<boolean>

markFunded(): Promise<string>

markRepaid(): Promise<string>

markDefaulted(reason: string): Promise<string>

retire(amount: bigint, beneficiary: string, note: string): Promise<string>

const txHash = await registry.retire(
  10n * 10n ** 18n,            // retire 10 tCO2e
  "Acme Corp Lagos Office",
  "Annual Scope 1 offset 2025"
);

getTotalRetired(): Promise<bigint>

getTotalRetirements(): Promise<number>

getRetirement(index: number): Promise<RetirementRecord>

isLicenseExpired(): Promise<boolean>

renewLicense(newExpiry: bigint): Promise<string>

markLicenseExpired(): Promise<string>

declareRoyalty(extractionValueUSD: bigint): Promise<string>

getTokenMetadata(tokenId: number): Promise<unknown>

getTokenVersion(tokenId: number): Promise<number>

ownerOf(tokenId: number): Promise<string>

linkToERC20(erc20Address: string): Promise<string>

registry.address   // The token contract address passed to the constructor
registry.template  // The template string passed to the constructor

enum AssetStatus {
  DRAFT     = 0,
  ACTIVE    = 1,
  SUSPENDED = 2,
  REDEEMED  = 3,
  EXPIRED   = 4,
}

enum InvoiceStatus {
  PENDING   = 0,
  FUNDED    = 1,
  REPAID    = 2,
  DEFAULTED = 3,
}

interface RetirementRecord {
  retiredBy:      string;
  amount:         bigint;
  timestamp:      bigint;
  beneficiary:    string;
  retirementNote: string;
}

type AssetTemplate =
  | "farmland" | "commodity" | "real-estate"
  | "invoice"  | "carbon-credit" | "mining-rights";

type NFTAssetTemplate =
  | "farmland-nft" | "real-estate-nft"
  | "mining-rights-nft" | "commodity-vault-nft";