@ar.io/sdk 3.3.0-alpha.9 → 3.3.1-alpha.1

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;
 };
@@ -193,6 +197,11 @@ export type AoGatewayDelegate = {
 export type AoGatewayDelegateWithAddress = AoGatewayDelegate & {
     address: WalletAddress;
 };
+export type AoAllDelegates = AoGatewayDelegateWithAddress & {
+    gatewayAddress: WalletAddress;
+    vaultedStake: number;
+    cursorId: string;
+};
 export type AoGatewaySettings = {
     allowDelegatedStaking: boolean | 'allowlist';
     delegateRewardShareRatio: number;
@@ -232,6 +241,7 @@ export type AoStakeDelegation = AoDelegationBase & {
     balance: number;
 };
 export type AoDelegation = AoStakeDelegation | AoVaultDelegation;
+/** Operator stake being withdrawn from a given gateway */
 export type AoGatewayVault = {
     cursorId: string;
     vaultId: TransactionId;
@@ -239,6 +249,10 @@ export type AoGatewayVault = {
     endTimestamp: Timestamp;
     startTimestamp: Timestamp;
 };
+/** Operator stake being withdrawn from all gateway gateways */
+export type AoAllGatewayVaults = AoGatewayVault & {
+    gatewayAddress: WalletAddress;
+};
 export type AoJoinNetworkParams = Pick<AoGateway, 'operatorStake'> & Partial<AoGatewaySettings> & {
     observerAddress?: WalletAddress;
 };
@@ -250,7 +264,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;
@@ -418,15 +432,8 @@ export interface AoARIORead {
     }): Promise<AoRedelegationFeeInfo>;
     getGatewayRegistrySettings(): Promise<AoGatewayRegistrySettings>;
     getAllDelegates(params?: PaginationParams<AoAllDelegates>): Promise<PaginationResult<AoAllDelegates>>;
+    getAllGatewayVaults(params?: PaginationParams<AoAllGatewayVaults>): Promise<PaginationResult<AoAllGatewayVaults>>;
 }
-export type AoAllDelegates = {
-    address: WalletAddress;
-    gatewayAddress: WalletAddress;
-    delegatedStake: number;
-    startTimestamp: Timestamp;
-    vaultedStake: number;
-    cursorId: string;
-};
 export interface AoARIOWrite extends AoARIORead {
     transfer({ target, qty, }: {
         target: WalletAddress;
@@ -473,3 +480,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

@@ -21,6 +21,7 @@ export type SpawnANTParams = {
     stateContractTxId?: string;
     antRegistryId?: string;
     logger?: Logger;
+    authority?: string;
     /**
      * @deprecated Compiled modules are now being used instead of luaCodeTxId
      */
@@ -30,7 +31,7 @@ export type SpawnANTParams = {
      */
     arweave?: Arweave;
 };
-export declare function spawnANT({ signer, module, ao, scheduler, state, stateContractTxId, antRegistryId, logger, }: SpawnANTParams): Promise<string>;
+export declare function spawnANT({ signer, module, ao, scheduler, state, stateContractTxId, antRegistryId, logger, authority, }: SpawnANTParams): Promise<string>;
 export declare function evolveANT({ signer, processId, luaCodeTxId, ao, logger, arweave, }: {
     signer: AoSigner;
     processId: string;
@@ -51,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/utils/processes.d.ts

@@ -1,22 +1,7 @@
-/**
- * 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 { EventEmitter } from 'eventemitter3';
 import { ILogger } from '../common/logger.js';
 import { AoANTRegistryRead } from '../types/ant-registry.js';
-import { AoARIORead, AoArNSNameData, ProcessId, WalletAddress } from '../types/index.js';
+import { AoARIORead, AoArNSNameData, AoClient, ProcessId, WalletAddress } from '../types/index.js';
 /**
  * @beta This API is in beta and may change in the future.
  */
@@ -30,12 +15,14 @@ export declare class ArNSEventEmitter extends EventEmitter {
     private throttle;
     private logger;
     private strict;
-    constructor({ contract, timeoutMs, concurrency, logger, strict, }?: {
+    private antAoClient;
+    constructor({ contract, timeoutMs, concurrency, logger, strict, antAoClient, }?: {
         contract?: AoARIORead;
         timeoutMs?: number;
         concurrency?: number;
         logger?: ILogger;
         strict?: boolean;
+        antAoClient?: AoClient;
     });
     fetchProcessesOwnedByWallet({ address, pageSize, antRegistry, }: {
         address: WalletAddress;

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.8";
+export declare const version = "3.3.0";

package/package.json

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