@mrcointreautests/asa-metadata-registry-sdk 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 mrcointreau
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+# asa-metadata-registry-ts
+
+ASA Metadata Registry TypeScript SDK
+
+## Devs
+
+### Dependencies
+
+Node: 22.17.0 (see `.nvmrc`)
+
+```sh
+git submodule update --init --recursive
+pnpm install
+```
+
+### Code Quality
+
+```sh
+pnpm run format
+pnpm run lint
+```
+
+This project uses **Husky** and **lint-staged** to automatically lint and format staged files before they are committed.

package/dist/cjs/algod.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Algod helpers (ARC-89 box reads).
+ *
+ * Ported from `asa_metadata_registry/algod.py`.
+ * Uses the minimal Algod subset for box reads and ASA params.
+ */
+import type { AlgodClient, Box, Asset } from '@algorandfoundation/algokit-utils/algod-client';
+import { Arc90Uri } from './codec';
+import { AssetMetadataBox, AssetMetadataRecord, RegistryParameters } from './models';
+export type AlgodClientSubset = Pick<AlgodClient, 'applicationBoxByName' | 'assetById'>;
+/**
+ * Read ARC-89 metadata by directly reading the registry application box via Algod.
+ *
+ * This avoids transactions entirely and is usually the fastest read path.
+ *
+ * Required Algod methods:
+ * - getApplicationBoxByName
+ * - getAssetByID (for URI resolution)
+ */
+export declare class AlgodBoxReader {
+    readonly algod: AlgodClientSubset;
+    constructor(algod: AlgodClientSubset);
+    /**
+     * Fetch a box by name.
+     * @throws {BoxNotFoundError} If the box does not exist.
+     */
+    getBoxValue(args: {
+        appId: bigint | number;
+        boxName: Uint8Array;
+    }): Promise<Box>;
+    /**
+     * Return the parsed metadata box, or null if the box doesn't exist.
+     * @throws {BoxNotFoundError} If the box does not exist.
+     */
+    tryGetMetadataBox(args: {
+        appId: bigint | number;
+        assetId: bigint | number;
+        params?: RegistryParameters;
+    }): Promise<AssetMetadataBox | null>;
+    /**
+     * Return the parsed metadata box, or throw if missing.
+     * @throws {BoxNotFoundError} If the box does not exist.
+     */
+    getMetadataBox(args: {
+        appId: bigint | number;
+        assetId: bigint | number;
+        params?: RegistryParameters;
+    }): Promise<AssetMetadataBox>;
+    /**
+     * Retrieve the ARC-89 asset metadata box and return it as an AssetMetadataRecord.
+     * @param args - { appId, assetId, params }.
+     * @returns An AssetMetadataRecord containing the parsed header and body of the asset's metadata box.
+     * @throws {BoxNotFoundError} If the box does not exist.
+     */
+    getAssetMetadataRecord(args: {
+        appId: bigint | number;
+        assetId: bigint | number;
+        params?: RegistryParameters;
+    }): Promise<AssetMetadataRecord>;
+    /**
+     * Fetch ASA info from Algod.
+     * @throws {AsaNotFoundError} If the ASA does not exist.
+     */
+    getAssetInfo(assetId: bigint | number): Promise<Asset>;
+    /**
+     * Return the ASA's URL as a string, or null if missing.
+     * @param assetId - The ASA ID whose URL field should be retrieved.
+     * @returns The URL string from `info.params.url`, or null if missing.
+     * @throws {AsaNotFoundError} If the ASA does not exist.
+     */
+    getAssetUrl(assetId: bigint | number): Promise<string | null>;
+    /**
+     * Resolve an ARC-89 Asset Metadata URI from the ASA's URL.
+     * @param args - { assetId }.
+     * @returns Parsed ARC-90 URI.
+     * @throws {InvalidArc90UriError} If the ASA has no URL or if the URL is not an ARC-89-compatible ARC-90 partial URI.
+     */
+    resolveMetadataUriFromAsset(args: {
+        assetId: bigint | number;
+    }): Promise<Arc90Uri>;
+}

package/dist/cjs/algod.js

