@ar.io/sdk 1.2.2 → 2.0.0-alpha.10

package/lib/cjs/common/io.js

@@ -1,31 +1,11 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IOWriteable = exports.IOReadable = exports.IO = void 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/>.
- */
-const arweave_1 = __importDefault(require("arweave"));
 const constants_js_1 = require("../constants.js");
 const io_js_1 = require("../io.js");
+const arweave_js_1 = require("./arweave.js");
 const ao_process_js_1 = require("./contracts/ao-process.js");
 const error_js_1 = require("./error.js");
-const logger_js_1 = require("./logger.js");
 class IO {
     static init(config) {
         if (config && config.signer) {
@@ -42,7 +22,7 @@ exports.IO = IO;
 class IOReadable {
     process;
     arweave;
-    constructor(config, arweave = arweave_1.default.init({})) {
+    constructor(config, arweave = arweave_js_1.defaultArweave) {
         if (!config) {
             this.process = new ao_process_js_1.AOProcess({
                 processId: constants_js_1.IO_TESTNET_PROCESS_ID,
@@ -54,9 +34,6 @@ class IOReadable {
         else if ((0, io_js_1.isProcessIdConfiguration)(config)) {
             this.process = new ao_process_js_1.AOProcess({
                 processId: config.processId,
-                logger: new logger_js_1.DefaultLogger({
-                    level: 'info',
-                }),
             });
         }
         else {
@@ -127,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() {
@@ -153,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, }) {
@@ -166,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() {
@@ -436,6 +437,13 @@ class IOWriteable extends IOReadable {
             tags: prunedTags,
         });
     }
+    async leaveNetwork(options) {
+        const { tags = [] } = options || {};
+        return this.process.send({
+            signer: this.signer,
+            tags: [...tags, { name: 'Action', value: 'Leave-Network' }],
+        });
+    }
     async updateGatewaySettings({ allowDelegatedStaking, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }, options) {
         const { tags = [] } = options || {};
         const allTags = [

package/lib/cjs/common/logger.js

@@ -1,9 +1,6 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultLogger = void 0;
+exports.Logger = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc. All Rights Reserved.
  *
@@ -20,49 +17,64 @@ exports.DefaultLogger = void 0;
  * 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/>.
  */
-const bunyan_1 = __importDefault(require("bunyan"));
+const winston_1 = require("winston");
 const version_js_1 = require("../version.js");
-class DefaultLogger {
+class Logger {
     logger;
     silent = false;
+    static default = new Logger();
     constructor({ level = 'info', } = {}) {
         if (level === 'none') {
             this.silent = true;
             return;
         }
-        this.logger = bunyan_1.default.createLogger({
+        this.logger = (0, winston_1.createLogger)({
             level,
-            name: 'ar-io-sdk',
-            version: version_js_1.version,
-            serializers: bunyan_1.default.stdSerializers,
+            silent: this.silent,
+            defaultMeta: {
+                name: 'ar-io-sdk',
+                version: version_js_1.version,
+            },
+            format: winston_1.format.combine(winston_1.format.timestamp(), winston_1.format.json()),
         });
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        if (typeof window !== 'undefined') {
+            this.logger = console;
+        }
+        else {
+            this.logger.add(new winston_1.transports.Console({
+                format: winston_1.format.combine(winston_1.format.timestamp(), winston_1.format.json()),
+            }));
+        }
     }
     info(message, ...args) {
         if (this.silent)
             return;
-        this.logger.info(...args, message);
+        this.logger.info(message, ...args);
     }
     warn(message, ...args) {
         if (this.silent)
             return;
-        this.logger.warn(...args, message);
+        this.logger.warn(message, ...args);
     }
     error(message, ...args) {
         if (this.silent)
             return;
-        this.logger.error(...args, message);
+        this.logger.error(message, ...args);
     }
     debug(message, ...args) {
         if (this.silent)
             return;
-        this.logger.debug(...args, message);
+        this.logger.debug(message, ...args);
     }
     setLogLevel(level) {
-        if (level === 'none') {
-            this.silent = true;
-            return;
+        if ('silent' in this.logger) {
+            this.logger.silent = level === 'none';
+        }
+        if ('level' in this.logger) {
+            this.logger.level = level;
         }
-        this.logger.level(level);
     }
 }
-exports.DefaultLogger = DefaultLogger;
+exports.Logger = Logger;

package/lib/cjs/types.js

@@ -30,7 +30,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * 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("./arns-service.js"), exports);
 __exportStar(require("./contract-state.js"), exports);
 __exportStar(require("./common.js"), exports);
 __exportStar(require("./token.js"), exports);

package/lib/cjs/utils/arweave.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tagsToObject = exports.isTransaction = exports.isBlockHeight = exports.validateArweaveId = void 0;
+exports.isBlockHeight = exports.validateArweaveId = void 0;
 const constants_js_1 = require("../constants.js");
 const validateArweaveId = (id) => {
     return constants_js_1.ARWEAVE_TX_REGEX.test(id);
@@ -10,17 +10,3 @@ function isBlockHeight(height) {
     return height !== undefined && !isNaN(parseInt(height.toString()));
 }
 exports.isBlockHeight = isBlockHeight;
-const isTransaction = (tx) => {
-    const requiredTxKeys = ['id', 'owner', 'tags', 'signature'];
-    return requiredTxKeys.every((key) => key in tx);
-};
-exports.isTransaction = isTransaction;
-function tagsToObject(tags) {
-    return tags.reduce((decodedTags, tag) => {
-        const key = tag.get('name', { decode: true, string: true });
-        const value = tag.get('value', { decode: true, string: true });
-        decodedTags[key] = value;
-        return decodedTags;
-    }, {});
-}
-exports.tagsToObject = tagsToObject;

package/lib/cjs/utils/http-client.js

@@ -24,7 +24,7 @@ const axios_1 = __importDefault(require("axios"));
 const axios_retry_1 = __importDefault(require("axios-retry"));
 const logger_js_1 = require("../common/logger.js");
 const version_js_1 = require("../version.js");
-const createAxiosInstance = ({ axiosConfig = {}, logger = new logger_js_1.DefaultLogger(), retryConfig = {
+const createAxiosInstance = ({ axiosConfig = {}, logger = logger_js_1.Logger.default, retryConfig = {
     retries: 5,
     retryDelay: axios_retry_1.default.exponentialDelay,
     retryCondition: (error) => axios_retry_1.default.isRetryableError(error),

package/lib/cjs/utils/index.js

@@ -32,7 +32,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
  */
 __exportStar(require("./arweave.js"), exports);
 __exportStar(require("./http-client.js"), exports);
-__exportStar(require("./smartweave.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,25 @@ 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,
+}), }) => {
+    let cursor;
+    const records = {};
+    do {
+        const pageResult = await contract.getArNSRecords({ cursor }).catch((e) => {
+            console.error(`Error getting ArNS records: ${e}`);
+            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 = '1.2.2';
+exports.version = '2.0.0-alpha.10';