@ar.io/sdk 3.11.0-alpha.12 → 3.11.0-alpha.14

package/lib/cjs/common/ant-versions.js

@@ -75,7 +75,8 @@ class ANTVersionsWritable extends ANTVersionsReadable {
         super(config);
         this.signer = (0, ao_js_1.createAoSigner)(signer);
     }
-    async addVersion({ version, moduleId, luaSourceId, notes, }, { tags }) {
+    async addVersion(params, options) {
+        const { version, moduleId, luaSourceId, notes } = params;
         return this.process.send({
             tags: (0, arweave_js_1.pruneTags)([
                 { name: 'Action', value: 'Add-Version' },
@@ -83,7 +84,7 @@ class ANTVersionsWritable extends ANTVersionsReadable {
                 { name: 'Module-Id', value: moduleId },
                 { name: 'Lua-Source-Id', value: luaSourceId },
                 { name: 'Notes', value: notes },
-                ...(tags ?? []),
+                ...(options?.tags ?? []),
             ]),
             signer: this.signer,
         });

package/lib/cjs/common/index.js

@@ -38,5 +38,3 @@ __exportStar(require("./faucet.js"), exports);
 // ao
 __exportStar(require("./io.js"), exports);
 __exportStar(require("./contracts/ao-process.js"), exports);
-// wayfinder
-__exportStar(require("./wayfinder/index.js"), exports);

package/lib/cjs/common/io.js

@@ -457,7 +457,7 @@ class ARIOReadable {
                 years,
             });
             return {
-                tokenCost: +mARIO,
+                tokenCost: mARIO.valueOf(),
                 wincQty: winc,
                 discounts: [],
             };
@@ -626,12 +626,15 @@ class ARIOReadable {
         });
     }
     async resolveArNSName({ name, }) {
-        const baseName = name.split('_').pop();
-        if (baseName === undefined) {
-            throw new Error('Invalid name');
-        }
-        const undername = name === baseName ? '@' : name.replace(`_${baseName}`, '');
+        // derive baseName & undername using last underscore
+        const lastUnderscore = name.lastIndexOf('_');
+        const baseName = lastUnderscore === -1 ? name : name.slice(lastUnderscore + 1);
+        const undername = lastUnderscore === -1 ? '@' : name.slice(0, lastUnderscore);
+        // guard against missing or unregistered ARNS record
         const nameData = await this.getArNSRecord({ name: baseName });
+        if (nameData === undefined || nameData.processId === undefined) {
+            throw new Error(`Base ArNS name ${baseName} not found on ARIO contract (${this.process.processId}).`);
+        }
         const ant = ant_js_1.ANT.init({
             process: new ao_process_js_1.AOProcess({
                 ao: this.process.ao,
@@ -650,12 +653,13 @@ class ARIOReadable {
             throw new Error(`Invalid record on ANT. Must have ttlSeconds and transactionId. Record: ${JSON.stringify(antRecord)}`);
         }
         return {
-            name: name,
-            owner: owner,
+            name,
+            owner,
             txId: antRecord.transactionId,
             ttlSeconds: antRecord.ttlSeconds,
             priority: antRecord.priority,
-            // NOTE: we may want return the actual index of the record based on sorting in case ANT tries to set duplicate priority values to get around undername limits
+            // NOTE: we may want return the actual index of the record based on sorting
+            // in case ANT tries to set duplicate priority values to get around undername limits
             processId: nameData.processId,
             undernameLimit: nameData.undernameLimit,
             type: nameData.type,

package/lib/cjs/common/turbo.js

@@ -77,7 +77,7 @@ async function signedRequestHeadersFromSigner({ signer, nonce = (0, uuid_1.v4)()
         'x-public-key': publicKey,
         'x-nonce': nonce,
         'x-signature': signature,
-        'x-signature-type': signatureType,
+        'x-signature-type': signatureType.toString(),
     };
 }
 class TurboArNSPaymentFactory {

package/lib/cjs/types/index.js

@@ -35,4 +35,3 @@ __exportStar(require("./common.js"), exports);
 __exportStar(require("./faucet.js"), exports);
 __exportStar(require("./io.js"), exports);
 __exportStar(require("./token.js"), exports);
-__exportStar(require("./wayfinder.js"), exports);

package/lib/cjs/utils/ao.js

@@ -77,8 +77,9 @@ async function spawnANT({ signer, module = constants_js_1.AOS_MODULE_ID, ao = (0
         }
     }
     if (bootRes === undefined ||
-        bootRes.Messages.find((m) => m.Tags.find((t) => t.value === 'Invalid-Boot-Notice'))) {
+        bootRes.Messages?.some((m) => m?.Tags?.some((t) => t.value === 'Invalid-Boot-Notice'))) {
         if (bootRes === undefined) {
+            // …
             throw new Error('Failed to get boot result');
         }
         const bootError = errorMessageFromOutput(bootRes);

package/lib/cjs/version.js

@@ -17,4 +17,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '3.11.0-alpha.12';
+exports.version = '3.11.0-alpha.14';

package/lib/esm/common/ant-versions.js

@@ -70,7 +70,8 @@ export class ANTVersionsWritable extends ANTVersionsReadable {
         super(config);
         this.signer = createAoSigner(signer);
     }
-    async addVersion({ version, moduleId, luaSourceId, notes, }, { tags }) {
+    async addVersion(params, options) {
+        const { version, moduleId, luaSourceId, notes } = params;
         return this.process.send({
             tags: pruneTags([
                 { name: 'Action', value: 'Add-Version' },
@@ -78,7 +79,7 @@ export class ANTVersionsWritable extends ANTVersionsReadable {
                 { name: 'Module-Id', value: moduleId },
                 { name: 'Lua-Source-Id', value: luaSourceId },
                 { name: 'Notes', value: notes },
-                ...(tags ?? []),
+                ...(options?.tags ?? []),
             ]),
             signer: this.signer,
         });

package/lib/esm/common/index.js

@@ -22,5 +22,3 @@ export * from './faucet.js';
 // ao
 export * from './io.js';
 export * from './contracts/ao-process.js';
-// wayfinder
-export * from './wayfinder/index.js';

package/lib/esm/common/io.js

@@ -453,7 +453,7 @@ export class ARIOReadable {
                 years,
             });
             return {
-                tokenCost: +mARIO,
+                tokenCost: mARIO.valueOf(),
                 wincQty: winc,
                 discounts: [],
             };
@@ -622,12 +622,15 @@ export class ARIOReadable {
         });
     }
     async resolveArNSName({ name, }) {
-        const baseName = name.split('_').pop();
-        if (baseName === undefined) {
-            throw new Error('Invalid name');
-        }
-        const undername = name === baseName ? '@' : name.replace(`_${baseName}`, '');
+        // derive baseName & undername using last underscore
+        const lastUnderscore = name.lastIndexOf('_');
+        const baseName = lastUnderscore === -1 ? name : name.slice(lastUnderscore + 1);
+        const undername = lastUnderscore === -1 ? '@' : name.slice(0, lastUnderscore);
+        // guard against missing or unregistered ARNS record
         const nameData = await this.getArNSRecord({ name: baseName });
+        if (nameData === undefined || nameData.processId === undefined) {
+            throw new Error(`Base ArNS name ${baseName} not found on ARIO contract (${this.process.processId}).`);
+        }
         const ant = ANT.init({
             process: new AOProcess({
                 ao: this.process.ao,
@@ -646,12 +649,13 @@ export class ARIOReadable {
             throw new Error(`Invalid record on ANT. Must have ttlSeconds and transactionId. Record: ${JSON.stringify(antRecord)}`);
         }
         return {
-            name: name,
-            owner: owner,
+            name,
+            owner,
             txId: antRecord.transactionId,
             ttlSeconds: antRecord.ttlSeconds,
             priority: antRecord.priority,
-            // NOTE: we may want return the actual index of the record based on sorting in case ANT tries to set duplicate priority values to get around undername limits
+            // NOTE: we may want return the actual index of the record based on sorting
+            // in case ANT tries to set duplicate priority values to get around undername limits
             processId: nameData.processId,
             undernameLimit: nameData.undernameLimit,
             type: nameData.type,

package/lib/esm/common/turbo.js

@@ -72,7 +72,7 @@ export async function signedRequestHeadersFromSigner({ signer, nonce = uuidv4(),
         'x-public-key': publicKey,
         'x-nonce': nonce,
         'x-signature': signature,
-        'x-signature-type': signatureType,
+        'x-signature-type': signatureType.toString(),
     };
 }
 export class TurboArNSPaymentFactory {

package/lib/esm/types/index.js

@@ -19,4 +19,3 @@ export * from './common.js';
 export * from './faucet.js';
 export * from './io.js';
 export * from './token.js';
-export * from './wayfinder.js';

package/lib/esm/utils/ao.js

@@ -66,8 +66,9 @@ export async function spawnANT({ signer, module = AOS_MODULE_ID, ao = connect(),
         }
     }
     if (bootRes === undefined ||
-        bootRes.Messages.find((m) => m.Tags.find((t) => t.value === 'Invalid-Boot-Notice'))) {
+        bootRes.Messages?.some((m) => m?.Tags?.some((t) => t.value === 'Invalid-Boot-Notice'))) {
         if (bootRes === undefined) {
+            // …
             throw new Error('Failed to get boot result');
         }
         const bootError = errorMessageFromOutput(bootRes);

package/lib/esm/version.js

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '3.11.0-alpha.12';
+export const version = '3.11.0-alpha.14';

package/lib/types/common/ant-versions.d.ts

@@ -1,5 +1,5 @@
 import { AoANTVersionsRead, AoANTVersionsWrite } from '../types/ant.js';
-import { AoMessageResult, WithSigner } from '../types/common.js';
+import { AoMessageResult, WithSigner, WriteOptions } from '../types/common.js';
 import { ProcessConfiguration } from '../types/io.js';
 import { AOProcess } from './contracts/ao-process.js';
 type ANTVersionsNoSigner = ProcessConfiguration;
@@ -27,13 +27,11 @@ export declare class ANTVersionsReadable implements AoANTVersionsRead {
 export declare class ANTVersionsWritable extends ANTVersionsReadable implements AoANTVersionsWrite {
     private signer;
     constructor({ signer, ...config }: WithSigner<ProcessConfiguration>);
-    addVersion({ version, moduleId, luaSourceId, notes, }: {
+    addVersion(params: {
         version: string;
         moduleId: string;
         luaSourceId?: string;
         notes?: string;
-    }, { tags }: {
-        tags: any;
-    }): Promise<AoMessageResult>;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
 }
 export {};

package/lib/types/common/index.d.ts

@@ -21,4 +21,3 @@ export * from './ant-versions.js';
 export * from './faucet.js';
 export * from './io.js';
 export * from './contracts/ao-process.js';
-export * from './wayfinder/index.js';

package/lib/types/types/index.d.ts

@@ -19,4 +19,3 @@ export * from './common.js';
 export * from './faucet.js';
 export * from './io.js';
 export * from './token.js';
-export * from './wayfinder.js';

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.0-alpha.11";
+export declare const version = "3.11.0-alpha.13";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "3.11.0-alpha.12",
+  "version": "3.11.0-alpha.14",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"

package/lib/cjs/common/wayfinder/gateways/trusted-gateways.js

@@ -1,106 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TrustedGatewaysHashProvider = void 0;
-const arioGatewayHeaders = {
-    digest: 'x-ar-io-digest',
-    verified: 'x-ar-io-verified',
-    txId: 'x-arns-resolved-tx-id',
-    processId: 'x-arns-resolved-process-id',
-};
-class TrustedGatewaysHashProvider {
-    gatewaysProvider;
-    constructor({ gatewaysProvider,
-    // TODO: add threshold for allowed hash difference (i.e. by count or ratio of total gateways checked)
-     }) {
-        this.gatewaysProvider = gatewaysProvider;
-    }
-    /**
-     * Gets the digest for a given txId from all trusted gateways and ensures they all match.
-     * @param txId - The txId to get the digest for.
-     * @returns The digest for the given txId.
-     */
-    async getHash({ txId, }) {
-        // get the hash from every gateway, and ensure they all match
-        const hashSet = new Set();
-        const hashResults = [];
-        const gateways = await this.gatewaysProvider.getGateways();
-        const hashes = await Promise.all(gateways.map(async (gateway) => {
-            const response = await fetch(`${gateway.toString()}${txId}`, {
-                method: 'HEAD',
-                redirect: 'follow',
-            });
-            if (!response.ok) {
-                // skip this gateway
-                return undefined;
-            }
-            const txIdHash = response.headers.get(arioGatewayHeaders.digest);
-            if (txIdHash === null || txIdHash === undefined) {
-                // skip this gateway
-                return undefined;
-            }
-            hashResults.push({
-                gateway: gateway.hostname,
-                txIdHash,
-            });
-            return txIdHash;
-        }));
-        for (const hash of hashes) {
-            if (hash !== undefined) {
-                hashSet.add(hash);
-            }
-        }
-        if (hashSet.size === 0) {
-            throw new Error(`No trusted gateways returned a hash for txId ${txId}`);
-        }
-        if (hashSet.size > 1) {
-            throw new Error(`Failed to get consistent hash from all trusted gateways. ${JSON.stringify(hashResults)}`);
-        }
-        return { hash: hashResults[0].txIdHash, algorithm: 'sha256' };
-    }
-    /**
-     * Get the data root for a given txId from all trusted gateways and ensure they all match.
-     * @param txId - The txId to get the data root for.
-     * @returns The data root for the given txId.
-     */
-    async getDataRoot({ txId }) {
-        const dataRootSet = new Set();
-        const dataRootResults = [];
-        const gateways = await this.gatewaysProvider.getGateways();
-        const dataRoots = await Promise.all(gateways.map(async (gateway) => {
-            const response = await fetch(`${gateway.toString()}tx/${txId}/data_root`);
-            if (!response.ok) {
-                // skip this gateway
-                return undefined;
-            }
-            const dataRoot = await response.text();
-            dataRootResults.push({
-                gateway: gateway.hostname,
-                dataRoot,
-            });
-            return dataRoot;
-        }));
-        for (const dataRoot of dataRoots) {
-            if (dataRoot !== undefined) {
-                dataRootSet.add(dataRoot);
-            }
-        }
-        if (dataRootSet.size > 1) {
-            throw new Error(`Failed to get consistent data root from all trusted gateways. ${JSON.stringify(dataRootResults)}`);
-        }
-        return dataRootSet.values().next().value;
-    }
-}
-exports.TrustedGatewaysHashProvider = TrustedGatewaysHashProvider;
-// client could check hashes of data items, match expected hash
-// if the gateway has the hash and they've verified it, you can trust the data item and offset
-// you would be only trusting the gateway that it is a valid bundle
-// you can request the offset from the gateway to verify the id
-/**
- * Note from @djwhitt
- *
- * Calculating data roots this way is fine, but it may not reproduce the original data root.
- * We could also implement a data root verifier that pulls all the chunks, checks that they
- * reproduce the expected data root, and then compares the concatenated chunk data to the
- * original data retrieved. That would take a while, but it should be able to verify any L1
- * data where we can find the chunks.
- */

package/lib/cjs/common/wayfinder/gateways.js

@@ -1,86 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SimpleCacheGatewaysProvider = exports.StaticGatewaysProvider = exports.NetworkGatewaysProvider = void 0;
-class NetworkGatewaysProvider {
-    ario;
-    sortBy;
-    sortOrder;
-    limit;
-    filter;
-    constructor({ ario, sortBy = 'operatorStake', sortOrder = 'desc', limit = 1000, filter = (g) => g.status === 'joined', }) {
-        this.ario = ario;
-        this.sortBy = sortBy;
-        this.sortOrder = sortOrder;
-        this.limit = limit;
-        this.filter = filter;
-    }
-    async getGateways() {
-        let cursor;
-        let attempts = 0;
-        const gateways = [];
-        do {
-            try {
-                const { items: newGateways = [], nextCursor } = await this.ario.getGateways({
-                    limit: 1000,
-                    cursor,
-                    sortBy: this.sortBy,
-                    sortOrder: this.sortOrder,
-                });
-                gateways.push(...newGateways);
-                cursor = nextCursor;
-                attempts = 0; // reset attempts if we get a new cursor
-            }
-            catch (error) {
-                console.error('Error fetching gateways', {
-                    cursor,
-                    attempts,
-                    error,
-                });
-                attempts++;
-            }
-        } while (cursor !== undefined && attempts < 3);
-        // filter out any gateways that are not joined
-        const filteredGateways = gateways.filter(this.filter).slice(0, this.limit);
-        return filteredGateways.map((g) => new URL(`${g.settings.protocol}://${g.settings.fqdn}:${g.settings.port}`));
-    }
-}
-exports.NetworkGatewaysProvider = NetworkGatewaysProvider;
-class StaticGatewaysProvider {
-    gateways;
-    constructor({ gateways }) {
-        this.gateways = gateways.map((g) => new URL(g));
-    }
-    async getGateways() {
-        return this.gateways;
-    }
-}
-exports.StaticGatewaysProvider = StaticGatewaysProvider;
-class SimpleCacheGatewaysProvider {
-    gatewaysProvider;
-    ttlSeconds;
-    lastUpdated;
-    gatewaysCache;
-    constructor({ gatewaysProvider, ttlSeconds = 5 * 60, // 5 minutes
-     }) {
-        this.gatewaysCache = [];
-        this.gatewaysProvider = gatewaysProvider;
-        this.ttlSeconds = ttlSeconds;
-    }
-    async getGateways() {
-        const now = Date.now();
-        if (this.gatewaysCache.length === 0 ||
-            now - this.lastUpdated > this.ttlSeconds * 1000) {
-            try {
-                // preserve the cache if the fetch fails
-                const allGateways = await this.gatewaysProvider.getGateways();
-                this.gatewaysCache = allGateways;
-                this.lastUpdated = now;
-            }
-            catch (error) {
-                console.error('Error fetching gateways', error);
-            }
-        }
-        return this.gatewaysCache;
-    }
-}
-exports.SimpleCacheGatewaysProvider = SimpleCacheGatewaysProvider;

package/lib/cjs/common/wayfinder/index.js

@@ -1,44 +0,0 @@
-"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * 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.
- */
-__exportStar(require("./wayfinder.js"), exports);
-// routers
-__exportStar(require("./routers/random.js"), exports);
-__exportStar(require("./routers/priority.js"), exports);
-__exportStar(require("./routers/static.js"), exports);
-// gateways providers
-__exportStar(require("./gateways.js"), exports);
-// trusted gateways
-__exportStar(require("./gateways/trusted-gateways.js"), exports);
-// hash providers
-__exportStar(require("./verification/data-root-verifier.js"), exports);
-__exportStar(require("./verification/hash-verifier.js"), exports);
-// TODO: signature verification

package/lib/cjs/common/wayfinder/routers/priority.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PriorityGatewayRouter = void 0;
-const random_js_1 = require("../../../utils/random.js");
-const gateways_js_1 = require("../gateways.js");
-// TODO: one of N where N are in the last time window have met certain performance thresholds
-// TODO: look at bitorrent routing protocols for inspiration
-// TODO: router that looks at local stats/metrics and adjusts based on those
-class PriorityGatewayRouter {
-    name = 'priority';
-    gatewaysProvider;
-    constructor({ ario, sortBy, sortOrder, limit, }) {
-        this.gatewaysProvider = new gateways_js_1.NetworkGatewaysProvider({
-            ario,
-            sortBy,
-            sortOrder,
-            limit,
-        });
-    }
-    async getTargetGateway() {
-        const gateways = await this.gatewaysProvider.getGateways();
-        const targetGateway = gateways[(0, random_js_1.randomInt)(0, gateways.length)];
-        if (targetGateway === undefined) {
-            throw new Error('No target gateway found');
-        }
-        return targetGateway;
-    }
-}
-exports.PriorityGatewayRouter = PriorityGatewayRouter;