@ar.io/sdk 2.0.0-alpha.9 → 2.0.0

package/lib/cjs/common/io.js

@@ -104,9 +104,17 @@ class IOReadable {
             ],
         });
     }
-    async getArNSRecords() {
+    async getArNSRecords(pageParams) {
+        const allTags = [
+            { name: 'Action', value: 'Paginated-Records' },
+            { name: 'Cursor', value: pageParams?.cursor?.toString() },
+            { name: 'Limit', value: pageParams?.limit?.toString() },
+            { name: 'Sort-By', value: pageParams?.sortBy },
+            { name: 'Sort-Order', value: pageParams?.sortOrder },
+        ];
+        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: [{ name: 'Action', value: 'Records' }],
+            tags: prunedTags,
         });
     }
     async getArNSReservedNames() {
@@ -130,9 +138,17 @@ class IOReadable {
             ],
         });
     }
-    async getBalances() {
+    async getBalances(pageParams) {
+        const allTags = [
+            { name: 'Action', value: 'Paginated-Balances' },
+            { name: 'Cursor', value: pageParams?.cursor?.toString() },
+            { name: 'Limit', value: pageParams?.limit?.toString() },
+            { name: 'Sort-By', value: pageParams?.sortBy },
+            { name: 'Sort-Order', value: pageParams?.sortOrder },
+        ];
+        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: [{ name: 'Action', value: 'Balances' }],
+            tags: prunedTags,
         });
     }
     async getGateway({ address, }) {
@@ -143,9 +159,17 @@ class IOReadable {
             ],
         });
     }
