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

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

@@ -19,7 +19,6 @@ import { IO_TESTNET_PROCESS_ID } from '../constants.js';
 import { isProcessConfiguration, isProcessIdConfiguration, } from '../io.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) {
@@ -47,9 +46,6 @@ export class IOReadable {
         else if (isProcessIdConfiguration(config)) {
             this.process = new AOProcess({
                 processId: config.processId,
-                logger: new DefaultLogger({
-                    level: 'info',
-                }),
             });
         }
         else {

package/lib/esm/common/logger.js

@@ -14,11 +14,12 @@
  * 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 { createLogger, format, transports } from 'winston';
+import { createLogger, format, transports, } from 'winston';
 import { version } from '../version.js';
-export class DefaultLogger {
+export class Logger {
     logger;
     silent = false;
+    static default = new Logger();
     constructor({ level = 'info', } = {}) {
         if (level === 'none') {
             this.silent = true;
@@ -67,7 +68,6 @@ export class DefaultLogger {
     setLogLevel(level) {
         if ('silent' in this.logger) {
             this.logger.silent = level === 'none';
-            return;
         }
         if ('level' in this.logger) {
             this.logger.level = level;

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

@@ -16,9 +16,9 @@
  */
 import axios from 'axios';
 import axiosRetry from 'axios-retry';
-import { DefaultLogger } from '../common/logger.js';
+import { Logger } from '../common/logger.js';
 import { version } from '../version.js';
-export const createAxiosInstance = ({ axiosConfig = {}, logger = new DefaultLogger(), retryConfig = {
+export const createAxiosInstance = ({ axiosConfig = {}, logger = Logger.default, retryConfig = {
     retries: 5,
     retryDelay: axiosRetry.exponentialDelay,
     retryCondition: (error) => axiosRetry.isRetryableError(error),

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

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

@@ -14,7 +14,8 @@
  * 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 { AoANTRead, AoANTWrite, ProcessConfiguration, WithSigner } from '../types.js';
+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.
@@ -45,3 +46,177 @@ export declare class ANT {
     }): AoANTRead;
     static init({ signer, ...config }: WithSigner<Required<ProcessConfiguration>>): AoANTWrite;
 }
+export declare class AoANTReadable implements AoANTRead {
+    protected process: AOProcess;
+    constructor(config: Required<ProcessConfiguration>);
+    getState(): Promise<AoANTState>;
+    getInfo(): Promise<{
+        Name: string;
+        Ticker: string;
+        Denomination: number;
+        Owner: string;
+    }>;
+    /**
+     * @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" });
+     * ```
+     */
+    getRecord({ undername }: {
+        undername: string;
+    }): Promise<ANTRecord>;
+    /**
+     * @returns {Promise<Record<string, ANTRecord>>} All the undernames managed by the ANT.
+     * @example
+     * Get the current records
+     * ```ts
+     * ant.getRecords();
+     * ````
+     */
+    getRecords(): Promise<Record<string, ANTRecord>>;
+    /**
+     * @returns {Promise<string>} The owner of the ANT.
+     * @example
+     * Get the current owner
+     * ```ts
+     *  ant.getOwner();
+     * ```
+     */
+    getOwner(): Promise<string>;
+    /**
+     * @returns {Promise<string[]>} The controllers of the ANT.
+     * @example
+     * Get the controllers of the ANT.
+     * ```ts
+     * ant.getControllers();
+     * ```
+     */
+    getControllers(): Promise<WalletAddress[]>;
+    /**
+     * @returns {Promise<string>} The name of the ANT (not the same as ArNS name).
+     * @example
+     * Get the current name
+     * ```ts
+     * ant.getName();
+     * ```
+     */
+    getName(): Promise<string>;
+    /**
+     * @returns {Promise<string>} The name of the ANT (not the same as ArNS name).
+     * @example
+     * The current ticker of the ANT.
+     * ```ts
+     * ant.getTicker();
+     * ```
+     */
+    getTicker(): Promise<string>;
+    /**
+     * @returns {Promise<Record<WalletAddress, number>>} The balances of the ANT
+     * @example
+     * The current balances of the ANT.
+     * ```ts
+     * ant.getBalances();
+     * ```
+     */
+    getBalances(): Promise<Record<string, number>>;
+    /**
+     * @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 });
+     * ```
+     */
+    getBalance({ address }: {
+        address: string;
+    }): Promise<number>;
+}
+export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite {
+    private signer;
+    constructor({ signer, ...config }: WithSigner<Required<ProcessConfiguration>>);
+    /**
+     * @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" });
+     * ```
+     */
+    transfer({ target }: {
+        target: string;
+    }): Promise<AoMessageResult>;
+    /**
+     * @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" });
+     * ```
+     */
+    addController({ controller, }: {
+        controller: string;
+    }): Promise<AoMessageResult>;
+    /**
+     * @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" });
+     * ```
+     */
+    removeController({ controller, }: {
+        controller: string;
+    }): Promise<AoMessageResult>;
+    /**
+     * @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" });
+     * ```
+     */
+    setRecord({ undername, transactionId, ttlSeconds, }: {
+        undername: string;
+        transactionId: string;
+        ttlSeconds: number;
+    }): Promise<AoMessageResult>;
+    /**
+     * @param undername @type {string} The record you want to remove.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.removeRecord({ subDomain: "shorts" });
+     * ```
+     */
+    removeRecord({ undername, }: {
+        undername: string;
+    }): Promise<AoMessageResult>;
+    /**
+     * @param ticker @type {string} Sets the ANT Ticker.
+     * @returns {Promise<AoMessageResult>} The result of the interaction.
+     * @example
+     * ```ts
+     * ant.setTicker({ ticker: "KAPOW" });
+     * ```
+     */
+    setTicker({ ticker }: {
+        ticker: string;
+    }): Promise<AoMessageResult>;
+    /**
+     * @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" });
+     * ```
+     */
+    setName({ name }: {
+        name: string;
+    }): Promise<AoMessageResult>;
+}

package/lib/types/common/contracts/ao-process.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { AOContract, AoClient, ContractSigner } from '../../types.js';
-import { DefaultLogger } from '../logger.js';
+import { ILogger } from '../logger.js';
 export declare class AOProcess implements AOContract {
     private logger;
     private processId;
@@ -8,7 +8,7 @@ export declare class AOProcess implements AOContract {
     constructor({ processId, ao, logger, }: {
         processId: string;
         ao?: AoClient;
-        logger?: DefaultLogger;
+        logger?: ILogger;
     });
     static createAoSigner(signer: ContractSigner): Promise<(args: {
         data: string | Buffer;

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

@@ -1,11 +1,12 @@
 /// <reference types="node" />
-import { HTTPClient, Logger } from '../types.js';
+import { HTTPClient } from '../types.js';
+import { ILogger } from './logger.js';
 export declare class AxiosHTTPService implements HTTPClient {
     private axios;
     private logger;
     constructor({ url, logger, }: {
         url: string;
-        logger?: Logger;
+        logger?: ILogger;
     });
     get<I, K>({ endpoint, signal, allowedStatuses, headers, params, }: {
         endpoint: string;

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

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

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

@@ -1,7 +1,14 @@
-import { Logger as ILogger } from '../types.js';
-export declare class DefaultLogger implements ILogger {
+export interface ILogger {
+    setLogLevel: (level: 'info' | 'debug' | 'error' | 'warn' | 'none') => void;
+    info: (message: string, ...args: unknown[]) => void;
+    warn: (message: string, ...args: unknown[]) => void;
+    error: (message: string, ...args: unknown[]) => void;
+    debug: (message: string, ...args: unknown[]) => void;
+}
+export declare class Logger implements ILogger {
     private logger;
     private silent;
+    static default: Logger;
     constructor({ level, }?: {
         level?: 'info' | 'debug' | 'error' | 'warn' | 'none';
     });
@@ -9,5 +16,5 @@ export declare class DefaultLogger implements ILogger {
     warn(message: string, ...args: unknown[]): void;
     error(message: string, ...args: unknown[]): void;
     debug(message: string, ...args: unknown[]): void;
-    setLogLevel(level: string): void;
+    setLogLevel(level: 'info' | 'debug' | 'error' | 'warn' | 'none'): void;
 }

package/lib/types/common.d.ts

@@ -72,13 +72,6 @@ export type AtLeastOne<T, U = {
     [K in keyof T]-?: Record<K, T[K]>;
 }> = Partial<T> & U[keyof U];
 export type UpdateGatewaySettingsParams = AtLeastOne<UpdateGatewaySettingsParamsBase>;
-export interface Logger {
-    setLogLevel: (level: string) => void;
-    info: (message: string, ...args: unknown[]) => void;
-    warn: (message: string, ...args: unknown[]) => void;
-    error: (message: string, ...args: unknown[]) => void;
-    debug: (message: string, ...args: unknown[]) => void;
-}
 export interface HTTPClient {
     get<I, K>({ endpoint, signal, headers, allowedStatuses, params, }: {
         endpoint: string;

package/lib/types/utils/http-client.d.ts

@@ -16,10 +16,10 @@
  */
 import { AxiosInstance, AxiosRequestConfig } from 'axios';
 import { IAxiosRetryConfig } from 'axios-retry';
-import { Logger } from '../types.js';
+import { ILogger } from '../common/logger.js';
 export interface AxiosInstanceParameters {
     axiosConfig?: Omit<AxiosRequestConfig, 'validateStatus'>;
     retryConfig?: IAxiosRetryConfig;
-    logger?: Logger;
+    logger?: ILogger;
 }
 export declare const createAxiosInstance: ({ axiosConfig, logger, retryConfig, }?: AxiosInstanceParameters) => AxiosInstance;

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.1";
+export declare const version = "2.0.0-alpha.2";