@@ -0,0 +1,154 @@
+"use strict";
+/**
+ * Algod helpers (ARC-89 box reads).
+ *
+ * Ported from `asa_metadata_registry/algod.py`.
+ * Uses the minimal Algod subset for box reads and ASA params.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AlgodBoxReader = void 0;
+const codec_1 = require("./codec");
+const numbers_1 = require("./internal/numbers");
+const errors_1 = require("./errors");
+const models_1 = require("./models");
+const asErrorMessage = (e) => {
+    if (e instanceof Error)
+        return e.message;
+    try {
+        return String(e);
+    }
+    catch {
+        return '';
+    }
+};
+const looksNotFound = (e) => {
+    const msg = asErrorMessage(e).toLowerCase();
+    return msg.includes('404') || msg.includes('not found') || msg.includes('does not exist');
+};
+/**
+ * Read ARC-89 metadata by directly reading the registry application box via Algod.
+ *
+ * This avoids transactions entirely and is usually the fastest read path.
+ *
+ * Required Algod methods:
+ * - getApplicationBoxByName
+ * - getAssetByID (for URI resolution)
+ */
+class AlgodBoxReader {
+    constructor(algod) {
+        this.algod = algod;
+    }
+    /**
+     * Fetch a box by name.
+     * @throws {BoxNotFoundError} If the box does not exist.
+     */
+    async getBoxValue(args) {
+        const appId = (0, numbers_1.toBigInt)(args.appId);
+        try {
+            return await this.algod.applicationBoxByName(appId, args.boxName);
+        }
+        catch (e) {
+            if (looksNotFound(e))
+                throw new errors_1.BoxNotFoundError('Box not found', { cause: e });
+            throw e;
+        }
+    }
+    /**
+     * Return the parsed metadata box, or null if the box doesn't exist.
+     * @throws {BoxNotFoundError} If the box does not exist.
+     */
+    async tryGetMetadataBox(args) {
+        let value;
+        try {
+            const box = await this.getBoxValue({ appId: args.appId, boxName: (0, codec_1.assetIdToBoxName)(args.assetId) });
+            value = box.value;
+        }
+        catch (e) {
+            if (e instanceof errors_1.BoxNotFoundError)
+                return null;
+            throw e;
+        }
+        const p = args.params ?? (0, models_1.getDefaultRegistryParams)();
+        return models_1.AssetMetadataBox.parse({
+            assetId: args.assetId,
+            value,
+            headerSize: p.headerSize,
+            maxMetadataSize: p.maxMetadataSize,
+        });
+    }
+    /**
+     * Return the parsed metadata box, or throw if missing.
+     * @throws {BoxNotFoundError} If the box does not exist.
+     */
+    async getMetadataBox(args) {
+        const box = await this.tryGetMetadataBox(args);
+        if (!box)
+            throw new errors_1.BoxNotFoundError('Metadata box not found');
+        return box;
+    }
+    /**
+     * Retrieve the ARC-89 asset metadata box and return it as an AssetMetadataRecord.
+     * @param args - { appId, assetId, params }.
+     * @returns An AssetMetadataRecord containing the parsed header and body of the asset's metadata box.
+     * @throws {BoxNotFoundError} If the box does not exist.
+     */
+    async getAssetMetadataRecord(args) {
+        const box = await this.getMetadataBox(args);
+        return new models_1.AssetMetadataRecord({
+            appId: args.appId,
+            assetId: args.assetId,
+            header: box.header,
+            body: box.body,
+        });
+    }
+    // ---------------------------------------------------------------------
+    // ASA lookups (optional)
+    // ---------------------------------------------------------------------
+    /**
+     * Fetch ASA info from Algod.
+     * @throws {AsaNotFoundError} If the ASA does not exist.
+     */
+    async getAssetInfo(assetId) {
+        const id = (0, numbers_1.toBigInt)(assetId);
+        try {
+            return await this.algod.assetById(id);
+        }
+        catch (e) {
+            if (looksNotFound(e))
+                throw new errors_1.AsaNotFoundError(`ASA ${id} not found`, { cause: e });
+            throw e;
+        }
+    }
+    /**
+     * Return the ASA's URL as a string, or null if missing.
+     * @param assetId - The ASA ID whose URL field should be retrieved.
+     * @returns The URL string from `info.params.url`, or null if missing.
+     * @throws {AsaNotFoundError} If the ASA does not exist.
+     */
+    async getAssetUrl(assetId) {
+        const info = await this.getAssetInfo(assetId);
+        const url = info?.params?.url ?? null;
+        return url == null ? null : String(url);
+    }
+    /**
+     * Resolve an ARC-89 Asset Metadata URI from the ASA's URL.
+     * @param args - { assetId }.
+     * @returns Parsed ARC-90 URI.
+     * @throws {InvalidArc90UriError} If the ASA has no URL or if the URL is not an ARC-89-compatible ARC-90 partial URI.
+     */
+    async resolveMetadataUriFromAsset(args) {
+        const url = await this.getAssetUrl(args.assetId);
+        if (!url) {
+            throw new errors_1.InvalidArc90UriError('ASA has no url field; cannot resolve ARC-89 metadata URI');
+        }
+        try {
+            const full = (0, codec_1.completePartialAssetUrl)(url, args.assetId);
+            return codec_1.Arc90Uri.parse(full);
+        }
+        catch (e) {
+            throw new errors_1.InvalidArc90UriError('Failed to resolve ARC-89 URI from ASA url', { cause: e });
+        }
+    }
+}
+exports.AlgodBoxReader = AlgodBoxReader;
+//# sourceMappingURL=algod.js.map