-    async getGateways() {
+    async getGateways(pageParams) {
+        const allTags = [
+            { name: 'Action', value: 'Paginated-Gateways' },
+            { name: 'Cursor', value: pageParams?.cursor?.toString() },
+            { name: 'Limit', value: pageParams?.limit?.toString() },
+            { name: 'Sort-By', value: pageParams?.sortBy },
+            { name: 'Sort-Order', value: pageParams?.sortOrder },
+        ];
+        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: [{ name: 'Action', value: 'Gateways' }],
+            tags: prunedTags,
         });
     }
     async getCurrentEpoch() {

package/lib/cjs/utils/index.js

@@ -32,6 +32,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 __exportStar(require("./arweave.js"), exports);
 __exportStar(require("./http-client.js"), exports);
-__exportStar(require("./graphql/index.js"), exports);
 __exportStar(require("./ao.js"), exports);
 __exportStar(require("./json.js"), exports);
+__exportStar(require("./processes.js"), exports);

package/lib/cjs/utils/{graphql/processes.js → processes.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArNSEventEmitter = exports.getANTProcessesOwnedByWallet = void 0;
+exports.fetchAllArNSRecords = exports.ArNSEventEmitter = exports.getANTProcessesOwnedByWallet = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc. All Rights Reserved.
  *
@@ -19,19 +19,20 @@ exports.ArNSEventEmitter = exports.getANTProcessesOwnedByWallet = void 0;
  */
 const eventemitter3_1 = require("eventemitter3");
 const plimit_lit_1 = require("plimit-lit");
-const ant_js_1 = require("../../common/ant.js");
-const io_js_1 = require("../../common/io.js");
-const constants_js_1 = require("../../constants.js");
+const ant_js_1 = require("../common/ant.js");
+const io_js_1 = require("../common/io.js");
+const constants_js_1 = require("../constants.js");
 const getANTProcessesOwnedByWallet = async ({ address, contract = io_js_1.IO.init({
     processId: constants_js_1.IO_TESTNET_PROCESS_ID,
 }), }) => {
     const throttle = (0, plimit_lit_1.pLimit)(50);
     // get the record names of the registry - TODO: this may need to be paginated
-    const uniqueContractProcessIds = await contract
-        .getArNSRecords()
-        .then((records) => Object.values(records)
+    const records = await (0, exports.fetchAllArNSRecords)({
+        contract: contract,
+    });
+    const uniqueContractProcessIds = Object.values(records)
         .filter((record) => record.processId !== undefined)
-        .map((record) => record.processId));
+        .map((record) => record.processId);
     // check the contract owner and controllers
     const ownedOrControlledByWallet = await Promise.all(uniqueContractProcessIds.map(async (processId) => throttle(async () => {
         const ant = ant_js_1.ANT.init({
@@ -80,10 +81,12 @@ class ArNSEventEmitter extends eventemitter3_1.EventEmitter {
     }
     async fetchProcessesOwnedByWallet({ address }) {
         const uniqueContractProcessIds = {};
-        await timeout(this.timeoutMs, this.contract.getArNSRecords().catch((e) => {
+        await timeout(this.timeoutMs, (0, exports.fetchAllArNSRecords)({ contract: this.contract }))
+            .catch((e) => {
             this.emit('error', `Error getting ArNS records: ${e}`);
             return {};
-        })).then((records) => {
+        })
+            .then((records) => {
             if (!records)
                 return;
             Object.entries(records).forEach(([name, record]) => {
@@ -125,3 +128,30 @@ class ArNSEventEmitter extends eventemitter3_1.EventEmitter {
     }
 }
 exports.ArNSEventEmitter = ArNSEventEmitter;
+const fetchAllArNSRecords = async ({ contract = io_js_1.IO.init({
+    processId: constants_js_1.IO_TESTNET_PROCESS_ID,
+}), logger, }) => {
+    let cursor;
+    const records = {};
+    do {
+        const pageResult = await contract
+            .getArNSRecords({ cursor })
+            .catch((e) => {
+            logger?.error(`Error getting ArNS records`, {
+                message: e?.message,
+                stack: e?.stack,
+            });
+            return undefined;
+        });
+        if (!pageResult) {
+            return {};
+        }
+        pageResult.items.forEach((record) => {
+            const { name, ...recordDetails } = record;
+            records[name] = recordDetails;
+        });
+        cursor = pageResult.nextCursor;
+    } while (cursor !== undefined);
+    return records;
+};
+exports.fetchAllArNSRecords = fetchAllArNSRecords;

package/lib/cjs/version.js

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

package/lib/esm/common/io.js

@@ -100,9 +100,17 @@ export class IOReadable {
             ],
         });
     }
-    async getArNSRecords() {
+    async getArNSRecords(pageParams) {
+        const allTags = [
+            { name: 'Action', value: 'Paginated-Records' },
+            { name: 'Cursor', value: pageParams?.cursor?.toString() },
+            { name: 'Limit', value: pageParams?.limit?.toString() },
+            { name: 'Sort-By', value: pageParams?.sortBy },
+            { name: 'Sort-Order', value: pageParams?.sortOrder },
+        ];
+        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: [{ name: 'Action', value: 'Records' }],
+            tags: prunedTags,
         });
     }
     async getArNSReservedNames() {
@@ -126,9 +134,17 @@ export class IOReadable {
             ],
         });
     }
-    async getBalances() {
+    async getBalances(pageParams) {
+        const allTags = [
+            { name: 'Action', value: 'Paginated-Balances' },
+            { name: 'Cursor', value: pageParams?.cursor?.toString() },
+            { name: 'Limit', value: pageParams?.limit?.toString() },
+            { name: 'Sort-By', value: pageParams?.sortBy },
+            { name: 'Sort-Order', value: pageParams?.sortOrder },
+        ];
+        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: [{ name: 'Action', value: 'Balances' }],
+            tags: prunedTags,
         });
     }
     async getGateway({ address, }) {
@@ -139,9 +155,17 @@ export class IOReadable {
             ],
         });
     }
-    async getGateways() {
+    async getGateways(pageParams) {
+        const allTags = [
+            { name: 'Action', value: 'Paginated-Gateways' },
+            { name: 'Cursor', value: pageParams?.cursor?.toString() },
+            { name: 'Limit', value: pageParams?.limit?.toString() },
+            { name: 'Sort-By', value: pageParams?.sortBy },
+            { name: 'Sort-Order', value: pageParams?.sortOrder },
+        ];
+        const prunedTags = allTags.filter((tag) => tag.value !== undefined);
         return this.process.read({
-            tags: [{ name: 'Action', value: 'Gateways' }],
+            tags: prunedTags,
         });
     }
     async getCurrentEpoch() {

package/lib/esm/utils/index.js

@@ -16,6 +16,6 @@
  */
 export * from './arweave.js';
 export * from './http-client.js';
-export * from './graphql/index.js';
 export * from './ao.js';
 export * from './json.js';
+export * from './processes.js';

package/lib/esm/utils/{graphql/processes.js → processes.js}

@@ -16,19 +16,20 @@
  */
 import { EventEmitter } from 'eventemitter3';
 import { pLimit } from 'plimit-lit';
-import { ANT } from '../../common/ant.js';
-import { IO } from '../../common/io.js';
-import { IO_TESTNET_PROCESS_ID } from '../../constants.js';
+import { ANT } from '../common/ant.js';
+import { IO } from '../common/io.js';
+import { IO_TESTNET_PROCESS_ID } from '../constants.js';
 export const getANTProcessesOwnedByWallet = async ({ address, contract = IO.init({
     processId: IO_TESTNET_PROCESS_ID,
 }), }) => {
     const throttle = pLimit(50);
     // get the record names of the registry - TODO: this may need to be paginated
-    const uniqueContractProcessIds = await contract
-        .getArNSRecords()
-        .then((records) => Object.values(records)
+    const records = await fetchAllArNSRecords({
+        contract: contract,
+    });
+    const uniqueContractProcessIds = Object.values(records)
         .filter((record) => record.processId !== undefined)
-        .map((record) => record.processId));
+        .map((record) => record.processId);
     // check the contract owner and controllers
     const ownedOrControlledByWallet = await Promise.all(uniqueContractProcessIds.map(async (processId) => throttle(async () => {
         const ant = ANT.init({
@@ -76,10 +77,12 @@ export class ArNSEventEmitter extends EventEmitter {
     }
     async fetchProcessesOwnedByWallet({ address }) {
         const uniqueContractProcessIds = {};
-        await timeout(this.timeoutMs, this.contract.getArNSRecords().catch((e) => {
+        await timeout(this.timeoutMs, fetchAllArNSRecords({ contract: this.contract }))
+            .catch((e) => {
             this.emit('error', `Error getting ArNS records: ${e}`);
             return {};
-        })).then((records) => {
+        })
+            .then((records) => {
             if (!records)
                 return;
             Object.entries(records).forEach(([name, record]) => {
@@ -120,3 +123,29 @@ export class ArNSEventEmitter extends EventEmitter {
         this.emit('end', uniqueContractProcessIds);
     }
 }
+export const fetchAllArNSRecords = async ({ contract = IO.init({
+    processId: IO_TESTNET_PROCESS_ID,
+}), logger, }) => {
+    let cursor;
+    const records = {};
+    do {
+        const pageResult = await contract
+            .getArNSRecords({ cursor })
+            .catch((e) => {
+            logger?.error(`Error getting ArNS records`, {
+                message: e?.message,
+                stack: e?.stack,
+            });
+            return undefined;
+        });
+        if (!pageResult) {
+            return {};
+        }
+        pageResult.items.forEach((record) => {
+            const { name, ...recordDetails } = record;
+            records[name] = recordDetails;
+        });
+        cursor = pageResult.nextCursor;
+    } while (cursor !== undefined);
+    return records;
+};

package/lib/esm/version.js

@@ -15,4 +15,4 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '2.0.0-alpha.9';
+export const version = '2.0.0';

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

@@ -17,30 +17,6 @@
 import { ANTRecord, AoANTRead, AoANTState, AoANTWrite, AoMessageResult, ProcessConfiguration, WalletAddress, WithSigner } from '../types.js';
 import { AOProcess } from './index.js';
 export declare class ANT {
-    /**
-     * Initializes an ANT instance.
-     *
-     * There are two overloads for this function:
-     * 1. When a signer is provided in the configuration, it returns an instance of ANTWritable.
-     * 2. When a signer is NOT provided in the configuration, it returns an instance of ANTReadable.
-     *
-     *
-     * @param {ContractConfiguration & WithSigner} config - The configuration object.
-     *    If a signer is provided, it should be an object that implements the ContractSigner interface.
-     *
-     * @returns {ANTWritable | ANTReadable} - An instance of ANTWritable if a signer is provided, otherwise an instance of ANTReadable.
-     * @throws {Error} - Throws an error if the configuration is invalid.
-     *
-     * @example
-     * Overload 1: When signer is provided
-     * ```ts
-     * const writable = ANT.init({ signer: mySigner, contract: myContract });
-     *```
-     * Overload 2: When signer is not provided
-     * ```ts
-     * const readable = ANT.init({ contract: myContract });
-     * ```
-     */
     static init(config: Required<ProcessConfiguration> & {
         signer?: undefined;
     }): AoANTRead;

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

@@ -18,7 +18,7 @@ import Arweave from 'arweave';
 import { ArNSReservedNameData, EpochDistributionData, EpochObservations, WeightedObserver } from '../contract-state.js';
 import { AoArNSNameData, AoEpochData, AoEpochSettings, AoGateway, AoIORead, AoIOWrite, EpochInput } from '../io.js';
 import { mIOToken } from '../token.js';
-import { AoMessageResult, ContractSigner, JoinNetworkParams, ProcessConfiguration, TransactionId, UpdateGatewaySettingsParams, WalletAddress, WithSigner, WriteOptions } from '../types.js';
+import { AoArNSNameDataWithName, AoBalanceWithAddress, AoGatewayWithAddress, AoMessageResult, ContractSigner, JoinNetworkParams, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, UpdateGatewaySettingsParams, WalletAddress, WithSigner, WriteOptions } from '../types.js';
 import { AOProcess } from './contracts/ao-process.js';
 export declare class IO {
     static init(): AoIORead;
@@ -54,7 +54,7 @@ export declare class IOReadable implements AoIORead {
     getArNSRecord({ name, }: {
         name: string;
     }): Promise<AoArNSNameData | undefined>;
-    getArNSRecords(): Promise<Record<string, AoArNSNameData>>;
+    getArNSRecords(pageParams?: PaginationParams): Promise<PaginationResult<AoArNSNameDataWithName>>;
     getArNSReservedNames(): Promise<Record<string, ArNSReservedNameData> | Record<string, never>>;
     getArNSReservedName({ name, }: {
         name: string;
@@ -62,11 +62,11 @@ export declare class IOReadable implements AoIORead {
     getBalance({ address }: {
         address: WalletAddress;
     }): Promise<number>;
-    getBalances(): Promise<Record<WalletAddress, number>>;
+    getBalances(pageParams?: PaginationParams): Promise<PaginationResult<AoBalanceWithAddress>>;
     getGateway({ address, }: {
         address: WalletAddress;
     }): Promise<AoGateway | undefined>;
-    getGateways(): Promise<Record<string, AoGateway> | Record<string, never>>;
+    getGateways(pageParams?: PaginationParams): Promise<PaginationResult<AoGatewayWithAddress>>;
     getCurrentEpoch(): Promise<AoEpochData>;
     getPrescribedObservers(epoch?: EpochInput): Promise<WeightedObserver[]>;
     getPrescribedNames(epoch?: EpochInput): Promise<string[]>;

package/lib/types/io.d.ts

@@ -25,6 +25,20 @@ export declare function isProcessIdConfiguration(config: object): config is {
     processId: string;
 };
 export declare function isLeasedArNSRecord(record: AoArNSNameData): record is AoArNSLeaseData;
+export type PaginationParams = {
+    cursor?: string;
+    limit?: number;
+    sortBy?: string;
+    sortOrder?: 'asc' | 'desc';
+};
+export type PaginationResult<T> = {
+    items: T[];
+    nextCursor: string | undefined;
+    totalItems: number;
+    sortBy: keyof T;
+    sortOrder: 'asc' | 'desc';
+    hasMore: boolean;
+};
 export type ProcessConfiguration = {
     process?: AOProcess;
 } | {
@@ -66,15 +80,15 @@ export interface AoIORead {
     getGateway({ address, }: {
         address: WalletAddress;
     }): Promise<AoGateway | undefined>;
-    getGateways(): Promise<Record<WalletAddress, AoGateway> | Record<string, never>>;
+    getGateways(params?: PaginationParams): Promise<PaginationResult<AoGatewayWithAddress>>;
     getBalance(params: {
         address: WalletAddress;
     }): Promise<number>;
-    getBalances(): Promise<Record<WalletAddress, number> | Record<string, never>>;
+    getBalances(params?: PaginationParams): Promise<PaginationResult<AoBalanceWithAddress>>;
     getArNSRecord({ name, }: {
         name: string;
     }): Promise<AoArNSNameData | undefined>;
-    getArNSRecords(): Promise<Record<string, AoArNSNameData> | Record<string, never>>;
+    getArNSRecords(params?: PaginationParams): Promise<PaginationResult<AoArNSNameDataWithName>>;
     getArNSReservedNames(): Promise<Record<string, AoArNSReservedNameData> | Record<string, never>>;
     getArNSReservedName({ name, }: {
         name: string;
@@ -201,6 +215,9 @@ export interface AoIOState {
 export type AoEpochIndex = number;
 export type AoArNSReservedNameData = ArNSReservedNameData;
 export type AoArNSNameData = AoArNSPermabuyData | AoArNSLeaseData;
+export type AoArNSNameDataWithName = AoArNSNameData & {
+    name: string;
+};
 export type AoArNSBaseNameData = {
     processId: ProcessId;
     startTimestamp: number;
@@ -259,6 +276,13 @@ export type AoGateway = {
     operatorStake: number;
     status: 'joined' | 'leaving';
 };
+export type AoBalanceWithAddress = {
+    address: WalletAddress;
+    balance: number;
+};
+export type AoGatewayWithAddress = AoGateway & {
+    gatewayAddress: WalletAddress;
+};
 export type AoANTState = {
     Name: string;
     Ticker: string;

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

@@ -16,6 +16,6 @@
  */
 export * from './arweave.js';
 export * from './http-client.js';
-export * from './graphql/index.js';
 export * from './ao.js';
 export * from './json.js';
+export * from './processes.js';

package/lib/types/utils/{graphql/processes.d.ts → processes.d.ts}

@@ -15,7 +15,8 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 import { EventEmitter } from 'eventemitter3';
-import { AoIORead, ProcessId, WalletAddress } from '../../types.js';
+import { ILogger } from '../common/logger.js';
+import { AoArNSNameData, AoIORead, ProcessId, WalletAddress } from '../types.js';
 export declare const getANTProcessesOwnedByWallet: ({ address, contract, }: {
     address: WalletAddress;
     contract?: AoIORead;
@@ -33,3 +34,7 @@ export declare class ArNSEventEmitter extends EventEmitter {
         address: WalletAddress;
     }): Promise<void>;
 }
+export declare const fetchAllArNSRecords: ({ contract, logger, }: {
+    contract?: AoIORead;
+    logger?: ILogger;
+}) => Promise<Record<string, AoArNSNameData>>;

package/lib/types/version.d.ts

@@ -14,4 +14,4 @@
  * You should have received a copy of the GNU Affero General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-export declare const version = "2.0.0-alpha.8";
+export declare const version = "2.0.0-alpha.11";

package/package.json

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

package/lib/cjs/utils/graphql/index.js

@@ -1,33 +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. All Rights Reserved.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-__exportStar(require("./processes.js"), exports);

package/lib/esm/utils/graphql/index.js

@@ -1,17 +0,0 @@
-/**
- * Copyright (C) 2022-2024 Permanent Data Solutions, Inc. All Rights Reserved.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-export * from './processes.js';

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

@@ -1,17 +0,0 @@
-/**
- * Copyright (C) 2022-2024 Permanent Data Solutions, Inc. All Rights Reserved.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-export * from './processes.js';