@ar.io/sdk 2.5.0-alpha.1 → 2.5.0-alpha.2

package/lib/cjs/common/ant.js

@@ -96,7 +96,7 @@ class AoANTReadable {
         return record;
     }
     /**
-     * @returns {Promise<Record<string, AoANTRecord>>} All the undernames managed by the ANT.
+     * @returns {Promise<AoANTRecordEntry[]>} All the undernames managed by the ANT.
      * @example
      * Get the current records
      * ```ts
@@ -108,9 +108,10 @@ class AoANTReadable {
         const records = await this.process.read({
             tags,
         });
+        const result = (0, ao_js_1.parseAntRecords)(records);
         if (strict)
-            (0, schema_js_1.parseSchemaResult)(ant_js_1.AntRecordsSchema, records);
-        return records;
+            (0, schema_js_1.parseSchemaResult)(ant_js_1.AntEntriesSchema, result);
+        return result;
     }
     /**
      * @returns {Promise<string>} The owner of the ANT.

package/lib/cjs/constants.js

@@ -30,5 +30,5 @@ exports.IO_TESTNET_PROCESS_ID = 'agYcCFJtrMG6cqMuZfskIkFTGvUPddICmtQSBIoPdiA';
 exports.ANT_REGISTRY_ID = 'i_le_yKKPVstLTDSmkHRqf-wYphMnwB9OhleiTgMkWc';
 exports.MIO_PER_IO = 1_000_000;
 exports.AOS_MODULE_ID = 'cbn0KKrBZH7hdNkNokuXLtGryrWM--PjSTBqIzw9Kkk';
-exports.ANT_LUA_ID = 'pOh2yupSaQCrLI_-ah8tVTiusUdVNTxxeWTQQHNdf30';
+exports.ANT_LUA_ID = 'AWO2a2lVfQnjPFThjE4Uuw4ZFAd9EsCHBEgDYkJA-kk'; // v8 id test - remove comment when updated with actual v8 id.
 exports.DEFAULT_SCHEDULER_ID = '_GQ33BkPtZrqxA84vM8Zk-N2aO0toNNu_C-l-rawrBA';

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.AntRecordsSchema = exports.AntRecordSchema = exports.AntKeywordsSchema = exports.AntDescriptionSchema = exports.IntegerStringSchema = exports.ArweaveTxIdSchema = void 0;
+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;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -51,7 +51,9 @@ exports.AntRecordSchema = zod_1.z.object({
     transactionId: exports.ArweaveTxIdSchema.describe('The Target ID of the undername'),
     ttlSeconds: zod_1.z.number(),
 });
+exports.AntEntrySchema = zod_1.z.intersection(exports.AntRecordSchema, zod_1.z.object({ name: zod_1.z.string() }));
 exports.AntRecordsSchema = zod_1.z.record(zod_1.z.string(), exports.AntRecordSchema);
+exports.AntEntriesSchema = zod_1.z.array(exports.AntEntrySchema);
 exports.AntControllersSchema = zod_1.z.array(exports.ArweaveTxIdSchema.describe('Controller address'));
 exports.AntBalancesSchema = zod_1.z.record(exports.ArweaveTxIdSchema.describe('Holder address'), zod_1.z.number());
 exports.AntStateSchema = zod_1.z.object({

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.parseAntRecords = exports.createAoSigner = exports.isAoSigner = exports.evolveANT = exports.spawnANT = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -177,3 +177,29 @@ function createAoSigner(signer) {
     return aoSigner;
 }
 exports.createAoSigner = createAoSigner;
+/**
+ * @param records @type {AoANTRecordEntry[] | Record<string, AoANTRecord>} - the records returned by an ANT
+ * @returns @type {AoANTRecordEntry[]} - the alphabetically sorted records
+ */
+function parseAntRecords(records) {
+    const result = Array.isArray(records)
+        ? records // assumes if records is an array that its AoANTRecordEntry[]
+        : // backwards compatibility for when ANTs returned as Record<string, AoANTRecord>
+            Object.keys(records) // sort the keys since string indexed maps in lua do not retain order
+                .sort((a, b) => {
+                if (a == '@')
+                    return -1;
+                if (b == '@')
+                    return 1;
+                return a.localeCompare(b);
+            })
+                .reduce((acc, undername) => {
+                acc.push({
+                    ...records[undername],
+                    name: undername,
+                });
+                return acc;
+            }, []);
+    return result;
+}
+exports.parseAntRecords = parseAntRecords;

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

package/lib/esm/common/ant.js

@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 import { z } from 'zod';
-import { AntBalancesSchema, AntControllersSchema, AntInfoSchema, AntRecordSchema, AntRecordsSchema, AntStateSchema, } from '../types/ant.js';
+import { AntBalancesSchema, AntControllersSchema, AntEntriesSchema, AntInfoSchema, AntRecordSchema, AntStateSchema, } from '../types/ant.js';
 import { isProcessConfiguration, isProcessIdConfiguration, } from '../types/index.js';
