@ar.io/sdk 2.0.0-alpha.1 → 2.0.0-alpha.11

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.1';
+exports.version = '2.0.0-alpha.11';

package/lib/esm/common/ant.js

@@ -15,7 +15,7 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 import { isProcessConfiguration, isProcessIdConfiguration, } from '../types.js';
-import { AoANTReadable, AoANTWriteable, InvalidContractConfigurationError, } from './index.js';
+import { AOProcess, InvalidContractConfigurationError } from './index.js';
 export class ANT {
     static init({ signer, ...config }) {
         // ao supported implementation
@@ -28,3 +28,292 @@ export class ANT {
         throw new InvalidContractConfigurationError();
     }
 }
+export class AoANTReadable {
+    process;
+    constructor(config) {
+        if (isProcessConfiguration(config)) {
+            this.process = config.process;
+        }
+        else if (isProcessIdConfiguration(config)) {
+            this.process = new AOProcess({
+                processId: config.processId,
+            });
+        }
+        else {
+            throw new InvalidContractConfigurationError();
+        }
+    }
+    async getState() {
+        const tags = [{ name: 'Action', value: 'State' }];
+        const res = await this.process.read({
+            tags,
+        });
+        return res;
+    }
+    async getInfo() {
+        const tags = [{ name: 'Action', value: 'Info' }];
+        const info = await this.process.read({
+            tags,
+        });
+        return info;
+    }
+    /**
+     * @param undername @type {string} The domain name.
+     * @returns {Promise<ANTRecord>} The record of the undername domain.
+     * @example
+     * Get the current record
+     * ```ts
+     * ant.getRecord({ undername: "john" });
+     * ```
+     */
+    async getRecord({ undername }) {
+        const tags = [
+            { name: 'Sub-Domain', value: undername },
+            { name: 'Action', value: 'Record' },
+        ];
+        const record = await this.process.read({
+            tags,
+        });
+        return record;
+    }
+    /**
+     * @returns {Promise<Record<string, ANTRecord>>} All the undernames managed by the ANT.
+     * @example
+     * Get the current records
+     * ```ts
+     * ant.getRecords();
+     * ````
+     */
+    async getRecords() {
+        const tags = [{ name: 'Action', value: 'Records' }];
+        const records = await this.process.read({
+            tags,
+        });
+        return records;
+    }
+    /**
+     * @returns {Promise<string>} The owner of the ANT.
+     * @example
+     * Get the current owner
+     * ```ts
+     *  ant.getOwner();
+     * ```
+     */
+    async getOwner() {
+        const info = await this.getInfo();
+        return info.Owner;
+    }
+    /**
+     * @returns {Promise<string[]>} The controllers of the ANT.
+     * @example
+     * Get the controllers of the ANT.
+     * ```ts
+     * ant.getControllers();
+     * ```
+     */
+    async getControllers() {
+        const tags = [{ name: 'Action', value: 'Controllers' }];
+        const controllers = await this.process.read({
+            tags,
+        });
+        return controllers;
+    }
+    /**
+     * @returns {Promise<string>} The name of the ANT (not the same as ArNS name).
+     * @example
+     * Get the current name
+     * ```ts
+     * ant.getName();
+     * ```
+     */
+    async getName() {
+        const info = await this.getInfo();
+        return info.Name;
+    }
+    /**
+     * @returns {Promise<string>} The name of the ANT (not the same as ArNS name).
+     * @example
+     * The current ticker of the ANT.
+     * ```ts
+     * ant.getTicker();
+     * ```
+     */
+    async getTicker() {
+        const info = await this.getInfo();
+        return info.Ticker;
+    }
+    /**
+     * @returns {Promise<Record<WalletAddress, number>>} The balances of the ANT
+     * @example
+     * The current balances of the ANT.
+     * ```ts
+     * ant.getBalances();
+     * ```
+     */
+    async getBalances() {
+        const tags = [{ name: 'Action', value: 'Balances' }];
+        const balances = await this.process.read({
+            tags,
+        });
+        return balances;
+    }
+    /**
+     * @param address @type {string} The address of the account you want the balance of.
+     * @returns {Promise<number>} The balance of the provided address
+     * @example
+     * The current balance of the address.
+     * ```ts
+     * ant.getBalance({ address });
+     * ```
+     */
+    async getBalance({ address }) {
+        const tags = [
+            { name: 'Action', value: 'Balance' },
+            { name: 'Recipient', value: address },
+        ];
+        const balance = await this.process.read({
+            tags,
+        });
+        return balance;
+    }
+}
+export class AoANTWriteable extends AoANTReadable {
+    signer;
+    constructor({ signer, ...config }) {
+        super(config);
+        this.signer = signer;
+    }
+    /**
+     * @param target @type {string} The address of the account you want to transfer the ANT to.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.transfer({ target: "fGht8v4STuwPnTck1zFVkQqJh5K9q9Zik4Y5-5dV7nk" });
+     * ```
+     */
+    async transfer({ target }) {
+        const tags = [
+            { name: 'Action', value: 'Transfer' },
+            { name: 'Recipient', value: target },
+        ];
+        return this.process.send({
+            tags,
+            data: {},
+            signer: this.signer,
+        });
+    }
+    /**
+     * @param controller @type {string} The address of the account you want to set as a controller.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setController({ controller: "fGht8v4STuwPnTck1zFVkQqJh5K9q9Zik4Y5-5dV7nk" });
+     * ```
+     */
+    async addController({ controller, }) {
+        const tags = [
+            { name: 'Action', value: 'Add-Controller' },
+            { name: 'Controller', value: controller },
+        ];
+        return this.process.send({
+            tags,
+            data: {},
+            signer: this.signer,
+        });
+    }
+    /**
+     * @param controller @type {string} The address of the account you want to remove from the controllers list
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.removeController({ controller: "fGht8v4STuwPnTck1zFVkQqJh5K9q9Zik4Y5-5dV7nk" });
+     * ```
+     */
+    async removeController({ controller, }) {
+        const tags = [
+            { name: 'Action', value: 'Remove-Controller' },
+            { name: 'Controller', value: controller },
+        ];
+        return this.process.send({
+            tags,
+            data: {},
+            signer: this.signer,
+        });
+    }
+    /**
+     * @param undername @type {string} The record you want to set the transactionId and ttlSeconds of.
+     * @param transactionId @type {string} The transactionId of the record.
+     * @param ttlSeconds @type {number} The time to live of the record.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setController({ controller: "fGht8v4STuwPnTck1zFVkQqJh5K9q9Zik4Y5-5dV7nk" });
+     * ```
+     */
+    async setRecord({ undername, transactionId, ttlSeconds, }) {
+        return this.process.send({
+            tags: [
+                { name: 'Action', value: 'Set-Record' },
+                { name: 'Sub-Domain', value: undername },
+                { name: 'Transaction-Id', value: transactionId },
+                { name: 'TTL-Seconds', value: ttlSeconds.toString() },
+            ],
+            data: { transactionId, ttlSeconds },
+            signer: this.signer,
+        });
+    }
+    /**
+     * @param undername @type {string} The record you want to remove.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.removeRecord({ subDomain: "shorts" });
+     * ```
+     */
+    async removeRecord({ undername, }) {
+        return this.process.send({
+            tags: [
+                { name: 'Action', value: 'Remove-Record' },
+                { name: 'Sub-Domain', value: undername },
+            ],
+            data: { undername },
+            signer: this.signer,
+        });
+    }
+    /**
+     * @param ticker @type {string} Sets the ANT Ticker.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setTicker({ ticker: "KAPOW" });
+     * ```
+     */
+    async setTicker({ ticker }) {
+        return this.process.send({
+            tags: [
+                { name: 'Action', value: 'Set-Ticker' },
+                { name: 'Ticker', value: ticker },
+            ],
+            data: { ticker },
+            signer: this.signer,
+        });
+    }
+    /**
+     * @param name @type {string} Sets the Name of the ANT.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setName({ name: "ships at sea" });
+     * ```
+     */
+    async setName({ name }) {
+        return this.process.send({
+            tags: [
+                { name: 'Action', value: 'Set-Name' },
+                { name: 'Name', value: name },
+            ],
+            data: { name },
+            signer: this.signer,
+        });
+    }
+}

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

@@ -19,12 +19,12 @@ import { createData } from 'arbundles';
 import { safeDecode } from '../../utils/json.js';
 import { version } from '../../version.js';
 import { WriteInteractionError } from '../error.js';
-import { DefaultLogger } from '../logger.js';
+import { Logger } from '../logger.js';
 export class AOProcess {
     logger;
     processId;
     ao;
-    constructor({ processId, ao = connect(), logger = new DefaultLogger({ level: 'info' }), }) {
+    constructor({ processId, ao = connect(), logger = Logger.default, }) {
         this.processId = processId;
         this.logger = logger;
         this.ao = ao;

package/lib/esm/common/http.js

@@ -1,11 +1,10 @@
 import { createAxiosInstance } from '../utils/index.js';
 import { FailedRequestError, NotFound, UnknownError } from './error.js';
-import { DefaultLogger } from './logger.js';
+import { Logger } from './logger.js';
 export class AxiosHTTPService {
     axios;
     logger;
-    // TODO: re-implement axios-retry. Currently that package is broken for nodenext.
-    constructor({ url, logger = new DefaultLogger(), }) {
+    constructor({ url, logger = Logger.default, }) {
         this.logger = logger;
         this.axios = createAxiosInstance({
             axiosConfig: {

package/lib/esm/common/index.js

@@ -19,5 +19,4 @@ export * from './logger.js';
 export * from './ant.js';
 // ao
 export * from './io.js';
-export * from './ant-ao.js';
 export * from './contracts/ao-process.js';

package/lib/esm/common/io.js

@@ -1,25 +1,8 @@
-/**
- * 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/>.
- */
-import Arweave from 'arweave';
 import { IO_TESTNET_PROCESS_ID } from '../constants.js';
 import { isProcessConfiguration, isProcessIdConfiguration, } from '../io.js';
+import { defaultArweave } from './arweave.js';
 import { AOProcess } from './contracts/ao-process.js';
 import { InvalidContractConfigurationError } from './error.js';
-import { DefaultLogger } from './logger.js';
 export class IO {
     static init(config) {
         if (config && config.signer) {
@@ -35,7 +18,7 @@ export class IO {
 export class IOReadable {
     process;
     arweave;
-    constructor(config, arweave = new Arweave({})) {
+    constructor(config, arweave = defaultArweave) {
         if (!config) {
             this.process = new AOProcess({
                 processId: IO_TESTNET_PROCESS_ID,
@@ -47,9 +30,6 @@ export class IOReadable {
         else if (isProcessIdConfiguration(config)) {
             this.process = new AOProcess({
                 processId: config.processId,
-                logger: new DefaultLogger({
-                    level: 'info',
-                }),
             });
         }
         else {
@@ -68,7 +48,12 @@ export class IOReadable {
             {
                 name: 'Timestamp',
                 value: params?.timestamp?.toString() ??
-                    (await this.arweave.blocks.getCurrent().catch(() => {
+                    (await this.arweave.blocks
+                        .getCurrent()
+                        .then((block) => {
+                        return { timestamp: block.timestamp * 1000 };
+                    })
+                        .catch(() => {
                         return { timestamp: Date.now() }; // fallback to current time
                     })).timestamp.toString(),
             },
@@ -88,7 +73,12 @@ export class IOReadable {
             {
                 name: 'Timestamp',
                 value: epoch?.timestamp?.toString() ??
-                    (await this.arweave.blocks.getCurrent().catch(() => {
+                    (await this.arweave.blocks
+                        .getCurrent()
+                        .then((block) => {
+                        return { timestamp: block.timestamp * 1000 };
+                    })
+                        .catch(() => {
                         return { timestamp: Date.now() }; // fallback to current time
                     })).timestamp.toString(),
             },
@@ -110,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() {
@@ -136,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, }) {
@@ -149,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() {
@@ -160,7 +174,12 @@ export class IOReadable {
                 { name: 'Action', value: 'Epoch' },
                 {
                     name: 'Timestamp',
-                    value: (await this.arweave.blocks.getCurrent().catch(() => {
+                    value: (await this.arweave.blocks
+                        .getCurrent()
+                        .then((block) => {
+                        return { timestamp: block.timestamp * 1000 };
+                    })
+                        .catch(() => {
                         return { timestamp: Date.now() }; // fallback to current time
                     })).timestamp.toString(),
                 },
@@ -173,7 +192,12 @@ export class IOReadable {
             {
                 name: 'Timestamp',
                 value: epoch?.timestamp?.toString() ??
-                    (await this.arweave.blocks.getCurrent().catch(() => {
+                    (await this.arweave.blocks
+                        .getCurrent()
+                        .then((block) => {
+                        return { timestamp: block.timestamp * 1000 };
+                    })
+                        .catch(() => {
                         return { timestamp: Date.now() }; // fallback to current time
                     })).timestamp.toString(),
             },
@@ -193,7 +217,12 @@ export class IOReadable {
             {
                 name: 'Timestamp',
                 value: epoch?.timestamp?.toString() ??
-                    (await this.arweave.blocks.getCurrent().catch(() => {
+                    (await this.arweave.blocks
+                        .getCurrent()
+                        .then((block) => {
+                        return { timestamp: block.timestamp * 1000 };
+                    })
+                        .catch(() => {
                         return { timestamp: Date.now() }; // fallback to current time
                     })).timestamp.toString(),
             },
@@ -213,7 +242,12 @@ export class IOReadable {
             {
                 name: 'Timestamp',
                 value: epoch?.timestamp?.toString() ??
-                    (await this.arweave.blocks.getCurrent().catch(() => {
+                    (await this.arweave.blocks
+                        .getCurrent()
+                        .then((block) => {
+                        return { timestamp: block.timestamp * 1000 };
+                    })
+                        .catch(() => {
                         return { timestamp: `${Date.now()}` }; // fallback to current time
                     })).timestamp.toString(),
             },
@@ -233,7 +267,12 @@ export class IOReadable {
             {
                 name: 'Timestamp',
                 value: epoch?.timestamp?.toString() ??
-                    (await this.arweave.blocks.getCurrent().catch(() => {
+                    (await this.arweave.blocks
+                        .getCurrent()
+                        .then((block) => {
+                        return { timestamp: block.timestamp * 1000 };
+                    })
+                        .catch(() => {
                         return { timestamp: Date.now() }; // fallback to current time
                     })).timestamp.toString(),
             },
@@ -272,7 +311,12 @@ export class IOReadable {
             },
             {
                 name: 'Timestamp',
-                value: (await this.arweave.blocks.getCurrent().catch(() => {
+                value: (await this.arweave.blocks
+                    .getCurrent()
+                    .then((block) => {
+                    return { timestamp: block.timestamp * 1000 };
+                })
+                    .catch(() => {
                     return { timestamp: Date.now() }; // fallback to current time
                 })).timestamp.toString(),
             },
@@ -388,6 +432,13 @@ export 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 = [