@ar.io/sdk 2.5.0-alpha.12 → 2.5.0-alpha.14

package/lib/cjs/common/ant.js

@@ -96,7 +96,7 @@ class AoANTReadable {
         return record;
     }
     /**
-     * @returns {Promise<AoANTRecordEntry[]>} All the undernames managed by the ANT.
+     * @returns {Promise<Record<string, AoANTRecord>>} All the undernames managed by the ANT.
      * @example
      * Get the current records
      * ```ts
@@ -108,10 +108,9 @@ 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.AntEntriesSchema, result);
-        return result;
+            (0, schema_js_1.parseSchemaResult)(ant_js_1.AntRecordsSchema, records);
+        return records;
     }
     /**
      * @returns {Promise<string>} The owner of the ANT.

package/lib/cjs/common/io.js

@@ -438,6 +438,21 @@ class IOReadable {
             ],
         });
     }
+    /**
+     * Get current redelegation fee percentage for address
+     *
+     * @param {Object} params - The parameters for fetching redelegation fee
+     * @param {string} params.address - The address to fetch the fee for
+     * @returns {Promise<AoMessageResult>} The redelegation fee result
+     */
+    async getRedelegationFee(params) {
+        return this.process.read({
+            tags: [
+                { name: 'Action', value: 'Redelegation-Fee' },
+                { name: 'Address', value: params.address },
+            ],
+        });
+    }
 }
 exports.IOReadable = IOReadable;
 class IOWriteable extends IOReadable {
@@ -790,5 +805,31 @@ class IOWriteable extends IOReadable {
             ],
         });
     }
+    /**
+     * Redelegate stake from one gateway to another gateway.
+     *
+     * @param {Object} params - The parameters for redelegating stake
+     * @param {string} params.target - The target gateway address
+     * @param {string} params.source - The source gateway address
+     * @param {number} params.stakeQty - The quantity of stake to redelegate
+     * @param {string} params.vaultId - An optional vault ID to redelegate from
+     * @param {Object} [options] - The options for the redelegation
+     * @returns {Promise<AoMessageResult>} The result of the redelegation
+     */
+    async redelegateStake(params, options) {
+        const { tags = [] } = options || {};
+        const allTags = [
+            ...tags,
+            { name: 'Action', value: 'Redelegate-Stake' },
+            { name: 'Target', value: params.target },
+            { name: 'Source', value: params.source },
+            { name: 'Quantity', value: params.stakeQty.valueOf().toString() },
+            { name: 'Vault-Id', value: params.vaultId },
+        ];
+        return this.process.send({
+            signer: this.signer,
+            tags: (0, arweave_js_1.pruneTags)(allTags),
+        });
+    }
 }
 exports.IOWriteable = IOWriteable;

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.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.AntRecordsSchema = exports.AntRecordSchema = exports.AntKeywordsSchema = exports.AntDescriptionSchema = exports.IntegerStringSchema = exports.ArweaveTxIdSchema = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -51,9 +51,7 @@ 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.parseAntRecords = exports.createAoSigner = exports.isAoSigner = exports.evolveANT = exports.spawnANT = void 0;
+exports.createAoSigner = exports.isAoSigner = exports.evolveANT = exports.spawnANT = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -181,29 +181,3 @@ 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.12';
+exports.version = '2.5.0-alpha.14';

package/lib/esm/common/ant.js

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

package/lib/esm/common/io.js

@@ -434,6 +434,21 @@ export class IOReadable {
             ],
         });
     }
+    /**
+     * Get current redelegation fee percentage for address
+     *
+     * @param {Object} params - The parameters for fetching redelegation fee
+     * @param {string} params.address - The address to fetch the fee for
+     * @returns {Promise<AoMessageResult>} The redelegation fee result
+     */
+    async getRedelegationFee(params) {
+        return this.process.read({
+            tags: [
+                { name: 'Action', value: 'Redelegation-Fee' },
+                { name: 'Address', value: params.address },
+            ],
+        });
+    }
 }
 export class IOWriteable extends IOReadable {
     signer;
@@ -785,4 +800,30 @@ export class IOWriteable extends IOReadable {
             ],
         });
     }
