@ar.io/sdk 1.2.0-alpha.7 → 1.2.0-alpha.8

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

@@ -20,23 +20,19 @@ exports.AOProcess = void 0;
 const aoconnect_1 = require("@permaweb/aoconnect");
 const arbundles_1 = require("arbundles");
 const version_js_1 = require("../../version.js");
+const error_js_1 = require("../error.js");
 const logger_js_1 = require("../logger.js");
 class AOProcess {
     logger;
     processId;
     ao;
-    constructor({ processId, connectionConfig, logger = new logger_js_1.DefaultLogger({ level: 'info' }), }) {
+    constructor({ processId, ao = (0, aoconnect_1.connect)(), logger = new logger_js_1.DefaultLogger({ level: 'info' }), }) {
         this.processId = processId;
         this.logger = logger;
-        this.ao = (0, aoconnect_1.connect)({
-            MU_URL: connectionConfig?.MU_URL,
-            CU_URL: connectionConfig?.CU_URL,
-            GATEWAY_URL: connectionConfig?.GATEWAY_URL,
-            GRAPHQL_URL: connectionConfig?.GRAPHQL_URL,
-        });
+        this.ao = ao;
     }
     // TODO: could abstract into our own interface that constructs different signers
-    async createAoSigner(signer) {
+    static async createAoSigner(signer) {
         // ensure appropriate permissions are granted with injected signers.
         if (signer.publicKey === undefined && 'setPublicKey' in signer) {
             await signer.setPublicKey();
@@ -91,52 +87,82 @@ class AOProcess {
         }
         throw lastError;
     }
-    async send({ tags, data, signer, }) {
-        this.logger.debug(`Evaluating send interaction on contract`, {
-            tags,
-            data,
-            processId: this.processId,
-        });
-        // TODO: do a read as a dry run to check if the process supports the action
-        const messageId = await this.ao.message({
-            process: this.processId,
-            // TODO: any other default tags we want to add?
-            tags: [...tags, { name: 'AR-IO-SDK', value: version_js_1.version }],
-            data: JSON.stringify(data),
-            signer: await this.createAoSigner(signer),
-        });
-        this.logger.debug(`Sent message to process`, {
-            messageId,
-            processId: this.processId,
-        });
-        // check the result of the send interaction
-        const output = await this.ao.result({
-            message: messageId,
-            process: this.processId,
-        });
-        this.logger.debug('Message result', {
-            output,
-            messageId,
-            processId: this.processId,
-        });
-        // check if there are any Messages in the output
-        if (output.Messages.length === 0) {
-            return { id: messageId };
-        }
-        const tagsOutput = output.Messages[0].Tags;
-        const error = tagsOutput.find((tag) => tag.name === 'Error');
-        // if there's an Error tag, throw an error related to it
-        if (error) {
-            const result = output.Messages[0].Data;
-            throw new Error(`${error.Value}: ${result}`);
+    async send({ tags, data, signer, retries = 3, }) {
+        // main purpose of retries is to handle network errors/new process delays
+        let attempts = 0;
+        let lastError;
+        while (attempts < retries) {
+            try {
+                this.logger.debug(`Evaluating send interaction on contract`, {
+                    tags,
+                    data,
+                    processId: this.processId,
+                });
+                // TODO: do a read as a dry run to check if the process supports the action
+                const messageId = await this.ao.message({
+                    process: this.processId,
+                    // TODO: any other default tags we want to add?
+                    tags: [...tags, { name: 'AR-IO-SDK', value: version_js_1.version }],
+                    data: typeof data !== 'string' ? JSON.stringify(data) : data,
+                    signer: await AOProcess.createAoSigner(signer),
+                });
+                this.logger.debug(`Sent message to process`, {
+                    messageId,
+                    processId: this.processId,
+                });
+                // check the result of the send interaction
+                const output = await this.ao.result({
+                    message: messageId,
+                    process: this.processId,
+                });
+                this.logger.debug('Message result', {
+                    output,
+                    messageId,
+                    processId: this.processId,
+                });
+                // check if there are any Messages in the output
+                if (output.Messages?.length === 0 || output.Messages === undefined) {
+                    return { id: messageId };
+                }
+                const tagsOutput = output.Messages[0].Tags;
+                const error = tagsOutput.find((tag) => tag.name === 'Error');
+                // if there's an Error tag, throw an error related to it
+                if (error) {
+                    const result = output.Messages[0].Data;
+                    throw new error_js_1.WriteInteractionError(`${error.Value}: ${result}`);
+                }
+                const resultData = JSON.parse(output.Messages[0].Data);
+                this.logger.debug('Message result data', {
+                    resultData,
+                    messageId,
+                    processId: this.processId,
+                });
+                return { id: messageId, result: resultData };
+            }
+            catch (error) {
+                this.logger.error('Error sending message to process', {
+                    error: error.message,
+                    processId: this.processId,
+                    tags,
+                });
+                // throw on write interaction errors. No point retrying wr ite interactions, waste of gas.
+                if (error.message.includes('500')) {
+                    this.logger.debug('Retrying send interaction', {
+                        attempts,
+                        retries,
+                        error: error.message,
+                        processId: this.processId,
+                    });
+                    // exponential backoff
+                    await new Promise((resolve) => setTimeout(resolve, 2 ** attempts * 2000));
+                    attempts++;
+                    lastError = error;
+                }
+                else
+                    throw error;
+            }
         }
-        const resultData = JSON.parse(output.Messages[0].Data);
-        this.logger.debug('Message result data', {
-            resultData,
-            messageId,
-            processId: this.processId,
-        });
-        return { id: messageId, result: resultData };
+        throw lastError;
     }
 }
 exports.AOProcess = AOProcess;

package/lib/cjs/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MIO_PER_IO = exports.ioDevnetProcessId = exports.ARNS_DEVNET_REGISTRY_TX = exports.ARNS_TESTNET_REGISTRY_TX = exports.SORT_KEY_REGEX = exports.FQDN_REGEX = exports.ARWEAVE_TX_REGEX = void 0;
+exports.DEFAULT_SCHEDULER_ID = exports.ANT_LUA_ID = exports.AOS_MODULE_ID = exports.MIO_PER_IO = exports.ioDevnetProcessId = exports.ARNS_DEVNET_REGISTRY_TX = exports.ARNS_TESTNET_REGISTRY_TX = exports.SORT_KEY_REGEX = exports.FQDN_REGEX = exports.ARWEAVE_TX_REGEX = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc. All Rights Reserved.
  *
@@ -26,3 +26,6 @@ exports.ARNS_TESTNET_REGISTRY_TX = process.env.ARNS_REGISTRY_TX ?? 'bLAgYxAdX2Ry
 exports.ARNS_DEVNET_REGISTRY_TX = '_NctcA2sRy1-J4OmIQZbYFPM17piNcbdBPH2ncX2RL8';
 exports.ioDevnetProcessId = 'GaQrvEMKBpkjofgnBi_B3IgIDmY_XYelVLB6GcRGrHc';
 exports.MIO_PER_IO = 1_000_000;
+exports.AOS_MODULE_ID = '9afQ1PLf2mrshqCTZEzzJTR2gWaC9zNPnYgYEqg1Pt4';
+exports.ANT_LUA_ID = 'obPBMsBWmG5q2qODj3y-zdKiuhZaJC_nuBaQRvORKkU';
+exports.DEFAULT_SCHEDULER_ID = '_GQ33BkPtZrqxA84vM8Zk-N2aO0toNNu_C-l-rawrBA';

package/lib/cjs/utils/ao.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.spawnANT = 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 aoconnect_1 = require("@permaweb/aoconnect");
+const arweave_js_1 = require("../common/arweave.js");
+const index_js_1 = require("../common/index.js");
+const constants_js_1 = require("../constants.js");
+async function spawnANT({ module = constants_js_1.AOS_MODULE_ID, luaCodeTxId = constants_js_1.ANT_LUA_ID, scheduler = constants_js_1.DEFAULT_SCHEDULER_ID, ao = (0, aoconnect_1.connect)(), signer, state, stateContractTxId, }) {
+    //TODO: cache locally and only fetch if not cached
+    const luaString = (await arweave_js_1.defaultArweave.transactions.getData(luaCodeTxId, {
+        decode: true,
+        string: true,
+    }));
+    const processId = await ao.spawn({
+        module,
+        scheduler,
+        signer: await index_js_1.AOProcess.createAoSigner(signer),
+    });
+    const aosClient = new index_js_1.AOProcess({
+        processId,
+        ao,
+    });
+    await aosClient.send({
+        tags: [
+            { name: 'Action', value: 'Eval' },
+            { name: 'App-Name', value: 'ArNS-ANT' },
+            { name: 'Source-Code-TX-ID', value: luaCodeTxId },
+        ],
+        data: luaString,
+        signer,
+    });
+    if (state) {
+        await aosClient.send({
+            tags: [
+                { name: 'Action', value: 'Initialize-State' },
+                ...(stateContractTxId !== undefined
+                    ? [{ name: 'State-Contract-TX-ID', value: stateContractTxId }]
+                    : []),
+            ],
+            data: JSON.stringify(state),
+            signer,
+        });
+    }
+    return processId;
+}
+exports.spawnANT = spawnANT;

package/lib/cjs/utils/index.js

@@ -34,3 +34,4 @@ __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);

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.0-alpha.7';
+exports.version = '1.2.0-alpha.8';

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

@@ -17,23 +17,19 @@
 import { connect } from '@permaweb/aoconnect';
 import { createData } from 'arbundles';
 import { version } from '../../version.js';
+import { WriteInteractionError } from '../error.js';
 import { DefaultLogger } from '../logger.js';
 export class AOProcess {
     logger;
     processId;
     ao;
-    constructor({ processId, connectionConfig, logger = new DefaultLogger({ level: 'info' }), }) {
+    constructor({ processId, ao = connect(), logger = new DefaultLogger({ level: 'info' }), }) {
         this.processId = processId;
         this.logger = logger;
-        this.ao = connect({
-            MU_URL: connectionConfig?.MU_URL,
-            CU_URL: connectionConfig?.CU_URL,
-            GATEWAY_URL: connectionConfig?.GATEWAY_URL,
-            GRAPHQL_URL: connectionConfig?.GRAPHQL_URL,
-        });
+        this.ao = ao;
     }
     // TODO: could abstract into our own interface that constructs different signers
-    async createAoSigner(signer) {
+    static async createAoSigner(signer) {
         // ensure appropriate permissions are granted with injected signers.
         if (signer.publicKey === undefined && 'setPublicKey' in signer) {
             await signer.setPublicKey();
@@ -88,51 +84,81 @@ export class AOProcess {
         }
         throw lastError;
     }
-    async send({ tags, data, signer, }) {
-        this.logger.debug(`Evaluating send interaction on contract`, {
-            tags,
-            data,
-            processId: this.processId,
-        });
-        // TODO: do a read as a dry run to check if the process supports the action
-        const messageId = await this.ao.message({
-            process: this.processId,
-            // TODO: any other default tags we want to add?
-            tags: [...tags, { name: 'AR-IO-SDK', value: version }],
-            data: JSON.stringify(data),
-            signer: await this.createAoSigner(signer),
-        });
-        this.logger.debug(`Sent message to process`, {
-            messageId,
-            processId: this.processId,
-        });
-        // check the result of the send interaction
-        const output = await this.ao.result({
-            message: messageId,
-            process: this.processId,
-        });
-        this.logger.debug('Message result', {
-            output,
-            messageId,
-            processId: this.processId,
-        });
-        // check if there are any Messages in the output
-        if (output.Messages.length === 0) {
-            return { id: messageId };
-        }
-        const tagsOutput = output.Messages[0].Tags;
-        const error = tagsOutput.find((tag) => tag.name === 'Error');
-        // if there's an Error tag, throw an error related to it
-        if (error) {
-            const result = output.Messages[0].Data;
-            throw new Error(`${error.Value}: ${result}`);
+    async send({ tags, data, signer, retries = 3, }) {
+        // main purpose of retries is to handle network errors/new process delays
+        let attempts = 0;
+        let lastError;
+        while (attempts < retries) {
+            try {
+                this.logger.debug(`Evaluating send interaction on contract`, {
+                    tags,
+                    data,
+                    processId: this.processId,
+                });
+                // TODO: do a read as a dry run to check if the process supports the action
+                const messageId = await this.ao.message({
+                    process: this.processId,
+                    // TODO: any other default tags we want to add?
+                    tags: [...tags, { name: 'AR-IO-SDK', value: version }],
+                    data: typeof data !== 'string' ? JSON.stringify(data) : data,
+                    signer: await AOProcess.createAoSigner(signer),
+                });
+                this.logger.debug(`Sent message to process`, {
+                    messageId,
+                    processId: this.processId,
+                });
+                // check the result of the send interaction
+                const output = await this.ao.result({
+                    message: messageId,
+                    process: this.processId,
+                });
+                this.logger.debug('Message result', {
+                    output,
+                    messageId,
+                    processId: this.processId,
+                });
+                // check if there are any Messages in the output
+                if (output.Messages?.length === 0 || output.Messages === undefined) {
+                    return { id: messageId };
+                }
+                const tagsOutput = output.Messages[0].Tags;
+                const error = tagsOutput.find((tag) => tag.name === 'Error');
+                // if there's an Error tag, throw an error related to it
+                if (error) {
+                    const result = output.Messages[0].Data;
+                    throw new WriteInteractionError(`${error.Value}: ${result}`);
+                }
+                const resultData = JSON.parse(output.Messages[0].Data);
+                this.logger.debug('Message result data', {
+                    resultData,
+                    messageId,
+                    processId: this.processId,
+                });
+                return { id: messageId, result: resultData };
+            }
+            catch (error) {
+                this.logger.error('Error sending message to process', {
+                    error: error.message,
+                    processId: this.processId,
+                    tags,
+                });
+                // throw on write interaction errors. No point retrying wr ite interactions, waste of gas.
+                if (error.message.includes('500')) {
+                    this.logger.debug('Retrying send interaction', {
+                        attempts,
+                        retries,
+                        error: error.message,
+                        processId: this.processId,
+                    });
+                    // exponential backoff
+                    await new Promise((resolve) => setTimeout(resolve, 2 ** attempts * 2000));
+                    attempts++;
+                    lastError = error;
+                }
+                else
+                    throw error;
+            }
         }
-        const resultData = JSON.parse(output.Messages[0].Data);
-        this.logger.debug('Message result data', {
-            resultData,
-            messageId,
-            processId: this.processId,
-        });
-        return { id: messageId, result: resultData };
+        throw lastError;
     }
 }

package/lib/esm/constants.js

@@ -23,3 +23,6 @@ export const ARNS_TESTNET_REGISTRY_TX = process.env.ARNS_REGISTRY_TX ?? 'bLAgYxA
 export const ARNS_DEVNET_REGISTRY_TX = '_NctcA2sRy1-J4OmIQZbYFPM17piNcbdBPH2ncX2RL8';
 export const ioDevnetProcessId = 'GaQrvEMKBpkjofgnBi_B3IgIDmY_XYelVLB6GcRGrHc';
 export const MIO_PER_IO = 1_000_000;
+export const AOS_MODULE_ID = '9afQ1PLf2mrshqCTZEzzJTR2gWaC9zNPnYgYEqg1Pt4';
+export const ANT_LUA_ID = 'obPBMsBWmG5q2qODj3y-zdKiuhZaJC_nuBaQRvORKkU';
+export const DEFAULT_SCHEDULER_ID = '_GQ33BkPtZrqxA84vM8Zk-N2aO0toNNu_C-l-rawrBA';

package/lib/esm/utils/ao.js

@@ -0,0 +1,58 @@
+/**
+ * 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 { connect } from '@permaweb/aoconnect';
+import { defaultArweave } from '../common/arweave.js';
+import { AOProcess } from '../common/index.js';
+import { ANT_LUA_ID, AOS_MODULE_ID, DEFAULT_SCHEDULER_ID, } from '../constants.js';
+export async function spawnANT({ module = AOS_MODULE_ID, luaCodeTxId = ANT_LUA_ID, scheduler = DEFAULT_SCHEDULER_ID, ao = connect(), signer, state, stateContractTxId, }) {
+    //TODO: cache locally and only fetch if not cached
+    const luaString = (await defaultArweave.transactions.getData(luaCodeTxId, {
+        decode: true,
+        string: true,
+    }));
+    const processId = await ao.spawn({
+        module,
+        scheduler,
+        signer: await AOProcess.createAoSigner(signer),
+    });
+    const aosClient = new AOProcess({
+        processId,
+        ao,
+    });
+    await aosClient.send({
+        tags: [
+            { name: 'Action', value: 'Eval' },
+            { name: 'App-Name', value: 'ArNS-ANT' },
+            { name: 'Source-Code-TX-ID', value: luaCodeTxId },
+        ],
+        data: luaString,
+        signer,
+    });
+    if (state) {
+        await aosClient.send({
+            tags: [
+                { name: 'Action', value: 'Initialize-State' },
+                ...(stateContractTxId !== undefined
+                    ? [{ name: 'State-Contract-TX-ID', value: stateContractTxId }]
+                    : []),
+            ],
+            data: JSON.stringify(state),
+            signer,
+        });
+    }
+    return processId;
+}

package/lib/esm/utils/index.js

@@ -18,3 +18,4 @@ export * from './arweave.js';
 export * from './http-client.js';
 export * from './smartweave.js';
 export * from './graphql/index.js';
+export * from './ao.js';

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 = '1.2.0-alpha.7';
+export const version = '1.2.0-alpha.8';

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

@@ -1,21 +1,16 @@
 /// <reference types="node" />
-import { AOContract, ContractSigner } from '../../types.js';
+import { AOContract, AoClient, ContractSigner } from '../../types.js';
 import { DefaultLogger } from '../logger.js';
 export declare class AOProcess implements AOContract {
     private logger;
     private processId;
     private ao;
-    constructor({ processId, connectionConfig, logger, }: {
+    constructor({ processId, ao, logger, }: {
         processId: string;
-        connectionConfig?: {
-            CU_URL: string;
-            MU_URL: string;
-            GATEWAY_URL: string;
-            GRAPHQL_URL: string;
-        };
+        ao?: AoClient;
         logger?: DefaultLogger;
     });
-    createAoSigner(signer: ContractSigner): Promise<(args: {
+    static createAoSigner(signer: ContractSigner): Promise<(args: {
         data: string | Buffer;
         tags?: {
             name: string;
@@ -34,13 +29,14 @@ export declare class AOProcess implements AOContract {
         }>;
         retries?: number;
     }): Promise<K>;
-    send<I, K>({ tags, data, signer, }: {
+    send<I, K>({ tags, data, signer, retries, }: {
         tags: Array<{
             name: string;
             value: string;
         }>;
         data?: I;
         signer: ContractSigner;
+        retries?: number;
     }): Promise<{
         id: string;
         result?: K;

package/lib/types/common.d.ts

@@ -15,6 +15,7 @@
  * 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 { dryrun, message, monitor, result, results, spawn, unmonitor } from '@permaweb/aoconnect';
 import { ArconnectSigner, ArweaveSigner } from 'arbundles';
 import { GQLNodeInterface, Transaction } from 'warp-contracts';
 import { RemoteContract, WarpContract } from './common/index.js';
@@ -224,4 +225,13 @@ export interface HTTPClient {
         params?: object | I;
     }): Promise<K>;
 }
+export interface AoClient {
+    result: typeof result;
+    results: typeof results;
+    message: typeof message;
+    spawn: typeof spawn;
+    monitor: typeof monitor;
+    unmonitor: typeof unmonitor;
+    dryrun: typeof dryrun;
+}
 export {};

package/lib/types/constants.d.ts

@@ -22,3 +22,6 @@ export declare const ARNS_TESTNET_REGISTRY_TX: string;
 export declare const ARNS_DEVNET_REGISTRY_TX = "_NctcA2sRy1-J4OmIQZbYFPM17piNcbdBPH2ncX2RL8";
 export declare const ioDevnetProcessId = "GaQrvEMKBpkjofgnBi_B3IgIDmY_XYelVLB6GcRGrHc";
 export declare const MIO_PER_IO = 1000000;
+export declare const AOS_MODULE_ID = "9afQ1PLf2mrshqCTZEzzJTR2gWaC9zNPnYgYEqg1Pt4";
+export declare const ANT_LUA_ID = "obPBMsBWmG5q2qODj3y-zdKiuhZaJC_nuBaQRvORKkU";
+export declare const DEFAULT_SCHEDULER_ID = "_GQ33BkPtZrqxA84vM8Zk-N2aO0toNNu_C-l-rawrBA";

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

@@ -0,0 +1,11 @@
+import { ANTState } from '../contract-state.js';
+import { AoClient, ContractSigner } from '../types.js';
+export declare function spawnANT({ module, luaCodeTxId, scheduler, ao, signer, state, stateContractTxId, }: {
+    module: string;
+    luaCodeTxId: string;
+    ao: AoClient;
+    scheduler: string;
+    signer: ContractSigner;
+    state?: ANTState;
+    stateContractTxId?: string;
+}): Promise<string>;

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

@@ -18,3 +18,4 @@ export * from './arweave.js';
 export * from './http-client.js';
 export * from './smartweave.js';
 export * from './graphql/index.js';
+export * from './ao.js';

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 = "1.2.0-alpha.6";
+export declare const version = "1.2.0-alpha.7";

package/package.json

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