package/dist/cjs/algod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"algod.js","sourceRoot":"","sources":["../../src/algod.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAGH,mCAA6E;AAC7E,gDAA6C;AAC7C,qCAAmF;AACnF,qCAA8G;AAE9G,MAAM,cAAc,GAAG,CAAC,CAAU,EAAU,EAAE;IAC5C,IAAI,CAAC,YAAY,KAAK;QAAE,OAAO,CAAC,CAAC,OAAO,CAAA;IACxC,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,CAAC,CAAC,CAAA;IAClB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAA;IACX,CAAC;AACH,CAAC,CAAA;AAED,MAAM,aAAa,GAAG,CAAC,CAAU,EAAW,EAAE;IAC5C,MAAM,GAAG,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAA;IAC3C,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;AAC3F,CAAC,CAAA;AAID;;;;;;;;GAQG;AACH,MAAa,cAAc;IAGzB,YAAY,KAAwB;QAClC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAC,IAAqD;QACrE,MAAM,KAAK,GAAG,IAAA,kBAAQ,EAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAElC,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;QACnE,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,aAAa,CAAC,CAAC,CAAC;gBAAE,MAAM,IAAI,yBAAgB,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAA;YAC/E,MAAM,CAAC,CAAA;QACT,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,IAIvB;QACC,IAAI,KAAiB,CAAA;QACrB,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAA,wBAAgB,EAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YAClG,KAAK,GAAG,GAAG,CAAC,KAAK,CAAA;QACnB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,yBAAgB;gBAAE,OAAO,IAAI,CAAA;YAC9C,MAAM,CAAC,CAAA;QACT,CAAC;QAED,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,IAAA,iCAAwB,GAAE,CAAA;QACnD,OAAO,yBAAgB,CAAC,KAAK,CAAC;YAC5B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK;YACL,UAAU,EAAE,CAAC,CAAC,UAAU;YACxB,eAAe,EAAE,CAAC,CAAC,eAAe;SACnC,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,IAIpB;QACC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;QAC9C,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,yBAAgB,CAAC,wBAAwB,CAAC,CAAA;QAC9D,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAAC,IAI5B;QACC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAA;QAC3C,OAAO,IAAI,4BAAmB,CAAC;YAC7B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,IAAI,EAAE,GAAG,CAAC,IAAI;SACf,CAAC,CAAA;IACJ,CAAC;IAED,wEAAwE;IACxE,yBAAyB;IACzB,wEAAwE;IAExE;;;OAGG;IACH,KAAK,CAAC,YAAY,CAAC,OAAwB;QACzC,MAAM,EAAE,GAAG,IAAA,kBAAQ,EAAC,OAAO,CAAC,CAAA;QAE5B,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;QACvC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,aAAa,CAAC,CAAC,CAAC;gBAAE,MAAM,IAAI,yBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAA;YACrF,MAAM,CAAC,CAAA;QACT,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CAAC,OAAwB;QACxC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;QAC7C,MAAM,GAAG,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,IAAI,CAAA;QACrC,OAAO,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACzC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,2BAA2B,CAAC,IAAkC;QAClE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAChD,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,MAAM,IAAI,6BAAoB,CAAC,0DAA0D,CAAC,CAAA;QAC5F,CAAC;QAED,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,IAAA,+BAAuB,EAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;YACvD,OAAO,gBAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAC7B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,6BAAoB,CAAC,2CAA2C,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAA;QAC3F,CAAC;IACH,CAAC;CACF;AArID,wCAqIC"}

