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

package/lib/cjs/utils/ao.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAoSigner = exports.isAoSigner = exports.evolveANT = exports.spawnANT = void 0;
+exports.isAoANTState = exports.AntStateSchema = exports.createAoSigner = exports.isAoSigner = exports.evolveANT = exports.spawnANT = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc. All Rights Reserved.
  *
@@ -152,3 +152,36 @@ function createAoSigner(signer) {
     return aoSigner;
 }
 exports.createAoSigner = createAoSigner;
+// using passThrough to require the minimum fields and allow others (eg TotalSupply, Logo, etc)
+exports.AntStateSchema = zod_1.z
+    .object({
+    Name: zod_1.z.string(),
+    Ticker: zod_1.z.string(),
+    Owner: zod_1.z.string(),
+    Controllers: zod_1.z.array(zod_1.z.string()),
+    Records: zod_1.z.record(zod_1.z.string(), zod_1.z
+        .object({
+        transactionId: zod_1.z.string(),
+        ttlSeconds: zod_1.z.number(),
+    })
+        .passthrough()),
+    Balances: zod_1.z.record(zod_1.z.string(), zod_1.z.number()),
+})
+    .passthrough();
+/**
+ * @param state
+ * @returns {boolean}
+ * @throws {z.ZodError} if the state object does not match the expected schema
+ */
+function isAoANTState(state, logger = index_js_1.Logger.default) {
+    try {
+        exports.AntStateSchema.parse(state);
+        return true;
+    }
+    catch (error) {
+        // this allows us to see the path of the error in the object as well as the expected schema on invalid fields
+        logger.error(error.issues);
+        return false;
+    }
+}
+exports.isAoANTState = isAoANTState;

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

package/lib/esm/utils/ao.js

@@ -18,7 +18,7 @@ import { connect, createDataItemSigner } from '@permaweb/aoconnect';
 import { createData } from 'arbundles';
 import { z } from 'zod';
 import { defaultArweave } from '../common/arweave.js';
-import { AOProcess } from '../common/index.js';
+import { AOProcess, Logger } from '../common/index.js';
 import { ANT_LUA_ID, ANT_REGISTRY_ID, AOS_MODULE_ID, DEFAULT_SCHEDULER_ID, } from '../constants.js';
 export async function spawnANT({ signer, module = AOS_MODULE_ID, luaCodeTxId = ANT_LUA_ID, ao = connect(), scheduler = DEFAULT_SCHEDULER_ID, state, stateContractTxId, antRegistryId = ANT_REGISTRY_ID, }) {
     // AoSigner is not a Contract Signer - should probably add that to the contract signer type
@@ -145,3 +145,35 @@ export function createAoSigner(signer) {
     };
     return aoSigner;
 }
+// using passThrough to require the minimum fields and allow others (eg TotalSupply, Logo, etc)
+export const AntStateSchema = z
+    .object({
+    Name: z.string(),
+    Ticker: z.string(),
+    Owner: z.string(),
+    Controllers: z.array(z.string()),
+    Records: z.record(z.string(), z
+        .object({
+        transactionId: z.string(),
+        ttlSeconds: z.number(),
+    })
+        .passthrough()),
+    Balances: z.record(z.string(), z.number()),
+})
+    .passthrough();
+/**
+ * @param state
+ * @returns {boolean}
+ * @throws {z.ZodError} if the state object does not match the expected schema
+ */
+export function isAoANTState(state, logger = Logger.default) {
+    try {
+        AntStateSchema.parse(state);
+        return true;
+    }
+    catch (error) {
+        // this allows us to see the path of the error in the object as well as the expected schema on invalid fields
+        logger.error(error.issues);
+        return false;
+    }
+}

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

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

@@ -1,4 +1,6 @@
-import { AoANTRecord, AoClient, AoSigner, ContractSigner, WalletAddress } from '../types.js';
+import { z } from 'zod';
+import { Logger } from '../common/index.js';
+import { AoANTRecord, AoANTState, AoClient, AoSigner, ContractSigner, WalletAddress } from '../types.js';
 export declare function spawnANT({ signer, module, luaCodeTxId, ao, scheduler, state, stateContractTxId, antRegistryId, }: {
     signer: AoSigner;
     module?: string;
@@ -24,3 +26,58 @@ export declare function evolveANT({ signer, processId, luaCodeTxId, ao, }: {
 }): Promise<string>;
 export declare function isAoSigner(value: unknown): value is AoSigner;
 export declare function createAoSigner(signer: ContractSigner): AoSigner;
+export declare const AntStateSchema: z.ZodObject<{
+    Name: z.ZodString;
+    Ticker: z.ZodString;
+    Owner: z.ZodString;
+    Controllers: z.ZodArray<z.ZodString, "many">;
+    Records: z.ZodRecord<z.ZodString, z.ZodObject<{
+        transactionId: z.ZodString;
+        ttlSeconds: z.ZodNumber;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        transactionId: z.ZodString;
+        ttlSeconds: z.ZodNumber;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        transactionId: z.ZodString;
+        ttlSeconds: z.ZodNumber;
+    }, z.ZodTypeAny, "passthrough">>>;
+    Balances: z.ZodRecord<z.ZodString, z.ZodNumber>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    Name: z.ZodString;
+    Ticker: z.ZodString;
+    Owner: z.ZodString;
+    Controllers: z.ZodArray<z.ZodString, "many">;
+    Records: z.ZodRecord<z.ZodString, z.ZodObject<{
+        transactionId: z.ZodString;
+        ttlSeconds: z.ZodNumber;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        transactionId: z.ZodString;
+        ttlSeconds: z.ZodNumber;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        transactionId: z.ZodString;
+        ttlSeconds: z.ZodNumber;
+    }, z.ZodTypeAny, "passthrough">>>;
+    Balances: z.ZodRecord<z.ZodString, z.ZodNumber>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    Name: z.ZodString;
+    Ticker: z.ZodString;
+    Owner: z.ZodString;
+    Controllers: z.ZodArray<z.ZodString, "many">;
+    Records: z.ZodRecord<z.ZodString, z.ZodObject<{
+        transactionId: z.ZodString;
+        ttlSeconds: z.ZodNumber;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        transactionId: z.ZodString;
+        ttlSeconds: z.ZodNumber;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        transactionId: z.ZodString;
+        ttlSeconds: z.ZodNumber;
+    }, z.ZodTypeAny, "passthrough">>>;
+    Balances: z.ZodRecord<z.ZodString, z.ZodNumber>;
+}, z.ZodTypeAny, "passthrough">>;
+/**
+ * @param state
+ * @returns {boolean}
+ * @throws {z.ZodError} if the state object does not match the expected schema
+ */
+export declare function isAoANTState(state: object, logger?: Logger): state is AoANTState;

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

package/package.json

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