-import { createAoSigner } from '../utils/ao.js';
+import { createAoSigner, parseAntRecords } from '../utils/ao.js';
 import { parseSchemaResult } from '../utils/schema.js';
 import { AOProcess, InvalidContractConfigurationError } from './index.js';
 export class ANT {
@@ -92,7 +92,7 @@ export class AoANTReadable {
         return record;
     }
     /**
-     * @returns {Promise<Record<string, AoANTRecord>>} All the undernames managed by the ANT.
+     * @returns {Promise<AoANTRecordEntry[]>} All the undernames managed by the ANT.
      * @example
      * Get the current records
      * ```ts
@@ -104,9 +104,10 @@ export class AoANTReadable {
         const records = await this.process.read({
             tags,
         });
+        const result = parseAntRecords(records);
         if (strict)
-            parseSchemaResult(AntRecordsSchema, records);
-        return records;
+            parseSchemaResult(AntEntriesSchema, result);
+        return result;
     }
     /**
      * @returns {Promise<string>} The owner of the ANT.

package/lib/esm/constants.js

@@ -27,5 +27,5 @@ export const IO_TESTNET_PROCESS_ID = 'agYcCFJtrMG6cqMuZfskIkFTGvUPddICmtQSBIoPdi
 export const ANT_REGISTRY_ID = 'i_le_yKKPVstLTDSmkHRqf-wYphMnwB9OhleiTgMkWc';
 export const MIO_PER_IO = 1_000_000;
 export const AOS_MODULE_ID = 'cbn0KKrBZH7hdNkNokuXLtGryrWM--PjSTBqIzw9Kkk';
-export const ANT_LUA_ID = 'pOh2yupSaQCrLI_-ah8tVTiusUdVNTxxeWTQQHNdf30';
+export const ANT_LUA_ID = 'AWO2a2lVfQnjPFThjE4Uuw4ZFAd9EsCHBEgDYkJA-kk'; // v8 id test - remove comment when updated with actual v8 id.
 export const DEFAULT_SCHEDULER_ID = '_GQ33BkPtZrqxA84vM8Zk-N2aO0toNNu_C-l-rawrBA';

package/lib/esm/types/ant.js

@@ -48,7 +48,9 @@ export const AntRecordSchema = z.object({
     transactionId: ArweaveTxIdSchema.describe('The Target ID of the undername'),
     ttlSeconds: z.number(),
 });
+export const AntEntrySchema = z.intersection(AntRecordSchema, z.object({ name: z.string() }));
 export const AntRecordsSchema = z.record(z.string(), AntRecordSchema);
+export const AntEntriesSchema = z.array(AntEntrySchema);
 export const AntControllersSchema = z.array(ArweaveTxIdSchema.describe('Controller address'));
 export const AntBalancesSchema = z.record(ArweaveTxIdSchema.describe('Holder address'), z.number());
 export const AntStateSchema = z.object({

package/lib/esm/utils/ao.js

@@ -170,3 +170,28 @@ export function createAoSigner(signer) {
     };
     return aoSigner;
 }
+/**
+ * @param records @type {AoANTRecordEntry[] | Record<string, AoANTRecord>} - the records returned by an ANT
+ * @returns @type {AoANTRecordEntry[]} - the alphabetically sorted records
+ */
+export function parseAntRecords(records) {
+    const result = Array.isArray(records)
+        ? records // assumes if records is an array that its AoANTRecordEntry[]
+        : // backwards compatibility for when ANTs returned as Record<string, AoANTRecord>
+            Object.keys(records) // sort the keys since string indexed maps in lua do not retain order
+                .sort((a, b) => {
+                if (a == '@')
+                    return -1;
+                if (b == '@')
+                    return 1;
+                return a.localeCompare(b);
+            })
+                .reduce((acc, undername) => {
+                acc.push({
+                    ...records[undername],
+                    name: undername,
+                });
+                return acc;
+            }, []);
+    return result;
+}

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.1';
+export const version = '2.5.0-alpha.2';

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

@@ -1,4 +1,4 @@
-import { AntReadOptions, AoANTInfo, AoANTRead, AoANTRecord, AoANTState, AoANTWrite } from '../types/ant.js';
+import { AntReadOptions, 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 {
@@ -31,14 +31,14 @@ export declare class AoANTReadable implements AoANTRead {
         undername: string;
     }, { strict }?: AntReadOptions): Promise<AoANTRecord>;
     /**
-     * @returns {Promise<Record<string, AoANTRecord>>} All the undernames managed by the ANT.
+     * @returns {Promise<AoANTRecordEntry[]>} All the undernames managed by the ANT.
      * @example
      * Get the current records
      * ```ts
      * ant.getRecords();
      * ````
      */
-    getRecords({ strict }?: AntReadOptions): Promise<Record<string, AoANTRecord>>;
+    getRecords({ strict }?: AntReadOptions): Promise<AoANTRecordEntry[]>;
     /**
      * @returns {Promise<string>} The owner of the ANT.
      * @example

package/lib/types/constants.d.ts

@@ -25,5 +25,5 @@ export declare const IO_TESTNET_PROCESS_ID = "agYcCFJtrMG6cqMuZfskIkFTGvUPddICmt
 export declare const ANT_REGISTRY_ID = "i_le_yKKPVstLTDSmkHRqf-wYphMnwB9OhleiTgMkWc";
 export declare const MIO_PER_IO = 1000000;
 export declare const AOS_MODULE_ID = "cbn0KKrBZH7hdNkNokuXLtGryrWM--PjSTBqIzw9Kkk";
-export declare const ANT_LUA_ID = "pOh2yupSaQCrLI_-ah8tVTiusUdVNTxxeWTQQHNdf30";
+export declare const ANT_LUA_ID = "AWO2a2lVfQnjPFThjE4Uuw4ZFAd9EsCHBEgDYkJA-kk";
 export declare const DEFAULT_SCHEDULER_ID = "_GQ33BkPtZrqxA84vM8Zk-N2aO0toNNu_C-l-rawrBA";

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

@@ -41,7 +41,24 @@ export declare const AntRecordSchema: z.ZodObject<{
     transactionId: string;
     ttlSeconds: number;
 }>;
+export declare const AntEntrySchema: z.ZodIntersection<z.ZodObject<{
+    transactionId: z.ZodEffects<z.ZodString, string, string>;
+    ttlSeconds: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    transactionId: string;
+    ttlSeconds: number;
+}, {
+    transactionId: string;
+    ttlSeconds: number;
+}>, z.ZodObject<{
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+}, {
+    name: string;
+}>>;
 export type AoANTRecord = z.infer<typeof AntRecordSchema>;
+export type AoANTRecordEntry = z.infer<typeof AntEntrySchema>;
 export declare const AntRecordsSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
     transactionId: z.ZodEffects<z.ZodString, string, string>;
     ttlSeconds: z.ZodNumber;
@@ -52,6 +69,22 @@ export declare const AntRecordsSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
     transactionId: string;
     ttlSeconds: number;
 }>>;
+export declare const AntEntriesSchema: z.ZodArray<z.ZodIntersection<z.ZodObject<{
+    transactionId: z.ZodEffects<z.ZodString, string, string>;
+    ttlSeconds: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    transactionId: string;
+    ttlSeconds: number;
+}, {
+    transactionId: string;
+    ttlSeconds: number;
+}>, z.ZodObject<{
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+}, {
+    name: string;
+}>>, "many">;
 export declare const AntControllersSchema: z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">;
 export declare const AntBalancesSchema: z.ZodRecord<z.ZodEffects<z.ZodString, string, string>, z.ZodNumber>;
 export declare const AntStateSchema: z.ZodObject<{
@@ -167,7 +200,7 @@ export interface AoANTRead {
     getRecord({ undername }: {
         undername: string;
     }, opts?: AntReadOptions): Promise<AoANTRecord | undefined>;
-    getRecords(opts?: AntReadOptions): Promise<Record<string, AoANTRecord>>;
+    getRecords(opts?: AntReadOptions): Promise<AoANTRecordEntry[]>;
     getOwner(opts?: AntReadOptions): Promise<WalletAddress>;
     getControllers(): Promise<WalletAddress[]>;
     getTicker(opts?: AntReadOptions): Promise<string>;

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

@@ -1,6 +1,6 @@
 import Arweave from 'arweave';
 import { Logger } from '../common/index.js';
-import { AoANTRecord } from '../types/ant.js';
+import { AoANTRecord, AoANTRecordEntry } from '../types/ant.js';
 import { AoClient, AoSigner, ContractSigner, WalletAddress } from '../types/index.js';
 export declare function spawnANT({ signer, module, luaCodeTxId, ao, scheduler, state, stateContractTxId, antRegistryId, logger, arweave, }: {
     signer: AoSigner;
@@ -31,3 +31,8 @@ export declare function evolveANT({ signer, processId, luaCodeTxId, ao, logger,
 }): Promise<string>;
 export declare function isAoSigner(value: unknown): value is AoSigner;
 export declare function createAoSigner(signer: ContractSigner): AoSigner;
+/**
+ * @param records @type {AoANTRecordEntry[] | Record<string, AoANTRecord>} - the records returned by an ANT
+ * @returns @type {AoANTRecordEntry[]} - the alphabetically sorted records
+ */
+export declare function parseAntRecords(records: AoANTRecordEntry[] | Record<string, AoANTRecord>): AoANTRecordEntry[];

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

package/package.json

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