@ar.io/sdk 3.3.0-alpha.11 → 3.3.0-alpha.13

package/lib/cjs/cli/cli.js

@@ -671,6 +671,7 @@ const utils_js_1 = require("./utils.js");
     action: async (options) => {
         const process = new index_js_1.AOProcess({
             processId: (0, utils_js_1.requiredProcessIdFromOptions)(options),
+            logger: (0, utils_js_1.getLoggerFromOptions)(options),
         });
         return process.send({
             tags: (0, utils_js_1.writeActionTagsFromOptions)(options).tags ?? [],

package/lib/cjs/cli/utils.js

@@ -198,7 +198,7 @@ function paginationParamsFromOptions(options) {
     return {
         cursor,
         limit: numberLimit,
-        sortBy,
+        sortBy: sortBy,
         sortOrder,
     };
 }

package/lib/cjs/common/contracts/ao-process.js

@@ -18,6 +18,7 @@ exports.AOProcess = void 0;
  */
 const aoconnect_1 = require("@permaweb/aoconnect");
 const base64_js_1 = require("../../utils/base64.js");
+const index_js_1 = require("../../utils/index.js");
 const json_js_1 = require("../../utils/json.js");
 const version_js_1 = require("../../version.js");
 const error_js_1 = require("../error.js");
@@ -59,7 +60,7 @@ class AOProcess {
                     result,
                     processId: this.processId,
                 });
-                const error = errorMessageFromOutput(result);
+                const error = (0, index_js_1.errorMessageFromOutput)(result);
                 if (error !== undefined) {
                     throw new Error(error);
                 }
@@ -131,7 +132,7 @@ class AOProcess {
                     messageId,
                     processId: this.processId,
                 });
-                const error = errorMessageFromOutput(output);
+                const error = (0, index_js_1.errorMessageFromOutput)(output);
                 if (error !== undefined) {
                     throw new error_js_1.WriteInteractionError(error);
                 }
@@ -181,18 +182,3 @@ class AOProcess {
     }
 }
 exports.AOProcess = AOProcess;
-function errorMessageFromOutput(output) {
-    const errorData = output.Error;
-    // Attempt to extract error details from Messages.Tags if Error is undefined
-    const error = errorData ??
-        output.Messages?.[0]?.Tags?.find((tag) => tag.name === 'Error')?.value;
-    if (error !== undefined) {
-        // Consolidated regex to match and extract line number and AO error message or Error Tags
-        const match = error.match(/\[string "aos"]:(\d+):\s*(.+)/);
-        if (match) {
-            const [, lineNumber, errorMessage] = match;
-            return `${errorMessage.trim()} (line ${lineNumber.trim()})`.trim();
-        }
-    }
-    return undefined;
-}

package/lib/cjs/utils/ao.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseAoEpochData = exports.initANTStateForAddress = exports.defaultTargetManifestId = exports.createAoSigner = exports.isAoSigner = exports.evolveANT = exports.spawnANT = void 0;
+exports.removeUnicodeFromError = exports.errorMessageFromOutput = exports.parseAoEpochData = exports.initANTStateForAddress = exports.defaultTargetManifestId = exports.createAoSigner = exports.isAoSigner = exports.evolveANT = exports.spawnANT = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -219,3 +219,30 @@ function parseAoEpochData(value) {
     return epochDataSchema.parse(value);
 }
 exports.parseAoEpochData = parseAoEpochData;
+function errorMessageFromOutput(output) {
+    const errorData = output.Error;
+    // Attempt to extract error details from Messages.Tags if Error is undefined
+    const error = errorData ??
+        output.Messages?.[0]?.Tags?.find((tag) => tag.name === 'Error')?.value;
+    if (error !== undefined) {
+        // Consolidated regex to match and extract line number and AO error message or Error Tags
+        const match = error.match(/\[string "aos"]:(\d+):\s*(.+)/);
+        if (match) {
+            const [, lineNumber, errorMessage] = match;
+            const cleanError = removeUnicodeFromError(errorMessage);
+            return `${cleanError.trim()} (line ${lineNumber.trim()})`.trim();
+        }
+        // With no match, just remove unicode
+        return removeUnicodeFromError(error);
+    }
+    return undefined;
+}
+exports.errorMessageFromOutput = errorMessageFromOutput;
+function removeUnicodeFromError(error) {
+    //The regular expression /[\u001b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g is designed to match ANSI escape codes used for terminal formatting. These are sequences that begin with \u001b (ESC character) and are often followed by [ and control codes.
+    const ESC = String.fromCharCode(27); // Represents '\u001b' or '\x1b'
+    return error
+        .replace(new RegExp(`${ESC}[\\[\\]()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]`, 'g'), '')
+        .trim();
+}
+exports.removeUnicodeFromError = removeUnicodeFromError;

