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

package/lib/cjs/types/ant.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAoANTState = exports.AntInfoSchema = exports.AntHandlersSchema = exports.AntHandlerNames = exports.AntWriteHandlers = exports.AntReadHandlers = exports.AntStateSchema = exports.AntBalancesSchema = exports.AntControllersSchema = exports.AntRecordsSchema = exports.AntRecordSchema = exports.AntKeywordsSchema = exports.AntDescriptionSchema = exports.IntegerStringSchema = exports.AOAddressSchema = exports.ArweaveTxIdSchema = void 0;
+exports.isAoANTState = exports.AntInfoSchema = exports.AntHandlersSchema = exports.AntHandlerNames = exports.AntWriteHandlers = exports.AntReadHandlers = exports.SpawnANTStateSchema = exports.AntStateSchema = exports.AntBalancesSchema = exports.AntControllersSchema = exports.AntRecordsSchema = exports.AntRecordSchema = exports.AntKeywordsSchema = exports.AntDescriptionSchema = exports.IntegerStringSchema = exports.AOAddressSchema = exports.ArweaveTxIdSchema = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -80,6 +80,17 @@ exports.AntStateSchema = zod_1.z.object({
         .boolean()
         .describe('Flag indicating whether the ANT has been initialized.'),
 });
+exports.SpawnANTStateSchema = zod_1.z.object({
+    name: zod_1.z.string().describe('The name of the ANT.'),
+    ticker: zod_1.z.string().describe('The ticker symbol for the ANT.'),
+    description: zod_1.z.string().describe('The description for the ANT.'),
+    keywords: exports.AntKeywordsSchema.describe('The keywords for the ANT.'),
+    owner: exports.AOAddressSchema.describe('The Owners address.'),
+    controllers: exports.AntControllersSchema.describe('Controllers of the ANT who have administrative privileges.'),
+    records: exports.AntRecordsSchema.describe('Records associated with the ANT.'),
+    balances: exports.AntBalancesSchema.describe('Balance details for each address holding the ANT.'),
+    logo: exports.ArweaveTxIdSchema.describe('Transaction ID of the ANT logo.'),
+});
 exports.AntReadHandlers = [
     'balance',
     'balances',

package/lib/cjs/utils/ao.js

@@ -22,8 +22,13 @@ const zod_1 = require("zod");
 const arweave_js_1 = require("../common/arweave.js");
 const index_js_1 = require("../common/index.js");
 const constants_js_1 = require("../constants.js");
+const ant_js_1 = require("../types/ant.js");
+const schema_js_1 = require("./schema.js");
 async function spawnANT({ signer, module = constants_js_1.AOS_MODULE_ID, ao = (0, aoconnect_1.connect)(), scheduler = constants_js_1.DEFAULT_SCHEDULER_ID, state, antRegistryId = constants_js_1.ANT_REGISTRY_ID, logger = index_js_1.Logger.default, authority = constants_js_1.AO_AUTHORITY, }) {
     // TODO: use On-Boot data handler for bootstrapping state instead of initialize-state
+    if (state) {
+        (0, schema_js_1.parseSchemaResult)(ant_js_1.SpawnANTStateSchema, state);
+    }
     const processId = await ao.spawn({
         module,
         scheduler,

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

package/lib/esm/types/ant.js

@@ -77,6 +77,17 @@ export const AntStateSchema = z.object({
         .boolean()
         .describe('Flag indicating whether the ANT has been initialized.'),
 });
+export const SpawnANTStateSchema = z.object({
+    name: z.string().describe('The name of the ANT.'),
+    ticker: z.string().describe('The ticker symbol for the ANT.'),
+    description: z.string().describe('The description for the ANT.'),
+    keywords: AntKeywordsSchema.describe('The keywords for the ANT.'),
+    owner: AOAddressSchema.describe('The Owners address.'),
+    controllers: AntControllersSchema.describe('Controllers of the ANT who have administrative privileges.'),
+    records: AntRecordsSchema.describe('Records associated with the ANT.'),
+    balances: AntBalancesSchema.describe('Balance details for each address holding the ANT.'),
+    logo: ArweaveTxIdSchema.describe('Transaction ID of the ANT logo.'),
+});
 export const AntReadHandlers = [
     'balance',
     'balances',

package/lib/esm/utils/ao.js

@@ -19,8 +19,13 @@ import { z } from 'zod';
 import { defaultArweave } from '../common/arweave.js';
 import { AOProcess, Logger } from '../common/index.js';
 import { ANT_LUA_ID, ANT_REGISTRY_ID, AOS_MODULE_ID, AO_AUTHORITY, DEFAULT_SCHEDULER_ID, } from '../constants.js';
+import { SpawnANTStateSchema } from '../types/ant.js';
+import { parseSchemaResult } from './schema.js';
 export async function spawnANT({ signer, module = AOS_MODULE_ID, ao = connect(), scheduler = DEFAULT_SCHEDULER_ID, state, antRegistryId = ANT_REGISTRY_ID, logger = Logger.default, authority = AO_AUTHORITY, }) {
     // TODO: use On-Boot data handler for bootstrapping state instead of initialize-state
+    if (state) {
+        parseSchemaResult(SpawnANTStateSchema, state);
+    }
     const processId = await ao.spawn({
         module,
         scheduler,

package/lib/esm/version.js

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

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

@@ -127,11 +127,63 @@ export declare const AntStateSchema: z.ZodObject<{
     Initialized: boolean;
 }>;
 export type AoANTState = z.infer<typeof AntStateSchema>;
+export declare const SpawnANTStateSchema: z.ZodObject<{
+    name: z.ZodString;
+    ticker: z.ZodString;
+    description: z.ZodString;
+    keywords: z.ZodArray<z.ZodString, "many">;
+    owner: z.ZodString;
+    controllers: z.ZodArray<z.ZodString, "many">;
+    records: z.ZodRecord<z.ZodString, z.ZodObject<{
+        transactionId: z.ZodEffects<z.ZodString, string, string>;
+        ttlSeconds: z.ZodNumber;
+        priority: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        transactionId: string;
+        ttlSeconds: number;
+        priority?: number | undefined;
+    }, {
+        transactionId: string;
+        ttlSeconds: number;
+        priority?: number | undefined;
+    }>>;
+    balances: z.ZodRecord<z.ZodString, z.ZodNumber>;
+    logo: z.ZodEffects<z.ZodString, string, string>;
+}, "strip", z.ZodTypeAny, {
+    description: string;
+    name: string;
+    ticker: string;
+    keywords: string[];
+    owner: string;
+    controllers: string[];
+    records: Record<string, {
+        transactionId: string;
+        ttlSeconds: number;
+        priority?: number | undefined;
+    }>;
+    balances: Record<string, number>;
+    logo: string;
+}, {
+    description: string;
+    name: string;
+    ticker: string;
+    keywords: string[];
+    owner: string;
+    controllers: string[];
+    records: Record<string, {
+        transactionId: string;
+        ttlSeconds: number;
+        priority?: number | undefined;
+    }>;
+    balances: Record<string, number>;
+    logo: string;
+}>;
+export type SpawnANTState = z.infer<typeof SpawnANTStateSchema>;
 export declare const AntReadHandlers: readonly ["balance", "balances", "totalSupply", "info", "controllers", "record", "records", "state"];
 export type AoANTReadHandler = (typeof AntReadHandlers)[number];
 export declare const AntWriteHandlers: readonly ["_eval", "_default", "transfer", "addController", "removeController", "setRecord", "removeRecord", "setName", "setTicker", "setDescription", "setKeywords", "setLogo", "initializeState", "releaseName", "reassignName", "approvePrimaryName", "removePrimaryNames"];
 export type AoANTWriteHandler = (typeof AntWriteHandlers)[number];
-export declare const AntHandlerNames: ("balance" | "balances" | "totalSupply" | "info" | "controllers" | "record" | "records" | "state" | "_eval" | "_default" | "transfer" | "addController" | "removeController" | "setRecord" | "removeRecord" | "setName" | "setTicker" | "setDescription" | "setKeywords" | "setLogo" | "initializeState" | "releaseName" | "reassignName" | "approvePrimaryName" | "removePrimaryNames")[];
+export declare const AntHandlerNames: ("controllers" | "records" | "balances" | "balance" | "totalSupply" | "info" | "record" | "state" | "_eval" | "_default" | "transfer" | "addController" | "removeController" | "setRecord" | "removeRecord" | "setName" | "setTicker" | "setDescription" | "setKeywords" | "setLogo" | "initializeState" | "releaseName" | "reassignName" | "approvePrimaryName" | "removePrimaryNames")[];
 export type AoANTHandler = AoANTWriteHandler | AoANTReadHandler;
 export declare const AntHandlersSchema: z.ZodEffects<z.ZodArray<z.ZodString, "many">, string[], string[]>;
 export declare const AntInfoSchema: z.ZodObject<{

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

@@ -1,18 +1,7 @@
 import Arweave from 'arweave';
 import { Logger } from '../common/index.js';
-import { AoANTRecord } from '../types/ant.js';
+import { SpawnANTState } from '../types/ant.js';
 import { AoClient, AoEpochData, AoEpochDistributed, AoSigner, ContractSigner, WalletAddress } from '../types/index.js';
-export type SpawnANTState = {
-    owner: WalletAddress;
-    controllers: WalletAddress[];
-    name: string;
-    description: string;
-    keywords: string[];
-    ticker: string;
-    records: Record<string, AoANTRecord>;
-    balances: Record<WalletAddress, number>;
-    logo: string;
-};
 export type SpawnANTParams = {
     signer: AoSigner;
     module?: string;

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

package/package.json

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