package/dist/cjs/bitmasks.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Derived bitmasks for ASA Metadata Registry flags (ported from Python `bitmasks.py`).
+ */
+export declare const MASK_ID_SHORT: number;
+export declare const MASK_REV_ARC20: number;
+export declare const MASK_REV_ARC62: number;
+export declare const MASK_REV_NTT: number;
+export declare const MASK_REV_RESERVED_3: number;
+export declare const MASK_REV_RESERVED_4: number;
+export declare const MASK_REV_RESERVED_5: number;
+export declare const MASK_REV_RESERVED_6: number;
+export declare const MASK_REV_RESERVED_7: number;
+export declare const MASK_IRR_ARC3: number;
+export declare const MASK_IRR_ARC89: number;
+export declare const MASK_IRR_ARC54: number;
+export declare const MASK_IRR_RESERVED_3: number;
+export declare const MASK_IRR_RESERVED_4: number;
+export declare const MASK_IRR_RESERVED_5: number;
+export declare const MASK_IRR_RESERVED_6: number;
+export declare const MASK_IRR_IMMUTABLE: number;

package/dist/cjs/bitmasks.js

@@ -0,0 +1,61 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MASK_IRR_IMMUTABLE = exports.MASK_IRR_RESERVED_6 = exports.MASK_IRR_RESERVED_5 = exports.MASK_IRR_RESERVED_4 = exports.MASK_IRR_RESERVED_3 = exports.MASK_IRR_ARC54 = exports.MASK_IRR_ARC89 = exports.MASK_IRR_ARC3 = exports.MASK_REV_RESERVED_7 = exports.MASK_REV_RESERVED_6 = exports.MASK_REV_RESERVED_5 = exports.MASK_REV_RESERVED_4 = exports.MASK_REV_RESERVED_3 = exports.MASK_REV_NTT = exports.MASK_REV_ARC62 = exports.MASK_REV_ARC20 = exports.MASK_ID_SHORT = void 0;
+const flags = __importStar(require("./flags"));
+/**
+ * Derived bitmasks for ASA Metadata Registry flags (ported from Python `bitmasks.py`).
+ */
+// Metadata Identifiers byte (set by the ASA Metadata Registry; clients just read)
+exports.MASK_ID_SHORT = 1 << flags.ID_SHORT;
+// Reversible Flags byte (set by ASA Manager Address)
+exports.MASK_REV_ARC20 = 1 << flags.REV_FLG_ARC20;
+exports.MASK_REV_ARC62 = 1 << flags.REV_FLG_ARC62;
+exports.MASK_REV_NTT = 1 << flags.REV_FLG_NTT;
+exports.MASK_REV_RESERVED_3 = 1 << flags.REV_FLG_RESERVED_3;
+exports.MASK_REV_RESERVED_4 = 1 << flags.REV_FLG_RESERVED_4;
+exports.MASK_REV_RESERVED_5 = 1 << flags.REV_FLG_RESERVED_5;
+exports.MASK_REV_RESERVED_6 = 1 << flags.REV_FLG_RESERVED_6;
+exports.MASK_REV_RESERVED_7 = 1 << flags.REV_FLG_RESERVED_7;
+// Irreversible Flags byte (set by ASA Manager Address)
+exports.MASK_IRR_ARC3 = 1 << flags.IRR_FLG_ARC3;
+exports.MASK_IRR_ARC89 = 1 << flags.IRR_FLG_ARC89;
+exports.MASK_IRR_ARC54 = 1 << flags.IRR_FLG_ARC54;
+exports.MASK_IRR_RESERVED_3 = 1 << flags.IRR_FLG_RESERVED_3;
+exports.MASK_IRR_RESERVED_4 = 1 << flags.IRR_FLG_RESERVED_4;
+exports.MASK_IRR_RESERVED_5 = 1 << flags.IRR_FLG_RESERVED_5;
+exports.MASK_IRR_RESERVED_6 = 1 << flags.IRR_FLG_RESERVED_6;
+exports.MASK_IRR_IMMUTABLE = 1 << flags.IRR_FLG_IMMUTABLE;
+//# sourceMappingURL=bitmasks.js.map

