@ar.io/sdk 3.18.2 → 3.19.0-alpha.1

package/lib/cjs/common/ant.js

@@ -37,7 +37,12 @@ class ANT {
      * Spawn a new ANT.
      */
     static spawn = ao_js_1.spawnANT;
-    // implementation
+    /**
+     * Fork an ANT to a new process.
+     *
+     * @param config
+     */
+    static fork = ao_js_1.forkANT;
     static init(config) {
         if (config !== undefined && 'signer' in config) {
             return new AoANTWriteable(config);

package/lib/cjs/utils/ao.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultANTLogoId = exports.defaultTargetManifestId = void 0;
 exports.spawnANT = spawnANT;
+exports.forkANT = forkANT;
 exports.evolveANT = evolveANT;
 exports.isAoSigner = isAoSigner;
 exports.createAoSigner = createAoSigner;
@@ -222,7 +223,40 @@ async function spawnANT({ signer, module, ao = (0, aoconnect_1.connect)({
     }
     return processId;
 }
-// TODO: add a utility for forking an ANT to the latest module that leverages getState and spawnANT
+async function forkANT({ signer, antProcessId, logger = index_js_1.Logger.default, ao, antRegistryId = constants_js_1.ANT_REGISTRY_ID, onSigningProgress = (name, payload) => {
+    logger.debug('Forking ANT', { name, payload });
+}, }) {
+    // get the state of the current ANT and use it to spawn a new ANT
+    const ant = index_js_1.ANT.init({
+        process: new index_js_1.AOProcess({
+            processId: antProcessId,
+            ao,
+            logger,
+        }),
+    });
+    const state = await ant.getState();
+    if (state === undefined) {
+        throw new Error(`ANT state (${antProcessId}) is undefined and cannot be upgraded`);
+    }
+    const forkedProcessId = await spawnANT({
+        signer,
+        antRegistryId,
+        logger,
+        onSigningProgress,
+        state: {
+            owner: state.Owner,
+            name: state.Name,
+            ticker: state.Ticker,
+            description: state.Description,
+            keywords: state.Keywords,
+            controllers: state.Controllers,
+            records: state.Records,
+            balances: state.Balances,
+            logo: state.Logo,
+        },
+    });
+    return forkedProcessId;
+}
 /**
  * @deprecated
  * Direct Evals are not encouraged when dealing with ANTs.

package/lib/cjs/version.js

@@ -17,4 +17,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '3.18.2';
+exports.version = '3.19.0-alpha.1';

package/lib/esm/common/ant.js

@@ -17,7 +17,7 @@ import { z } from 'zod';
 import { AntBalancesSchema, AntControllersSchema, AntInfoSchema, AntRecordSchema, AntRecordsSchema, AntStateSchema, } from '../types/ant.js';
 import { isProcessConfiguration, isProcessIdConfiguration, } from '../types/index.js';
 import { convertHyperBeamStateToAoANTState, isHyperBeamANTState, sortANTRecords, } from '../utils/ant.js';
-import { createAoSigner, spawnANT } from '../utils/ao.js';
+import { createAoSigner, forkANT, spawnANT } from '../utils/ao.js';
 import { parseSchemaResult } from '../utils/schema.js';
 import { ANTVersions } from './ant-versions.js';
 import { AOProcess, InvalidContractConfigurationError, Logger, } from './index.js';
@@ -34,7 +34,12 @@ export class ANT {
      * Spawn a new ANT.
      */
     static spawn = spawnANT;
-    // implementation
+    /**
+     * Fork an ANT to a new process.
+     *
+     * @param config
+     */
+    static fork = forkANT;
     static init(config) {
         if (config !== undefined && 'signer' in config) {
             return new AoANTWriteable(config);

package/lib/esm/utils/ao.js

@@ -19,7 +19,7 @@ import { z } from 'zod';
 import { ANTRegistry } from '../common/ant-registry.js';
 import { ANTVersions } from '../common/ant-versions.js';
 import { defaultArweave } from '../common/arweave.js';
-import { AOProcess, Logger } from '../common/index.js';
+import { ANT, AOProcess, Logger } from '../common/index.js';
 import { ANT_LUA_ID, ANT_REGISTRY_ID, AO_AUTHORITY, DEFAULT_SCHEDULER_ID, } from '../constants.js';
 import { SpawnANTStateSchema } from '../types/ant.js';
 import { parseSchemaResult } from './schema.js';
@@ -211,7 +211,40 @@ export async function spawnANT({ signer, module, ao = connect({
     }
     return processId;
 }
-// TODO: add a utility for forking an ANT to the latest module that leverages getState and spawnANT
+export async function forkANT({ signer, antProcessId, logger = Logger.default, ao, antRegistryId = ANT_REGISTRY_ID, onSigningProgress = (name, payload) => {
+    logger.debug('Forking ANT', { name, payload });
+}, }) {
+    // get the state of the current ANT and use it to spawn a new ANT
+    const ant = ANT.init({
+        process: new AOProcess({
+            processId: antProcessId,
+            ao,
+            logger,
+        }),
+    });
+    const state = await ant.getState();
+    if (state === undefined) {
+        throw new Error(`ANT state (${antProcessId}) is undefined and cannot be upgraded`);
+    }
+    const forkedProcessId = await spawnANT({
+        signer,
+        antRegistryId,
+        logger,
+        onSigningProgress,
+        state: {
+            owner: state.Owner,
+            name: state.Name,
+            ticker: state.Ticker,
+            description: state.Description,
+            keywords: state.Keywords,
+            controllers: state.Controllers,
+            records: state.Records,
+            balances: state.Balances,
+            logo: state.Logo,
+        },
+    });
+    return forkedProcessId;
+}
 /**
  * @deprecated
  * Direct Evals are not encouraged when dealing with ANTs.

package/lib/esm/version.js

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '3.18.2';
+export const version = '3.19.0-alpha.1';

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

@@ -1,6 +1,6 @@
 import { AntReadOptions, AoANTHandler, AoANTInfo, AoANTRead, AoANTRecord, AoANTSetBaseNameRecordParams, AoANTSetUndernameRecordParams, AoANTState, AoANTWrite, SortedANTRecords } from '../types/ant.js';
 import { AoMessageResult, ProcessConfiguration, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
-import { spawnANT } from '../utils/ao.js';
+import { forkANT, spawnANT } from '../utils/ao.js';
 import { AOProcess } from './index.js';
 type ANTConfigOptionalStrict = Required<ProcessConfiguration> & {
     strict?: boolean;
@@ -19,6 +19,17 @@ export declare class ANT {
      * Spawn a new ANT.
      */
     static spawn: typeof spawnANT;
+    /**
+     * Fork an ANT to a new process.
+     *
+     * @param config
+     */
+    static fork: typeof forkANT;
+    /**
+     * Initialize overloads.
+     *
+     * @param config
+     */
     static init(config: ANTConfigNoSigner): AoANTRead;
     static init(config: ANTConfigWithSigner): AoANTWrite;
 }

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

@@ -30,6 +30,14 @@ export type SpawnANTParams = {
     onSigningProgress?: (name: keyof SpawnAntProgressEvent, payload: SpawnAntProgressEvent[keyof SpawnAntProgressEvent]) => void;
 };
 export declare function spawnANT({ signer, module, ao, scheduler, state, tags, antRegistryId, logger, authority, onSigningProgress, }: SpawnANTParams): Promise<ProcessId>;
+export declare function forkANT({ signer, antProcessId, logger, ao, antRegistryId, onSigningProgress, }: {
+    signer: AoSigner;
+    antProcessId: string;
+    logger?: Logger;
+    ao?: AoClient;
+    antRegistryId?: string;
+    onSigningProgress?: (name: keyof SpawnAntProgressEvent, payload: SpawnAntProgressEvent[keyof SpawnAntProgressEvent]) => void;
+}): Promise<string>;
 /**
  * @deprecated
  * Direct Evals are not encouraged when dealing with ANTs.

package/lib/types/version.d.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare const version = "3.18.2-alpha.1";
+export declare const version = "3.18.2";

package/package.json

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