package/lib/cjs/utils/arweave.js

@@ -35,22 +35,40 @@ exports.paginationParamsToTags = paginationParamsToTags;
  * @param arweave - The Arweave instance
  * @returns The epoch with distribution data
  */
-const getEpochDataFromGql = async ({ arweave, epochIndex, processId = constants_js_1.ARIO_TESTNET_PROCESS_ID, }) => {
+const getEpochDataFromGql = async ({ arweave, epochIndex, processId = constants_js_1.ARIO_TESTNET_PROCESS_ID, retries = 3, }) => {
     // fetch from gql
     const query = (0, exports.epochDistributionNoticeGqlQuery)({ epochIndex, processId });
-    const response = await arweave.api.post('graphql', query);
-    // parse the nodes to get the id
-    if (response.data.data.transactions?.edges?.length === 0) {
-        return undefined;
+    // add three retries with exponential backoff
+    for (let i = 0; i < retries; i++) {
+        try {
+            const response = await arweave.api.post('graphql', query);
+            // parse the nodes to get the id
+            if (response.data?.data?.transactions?.edges?.length === 0) {
+                return undefined;
+            }
+            const id = response.data.data.transactions.edges[0].node.id;
+            // fetch the transaction from arweave
+            const transaction = await arweave.api.get(id);
+            // assert it is the correct type
+            return (0, ao_js_1.parseAoEpochData)(transaction.data);
+        }
+        catch (error) {
+            if (i === retries - 1)
+                throw error; // Re-throw on final attempt
+            // exponential backoff
+            await new Promise((resolve) => setTimeout(resolve, Math.pow(2, i) * 1000));
+        }
     }
-    const id = response.data.data.transactions.edges[0].node.id;
-    // fetch the transaction from arweave
-    const transaction = await arweave.api.get(id);
-    const data = transaction.data;
-    // assert it is the correct type
-    return (0, ao_js_1.parseAoEpochData)(data);
+    return undefined;
 };
 exports.getEpochDataFromGql = getEpochDataFromGql;
+/**
+ * Get the epoch with distribution data for the current epoch
+ * @param arweave - The Arweave instance
+ * @param epochIndex - The index of the epoch
+ * @param processId - The process ID (optional, defaults to ARIO_TESTNET_PROCESS_ID)
+ * @returns string - The stringified GQL query
+ */
 const epochDistributionNoticeGqlQuery = ({ epochIndex, processId = constants_js_1.ARIO_TESTNET_PROCESS_ID, }) => {
     // write the query
     const gqlQuery = JSON.stringify({

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.3.0-alpha.11';
+exports.version = '3.3.0-alpha.13';

package/lib/esm/cli/cli.js

@@ -669,6 +669,7 @@ makeCommand({
     action: async (options) => {
         const process = new AOProcess({
             processId: requiredProcessIdFromOptions(options),
+            logger: getLoggerFromOptions(options),
         });
         return process.send({
             tags: writeActionTagsFromOptions(options).tags ?? [],

package/lib/esm/cli/utils.js

@@ -176,7 +176,7 @@ export function paginationParamsFromOptions(options) {
     return {
         cursor,
         limit: numberLimit,
-        sortBy,
+        sortBy: sortBy,
         sortOrder,
     };
 }

package/lib/esm/common/contracts/ao-process.js

@@ -15,6 +15,7 @@
  */
 import { connect } from '@permaweb/aoconnect';
 import { getRandomText } from '../../utils/base64.js';
+import { errorMessageFromOutput } from '../../utils/index.js';
 import { safeDecode } from '../../utils/json.js';
 import { version } from '../../version.js';
 import { WriteInteractionError } from '../error.js';
@@ -177,18 +178,3 @@ export class AOProcess {
         throw lastError;
     }
 }
-function errorMessageFromOutput(output) {
-    const errorData = output.Error;
-    // Attempt to extract error details from Messages.Tags if Error is undefined
-    const error = errorData ??
-        output.Messages?.[0]?.Tags?.find((tag) => tag.name === 'Error')?.value;
-    if (error !== undefined) {
-        // Consolidated regex to match and extract line number and AO error message or Error Tags
-        const match = error.match(/\[string "aos"]:(\d+):\s*(.+)/);
-        if (match) {
-            const [, lineNumber, errorMessage] = match;
-            return `${errorMessage.trim()} (line ${lineNumber.trim()})`.trim();
-        }
-    }
-    return undefined;
-}

package/lib/esm/utils/ao.js

@@ -210,3 +210,28 @@ export function parseAoEpochData(value) {
     });
     return epochDataSchema.parse(value);
 }
+export function errorMessageFromOutput(output) {
+    const errorData = output.Error;
+    // Attempt to extract error details from Messages.Tags if Error is undefined
+    const error = errorData ??
+        output.Messages?.[0]?.Tags?.find((tag) => tag.name === 'Error')?.value;
+    if (error !== undefined) {
+        // Consolidated regex to match and extract line number and AO error message or Error Tags
+        const match = error.match(/\[string "aos"]:(\d+):\s*(.+)/);
+        if (match) {
+            const [, lineNumber, errorMessage] = match;
+            const cleanError = removeUnicodeFromError(errorMessage);
+            return `${cleanError.trim()} (line ${lineNumber.trim()})`.trim();
+        }
+        // With no match, just remove unicode
+        return removeUnicodeFromError(error);
+    }
+    return undefined;
+}
+export function removeUnicodeFromError(error) {
+    //The regular expression /[\u001b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g is designed to match ANSI escape codes used for terminal formatting. These are sequences that begin with \u001b (ESC character) and are often followed by [ and control codes.
+    const ESC = String.fromCharCode(27); // Represents '\u001b' or '\x1b'
+    return error
+        .replace(new RegExp(`${ESC}[\\[\\]()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]`, 'g'), '')
+        .trim();
+}

package/lib/esm/utils/arweave.js

@@ -28,21 +28,39 @@ export const paginationParamsToTags = (params) => {
  * @param arweave - The Arweave instance
  * @returns The epoch with distribution data
  */
-export const getEpochDataFromGql = async ({ arweave, epochIndex, processId = ARIO_TESTNET_PROCESS_ID, }) => {
+export const getEpochDataFromGql = async ({ arweave, epochIndex, processId = ARIO_TESTNET_PROCESS_ID, retries = 3, }) => {
     // fetch from gql
     const query = epochDistributionNoticeGqlQuery({ epochIndex, processId });
-    const response = await arweave.api.post('graphql', query);
-    // parse the nodes to get the id
-    if (response.data.data.transactions?.edges?.length === 0) {
-        return undefined;
+    // add three retries with exponential backoff
+    for (let i = 0; i < retries; i++) {
+        try {
+            const response = await arweave.api.post('graphql', query);
+            // parse the nodes to get the id
+            if (response.data?.data?.transactions?.edges?.length === 0) {
+                return undefined;
+            }
+            const id = response.data.data.transactions.edges[0].node.id;
+            // fetch the transaction from arweave
+            const transaction = await arweave.api.get(id);
+            // assert it is the correct type
+            return parseAoEpochData(transaction.data);
+        }
+        catch (error) {
+            if (i === retries - 1)
+                throw error; // Re-throw on final attempt
+            // exponential backoff
+            await new Promise((resolve) => setTimeout(resolve, Math.pow(2, i) * 1000));
+        }
     }
-    const id = response.data.data.transactions.edges[0].node.id;
-    // fetch the transaction from arweave
-    const transaction = await arweave.api.get(id);
-    const data = transaction.data;
-    // assert it is the correct type
-    return parseAoEpochData(data);
+    return undefined;
 };
+/**
+ * Get the epoch with distribution data for the current epoch
+ * @param arweave - The Arweave instance
+ * @param epochIndex - The index of the epoch
+ * @param processId - The process ID (optional, defaults to ARIO_TESTNET_PROCESS_ID)
+ * @returns string - The stringified GQL query
+ */
 export const epochDistributionNoticeGqlQuery = ({ epochIndex, processId = ARIO_TESTNET_PROCESS_ID, }) => {
     // write the query
     const gqlQuery = JSON.stringify({

package/lib/esm/version.js

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

package/lib/types/cli/commands/readCommands.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { AoGetCostDetailsParams } from '../../types/io.js';
+import { AoDelegation, AoGatewayDelegateWithAddress, AoGatewayVault, AoGetCostDetailsParams } from '../../types/io.js';
 import { AddressAndNameCLIOptions, AddressAndVaultIdCLIOptions, AddressCLIOptions, CLIOptionsFromAoParams, EpochCLIOptions, GetTokenCostCLIOptions, GlobalCLIOptions, NameCLIOptions, PaginationAddressCLIOptions, PaginationCLIOptions } from '../types.js';
 export declare function getGateway(o: AddressCLIOptions): Promise<import("../../types/io.js").AoGateway | {
     message: string;
@@ -24,10 +24,10 @@ export declare function listGateways(o: PaginationCLIOptions): Promise<import(".
 export declare function listAllDelegatesCLICommand(o: PaginationCLIOptions): Promise<import("../../types/io.js").PaginationResult<import("../../types/io.js").AoAllDelegates> | {
     message: string;
 }>;
-export declare function getGatewayDelegates(o: AddressCLIOptions): Promise<import("../../types/io.js").PaginationResult<import("../../types/io.js").AoGatewayDelegateWithAddress> | {
+export declare function getGatewayDelegates(o: AddressCLIOptions): Promise<import("../../types/io.js").PaginationResult<AoGatewayDelegateWithAddress> | {
     message: string;
 }>;
-export declare function getDelegations(o: PaginationAddressCLIOptions): Promise<import("../../types/io.js").PaginationResult<import("../../types/io.js").AoDelegation> | {
+export declare function getDelegations(o: PaginationAddressCLIOptions): Promise<import("../../types/io.js").PaginationResult<AoDelegation> | {
     message: string;
 }>;
 export declare function getAllowedDelegates(o: PaginationAddressCLIOptions): Promise<import("../../types/io.js").PaginationResult<string> | {
@@ -76,7 +76,7 @@ export declare function getCostDetails(o: GlobalCLIOptions & CLIOptionsFromAoPar
 export declare function getPrimaryName(o: AddressAndNameCLIOptions): Promise<import("../../types/common.js").AoPrimaryName | {
     message: string;
 }>;
-export declare function getGatewayVaults(o: PaginationAddressCLIOptions): Promise<import("../../types/io.js").PaginationResult<import("../../types/io.js").AoGatewayVault> | {
+export declare function getGatewayVaults(o: PaginationAddressCLIOptions): Promise<import("../../types/io.js").PaginationResult<AoGatewayVault> | {
     message: string;
 }>;
 export declare function getVault(o: AddressAndVaultIdCLIOptions): Promise<import("../../types/io.js").AoVaultData | {

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

@@ -35,9 +35,7 @@ export declare function formatMARIOToARIOWithCommas(value: mARIOToken): string;
 /** helper to get address from --address option first, then check wallet options  */
 export declare function addressFromOptions<O extends AddressCLIOptions>(options: O): string | undefined;
 export declare function requiredAddressFromOptions<O extends AddressCLIOptions>(options: O): string;
-export declare function paginationParamsFromOptions<O extends PaginationCLIOptions>(options: O): PaginationParams & {
-    sortBy: any;
-};
+export declare function paginationParamsFromOptions<O extends PaginationCLIOptions, R>(options: O): PaginationParams<R>;
 export declare function epochInputFromOptions(options: EpochCLIOptions): EpochInput;
 export declare function requiredInitiatorFromOptions(options: InitiatorCLIOptions): string;
 export declare function writeActionTagsFromOptions<O extends WriteActionCLIOptions>(options: O): WriteOptions;

package/lib/types/types/io.d.ts

@@ -16,10 +16,14 @@
 import { AOProcess } from '../common/index.js';
 import { AoMessageResult, AoPrimaryName, AoPrimaryNameRequest, AoRedelegationFeeInfo, AtLeastOne, BlockHeight, ProcessId, Timestamp, TransactionId, WalletAddress, WriteOptions } from './index.js';
 import { mARIOToken } from './token.js';
+type NestedKeys<T> = T extends object ? T extends readonly unknown[] ? never : {
+    [K in keyof T & string]: T[K] extends object ? `${K}.${NestedKeys<T[K]>}` : K;
+}[keyof T & string] : never;
+export type SortBy<T> = T extends string ? string : keyof T extends never ? string : NestedKeys<T>;
 export type PaginationParams<T = Record<string, never>> = {
     cursor?: string;
     limit?: number;
-    sortBy?: keyof T extends never ? string : keyof T;
+    sortBy?: SortBy<T>;
     sortOrder?: 'asc' | 'desc';
 };
 export type PaginationResult<T> = {
@@ -27,7 +31,7 @@ export type PaginationResult<T> = {
     nextCursor?: string;
     limit: number;
     totalItems: number;
-    sortBy?: T extends string ? string : keyof T;
+    sortBy?: SortBy<T>;
     sortOrder: 'asc' | 'desc';
     hasMore: boolean;
 };
@@ -250,7 +254,7 @@ export type AoAddressParams = {
     address: WalletAddress;
 };
 export type AoBalanceParams = AoAddressParams;
-export type AoPaginatedAddressParams = PaginationParams & AoAddressParams;
+export type AoPaginatedAddressParams = PaginationParams<string> & AoAddressParams;
 export type AoDelegateStakeParams = {
     target: WalletAddress;
     stakeQty: number | mARIOToken;
@@ -473,3 +477,4 @@ export interface AoARIOWrite extends AoARIORead {
 export declare function isProcessConfiguration(config: object): config is Required<ProcessConfiguration> & Record<string, never>;
 export declare function isProcessIdConfiguration(config: object): config is Required<ProcessIdConfig> & Record<string, never>;
 export declare function isLeasedArNSRecord(record: AoArNSNameData): record is AoArNSLeaseData;
+export {};

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

@@ -52,3 +52,13 @@ export declare function initANTStateForAddress({ owner, targetId, ttlSeconds, ke
  * Uses zod schema to parse the epoch data
  */
 export declare function parseAoEpochData(value: unknown): AoEpochData;
+export declare function errorMessageFromOutput(output: {
+    Error?: string;
+    Messages?: {
+        Tags?: {
+            name: string;
+            value: string;
+        }[];
+    }[];
+}): string | undefined;
+export declare function removeUnicodeFromError(error: string): string;

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

@@ -39,11 +39,19 @@ export declare const paginationParamsToTags: <T>(params?: PaginationParams<T>) =
  * @param arweave - The Arweave instance
  * @returns The epoch with distribution data
  */
-export declare const getEpochDataFromGql: ({ arweave, epochIndex, processId, }: {
+export declare const getEpochDataFromGql: ({ arweave, epochIndex, processId, retries, }: {
     arweave: Arweave;
     epochIndex: number;
     processId?: string;
+    retries?: number;
 }) => Promise<AoEpochData | undefined>;
+/**
+ * Get the epoch with distribution data for the current epoch
+ * @param arweave - The Arweave instance
+ * @param epochIndex - The index of the epoch
+ * @param processId - The process ID (optional, defaults to ARIO_TESTNET_PROCESS_ID)
+ * @returns string - The stringified GQL query
+ */
 export declare const epochDistributionNoticeGqlQuery: ({ epochIndex, processId, }: {
     epochIndex: number;
     processId?: string;

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.3.0-alpha.10";
+export declare const version = "3.3.0-alpha.12";

package/package.json

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