@ar.io/sdk 2.0.1 → 2.0.3-alpha.1

package/lib/cjs/utils/processes.js

@@ -21,6 +21,7 @@ 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 logger_js_1 = require("../common/logger.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,
@@ -71,19 +72,25 @@ class ArNSEventEmitter extends eventemitter3_1.EventEmitter {
     contract;
     timeoutMs; // timeout for each request to 3 seconds
     throttle;
+    logger;
     constructor({ contract = io_js_1.IO.init({
         processId: constants_js_1.IO_TESTNET_PROCESS_ID,
-    }), timeoutMs = 60_000, concurrency = 30, }) {
+    }), timeoutMs = 60_000, concurrency = 30, logger = logger_js_1.Logger.default, } = {}) {
         super();
         this.contract = contract;
         this.timeoutMs = timeoutMs;
         this.throttle = (0, plimit_lit_1.pLimit)(concurrency);
+        this.logger = logger;
     }
     async fetchProcessesOwnedByWallet({ address }) {
         const uniqueContractProcessIds = {};
-        await timeout(this.timeoutMs, (0, exports.fetchAllArNSRecords)({ contract: this.contract }))
+        await timeout(this.timeoutMs, (0, exports.fetchAllArNSRecords)({ contract: this.contract, emitter: this }))
             .catch((e) => {
             this.emit('error', `Error getting ArNS records: ${e}`);
+            this.logger.error(`Error getting ArNS records`, {
+                message: e?.message,
+                stack: e?.stack,
+            });
             return {};
         })
             .then((records) => {
@@ -103,8 +110,8 @@ class ArNSEventEmitter extends eventemitter3_1.EventEmitter {
             });
         });
         const idCount = Object.keys(uniqueContractProcessIds).length;
-        // check the contract owner and controllers
         this.emit('progress', 0, idCount);
