@ar.io/sdk 3.12.0-alpha.1 → 3.12.0-beta.1

package/lib/types/types/wayfinder.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Readable } from 'stream';
+export interface RoutingStrategy {
+    selectGateway: ({ gateways }: {
+        gateways: URL[];
+    }) => Promise<URL>;
+}
+export interface GatewaysProvider {
+    getGateways: () => Promise<URL[]>;
+}
+export interface DataVerificationStrategy {
+    /**
+     * Verifies the provided data for a given txId
+     *
+     * Depending on the implementation, the hash can be the computed data root of a transaction, the digest of the data, or some other hash of the data.
+     *
+     * The interface is intended to be vague in order to support various degrees of verification.
+     *
+     * @param data - The data to verify
+     * @param txId - The txId of the data
+     * @returns the hash of the data
+     */
+    verifyData: ({ data, txId, }: {
+        data: Buffer | Readable | ReadableStream;
+        txId: string;
+    }) => Promise<void>;
+}
+export interface DataHashProvider {
+    /**
+     * Returns a hash for the provided txId using the specified algorithm.
+     *
+     * @param txId - The txId of the data
+     * @returns the hash of the data
+     */
+    getHash: ({ txId, }: {
+        txId: string;
+    }) => Promise<{
+        hash: string;
+        algorithm: 'sha256';
+    }>;
+}
+export interface DataRootProvider {
+    /**
+     * Returns the data root for the provided txId
+     *
+     * @param txId - The txId of the data
+     * @returns the data root of the data
+     */
+    getDataRoot: ({ txId }: {
+        txId: string;
+    }) => Promise<string>;
+}

package/lib/types/utils/json.d.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare function safeDecode<R = unknown>(data: any): R;
+export declare function safeDecode<R = unknown>(data: string): R;

package/lib/types/version.d.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare const version = "3.11.1-alpha.1";
+export declare const version = "3.12.0-alpha.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "3.12.0-alpha.1",
+  "version": "3.12.0-beta.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"
@@ -72,7 +72,7 @@
     "test:cjs": "yarn build:cjs && yarn link && cd ./tests/e2e/cjs && yarn && yarn test",
     "test:esm": "yarn build:esm && yarn link && cd ./tests/e2e/esm && yarn && yarn test",
     "test:web": "yarn build:esm && yarn link && cd ./tests/e2e/web && yarn && yarn test",
-    "test:unit": "node --import=./register.mjs --test --test-reporter=spec --enable-source-maps --trace-warnings 'src/**/*.test.ts'",
+    "test:unit": "c8 node --import=./register.mjs --test --test-reporter=spec --enable-source-maps --trace-warnings 'src/**/*.test.ts'",
     "test:link": "yarn build && yarn link",
     "test:e2e": "yarn test:cjs && yarn test:esm && yarn test:web",
     "test:integration": "yarn build:esm && yarn link && cd ./tests/integration && yarn && yarn test",
@@ -99,6 +99,7 @@
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^6.4.0",
     "arconnect": "^1.0.3",
+    "c8": "^10.1.3",
     "dotenv": "^16.4.5",
     "dotenv-cli": "^7.4.2",
     "esbuild": "^0.25.2",

package/lib/cjs/types/ant.test.js

