@ar.io/sdk 2.1.0-alpha.4 → 2.1.0-alpha.5

package/lib/cjs/common/ant.js

@@ -18,6 +18,7 @@ exports.AoANTWriteable = exports.AoANTReadable = exports.ANT = void 0;
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 const types_js_1 = require("../types.js");
+const ao_js_1 = require("../utils/ao.js");
 const index_js_1 = require("./index.js");
 class ANT {
     static init({ signer, ...config }) {
@@ -186,7 +187,7 @@ class AoANTWriteable extends AoANTReadable {
     signer;
     constructor({ signer, ...config }) {
         super(config);
-        this.signer = signer;
+        this.signer = (0, ao_js_1.createAoSigner)(signer);
     }
     /**
      * @param target @type {string} The address of the account you want to transfer the ANT to.

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

@@ -18,7 +18,6 @@ exports.AOProcess = void 0;
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 const aoconnect_1 = require("@permaweb/aoconnect");
-const arbundles_1 = require("arbundles");
 const json_js_1 = require("../../utils/json.js");
 const version_js_1 = require("../../version.js");
 const error_js_1 = require("../error.js");
@@ -32,22 +31,6 @@ class AOProcess {
         this.logger = logger;
         this.ao = ao;
     }
-    // TODO: could abstract into our own interface that constructs different signers
-    static async createAoSigner(signer) {
-        // ensure appropriate permissions are granted with injected signers.
-        if (signer.publicKey === undefined && 'setPublicKey' in signer) {
-            await signer.setPublicKey();
-        }
-        const aoSigner = async ({ data, tags, target, anchor }) => {
-            const dataItem = (0, arbundles_1.createData)(data, signer, { tags, target, anchor });
-            const signedData = dataItem.sign(signer).then(async () => ({
-                id: await dataItem.id,
-                raw: await dataItem.getRaw(),
-            }));
-            return signedData;
-        };
-        return aoSigner;
-    }
     async read({ tags, retries = 3, }) {
         let attempts = 0;
         let lastError;
@@ -109,7 +92,7 @@ class AOProcess {
                     // 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),
+                    signer,
                 });
                 this.logger.debug(`Sent message to process`, {
                     messageId,

package/lib/cjs/common/io.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.IOWriteable = exports.IOReadable = exports.IO = void 0;
 const constants_js_1 = require("../constants.js");
 const io_js_1 = require("../io.js");
+const ao_js_1 = require("../utils/ao.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");
@@ -346,11 +347,11 @@ class IOWriteable extends IOReadable {
                     processId: constants_js_1.IO_TESTNET_PROCESS_ID,
                 }),
             });
-            this.signer = signer;
+            this.signer = (0, ao_js_1.createAoSigner)(signer);
         }
         else if ((0, io_js_1.isProcessConfiguration)(config)) {
             super({ process: config.process });
-            this.signer = signer;
+            this.signer = (0, ao_js_1.createAoSigner)(signer);
         }
         else if ((0, io_js_1.isProcessIdConfiguration)(config)) {
             super({
@@ -358,7 +359,7 @@ class IOWriteable extends IOReadable {
                     processId: config.processId,
                 }),
             });
-            this.signer = signer;
+            this.signer = (0, ao_js_1.createAoSigner)(signer);
         }
         else {
             throw new error_js_1.InvalidContractConfigurationError();

package/lib/cjs/utils/ao.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.evolveANT = exports.spawnANT = void 0;
+exports.createAoSigner = exports.evolveANT = exports.spawnANT = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc. All Rights Reserved.
  *
@@ -18,6 +18,7 @@ exports.evolveANT = exports.spawnANT = void 0;
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 const aoconnect_1 = require("@permaweb/aoconnect");
+const arbundles_1 = require("arbundles");
 const arweave_js_1 = require("../common/arweave.js");
 const index_js_1 = require("../common/index.js");
 const constants_js_1 = require("../constants.js");
@@ -30,7 +31,7 @@ async function spawnANT({ signer, module = constants_js_1.AOS_MODULE_ID, luaCode
     const processId = await ao.spawn({
         module,
         scheduler,
-        signer: await index_js_1.AOProcess.createAoSigner(signer),
+        signer,
     });
     const aosClient = new index_js_1.AOProcess({
         processId,
@@ -82,3 +83,24 @@ async function evolveANT({ signer, processId, luaCodeTxId = constants_js_1.ANT_L
     return id;
 }
 exports.evolveANT = evolveANT;
+function createAoSigner(signer) {
+    if (!('publicKey' in signer)) {
+        return (0, aoconnect_1.createDataItemSigner)(signer);
+    }
+    const aoSigner = async ({ data, tags, target, anchor }) => {
+        // ensure appropriate permissions are granted with injected signers.
+        if (signer.publicKey === undefined &&
+            'setPublicKey' in signer &&
+            typeof signer.setPublicKey === 'function') {
+            await signer.setPublicKey();
+        }
+        const dataItem = (0, arbundles_1.createData)(data, signer, { tags, target, anchor });
+        const signedData = dataItem.sign(signer).then(async () => ({
+            id: await dataItem.id,
+            raw: await dataItem.getRaw(),
+        }));
+        return signedData;
+    };
+    return aoSigner;
+}
+exports.createAoSigner = createAoSigner;

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.1.0-alpha.4';
+exports.version = '2.1.0-alpha.5';

package/lib/esm/common/ant.js

@@ -15,6 +15,7 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 import { isProcessConfiguration, isProcessIdConfiguration, } from '../types.js';
+import { createAoSigner } from '../utils/ao.js';
 import { AOProcess, InvalidContractConfigurationError } from './index.js';
 export class ANT {
     static init({ signer, ...config }) {
@@ -181,7 +182,7 @@ export class AoANTWriteable extends AoANTReadable {
     signer;
     constructor({ signer, ...config }) {
         super(config);
-        this.signer = signer;
+        this.signer = createAoSigner(signer);
     }
     /**
      * @param target @type {string} The address of the account you want to transfer the ANT to.

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

@@ -15,7 +15,6 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 import { connect } from '@permaweb/aoconnect';
-import { createData } from 'arbundles';
 import { safeDecode } from '../../utils/json.js';
 import { version } from '../../version.js';
 import { WriteInteractionError } from '../error.js';
@@ -29,22 +28,6 @@ export class AOProcess {
         this.logger = logger;
         this.ao = ao;
     }
-    // TODO: could abstract into our own interface that constructs different signers
-    static async createAoSigner(signer) {
-        // ensure appropriate permissions are granted with injected signers.
-        if (signer.publicKey === undefined && 'setPublicKey' in signer) {
-            await signer.setPublicKey();
-        }
-        const aoSigner = async ({ data, tags, target, anchor }) => {
-            const dataItem = createData(data, signer, { tags, target, anchor });
-            const signedData = dataItem.sign(signer).then(async () => ({
-                id: await dataItem.id,
-                raw: await dataItem.getRaw(),
-            }));
-            return signedData;
-        };
-        return aoSigner;
-    }
     async read({ tags, retries = 3, }) {
         let attempts = 0;
         let lastError;
@@ -106,7 +89,7 @@ export class AOProcess {
                     // 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),
+                    signer,
                 });
                 this.logger.debug(`Sent message to process`, {
                     messageId,

package/lib/esm/common/io.js

@@ -1,5 +1,6 @@
 import { IO_TESTNET_PROCESS_ID } from '../constants.js';
 import { isProcessConfiguration, isProcessIdConfiguration, } from '../io.js';
+import { createAoSigner } from '../utils/ao.js';
 import { defaultArweave } from './arweave.js';
 import { AOProcess } from './contracts/ao-process.js';
 import { InvalidContractConfigurationError } from './error.js';
@@ -341,11 +342,11 @@ export class IOWriteable extends IOReadable {
                     processId: IO_TESTNET_PROCESS_ID,
                 }),
             });
-            this.signer = signer;
+            this.signer = createAoSigner(signer);
         }
         else if (isProcessConfiguration(config)) {
             super({ process: config.process });
-            this.signer = signer;
+            this.signer = createAoSigner(signer);
         }
         else if (isProcessIdConfiguration(config)) {
             super({
@@ -353,7 +354,7 @@ export class IOWriteable extends IOReadable {
                     processId: config.processId,
                 }),
             });
-            this.signer = signer;
+            this.signer = createAoSigner(signer);
         }
         else {
             throw new InvalidContractConfigurationError();

package/lib/esm/utils/ao.js

@@ -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 { connect } from '@permaweb/aoconnect';
+import { connect, createDataItemSigner } from '@permaweb/aoconnect';
+import { createData } from 'arbundles';
 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';
@@ -27,7 +28,7 @@ export async function spawnANT({ signer, module = AOS_MODULE_ID, luaCodeTxId = A
     const processId = await ao.spawn({
         module,
         scheduler,
-        signer: await AOProcess.createAoSigner(signer),
+        signer,
     });
     const aosClient = new AOProcess({
         processId,
@@ -77,3 +78,23 @@ export async function evolveANT({ signer, processId, luaCodeTxId = ANT_LUA_ID, a
     });
     return id;
 }
+export function createAoSigner(signer) {
+    if (!('publicKey' in signer)) {
+        return createDataItemSigner(signer);
+    }
+    const aoSigner = async ({ data, tags, target, anchor }) => {
+        // ensure appropriate permissions are granted with injected signers.
+        if (signer.publicKey === undefined &&
+            'setPublicKey' in signer &&
+            typeof signer.setPublicKey === 'function') {
+            await signer.setPublicKey();
+        }
+        const dataItem = createData(data, signer, { tags, target, anchor });
+        const signedData = dataItem.sign(signer).then(async () => ({
+            id: await dataItem.id,
+            raw: await dataItem.getRaw(),
+        }));
+        return signedData;
+    };
+    return aoSigner;
+}

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.1.0-alpha.4';
+export const version = '2.1.0-alpha.5';

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

@@ -1,5 +1,4 @@
-/// <reference types="node" />
-import { AOContract, AoClient, ContractSigner } from '../../types.js';
+import { AOContract, AoClient, AoSigner } from '../../types.js';
 import { ILogger } from '../logger.js';
 export declare class AOProcess implements AOContract {
     private logger;
@@ -10,18 +9,6 @@ export declare class AOProcess implements AOContract {
         ao?: AoClient;
         logger?: ILogger;
     });
-    static createAoSigner(signer: ContractSigner): Promise<(args: {
-        data: string | Buffer;
-        tags?: {
-            name: string;
-            value: string;
-        }[];
-        target?: string;
-        anchor?: string;
-    }) => Promise<{
-        id: string;
-        raw: ArrayBuffer;
-    }>>;
     read<K>({ tags, retries, }: {
         tags?: Array<{
             name: string;
@@ -35,7 +22,7 @@ export declare class AOProcess implements AOContract {
             value: string;
         }>;
         data?: I;
-        signer: ContractSigner;
+        signer: AoSigner;
         retries?: number;
     }): Promise<{
         id: string;

package/lib/types/common.d.ts

@@ -16,7 +16,7 @@
  * 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 { Signer } from 'arbundles';
 import { AllowedProtocols, GatewayConnectionSettings, GatewayMetadata, GatewayStakingSettings } from './contract-state.js';
 import { mIOToken } from './token.js';
 export type BlockHeight = number;
@@ -25,7 +25,7 @@ export type Timestamp = number;
 export type WalletAddress = string;
 export type TransactionId = string;
 export type ProcessId = string;
-export type ContractSigner = ArweaveSigner | ArconnectSigner;
+export type ContractSigner = Signer | Window['arweaveWallet'];
 export type WithSigner<T = NonNullable<unknown>> = {
     signer: ContractSigner;
 } & T;

package/lib/types/io.d.ts

@@ -16,8 +16,8 @@
  */
 import { AOProcess } from './common/index.js';
 import { ANTRecord, ArNSReservedNameData, EpochDistributionData, EpochObservations, GatewayDelegate, GatewaySettings, RegistrationType, VaultData, WeightedObserver } from './contract-state.js';
-import { mIOToken } from './token.js';
-import { AoMessageResult, BlockHeight, ContractSigner, JoinNetworkParams, ProcessId, Timestamp, TransactionId, UpdateGatewaySettingsParams, WalletAddress, WriteOptions } from './types.js';
+import { AoSigner, mIOToken } from './token.js';
+import { AoMessageResult, BlockHeight, JoinNetworkParams, ProcessId, Timestamp, TransactionId, UpdateGatewaySettingsParams, WalletAddress, WriteOptions } from './types.js';
 export declare function isProcessConfiguration(config: object): config is {
     process: AOProcess;
 };
@@ -63,7 +63,7 @@ export interface AOContract {
             value: string;
         }[];
         data: I;
-        signer: ContractSigner;
+        signer: AoSigner;
     }): Promise<{
         id: string;
         result?: K;

package/lib/types/token.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 interface Equatable<T> {
     equals(other: T): boolean;
 }
@@ -31,4 +32,16 @@ export declare class mIOToken extends PositiveFiniteInteger {
     minus(subtractHend: mIOToken): mIOToken;
     toIO(): IOToken;
 }
+export type AoSigner = (args: {
+    data: string | Buffer;
+    tags?: {
+        name: string;
+        value: string;
+    }[];
+    target?: string;
+    anchor?: string;
+}) => Promise<{
+    id: string;
+    raw: ArrayBuffer;
+}>;
 export {};

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

@@ -1,7 +1,7 @@
 import { ANTState } from '../contract-state.js';
-import { AoClient, ContractSigner } from '../types.js';
+import { AoClient, AoSigner, ContractSigner } from '../types.js';
 export declare function spawnANT({ signer, module, luaCodeTxId, ao, scheduler, state, stateContractTxId, }: {
-    signer: ContractSigner;
+    signer: AoSigner;
     module?: string;
     luaCodeTxId?: string;
     ao?: AoClient;
@@ -10,8 +10,9 @@ export declare function spawnANT({ signer, module, luaCodeTxId, ao, scheduler, s
     stateContractTxId?: string;
 }): Promise<string>;
 export declare function evolveANT({ signer, processId, luaCodeTxId, ao, }: {
-    signer: ContractSigner;
+    signer: AoSigner;
     processId: string;
     luaCodeTxId?: string;
     ao?: AoClient;
 }): Promise<string>;
+export declare function createAoSigner(signer: ContractSigner): AoSigner;

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.1.0-alpha.3";
+export declare const version = "2.1.0-alpha.4";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "2.1.0-alpha.4",
+  "version": "2.1.0-alpha.5",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"
@@ -91,6 +91,7 @@
     "@types/sinon": "^10.0.15",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^6.4.0",
+    "arconnect": "^1.0.3",
     "dotenv": "^16.4.5",
     "dotenv-cli": "^7.4.2",
     "esbuild": "^0.19.2",
@@ -118,7 +119,7 @@
     "vite-plugin-node-polyfills": "^0.22.0"
   },
   "dependencies": {
-    "@permaweb/aoconnect": "^0.0.55",
+    "@permaweb/aoconnect": "^0.0.57",
     "arbundles": "0.11.0",
     "arweave": "1.14.4",
     "axios": "1.7.2",