package/dist/cjs/bitmasks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bitmasks.js","sourceRoot":"","sources":["../../src/bitmasks.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAgC;AAEhC;;GAEG;AAEH,kFAAkF;AACrE,QAAA,aAAa,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAA;AAEhD,qDAAqD;AACxC,QAAA,cAAc,GAAG,CAAC,IAAI,KAAK,CAAC,aAAa,CAAA;AACzC,QAAA,cAAc,GAAG,CAAC,IAAI,KAAK,CAAC,aAAa,CAAA;AACzC,QAAA,YAAY,GAAG,CAAC,IAAI,KAAK,CAAC,WAAW,CAAA;AACrC,QAAA,mBAAmB,GAAG,CAAC,IAAI,KAAK,CAAC,kBAAkB,CAAA;AACnD,QAAA,mBAAmB,GAAG,CAAC,IAAI,KAAK,CAAC,kBAAkB,CAAA;AACnD,QAAA,mBAAmB,GAAG,CAAC,IAAI,KAAK,CAAC,kBAAkB,CAAA;AACnD,QAAA,mBAAmB,GAAG,CAAC,IAAI,KAAK,CAAC,kBAAkB,CAAA;AACnD,QAAA,mBAAmB,GAAG,CAAC,IAAI,KAAK,CAAC,kBAAkB,CAAA;AAEhE,uDAAuD;AAC1C,QAAA,aAAa,GAAG,CAAC,IAAI,KAAK,CAAC,YAAY,CAAA;AACvC,QAAA,cAAc,GAAG,CAAC,IAAI,KAAK,CAAC,aAAa,CAAA;AACzC,QAAA,cAAc,GAAG,CAAC,IAAI,KAAK,CAAC,aAAa,CAAA;AACzC,QAAA,mBAAmB,GAAG,CAAC,IAAI,KAAK,CAAC,kBAAkB,CAAA;AACnD,QAAA,mBAAmB,GAAG,CAAC,IAAI,KAAK,CAAC,kBAAkB,CAAA;AACnD,QAAA,mBAAmB,GAAG,CAAC,IAAI,KAAK,CAAC,kBAAkB,CAAA;AACnD,QAAA,mBAAmB,GAAG,CAAC,IAAI,KAAK,CAAC,kBAAkB,CAAA;AACnD,QAAA,kBAAkB,GAAG,CAAC,IAAI,KAAK,CAAC,iBAAiB,CAAA"}

package/dist/cjs/codec.d.ts

@@ -0,0 +1,63 @@
+/**
+ * ARC-89 / ARC-90 codec utilities.
+ *
+ * Ported from Python `asa_metadata_registry/codec.py`.
+ */
+/** Convert an Asset ID (uint64) into the ARC-89 box key bytes (8-byte big-endian). */
+export declare const assetIdToBoxName: (assetId: bigint | number) => Uint8Array;
+/** Convert an ARC-89 box key (8-byte big-endian) into an Asset ID (uint64). */
+export declare const boxNameToAssetId: (boxName: Uint8Array) => bigint;
+/** Standard base64 (with padding). */
+export declare const b64Encode: (data: Uint8Array) => string;
+/** Standard base64 decode (accepts padding). */
+export declare const b64Decode: (dataB64: string) => Uint8Array;
+/** URL-safe base64, per ARC-90 examples (padding preserved to match Python SDK). */
+export declare const b64UrlEncode: (data: Uint8Array) => string;
+/** URL-safe base64 decode. */
+export declare const b64UrlDecode: (dataB64Url: string) => Uint8Array;
+/**
+ * Represents the ARC-90 compliance fragment '#arc<A>+<B>+...'.
+ *
+ * Per ARC-90:
+ * - Format: #arc<A>+<B>+<C> where A, B, C are decimal numbers
+ * - First entry has 'arc' prefix, subsequent entries are bare numbers
+ * - No leading zeros allowed
+ * - Special case: ARC-3 must be sole entry (#arc3)
+ * - Order is not enforced (clients MUST accept any order)
+ */
+export declare class Arc90Compliance {
+    readonly arcs: readonly number[];
+    constructor(arcs?: readonly number[]);
+    static parse(fragment?: string | null): Arc90Compliance;
+    toFragment(): string | null;
+}
+/**
+ * Parsed ARC-90 URI referencing an application box.
+ *
+ * ARC-89 uses URIs of the form:
+ *   algorand://<netauth>/app/<app_id>?box=<base64url_box_name>#arc<A>+<B>...
+ */
+export declare class Arc90Uri {
+    readonly netauth: string | null;
+    readonly appId: bigint;
+    readonly boxName: Uint8Array | null;
+    readonly compliance: Arc90Compliance;
+    constructor(args: {
+        netauth: string | null;
+        appId: bigint | number;
+        boxName: Uint8Array | null;
+        compliance?: Arc90Compliance;
+    });
+    get assetId(): bigint | null;
+    get isPartial(): boolean;
+    withAssetId(assetId: bigint | number): Arc90Uri;
+    /** Render the URI using ARC-89 conventions (base64url for box query parameter). */
+    toUri(): string;
+    /** The Algod `/box?name=` query parameter expects standard base64 (with padding). */
+    toAlgodBoxNameB64(): string;
+    static parse(uri: string): Arc90Uri;
+}
+/**
+ * Complete an ARC-89 partial Asset URL (Asset Params `url`) into a full Asset Metadata URI.
+ */
+export declare const completePartialAssetUrl: (assetUrl: string, assetId: bigint | number) => string;