@@ -1,150 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_assert_1 = require("node:assert");
-const node_test_1 = require("node:test");
-const zod_1 = require("zod");
-const ant_js_1 = require("./ant.js");
-const stub_arweave_address = 'valid-address'.padEnd(43, '1');
-const stub_eth_address = '0x8B5f221c8837d862b818799e6b19cc23CE23B0E5';
-(0, node_test_1.describe)('ANT Schemas', () => {
-    (0, node_test_1.it)('should validate AntStateSchema', () => {
-        const validState = {
-            Name: 'TestToken',
-            Ticker: 'TST',
-            Description: 'Test description',
-            Keywords: ['keyword1', 'keyword2', 'keyword3'],
-            Denomination: 0,
-            Owner: stub_arweave_address,
-            Controllers: [stub_arweave_address],
-            Records: {
-                record1: {
-                    transactionId: stub_arweave_address,
-                    ttlSeconds: 3600,
-                },
-            },
-            Balances: {
-                [stub_arweave_address]: 1,
-            },
-            Logo: stub_arweave_address,
-            TotalSupply: 1,
-            Initialized: true,
-        };
-        const invalidState = {
-            Name: 'TestToken',
-            Ticker: 'TST',
-            Description: 'Test description',
-            Keywords: ['keyword1', 'keyword2', 'keyword3'],
-            Denomination: 0,
-            Owner: stub_arweave_address,
-            Controllers: [stub_arweave_address],
-            Records: {
-                record1: {
-                    transactionId: 'invalid-id',
-                    ttlSeconds: '3600',
-                },
-            },
-            Balances: {
-                [stub_arweave_address]: 1,
-            },
-            Logo: stub_arweave_address,
-            TotalSupply: -1,
-            Initialized: true,
-        };
-        node_assert_1.strict.doesNotThrow(() => ant_js_1.AntStateSchema.parse(validState));
-        node_assert_1.strict.throws(() => ant_js_1.AntStateSchema.parse(invalidState), zod_1.z.ZodError);
-    });
-    (0, node_test_1.it)('should validate AntStateSchema with ETH address', () => {
-        const validState = {
-            Name: 'TestToken',
-            Ticker: 'TST',
-            Description: 'Test description',
-            Keywords: ['keyword1', 'keyword2', 'keyword3'],
-            Denomination: 0,
-            Owner: stub_eth_address,
-            Controllers: [stub_eth_address],
-            Records: {
-                record1: {
-                    transactionId: stub_arweave_address,
-                    ttlSeconds: 3600,
-                },
-            },
-            Balances: {
-                [stub_eth_address]: 1,
-            },
-            Logo: stub_arweave_address,
-            TotalSupply: 1,
-            Initialized: true,
-        };
-        node_assert_1.strict.doesNotThrow(() => ant_js_1.AntStateSchema.parse(validState));
-    });
-    (0, node_test_1.it)('should validate AntInfoSchema', () => {
-        const validInfo = {
-            Name: 'TestToken',
-            Owner: stub_arweave_address,
-            Ticker: 'TST',
-            Description: 'Test description',
-            Keywords: ['keyword1', 'keyword2', 'keyword3'],
-            ['Total-Supply']: '1',
-            Logo: stub_arweave_address,
-            Denomination: '0',
-            Handlers: ant_js_1.AntHandlerNames,
-        };
-        const invalidInfo = {
-            Name: 'TestToken',
-            Owner: stub_arweave_address,
-            Ticker: 'TST',
-            ['Total-Supply']: 1000,
-            Logo: stub_arweave_address,
-            Denomination: '1',
-            Handlers: ant_js_1.AntHandlerNames,
-        };
-        node_assert_1.strict.doesNotThrow(() => ant_js_1.AntInfoSchema.parse(validInfo));
-        node_assert_1.strict.throws(() => ant_js_1.AntInfoSchema.parse(invalidInfo), zod_1.z.ZodError);
-    });
-    (0, node_test_1.it)('should validate isAoANTState', () => {
-        const validState = {
-            Name: 'TestToken',
-            Ticker: 'TST',
-            Description: 'Test description',
-            Keywords: ['keyword1', 'keyword2', 'keyword3'],
-            Denomination: 0,
-            Owner: stub_arweave_address,
-            Controllers: [stub_arweave_address],
-            Records: {
-                record1: {
-                    transactionId: stub_arweave_address,
-                    ttlSeconds: 3600,
-                },
-            },
-            Balances: {
-                [stub_arweave_address]: 1,
-            },
-            Logo: stub_arweave_address,
-            TotalSupply: 0,
-            Initialized: true,
-        };
-        const invalidState = {
-            Name: 'TestToken',
-            Ticker: 'TST',
-            Description: 'Test description',
-            Keywords: ['keyword1', 'keyword2', 'keyword3'],
-            Denomination: 0,
-            Owner: stub_arweave_address,
-            Controllers: [stub_arweave_address],
-            Records: {
-                record1: {
-                    transactionId: 'invalid-id',
-                    ttlSeconds: '3600',
-                },
-            },
-            Balances: {
-                [stub_arweave_address]: 1,
-            },
-            Logo: stub_arweave_address,
-            TotalSupply: -1,
-            Initialized: true,
-        };
-        node_assert_1.strict.strictEqual((0, ant_js_1.isAoANTState)(validState), true);
-        node_assert_1.strict.strictEqual((0, ant_js_1.isAoANTState)(invalidState), false);
-    });
-});