+    /**
+     * Redelegate stake from one gateway to another gateway.
+     *
+     * @param {Object} params - The parameters for redelegating stake
+     * @param {string} params.target - The target gateway address
+     * @param {string} params.source - The source gateway address
+     * @param {number} params.stakeQty - The quantity of stake to redelegate
+     * @param {string} params.vaultId - An optional vault ID to redelegate from
+     * @param {Object} [options] - The options for the redelegation
+     * @returns {Promise<AoMessageResult>} The result of the redelegation
+     */
+    async redelegateStake(params, options) {
+        const { tags = [] } = options || {};
+        const allTags = [
+            ...tags,
+            { name: 'Action', value: 'Redelegate-Stake' },
+            { name: 'Target', value: params.target },
+            { name: 'Source', value: params.source },
+            { name: 'Quantity', value: params.stakeQty.valueOf().toString() },
+            { name: 'Vault-Id', value: params.vaultId },
+        ];
+        return this.process.send({
+            signer: this.signer,
+            tags: pruneTags(allTags),
+        });
+    }
 }

package/lib/esm/types/ant.js

@@ -48,9 +48,7 @@ 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

@@ -174,28 +174,3 @@ 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.12';
+export const version = '2.5.0-alpha.14';

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

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

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

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import Arweave from 'arweave';
-import { AoArNSNameDataWithName, AoArNSReservedNameData, AoAuction, AoBalanceWithAddress, AoEpochDistributionData, AoEpochObservationData, AoGatewayWithAddress, AoJoinNetworkParams, AoMessageResult, AoPrimaryName, AoPrimaryNameRequest, AoTokenSupplyData, AoUpdateGatewaySettingsParams, AoWeightedObserver, ContractSigner, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
+import { AoArNSNameDataWithName, AoArNSReservedNameData, AoAuction, AoBalanceWithAddress, AoEpochDistributionData, AoEpochObservationData, AoGatewayWithAddress, AoJoinNetworkParams, AoMessageResult, AoPrimaryName, AoPrimaryNameRequest, AoRedelegationFeeInfo, AoTokenSupplyData, AoUpdateGatewaySettingsParams, AoWeightedObserver, ContractSigner, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
 import { AoArNSNameData, AoArNSReservedNameDataWithName, AoAuctionPriceData, AoDelegation, AoEpochData, AoEpochSettings, AoGateway, AoGatewayDelegateWithAddress, AoGatewayVault, AoIORead, AoIOWrite, AoRegistrationFees, AoVaultData, AoWalletVault, EpochInput } from '../types/io.js';
 import { mIOToken } from '../types/token.js';
 import { AOProcess } from './contracts/ao-process.js';
@@ -146,6 +146,16 @@ export declare class IOReadable implements AoIORead {
         name: string;
     }): Promise<AoPrimaryName>;
     getPrimaryNames(params: PaginationParams<AoPrimaryName>): Promise<PaginationResult<AoPrimaryName>>;
+    /**
+     * Get current redelegation fee percentage for address
+     *
+     * @param {Object} params - The parameters for fetching redelegation fee
+     * @param {string} params.address - The address to fetch the fee for
+     * @returns {Promise<AoMessageResult>} The redelegation fee result
+     */
+    getRedelegationFee(params: {
+        address: WalletAddress;
+    }): Promise<AoRedelegationFeeInfo>;
 }
 export declare class IOWriteable extends IOReadable implements AoIOWrite {
     protected process: AOProcess;
@@ -250,4 +260,21 @@ export declare class IOWriteable extends IOReadable implements AoIOWrite {
     requestPrimaryName(params: {
         name: string;
     }): Promise<AoMessageResult>;
+    /**
+     * Redelegate stake from one gateway to another gateway.
+     *
+     * @param {Object} params - The parameters for redelegating stake
+     * @param {string} params.target - The target gateway address
+     * @param {string} params.source - The source gateway address
+     * @param {number} params.stakeQty - The quantity of stake to redelegate
+     * @param {string} params.vaultId - An optional vault ID to redelegate from
+     * @param {Object} [options] - The options for the redelegation
+     * @returns {Promise<AoMessageResult>} The result of the redelegation
+     */
+    redelegateStake(params: {
+        target: string;
+        source: string;
+        stakeQty: number | mIOToken;
+        vaultId?: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
 }

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

@@ -41,24 +41,7 @@ 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;
@@ -69,22 +52,6 @@ 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<{
@@ -199,7 +166,7 @@ export interface AoANTRead {
     getRecord({ undername }: {
         undername: string;
     }, opts?: AntReadOptions): Promise<AoANTRecord | undefined>;
-    getRecords(opts?: AntReadOptions): Promise<AoANTRecordEntry[]>;
+    getRecords(opts?: AntReadOptions): Promise<Record<string, AoANTRecord>>;
     getOwner(opts?: AntReadOptions): Promise<WalletAddress>;
     getControllers(): Promise<WalletAddress[]>;
     getTicker(opts?: AntReadOptions): Promise<string>;

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

@@ -54,6 +54,16 @@ export type AoPrimaryName = {
     name: string;
     startTimestamp: Timestamp;
 };
+/**
+ * Users are allowed one free redelegation every seven epochs. Each additional
+ * redelegation increases the fee by 10%, capping at a 60% redelegation fee
+ */
+export type AoRedelegationFeeInfo = {
+    /** Percentage of redelegated stake that will be returned to the protocol on redelegation */
+    redelegationFeeRate: number;
+    /** Timestamp when the redelegation fee will reset to zero */
+    feeResetTimestamp: number;
+};
 export type AtLeastOne<T, U = {
     [K in keyof T]-?: Record<K, T[K]>;
 }> = Partial<T> & U[keyof U];

package/lib/types/types/io.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { AOProcess } from '../common/index.js';
-import { AoMessageResult, AoPrimaryName, AoPrimaryNameRequest, AtLeastOne, BlockHeight, ProcessId, Timestamp, TransactionId, WalletAddress, WriteOptions } from './index.js';
+import { AoMessageResult, AoPrimaryName, AoPrimaryNameRequest, AoRedelegationFeeInfo, AtLeastOne, BlockHeight, ProcessId, Timestamp, TransactionId, WalletAddress, WriteOptions } from './index.js';
 import { mIOToken } from './token.js';
 export type PaginationParams<T = Record<string, never>> = {
     cursor?: string;
@@ -331,6 +331,9 @@ export interface AoIORead {
         name: string;
     }): Promise<AoPrimaryName>;
     getPrimaryNames(params?: PaginationParams<AoPrimaryName>): Promise<PaginationResult<AoPrimaryName>>;
+    getRedelegationFee(params: {
+        address: WalletAddress;
+    }): Promise<AoRedelegationFeeInfo>;
 }
 export interface AoIOWrite extends AoIORead {
     transfer({ target, qty, }: {
@@ -394,6 +397,12 @@ export interface AoIOWrite extends AoIORead {
     requestPrimaryName(params: {
         name: string;
     }): Promise<AoMessageResult>;
+    redelegateStake(params: {
+        target: string;
+        source: string;
+        stakeQty: number | mIOToken;
+        vaultId?: string;
+    }, options?: WriteOptions): Promise<AoMessageResult>;
 }
 export declare function isProcessConfiguration(config: object): config is {
     process: AOProcess;

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

@@ -1,6 +1,6 @@
 import Arweave from 'arweave';
 import { Logger } from '../common/index.js';
-import { AoANTRecord, AoANTRecordEntry } from '../types/ant.js';
+import { AoANTRecord } 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,8 +31,3 @@ 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.5.0-alpha.11";
+export declare const version = "2.5.0-alpha.13";

package/package.json

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