+        // check the contract owner and controllers
         await Promise.all(Object.keys(uniqueContractProcessIds).map(async (processId, i) => this.throttle(async () => {
             if (uniqueContractProcessIds[processId].state !== undefined) {
                 this.emit('progress', i + 1, idCount);
@@ -130,8 +137,9 @@ 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, }) => {
+}), emitter, logger = logger_js_1.Logger.default, }) => {
     let cursor;
+    const startTimestamp = Date.now();
     const records = {};
     do {
         const pageResult = await contract
@@ -141,6 +149,7 @@ const fetchAllArNSRecords = async ({ contract = io_js_1.IO.init({
                 message: e?.message,
                 stack: e?.stack,
             });
+            emitter?.emit('arns:error', `Error getting ArNS records: ${e}`);
             return undefined;
         });
         if (!pageResult) {
@@ -150,8 +159,24 @@ const fetchAllArNSRecords = async ({ contract = io_js_1.IO.init({
             const { name, ...recordDetails } = record;
             records[name] = recordDetails;
         });
+        logger.debug('Fetched page of ArNS records', {
+            totalRecordCount: pageResult.totalItems,
+            fetchedRecordCount: Object.keys(records).length,
+            cursor: pageResult.nextCursor,
+        });
+        emitter?.emit('arns:pageLoaded', {
+            totalRecordCount: pageResult.totalItems,
+            fetchedRecordCount: Object.keys(records).length,
+            records: pageResult.items,
+            cursor: pageResult.nextCursor,
+        });
         cursor = pageResult.nextCursor;
     } while (cursor !== undefined);
+    emitter?.emit('arns:end', records);
+    logger.debug('Fetched all ArNS records', {
+        totalRecordCount: Object.keys(records).length,
+        durationMs: Date.now() - startTimestamp,
+    });
     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.1';
+exports.version = '2.0.3-alpha.1';

package/lib/esm/utils/processes.js

@@ -18,6 +18,7 @@ import { EventEmitter } from 'eventemitter3';
 import { pLimit } from 'plimit-lit';
 import { ANT } from '../common/ant.js';
 import { IO } from '../common/io.js';
+import { Logger } from '../common/logger.js';
 import { IO_TESTNET_PROCESS_ID } from '../constants.js';
 export const getANTProcessesOwnedByWallet = async ({ address, contract = IO.init({
     processId: IO_TESTNET_PROCESS_ID,
@@ -67,19 +68,25 @@ export class ArNSEventEmitter extends EventEmitter {
     contract;
     timeoutMs; // timeout for each request to 3 seconds
     throttle;
+    logger;
     constructor({ contract = IO.init({
         processId: IO_TESTNET_PROCESS_ID,
-    }), timeoutMs = 60_000, concurrency = 30, }) {
+    }), timeoutMs = 60_000, concurrency = 30, logger = Logger.default, } = {}) {
         super();
         this.contract = contract;
         this.timeoutMs = timeoutMs;
         this.throttle = pLimit(concurrency);
+        this.logger = logger;
     }
     async fetchProcessesOwnedByWallet({ address }) {
         const uniqueContractProcessIds = {};
-        await timeout(this.timeoutMs, fetchAllArNSRecords({ contract: this.contract }))
+        await timeout(this.timeoutMs, fetchAllArNSRecords({ contract: this.contract, emitter: this }))
             .catch((e) => {
             this.emit('error', `Error getting ArNS records: ${e}`);
+            this.logger.error(`Error getting ArNS records`, {
+                message: e?.message,
+                stack: e?.stack,
+            });
             return {};
         })
             .then((records) => {
@@ -99,8 +106,8 @@ export class ArNSEventEmitter extends EventEmitter {
             });
         });
         const idCount = Object.keys(uniqueContractProcessIds).length;
-        // check the contract owner and controllers
         this.emit('progress', 0, idCount);
+        // check the contract owner and controllers
         await Promise.all(Object.keys(uniqueContractProcessIds).map(async (processId, i) => this.throttle(async () => {
             if (uniqueContractProcessIds[processId].state !== undefined) {
                 this.emit('progress', i + 1, idCount);
@@ -125,8 +132,9 @@ export class ArNSEventEmitter extends EventEmitter {
 }
 export const fetchAllArNSRecords = async ({ contract = IO.init({
     processId: IO_TESTNET_PROCESS_ID,
-}), logger, }) => {
+}), emitter, logger = Logger.default, }) => {
     let cursor;
+    const startTimestamp = Date.now();
     const records = {};
     do {
         const pageResult = await contract
@@ -136,6 +144,7 @@ export const fetchAllArNSRecords = async ({ contract = IO.init({
                 message: e?.message,
                 stack: e?.stack,
             });
+            emitter?.emit('arns:error', `Error getting ArNS records: ${e}`);
             return undefined;
         });
         if (!pageResult) {
@@ -145,7 +154,23 @@ export const fetchAllArNSRecords = async ({ contract = IO.init({
             const { name, ...recordDetails } = record;
             records[name] = recordDetails;
         });
+        logger.debug('Fetched page of ArNS records', {
+            totalRecordCount: pageResult.totalItems,
+            fetchedRecordCount: Object.keys(records).length,
+            cursor: pageResult.nextCursor,
+        });
+        emitter?.emit('arns:pageLoaded', {
+            totalRecordCount: pageResult.totalItems,
+            fetchedRecordCount: Object.keys(records).length,
+            records: pageResult.items,
+            cursor: pageResult.nextCursor,
+        });
         cursor = pageResult.nextCursor;
     } while (cursor !== undefined);
+    emitter?.emit('arns:end', records);
+    logger.debug('Fetched all ArNS records', {
+        totalRecordCount: Object.keys(records).length,
+        durationMs: Date.now() - startTimestamp,
+    });
     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.1';
+export const version = '2.0.3-alpha.1';

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

@@ -106,9 +106,7 @@ export declare class IOWriteable extends IOReadable implements AoIOWrite {
         operatorStake: number | mIOToken;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     leaveNetwork(options?: WriteOptions): Promise<AoMessageResult>;
-    updateGatewaySettings({ allowDelegatedStaking, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }: Omit<UpdateGatewaySettingsParams, 'observerWallet'> & {
-        observerAddress: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
+    updateGatewaySettings({ allowDelegatedStaking, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }: UpdateGatewaySettingsParams, options?: WriteOptions): Promise<AoMessageResult>;
     delegateStake(params: {
         target: string;
         stakeQty: number | mIOToken;

package/lib/types/common.d.ts

@@ -51,10 +51,7 @@ type Overwrite<T, U> = {
 };
 export type JoinNetworkParams = Overwrite<GatewayConnectionSettings & GatewayStakingSettings & GatewayMetadata, {
     minDelegatedStake: number | mIOToken;
-}> & {
-    qty: number | mIOToken;
-    observerWallet?: WalletAddress;
-};
+}>;
 export type UpdateGatewaySettingsParamsBase = {
     allowDelegatedStaking?: boolean;
     delegateRewardShareRatio?: number;
@@ -66,7 +63,7 @@ export type UpdateGatewaySettingsParamsBase = {
     properties?: string;
     protocol?: AllowedProtocols;
     autoStake?: boolean;
-    observerWallet?: WalletAddress;
+    observerAddress?: WalletAddress;
 };
 export type AtLeastOne<T, U = {
     [K in keyof T]-?: Record<K, T[K]>;

package/lib/types/io.d.ts

@@ -117,9 +117,7 @@ export interface AoIOWrite extends AoIORead {
         operatorStake: number | mIOToken;
     }, options?: WriteOptions): Promise<AoMessageResult>;
     leaveNetwork(options?: WriteOptions): Promise<AoMessageResult>;
-    updateGatewaySettings({ allowDelegatedStaking, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }: Omit<UpdateGatewaySettingsParams, 'observerWallet'> & {
-        observerAddress?: WalletAddress;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
+    updateGatewaySettings({ allowDelegatedStaking, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }: UpdateGatewaySettingsParams, options?: WriteOptions): Promise<AoMessageResult>;
     increaseOperatorStake(params: {
         increaseQty: number | mIOToken;
     }, options?: WriteOptions): Promise<AoMessageResult>;

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

@@ -25,16 +25,19 @@ export declare class ArNSEventEmitter extends EventEmitter {
     protected contract: AoIORead;
     private timeoutMs;
     private throttle;
-    constructor({ contract, timeoutMs, concurrency, }: {
+    private logger;
+    constructor({ contract, timeoutMs, concurrency, logger, }?: {
         contract?: AoIORead;
         timeoutMs?: number;
         concurrency?: number;
+        logger?: ILogger;
     });
     fetchProcessesOwnedByWallet({ address }: {
         address: WalletAddress;
     }): Promise<void>;
 }
-export declare const fetchAllArNSRecords: ({ contract, logger, }: {
+export declare const fetchAllArNSRecords: ({ contract, emitter, logger, }: {
     contract?: AoIORead;
+    emitter?: EventEmitter;
     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";
+export declare const version = "2.0.2";

package/package.json

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