package/lib/cjs/types/token.test.js

@@ -1,83 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_assert_1 = require("node:assert");
-const node_test_1 = require("node:test");
-const token_js_1 = require("./token.js");
-(0, node_test_1.describe)('ARIOToken', () => {
-    (0, node_test_1.it)('should throw an error on invalid input', () => {
-        node_assert_1.strict.throws(() => new token_js_1.ARIOToken(-1));
-    });
-    (0, node_test_1.it)('should round at 6 decimal places', () => {
-        const token = new token_js_1.ARIOToken(1.123456789);
-        node_assert_1.strict.strictEqual(token.valueOf(), 1.123457);
-    });
-    (0, node_test_1.it)('should convert to mARIOToken', () => {
-        const token = new token_js_1.ARIOToken(1);
-        const mToken = token.toMARIO();
-        node_assert_1.strict.strictEqual(mToken.valueOf(), 1000000);
-    });
-    (0, node_test_1.it)('should print as a string', () => {
-        const token = new token_js_1.ARIOToken(1);
-        node_assert_1.strict.strictEqual(`${token}`, '1');
-    });
-});
-(0, node_test_1.describe)('mARIOToken', () => {
-    (0, node_test_1.it)('should multiply by a number', () => {
-        const token = new token_js_1.mARIOToken(1);
-        const result = token.multiply(2);
-        node_assert_1.strict.strictEqual(result.valueOf(), 2);
-    });
-    (0, node_test_1.it)('should multiply by another mARIOToken', () => {
-        const token = new token_js_1.mARIOToken(1);
-        const result = token.multiply(new token_js_1.mARIOToken(2));
-        node_assert_1.strict.strictEqual(result.valueOf(), 2);
-    });
-    (0, node_test_1.it)('should divide by a number', () => {
-        const token = new token_js_1.mARIOToken(2);
-        const result = token.divide(2);
-        node_assert_1.strict.strictEqual(result.valueOf(), 1);
-    });
-    (0, node_test_1.it)('should divide by another mARIOToken', () => {
-        const token = new token_js_1.mARIOToken(2);
-        const result = token.divide(new token_js_1.mARIOToken(2));
-        node_assert_1.strict.strictEqual(result.valueOf(), 1);
-    });
-    (0, node_test_1.it)('should throw an error on division by zero', () => {
-        const token = new token_js_1.mARIOToken(2);
-        node_assert_1.strict.throws(() => token.divide(0));
-    });
-    (0, node_test_1.it)('should round down on multiplication of a number', () => {
-        const token = new token_js_1.mARIOToken(1);
-        const result = token.multiply(1.5);
-        node_assert_1.strict.strictEqual(result.valueOf(), 1);
-    });
-    (0, node_test_1.it)('should round down on division with a number', () => {
-        const token = new token_js_1.mARIOToken(2);
-        const result = token.divide(3);
-        node_assert_1.strict.strictEqual(result.valueOf(), 0);
-    });
-    (0, node_test_1.it)('should round down on division with another mARIOToken', () => {
-        const token = new token_js_1.mARIOToken(2);
-        const result = token.divide(new token_js_1.mARIOToken(3));
-        node_assert_1.strict.strictEqual(result.valueOf(), 0);
-    });
-    (0, node_test_1.it)('should add', () => {
-        const token = new token_js_1.mARIOToken(1);
-        const result = token.plus(new token_js_1.mARIOToken(1));
-        node_assert_1.strict.strictEqual(result.valueOf(), 2);
-    });
-    (0, node_test_1.it)('should subtract', () => {
-        const token = new token_js_1.mARIOToken(2);
-        const result = token.minus(new token_js_1.mARIOToken(1));
-        node_assert_1.strict.strictEqual(result.valueOf(), 1);
-    });
-    (0, node_test_1.it)('should convert to ARIO', () => {
-        const token = new token_js_1.mARIOToken(1000000);
-        const result = token.toARIO();
-        node_assert_1.strict.strictEqual(result.valueOf(), 1);
-    });
-    (0, node_test_1.it)('should print as a string', () => {
-        const token = new token_js_1.mARIOToken(1);
-        node_assert_1.strict.strictEqual(`${token}`, '1');
-    });
-});

