@ar.io/sdk 2.0.0-alpha.2 → 2.0.0-alpha.3

package/lib/cjs/common/ant.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ANT = void 0;
+exports.AoANTWriteable = exports.AoANTReadable = exports.ANT = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc. All Rights Reserved.
  *
@@ -24,11 +24,302 @@ class ANT {
         // ao supported implementation
         if ((0, types_js_1.isProcessConfiguration)(config) || (0, types_js_1.isProcessIdConfiguration)(config)) {
             if (!signer) {
-                return new index_js_1.AoANTReadable(config);
+                return new AoANTReadable(config);
             }
-            return new index_js_1.AoANTWriteable({ signer, ...config });
+            return new AoANTWriteable({ signer, ...config });
         }
         throw new index_js_1.InvalidContractConfigurationError();
     }
 }
 exports.ANT = ANT;
+class AoANTReadable {
+    process;
+    constructor(config) {
+        if ((0, types_js_1.isProcessConfiguration)(config)) {
+            this.process = config.process;
+        }
+        else if ((0, types_js_1.isProcessIdConfiguration)(config)) {
+            this.process = new index_js_1.AOProcess({
+                processId: config.processId,
+            });
+        }
+        else {
+            throw new index_js_1.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;
+    }
+}
+exports.AoANTReadable = AoANTReadable;
+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,
+        });
+    }
+}
+exports.AoANTWriteable = AoANTWriteable;

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

@@ -27,7 +27,7 @@ class AOProcess {
     logger;
     processId;
     ao;
-    constructor({ processId, ao = (0, aoconnect_1.connect)(), logger = new logger_js_1.DefaultLogger({ level: 'info' }), }) {
+    constructor({ processId, ao = (0, aoconnect_1.connect)(), logger = logger_js_1.Logger.default, }) {
         this.processId = processId;
         this.logger = logger;
         this.ao = ao;

package/lib/cjs/common/http.js

@@ -7,8 +7,7 @@ const logger_js_1 = require("./logger.js");
 class AxiosHTTPService {
     axios;
     logger;
-    // TODO: re-implement axios-retry. Currently that package is broken for nodenext.
-    constructor({ url, logger = new logger_js_1.DefaultLogger(), }) {
+    constructor({ url, logger = logger_js_1.Logger.default, }) {
         this.logger = logger;
         this.axios = (0, index_js_1.createAxiosInstance)({
             axiosConfig: {

package/lib/cjs/common/index.js

@@ -35,5 +35,4 @@ __exportStar(require("./logger.js"), exports);
 __exportStar(require("./ant.js"), exports);
 // ao
 __exportStar(require("./io.js"), exports);
-__exportStar(require("./ant-ao.js"), exports);
 __exportStar(require("./contracts/ao-process.js"), exports);

package/lib/cjs/common/io.js

@@ -25,7 +25,6 @@ const constants_js_1 = require("../constants.js");
 const io_js_1 = require("../io.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) {
@@ -54,9 +53,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 {

package/lib/cjs/common/logger.js

@@ -1,6 +1,6 @@
 "use strict";
 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.
  *
@@ -19,9 +19,10 @@ exports.DefaultLogger = void 0;
  */
 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;
@@ -70,11 +71,10 @@ class DefaultLogger {
     setLogLevel(level) {
         if ('silent' in this.logger) {
             this.logger.silent = level === 'none';
-            return;
         }
         if ('level' in this.logger) {
             this.logger.level = level;
         }
     }
 }
-exports.DefaultLogger = DefaultLogger;
+exports.Logger = Logger;

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/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.2';
+exports.version = '2.0.0-alpha.3';