@ar.io/sdk 2.5.0-alpha.3 → 2.5.0-alpha.5

package/lib/cjs/common/ant.js

@@ -204,6 +204,18 @@ class AoANTReadable {
             (0, schema_js_1.parseSchemaResult)(zod_1.z.number(), balance);
         return balance;
     }
+    /**
+     * @returns {Promise<AoANTHandler[]>} The handlers of the ANT.
+     * @example
+     * Get the handlers of the ANT.
+     * ```ts
+     * const handlers = await ant.getHandlers();
+     * ```
+     */
+    async getHandlers() {
+        const info = await this.getInfo();
+        return (info.Handlers ?? info.HandlerNames);
+    }
 }
 exports.AoANTReadable = AoANTReadable;
 class AoANTWriteable extends AoANTReadable {

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.AntStateSchema = exports.AntBalancesSchema = exports.AntControllersSchema = exports.AntEntriesSchema = exports.AntRecordsSchema = exports.AntEntrySchema = exports.AntRecordSchema = exports.AntKeywordsSchema = exports.AntDescriptionSchema = exports.IntegerStringSchema = exports.ArweaveTxIdSchema = void 0;
+exports.isAoANTState = exports.AntInfoSchema = exports.AntHandlersSchema = exports.AntHandlerNames = exports.AntWriteHandlers = exports.AntReadHandlers = exports.AntStateSchema = exports.AntBalancesSchema = exports.AntControllersSchema = exports.AntEntriesSchema = exports.AntRecordsSchema = exports.AntEntrySchema = exports.AntRecordSchema = exports.AntKeywordsSchema = exports.AntDescriptionSchema = exports.IntegerStringSchema = exports.ArweaveTxIdSchema = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -77,33 +77,35 @@ exports.AntStateSchema = zod_1.z.object({
     Initialized: zod_1.z
         .boolean()
         .describe('Flag indicating whether the ANT has been initialized.'),
-    ['Source-Code-TX-ID']: exports.ArweaveTxIdSchema.describe('Transaction ID of the Source Code for the ANT.'),
 });
-exports.AntHandlerNames = [
-    'evolve',
-    '_eval',
-    '_default',
-    'transfer',
+exports.AntReadHandlers = [
     'balance',
     'balances',
     'totalSupply',
     'info',
+    'controllers',
+    'record',
+    'records',
+    'state',
+];
+exports.AntWriteHandlers = [
+    'evolve',
+    '_eval',
+    '_default',
+    'transfer',
     'addController',
     'removeController',
-    'controllers',
     'setRecord',
     'removeRecord',
-    'record',
-    'records',
     'setName',
     'setTicker',
     'setDescription',
     'setKeywords',
     'initializeState',
-    'state',
     'releaseName',
     'reassignName',
 ];
+exports.AntHandlerNames = [...exports.AntReadHandlers, ...exports.AntWriteHandlers];
 exports.AntHandlersSchema = zod_1.z
     .array(zod_1.z.string({ description: 'Handler Name' }))
     .refine((antHandlers) => {
@@ -114,7 +116,6 @@ exports.AntHandlersSchema = zod_1.z
 exports.AntInfoSchema = zod_1.z.object({
     Name: zod_1.z.string().describe('The name of the ANT.'),
     Owner: exports.ArweaveTxIdSchema.describe('The Owners address.'),
-    ['Source-Code-TX-ID']: exports.ArweaveTxIdSchema.describe('Transaction ID of the Source Code for the ANT.'),
     Ticker: zod_1.z.string().describe('The ticker symbol for the ANT.'),
     ['Total-Supply']: exports.IntegerStringSchema.describe('Total supply of the ANT in circulation.'),
     Description: exports.AntDescriptionSchema.describe('The description for the ANT.'),

package/lib/cjs/utils/ao.js

@@ -45,6 +45,10 @@ async function spawnANT({ signer, module = constants_js_1.AOS_MODULE_ID, luaCode
                 name: 'ANT-Registry-Id',
                 value: antRegistryId,
             },
+            {
+                name: 'Source-Code-TX-ID', // utility for understanding what the original source id of the lua code was
+                value: luaCodeTxId,
+            },
         ],
     });
     const aosClient = new index_js_1.AOProcess({

package/lib/cjs/utils/schema.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseSchemaResult = void 0;
 /**
- *
  * @param schema - zod schema
  * @param v - value to parse
  * @throws {z.SafeParseError<any>} - if the value fails to parse

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 = '2.5.0-alpha.3';
+exports.version = '2.5.0-alpha.5';

package/lib/esm/common/ant.js

@@ -200,6 +200,18 @@ export class AoANTReadable {
             parseSchemaResult(z.number(), balance);
         return balance;
     }
+    /**
+     * @returns {Promise<AoANTHandler[]>} The handlers of the ANT.
+     * @example
+     * Get the handlers of the ANT.
+     * ```ts
+     * const handlers = await ant.getHandlers();
+     * ```
+     */
+    async getHandlers() {
+        const info = await this.getInfo();
+        return (info.Handlers ?? info.HandlerNames);
+    }
 }
 export class AoANTWriteable extends AoANTReadable {
     signer;

package/lib/esm/types/ant.js

@@ -74,33 +74,35 @@ export const AntStateSchema = z.object({
     Initialized: z
         .boolean()
         .describe('Flag indicating whether the ANT has been initialized.'),
-    ['Source-Code-TX-ID']: ArweaveTxIdSchema.describe('Transaction ID of the Source Code for the ANT.'),
 });
-export const AntHandlerNames = [
-    'evolve',
-    '_eval',
-    '_default',
-    'transfer',
+export const AntReadHandlers = [
     'balance',
     'balances',
     'totalSupply',
     'info',
+    'controllers',
+    'record',
+    'records',
+    'state',
+];
+export const AntWriteHandlers = [
+    'evolve',
+    '_eval',
+    '_default',
+    'transfer',
     'addController',
     'removeController',
-    'controllers',
     'setRecord',
     'removeRecord',
-    'record',
-    'records',
     'setName',
     'setTicker',
     'setDescription',
     'setKeywords',
     'initializeState',
-    'state',
     'releaseName',
     'reassignName',
 ];
+export const AntHandlerNames = [...AntReadHandlers, ...AntWriteHandlers];
 export const AntHandlersSchema = z
     .array(z.string({ description: 'Handler Name' }))
     .refine((antHandlers) => {
@@ -111,7 +113,6 @@ export const AntHandlersSchema = z
 export const AntInfoSchema = z.object({
     Name: z.string().describe('The name of the ANT.'),
     Owner: ArweaveTxIdSchema.describe('The Owners address.'),
-    ['Source-Code-TX-ID']: ArweaveTxIdSchema.describe('Transaction ID of the Source Code for the ANT.'),
     Ticker: z.string().describe('The ticker symbol for the ANT.'),
     ['Total-Supply']: IntegerStringSchema.describe('Total supply of the ANT in circulation.'),
     Description: AntDescriptionSchema.describe('The description for the ANT.'),

package/lib/esm/utils/ao.js

@@ -42,6 +42,10 @@ export async function spawnANT({ signer, module = AOS_MODULE_ID, luaCodeTxId = A
                 name: 'ANT-Registry-Id',
                 value: antRegistryId,
             },
+            {
+                name: 'Source-Code-TX-ID', // utility for understanding what the original source id of the lua code was
+                value: luaCodeTxId,
+            },
         ],
     });
     const aosClient = new AOProcess({

package/lib/esm/utils/schema.js

@@ -1,5 +1,4 @@
 /**
- *
  * @param schema - zod schema
  * @param v - value to parse
  * @throws {z.SafeParseError<any>} - if the value fails to parse

package/lib/esm/version.js

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

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

@@ -1,4 +1,4 @@
-import { AntReadOptions, AoANTInfo, AoANTRead, AoANTRecord, AoANTRecordEntry, AoANTState, AoANTWrite } from '../types/ant.js';
+import { AntReadOptions, AoANTHandler, AoANTInfo, AoANTRead, AoANTRecord, AoANTRecordEntry, AoANTState, AoANTWrite } from '../types/ant.js';
 import { AoMessageResult, ProcessConfiguration, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
 import { AOProcess } from './index.js';
 export declare class ANT {
@@ -96,6 +96,15 @@ export declare class AoANTReadable implements AoANTRead {
     getBalance({ address }: {
         address: string;
     }, { strict }?: AntReadOptions): Promise<number>;
+    /**
+     * @returns {Promise<AoANTHandler[]>} The handlers of the ANT.
+     * @example
+     * Get the handlers of the ANT.
+     * ```ts
+     * const handlers = await ant.getHandlers();
+     * ```
+     */
+    getHandlers(): Promise<AoANTHandler[]>;
 }
 export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite {
     private signer;

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

@@ -109,9 +109,7 @@ export declare const AntStateSchema: z.ZodObject<{
     Logo: z.ZodEffects<z.ZodString, string, string>;
     TotalSupply: z.ZodNumber;
     Initialized: z.ZodBoolean;
-    "Source-Code-TX-ID": z.ZodEffects<z.ZodString, string, string>;
 }, "strip", z.ZodTypeAny, {
-    "Source-Code-TX-ID": string;
     Name: string;
     Ticker: string;
     Description: string;
@@ -128,7 +126,6 @@ export declare const AntStateSchema: z.ZodObject<{
     TotalSupply: number;
     Initialized: boolean;
 }, {
-    "Source-Code-TX-ID": string;
     Name: string;
     Ticker: string;
     Description: string;
@@ -146,12 +143,16 @@ export declare const AntStateSchema: z.ZodObject<{
     Initialized: boolean;
 }>;
 export type AoANTState = z.infer<typeof AntStateSchema>;
-export declare const AntHandlerNames: string[];
+export declare const AntReadHandlers: readonly ["balance", "balances", "totalSupply", "info", "controllers", "record", "records", "state"];
+export type AoANTReadHandler = (typeof AntReadHandlers)[number];
+export declare const AntWriteHandlers: readonly ["evolve", "_eval", "_default", "transfer", "addController", "removeController", "setRecord", "removeRecord", "setName", "setTicker", "setDescription", "setKeywords", "initializeState", "releaseName", "reassignName"];
+export type AoANTWriteHandler = (typeof AntWriteHandlers)[number];
+export declare const AntHandlerNames: ("balance" | "balances" | "totalSupply" | "info" | "controllers" | "record" | "records" | "state" | "evolve" | "_eval" | "_default" | "transfer" | "addController" | "removeController" | "setRecord" | "removeRecord" | "setName" | "setTicker" | "setDescription" | "setKeywords" | "initializeState" | "releaseName" | "reassignName")[];
+export type AoANTHandler = AoANTWriteHandler | AoANTReadHandler;
 export declare const AntHandlersSchema: z.ZodEffects<z.ZodArray<z.ZodString, "many">, string[], string[]>;
 export declare const AntInfoSchema: z.ZodObject<{
     Name: z.ZodString;
     Owner: z.ZodEffects<z.ZodString, string, string>;
-    "Source-Code-TX-ID": z.ZodEffects<z.ZodString, string, string>;
     Ticker: z.ZodString;
     "Total-Supply": z.ZodEffects<z.ZodString, string, string>;
     Description: z.ZodString;
@@ -161,7 +162,6 @@ export declare const AntInfoSchema: z.ZodObject<{
     Handlers: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodString, "many">, string[], string[]>>;
     HandlerNames: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodString, "many">, string[], string[]>>;
 }, "strip", z.ZodTypeAny, {
-    "Source-Code-TX-ID": string;
     Name: string;
     Ticker: string;
     Description: string;
@@ -173,7 +173,6 @@ export declare const AntInfoSchema: z.ZodObject<{
     Handlers?: string[] | undefined;
     HandlerNames?: string[] | undefined;
 }, {
-    "Source-Code-TX-ID": string;
     Name: string;
     Ticker: string;
     Description: string;
@@ -209,6 +208,7 @@ export interface AoANTRead {
         address: WalletAddress;
     }, opts?: AntReadOptions): Promise<number>;
     getBalances(opts?: AntReadOptions): Promise<Record<WalletAddress, number>>;
+    getHandlers(): Promise<AoANTHandler[]>;
 }
 export interface AoANTWrite extends AoANTRead {
     transfer({ target }: {

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

@@ -15,7 +15,6 @@
  */
 import { z } from 'zod';
 /**
- *
  * @param schema - zod schema
  * @param v - value to parse
  * @throws {z.SafeParseError<any>} - if the value fails to parse

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 = "2.5.0-alpha.2";
+export declare const version = "2.5.0-alpha.4";

package/package.json

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