package/lib/cjs/utils/ant.test.js

@@ -1,111 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_assert_1 = require("node:assert");
-const node_test_1 = require("node:test");
-const ant_js_1 = require("./ant.js");
-(0, node_test_1.describe)('sortANTRecordsByPriority', () => {
-    (0, node_test_1.it)('should sort records by priority and then lexicographically', () => {
-        const records = {
-            undername01: { priority: 1, transactionId: 'test', ttlSeconds: 1 }, // same priority, lexicographic sorting applied to the name
-            undername1: { priority: 1, transactionId: 'test', ttlSeconds: 1 },
-            undername11: { priority: 1, transactionId: 'test', ttlSeconds: 1 }, // same priority, lexicographic sorting applied to the name
-            undername2: { priority: 2, transactionId: 'test', ttlSeconds: 1 },
-            undername3: { priority: 3, transactionId: 'test', ttlSeconds: 1 }, // colliding priorities default to lexicographic sorting
-            undername4: { priority: 3, transactionId: 'test', ttlSeconds: 1 },
-            undername5: { priority: 100, transactionId: 'test', ttlSeconds: 1 }, // priority does not represent the index or position of the record, just the order of resolution relative to other records
-            noPriority: { transactionId: 'test', ttlSeconds: 1 },
-            noPriority01: { transactionId: 'test', ttlSeconds: 1 },
-            noPriority1: { transactionId: 'test', ttlSeconds: 1 },
-            noPriority11: { transactionId: 'test', ttlSeconds: 1 },
-            '@': { transactionId: 'test', ttlSeconds: 1 }, // always first, even if no priority
-        };
-        const sorted = (0, ant_js_1.sortANTRecords)(records);
-        node_assert_1.strict.deepStrictEqual(sorted, {
-            '@': { transactionId: 'test', ttlSeconds: 1, index: 0 }, // always first, even if no priority
-            undername01: {
-                priority: 1,
-                transactionId: 'test',
-                ttlSeconds: 1,
-                index: 1,
-            },
-            undername1: {
-                priority: 1,
-                transactionId: 'test',
-                ttlSeconds: 1,
-                index: 2,
-            },
-            undername11: {
-                priority: 1,
-                transactionId: 'test',
-                ttlSeconds: 1,
-                index: 3,
-            },
-            undername2: {
-                priority: 2,
-                transactionId: 'test',
-                ttlSeconds: 1,
-                index: 4,
-            },
-            undername3: {
-                priority: 3,
-                transactionId: 'test',
-                ttlSeconds: 1,
-                index: 5,
-            },
-            undername4: {
-                priority: 3,
-                transactionId: 'test',
-                ttlSeconds: 1,
-                index: 6,
-            },
-            undername5: {
-                priority: 100,
-                transactionId: 'test',
-                ttlSeconds: 1,
-                index: 7,
-            },
-            noPriority: { transactionId: 'test', ttlSeconds: 1, index: 8 },
-            noPriority01: { transactionId: 'test', ttlSeconds: 1, index: 9 },
-            noPriority1: { transactionId: 'test', ttlSeconds: 1, index: 10 },
-            noPriority11: { transactionId: 'test', ttlSeconds: 1, index: 11 },
-        });
-    });
-    (0, node_test_1.it)('should always return @ as the first, regardless of priority', () => {
-        const scenarios = [
-            {
-                records: {
-                    '@': { priority: 5, transactionId: 'test', ttlSeconds: 1 }, //  priorities set on '@' are ignored, they are always first
-                    undername1: { priority: 2, transactionId: 'test', ttlSeconds: 1 },
-                },
-                expected: {
-                    '@': { priority: 5, transactionId: 'test', ttlSeconds: 1, index: 0 },
-                    undername1: {
-                        priority: 2,
-                        transactionId: 'test',
-                        ttlSeconds: 1,
-                        index: 1,
-                    },
-                },
-            },
-            {
-                records: {
-                    '@': { transactionId: 'test', ttlSeconds: 1 }, // priority 0 is missing, but '@' is always first
-                    undername1: { priority: 2, transactionId: 'test', ttlSeconds: 1 },
-                },
-                expected: {
-                    '@': { transactionId: 'test', ttlSeconds: 1, index: 0 },
-                    undername1: {
-                        priority: 2,
-                        transactionId: 'test',
-                        ttlSeconds: 1,
-                        index: 1,
-                    },
-                },
-            },
-        ];
-        for (const scenario of scenarios) {
-            const sorted = (0, ant_js_1.sortANTRecords)(scenario.records);
-            node_assert_1.strict.deepStrictEqual(sorted, scenario.expected);
-        }
-    });
-});

package/lib/cjs/utils/b64.test.js

@@ -1,72 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_assert_1 = require("node:assert");
-const node_test_1 = require("node:test");
-const base64_js_1 = require("./base64.js");
-(0, node_test_1.describe)('b64utils', () => {
-    (0, node_test_1.it)('should convert various strings to base64url and back', () => {
-        const testStrings = [
-            'Hello, World!',
-            'Test123!@#',
-            'Base64URLEncoding',
-            'Special_Chars+/',
-            '',
-            'A',
-            '1234567890',
-        ];
-        for (const str of testStrings) {
-            const encoded = (0, base64_js_1.toB64Url)(Buffer.from(str));
-            const decoded = (0, base64_js_1.fromB64Url)(encoded);
-            node_assert_1.strict.deepStrictEqual(decoded, Buffer.from(str), `Failed for string: ${str}`);
-        }
-    });
-    (0, node_test_1.it)('should convert various buffers to base64url and back', () => {
-        const testBuffers = [
-            Buffer.from('Hello, World!'),
-            Buffer.from([0, 1, 2, 3, 4, 5]),
-            Buffer.from('Test123!@#'),
-            Buffer.from('Base64URLEncoding'),
-            Buffer.from('Special_Chars+/'),
-            Buffer.alloc(0),
-            Buffer.from('A'),
-            Buffer.from('1234567890'),
-        ];
-        for (const buf of testBuffers) {
-            const encoded = (0, base64_js_1.toB64Url)(buf);
-            const decoded = (0, base64_js_1.fromB64Url)(encoded);
-            node_assert_1.strict.deepStrictEqual(decoded, buf, `Failed for buffer: ${buf.toString()}`);
-        }
-    });
-    (0, node_test_1.it)('should handle edge cases for base64url conversion', () => {
-        const edgeCases = [
-            '',
-            'A',
-            'AA',
-            'AAA',
-            '====',
-            '===',
-            '==',
-            '=',
-            'A===',
-            'AA==',
-            'AAA=',
-        ];
-        for (const testCase of edgeCases) {
-            const encoded = (0, base64_js_1.toB64Url)(Buffer.from(testCase));
-            const decoded = Buffer.from((0, base64_js_1.fromB64Url)(encoded)).toString();
-            node_assert_1.strict.strictEqual(decoded, testCase, `Failed for edge case: ${testCase}`);
-        }
-    });
-    (0, node_test_1.it)('should generate random text', () => {
-        const randomText = (0, base64_js_1.getRandomText)();
-        const randomText2 = (0, base64_js_1.getRandomText)();
-        node_assert_1.strict.strictEqual(randomText.length, 32);
-        node_assert_1.strict.strictEqual(randomText2.length, 32);
-        node_assert_1.strict.notStrictEqual(randomText, randomText2);
-        const smallRandomText = (0, base64_js_1.getRandomText)(16);
-        const smallRandomText2 = (0, base64_js_1.getRandomText)(16);
-        node_assert_1.strict.strictEqual(smallRandomText.length, 16);
-        node_assert_1.strict.strictEqual(smallRandomText2.length, 16);
-        node_assert_1.strict.notStrictEqual(smallRandomText, smallRandomText2);
-    });
-});

package/lib/cjs/utils/url.test.js

@@ -1,24 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_assert_1 = __importDefault(require("node:assert"));
-const node_test_1 = require("node:test");
-const url_js_1 = require("./url.js");
-(0, node_test_1.test)('urlWithSearchParams prunes undefined values but keeps other falsey values', () => {
-    const result = (0, url_js_1.urlWithSearchParams)({
-        baseUrl: 'https://example.com',
-        params: {
-            number: 1,
-            string: 'string',
-            boolean: true,
-            empty: '',
-            zero: 0,
-            false: false,
-            null: null,
-            undef: undefined,
-        },
-    });
-    node_assert_1.default.strictEqual(result, 'https://example.com/?number=1&string=string&boolean=true&empty=&zero=0&false=false');
-});