@ar.io/sdk 3.6.2-alpha.1 → 3.7.0-alpha.1

package/lib/cjs/cli/cli.js

@@ -53,6 +53,16 @@ const utils_js_1 = require("./utils.js");
     description: 'Get demand factor',
     action: (options) => (0, utils_js_1.readARIOFromOptions)(options).getDemandFactor(),
 });
+(0, utils_js_1.makeCommand)({
+    name: 'get-demand-factor-settings',
+    description: 'Get current settings for demand factor',
+    action: (options) => (0, utils_js_1.readARIOFromOptions)(options).getDemandFactorSettings(),
+});
+(0, utils_js_1.makeCommand)({
+    name: 'get-epoch-settings',
+    description: 'Get current settings for epochs',
+    action: (options) => (0, utils_js_1.readARIOFromOptions)(options).getEpochSettings(),
+});
 (0, utils_js_1.makeCommand)({
     name: 'get-gateway',
     description: 'Get the gateway of an address',
@@ -164,6 +174,14 @@ const utils_js_1 = require("./utils.js");
         .getDistributions((0, utils_js_1.epochInputFromOptions)(o))
         .then((result) => result ?? { message: 'No distributions found for epoch' }),
 });
+(0, utils_js_1.makeCommand)({
+    name: 'get-eligible-rewards',
+    description: 'Get eligible rewards for an epoch',
+    options: [...options_js_1.epochOptions, ...options_js_1.paginationOptions],
+    action: (o) => (0, utils_js_1.readARIOFromOptions)(o)
+        .getEligibleEpochRewards((0, utils_js_1.epochInputFromOptions)(o), (0, utils_js_1.paginationParamsFromOptions)(o))
+        .then((result) => result ?? { message: 'No eligible distributions found for epoch' }),
+});
 (0, utils_js_1.makeCommand)({
     name: 'get-token-cost',
     description: 'Get token cost for an intended action',
@@ -511,7 +529,7 @@ const utils_js_1 = require("./utils.js");
         await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to transfer ANT ownership to ${target}?`, options);
         return (0, utils_js_1.writeANTFromOptions)(options).transfer({
             target,
-        }, (0, utils_js_1.writeActionTagsFromOptions)(options));
+        }, (0, utils_js_1.customTagsFromOptions)(options));
     },
 });
 (0, utils_js_1.makeCommand)({
@@ -523,7 +541,7 @@ const utils_js_1 = require("./utils.js");
         await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to add ${controller} as a controller?`, options);
         return (0, utils_js_1.writeANTFromOptions)(options).addController({
             controller: (0, utils_js_1.requiredStringFromOptions)(options, 'controller'),
-        }, (0, utils_js_1.writeActionTagsFromOptions)(options));
+        }, (0, utils_js_1.customTagsFromOptions)(options));
     },
 });
 (0, utils_js_1.makeCommand)({
@@ -533,7 +551,7 @@ const utils_js_1 = require("./utils.js");
     action: async (options) => {
         return (0, utils_js_1.writeANTFromOptions)(options).removeController({
             controller: (0, utils_js_1.requiredStringFromOptions)(options, 'controller'),
-        }, (0, utils_js_1.writeActionTagsFromOptions)(options));
+        }, (0, utils_js_1.customTagsFromOptions)(options));
     },
 });
 (0, utils_js_1.makeCommand)({
@@ -563,7 +581,7 @@ const utils_js_1 = require("./utils.js");
         await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to remove the record with undername ${undername}?`, options);
         return (0, utils_js_1.writeANTFromOptions)(options).removeRecord({
             undername,
-        }, (0, utils_js_1.writeActionTagsFromOptions)(options));
+        }, (0, utils_js_1.customTagsFromOptions)(options));
     },
 });
 (0, utils_js_1.makeCommand)({
@@ -575,7 +593,7 @@ const utils_js_1 = require("./utils.js");
         await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to set the ticker to ${ticker}?`, options);
         return (0, utils_js_1.writeANTFromOptions)(options).setTicker({
             ticker,
-        }, (0, utils_js_1.writeActionTagsFromOptions)(options));
+        }, (0, utils_js_1.customTagsFromOptions)(options));
     },
 });
 (0, utils_js_1.makeCommand)({
@@ -587,7 +605,7 @@ const utils_js_1 = require("./utils.js");
         await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to set the name to ${(0, utils_js_1.requiredStringFromOptions)(options, 'name')}?`, options);
         return (0, utils_js_1.writeANTFromOptions)(options).setName({
             name,
-        }, (0, utils_js_1.writeActionTagsFromOptions)(options));
+        }, (0, utils_js_1.customTagsFromOptions)(options));
     },
 });
 (0, utils_js_1.makeCommand)({
@@ -599,7 +617,7 @@ const utils_js_1 = require("./utils.js");
         await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to set the ANT description to ${description}?`, options);
         return (0, utils_js_1.writeANTFromOptions)(options).setDescription({
             description,
-        }, (0, utils_js_1.writeActionTagsFromOptions)(options));
+        }, (0, utils_js_1.customTagsFromOptions)(options));
     },
 });
 (0, utils_js_1.makeCommand)({
@@ -611,7 +629,7 @@ const utils_js_1 = require("./utils.js");
         await (0, utils_js_1.assertConfirmationPrompt)(`Are you sure you want to set the ANT keywords to ${keywords}?`, options);
         return (0, utils_js_1.writeANTFromOptions)(options).setKeywords({
             keywords,
-        }, (0, utils_js_1.writeActionTagsFromOptions)(options));
+        }, (0, utils_js_1.customTagsFromOptions)(options));
     },
 });
 (0, utils_js_1.makeCommand)({
@@ -628,7 +646,7 @@ const utils_js_1 = require("./utils.js");
         return (0, utils_js_1.writeANTFromOptions)(options).setLogo({
             // TODO: Could take a logo file, upload it to Arweave, get transaction ID
             txId,
-        }, (0, utils_js_1.writeActionTagsFromOptions)(options));
+        }, (0, utils_js_1.customTagsFromOptions)(options));
     },
 });
 (0, utils_js_1.makeCommand)({
@@ -641,7 +659,7 @@ const utils_js_1 = require("./utils.js");
         return (0, utils_js_1.writeANTFromOptions)(options).releaseName({
             name,
             arioProcessId: (0, utils_js_1.arioProcessIdFromOptions)(options),
-        }, (0, utils_js_1.writeActionTagsFromOptions)(options));
+        }, (0, utils_js_1.customTagsFromOptions)(options));
     },
 });
 (0, utils_js_1.makeCommand)({
@@ -661,7 +679,7 @@ const utils_js_1 = require("./utils.js");
             name,
             arioProcessId: (0, utils_js_1.arioProcessIdFromOptions)(options),
             antProcessId: targetProcess,
-        }, (0, utils_js_1.writeActionTagsFromOptions)(options));
+        }, (0, utils_js_1.customTagsFromOptions)(options));
     },
 });
 (0, utils_js_1.makeCommand)({
@@ -681,7 +699,7 @@ const utils_js_1 = require("./utils.js");
             name,
             address,
             arioProcessId: (0, utils_js_1.arioProcessIdFromOptions)(options),
-        }, (0, utils_js_1.writeActionTagsFromOptions)(options));
+        }, (0, utils_js_1.customTagsFromOptions)(options));
     },
 });
 (0, utils_js_1.makeCommand)({
@@ -694,7 +712,7 @@ const utils_js_1 = require("./utils.js");
         return (0, utils_js_1.writeANTFromOptions)(options).removePrimaryNames({
             names,
             arioProcessId: (0, utils_js_1.arioProcessIdFromOptions)(options),
-        }, (0, utils_js_1.writeActionTagsFromOptions)(options));
+        }, (0, utils_js_1.customTagsFromOptions)(options));
     },
 });
 (0, utils_js_1.makeCommand)({
@@ -707,11 +725,25 @@ const utils_js_1 = require("./utils.js");
             logger: (0, utils_js_1.getLoggerFromOptions)(options),
         });
         return process.send({
-            tags: (0, utils_js_1.writeActionTagsFromOptions)(options).tags ?? [],
+            tags: (0, utils_js_1.customTagsFromOptions)(options).tags ?? [],
             signer: (0, utils_js_1.requiredAoSignerFromOptions)(options),
         });
     },
 });
+(0, utils_js_1.makeCommand)({
+    name: 'read-action',
+    description: 'Send a dry-run read action to an AO Process',
+    options: [options_js_1.optionMap.processId, options_js_1.optionMap.tags],
+    action: async (options) => {
+        const process = new index_js_1.AOProcess({
+            processId: (0, utils_js_1.requiredProcessIdFromOptions)(options),
+            logger: (0, utils_js_1.getLoggerFromOptions)(options),
+        });
+        return process.read({
+            tags: (0, utils_js_1.customTagsFromOptions)(options).tags ?? [],
+        });
+    },
+});
 if (process.argv[1].includes('bin/ar.io') || // Running from global .bin
     process.argv[1].includes('cli/cli') // Running from source
 ) {

package/lib/cjs/cli/commands/antCommands.js

@@ -15,7 +15,7 @@ async function setAntRecordCLICommand(o) {
         undername,
         transactionId,
         ttlSeconds,
-    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+    }, (0, utils_js_1.customTagsFromOptions)(o));
 }
 exports.setAntRecordCLICommand = setAntRecordCLICommand;
 async function setAntBaseNameCLICommand(o) {
@@ -28,7 +28,7 @@ async function setAntBaseNameCLICommand(o) {
     return (0, utils_js_1.writeANTFromOptions)(o).setBaseNameRecord({
         transactionId,
         ttlSeconds,
-    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+    }, (0, utils_js_1.customTagsFromOptions)(o));
 }
 exports.setAntBaseNameCLICommand = setAntBaseNameCLICommand;
 async function setAntUndernameCLICommand(o) {
@@ -43,6 +43,6 @@ async function setAntUndernameCLICommand(o) {
         undername,
         transactionId,
         ttlSeconds,
-    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+    }, (0, utils_js_1.customTagsFromOptions)(o));
 }
 exports.setAntUndernameCLICommand = setAntUndernameCLICommand;

package/lib/cjs/cli/commands/arnsPurchaseCommands.js

@@ -40,7 +40,7 @@ async function buyRecordCLICommand(o) {
         type,
         years,
         fundFrom: (0, utils_js_1.fundFromFromOptions)(o),
-    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+    }, (0, utils_js_1.customTagsFromOptions)(o));
 }
 exports.buyRecordCLICommand = buyRecordCLICommand;
 async function upgradeRecordCLICommand(o) {
@@ -106,7 +106,7 @@ async function extendLeaseCLICommand(o) {
     return ario.extendLease({
         name,
         years,
-    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+    }, (0, utils_js_1.customTagsFromOptions)(o));
 }
 exports.extendLeaseCLICommand = extendLeaseCLICommand;
 async function increaseUndernameLimitCLICommand(o) {
@@ -137,7 +137,7 @@ async function increaseUndernameLimitCLICommand(o) {
     return ario.increaseUndernameLimit({
         name,
         increaseCount,
-    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+    }, (0, utils_js_1.customTagsFromOptions)(o));
 }
 exports.increaseUndernameLimitCLICommand = increaseUndernameLimitCLICommand;
 async function requestPrimaryNameCLICommand(o) {
@@ -162,6 +162,6 @@ async function requestPrimaryNameCLICommand(o) {
     return ario.requestPrimaryName({
         name,
         fundFrom,
-    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+    }, (0, utils_js_1.customTagsFromOptions)(o));
 }
 exports.requestPrimaryNameCLICommand = requestPrimaryNameCLICommand;

package/lib/cjs/cli/commands/gatewayWriteCommands.js

@@ -47,7 +47,7 @@ async function joinNetwork(options) {
         });
         await (0, utils_js_1.assertConfirmationPrompt)(`Gateway Settings:\n\n${JSON.stringify(settings, null, 2)}\n\nYou are about to stake ${(0, utils_js_1.formatARIOWithCommas)(mARIOQuantity.toARIO())} ARIO to join the AR.IO network\nAre you sure?\n`, options);
     }
-    const result = await ario.joinNetwork(settings, (0, utils_js_1.writeActionTagsFromOptions)(options));
+    const result = await ario.joinNetwork(settings, (0, utils_js_1.customTagsFromOptions)(options));
     const output = {
         joinNetworkResult: result,
         joinedAddress: signerAddress,
@@ -64,7 +64,7 @@ async function updateGatewaySettings(options) {
         throw new Error('No gateway settings provided');
     }
     await (0, utils_js_1.assertConfirmationPrompt)(`Gateway Settings:\n\n${(0, utils_js_1.stringifyJsonForCLIDisplay)(gatewaySettings)}\n\nYou are about to update your gateway settings to the above\nAre you sure?\n`, options);
-    const result = await ario.updateGatewaySettings(gatewaySettings, (0, utils_js_1.writeActionTagsFromOptions)(options));
+    const result = await ario.updateGatewaySettings(gatewaySettings, (0, utils_js_1.customTagsFromOptions)(options));
     const output = {
         updateGatewaySettingsResult: result,
         updatedGatewayAddress: signerAddress,
@@ -85,7 +85,7 @@ async function leaveNetwork(options) {
             '\n\n' +
             'Are you sure you want to leave the AR.IO network?', options);
     }
-    return (0, utils_js_1.writeARIOFromOptions)(options).ario.leaveNetwork((0, utils_js_1.writeActionTagsFromOptions)(options));
+    return (0, utils_js_1.writeARIOFromOptions)(options).ario.leaveNetwork((0, utils_js_1.customTagsFromOptions)(options));
 }
 exports.leaveNetwork = leaveNetwork;
 async function saveObservations(o) {
@@ -95,7 +95,7 @@ async function saveObservations(o) {
     return (0, utils_js_1.writeARIOFromOptions)(o).ario.saveObservations({
         failedGateways: (0, utils_js_1.requiredStringArrayFromOptions)(o, 'failedGateways'),
         reportTxId: (0, utils_js_1.requiredStringFromOptions)(o, 'transactionId'),
-    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+    }, (0, utils_js_1.customTagsFromOptions)(o));
 }
 exports.saveObservations = saveObservations;
 async function increaseOperatorStake(o) {
@@ -104,7 +104,7 @@ async function increaseOperatorStake(o) {
     return ((0, utils_js_1.writeARIOFromOptions)(o).ario.increaseOperatorStake({
         increaseQty,
     }),
-        (0, utils_js_1.writeActionTagsFromOptions)(o));
+        (0, utils_js_1.customTagsFromOptions)(o));
 }
 exports.increaseOperatorStake = increaseOperatorStake;
 async function decreaseOperatorStake(o) {
@@ -113,7 +113,7 @@ async function decreaseOperatorStake(o) {
     await (0, utils_js_1.assertConfirmationPrompt)(`You are about to decrease your operator stake by ${(0, utils_js_1.formatARIOWithCommas)(decreaseQty.toARIO())} ARIO\nAre you sure?`, o);
     return (0, utils_js_1.writeARIOFromOptions)(o).ario.decreaseOperatorStake({
         decreaseQty,
-    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+    }, (0, utils_js_1.customTagsFromOptions)(o));
 }
 exports.decreaseOperatorStake = decreaseOperatorStake;
 async function instantWithdrawal(o) {
@@ -123,7 +123,7 @@ async function instantWithdrawal(o) {
     return (0, utils_js_1.writeARIOFromOptions)(o).ario.instantWithdrawal({
         vaultId,
         gatewayAddress,
-    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+    }, (0, utils_js_1.customTagsFromOptions)(o));
 }
 exports.instantWithdrawal = instantWithdrawal;
 async function cancelWithdrawal(o) {
@@ -133,7 +133,7 @@ async function cancelWithdrawal(o) {
     return (0, utils_js_1.writeARIOFromOptions)(o).ario.cancelWithdrawal({
         vaultId,
         gatewayAddress,
-    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+    }, (0, utils_js_1.customTagsFromOptions)(o));
 }
 exports.cancelWithdrawal = cancelWithdrawal;
 async function delegateStake(options) {
@@ -166,7 +166,7 @@ async function delegateStake(options) {
     const result = await ario.delegateStake({
         target,
         stakeQty: arioQuantity.toMARIO(),
-    }, (0, utils_js_1.writeActionTagsFromOptions)(options));
+    }, (0, utils_js_1.customTagsFromOptions)(options));
     const output = {
         senderAddress: signerAddress,
         transferResult: result,

package/lib/cjs/cli/commands/transfer.js

@@ -19,7 +19,7 @@ async function transferCLICommand(options) {
     const result = await ario.transfer({
         target,
         qty: arioQuantity.toMARIO().valueOf(),
-    }, (0, utils_js_1.writeActionTagsFromOptions)(options));
+    }, (0, utils_js_1.customTagsFromOptions)(options));
     const output = {
         senderAddress: signerAddress,
         transferResult: result,
@@ -50,7 +50,7 @@ async function vaultedTransferCLICommand(o) {
         quantity: mARIOQuantity,
         lockLengthMs,
         revokable: o.revokable,
-    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+    }, (0, utils_js_1.customTagsFromOptions)(o));
     const output = {
         senderAddress: signerAddress,
         transferResult: result,
@@ -76,7 +76,7 @@ async function revokeVaultCLICommand(o) {
     const result = await ario.revokeVault({
         vaultId,
         recipient,
-    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+    }, (0, utils_js_1.customTagsFromOptions)(o));
     const output = {
         senderAddress: signerAddress,
         transferResult: result,
@@ -104,7 +104,7 @@ async function createVaultCLICommand(o) {
     const result = await ario.createVault({
         quantity: mARIOQuantity,
         lockLengthMs,
-    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+    }, (0, utils_js_1.customTagsFromOptions)(o));
     const output = {
         senderAddress: signerAddress,
         transferResult: result,
@@ -131,7 +131,7 @@ async function extendVaultCLICommand(o) {
     const result = await ario.extendVault({
         vaultId,
         extendLengthMs,
-    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+    }, (0, utils_js_1.customTagsFromOptions)(o));
     const output = {
         senderAddress: signerAddress,
         transferResult: result,
@@ -157,7 +157,7 @@ async function increaseVaultCLICommand(o) {
     const result = await ario.increaseVault({
         vaultId,
         quantity: mARIOQuantity,
-    }, (0, utils_js_1.writeActionTagsFromOptions)(o));
+    }, (0, utils_js_1.customTagsFromOptions)(o));
     const output = {
         senderAddress: signerAddress,
         transferResult: result,

package/lib/cjs/cli/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertLockLengthInRange = exports.fundFromFromOptions = exports.getTokenCostParamsFromOptions = exports.getANTStateFromOptions = exports.requiredPositiveIntegerFromOptions = exports.positiveIntegerFromOptions = exports.requiredStringArrayFromOptions = exports.requiredStringFromOptions = exports.booleanFromOptions = exports.writeANTFromOptions = exports.readANTFromOptions = exports.requiredProcessIdFromOptions = exports.assertConfirmationPrompt = exports.confirmationPrompt = exports.assertEnoughMARIOBalance = exports.assertEnoughBalanceForArNSPurchase = exports.requiredMARIOFromOptions = exports.recordTypeFromOptions = exports.redelegateParamsFromOptions = exports.requiredTargetAndQuantityFromOptions = exports.gatewaySettingsFromOptions = exports.writeActionTagsFromOptions = exports.requiredInitiatorFromOptions = exports.epochInputFromOptions = exports.paginationParamsFromOptions = exports.requiredAddressFromOptions = exports.addressFromOptions = exports.formatMARIOToARIOWithCommas = exports.formatARIOWithCommas = exports.writeARIOFromOptions = exports.requiredAoSignerFromOptions = exports.requiredContractSignerFromOptions = exports.readARIOFromOptions = exports.getLoggerFromOptions = exports.jwkToAddress = exports.requiredJwkFromOptions = exports.arioProcessIdFromOptions = exports.makeCommand = exports.applyOptions = exports.runCommand = exports.stringifyJsonForCLIDisplay = exports.defaultTtlSecondsCLI = void 0;
+exports.assertLockLengthInRange = exports.fundFromFromOptions = exports.getTokenCostParamsFromOptions = exports.getANTStateFromOptions = exports.requiredPositiveIntegerFromOptions = exports.positiveIntegerFromOptions = exports.requiredStringArrayFromOptions = exports.requiredStringFromOptions = exports.booleanFromOptions = exports.writeANTFromOptions = exports.readANTFromOptions = exports.requiredProcessIdFromOptions = exports.assertConfirmationPrompt = exports.confirmationPrompt = exports.assertEnoughMARIOBalance = exports.assertEnoughBalanceForArNSPurchase = exports.requiredMARIOFromOptions = exports.recordTypeFromOptions = exports.redelegateParamsFromOptions = exports.requiredTargetAndQuantityFromOptions = exports.gatewaySettingsFromOptions = exports.customTagsFromOptions = exports.requiredInitiatorFromOptions = exports.epochInputFromOptions = exports.paginationParamsFromOptions = exports.requiredAddressFromOptions = exports.addressFromOptions = exports.formatMARIOToARIOWithCommas = exports.formatARIOWithCommas = exports.writeARIOFromOptions = exports.requiredAoSignerFromOptions = exports.requiredContractSignerFromOptions = exports.readARIOFromOptions = exports.getLoggerFromOptions = exports.jwkToAddress = exports.requiredJwkFromOptions = exports.arioProcessIdFromOptions = exports.makeCommand = exports.applyOptions = exports.runCommand = exports.stringifyJsonForCLIDisplay = exports.defaultTtlSecondsCLI = void 0;
 /**
  * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
  *
@@ -229,7 +229,7 @@ function requiredInitiatorFromOptions(options) {
     return requiredAddressFromOptions(options);
 }
 exports.requiredInitiatorFromOptions = requiredInitiatorFromOptions;
-function writeActionTagsFromOptions(options) {
+function customTagsFromOptions(options) {
     if (options.tags === undefined) {
         return {};
     }
@@ -253,7 +253,7 @@ function writeActionTagsFromOptions(options) {
         tags,
     };
 }
-exports.writeActionTagsFromOptions = writeActionTagsFromOptions;
+exports.customTagsFromOptions = customTagsFromOptions;
 function gatewaySettingsFromOptions({ allowDelegatedStaking, autoStake, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, observerAddress, port, properties, allowedDelegates, }) {
     return {
         observerAddress,

package/lib/cjs/common/io.js

@@ -89,7 +89,7 @@ class ARIOReadable {
                 epochIndex: epochIndex,
                 processId: this.process.processId,
             });
-            return epochData;
+            return (0, arweave_js_1.removeEligibleRewardsFromEpochData)(epochData);
         }
         // go to the process epoch and fetch the epoch data
         const allTags = [
@@ -298,6 +298,26 @@ class ARIOReadable {
             tags: (0, arweave_js_1.pruneTags)(allTags),
         });
     }
+    async getEligibleEpochRewards(epoch, params) {
+        const epochIndex = await this.computeEpochIndex(epoch);
+        const currentIndex = await this.computeCurrentEpochIndex();
+        if (epochIndex !== undefined && epochIndex < currentIndex) {
+            const epochData = await (0, arweave_js_1.getEpochDataFromGql)({
+                arweave: this.arweave,
+                epochIndex: epochIndex,
+                processId: this.process.processId,
+            });
+            return (0, arweave_js_1.sortAndPaginateEpochDataIntoEligibleDistributions)(epochData, params);
+        }
+        // on current epoch, go to process and fetch the distributions
+        const allTags = [
+            { name: 'Action', value: 'Epoch-Eligible-Rewards' },
+            ...(0, arweave_js_1.paginationParamsToTags)(params),
+        ];
+        return this.process.read({
+            tags: (0, arweave_js_1.pruneTags)(allTags),
+        });
+    }
     async getTokenCost({ intent, type, years, name, quantity, fromAddress, }) {
         const replacedBuyRecordWithBuyName = intent === 'Buy-Record' ? 'Buy-Name' : intent;
         const allTags = [

package/lib/cjs/types/io.js

@@ -1,7 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isLeasedArNSRecord = exports.isProcessIdConfiguration = exports.isProcessConfiguration = exports.isValidFundFrom = exports.fundFromOptions = exports.isValidIntent = exports.intentsUsingYears = exports.validIntents = void 0;
+exports.isLeasedArNSRecord = exports.isProcessIdConfiguration = exports.isProcessConfiguration = exports.isValidFundFrom = exports.fundFromOptions = exports.isValidIntent = exports.intentsUsingYears = exports.validIntents = exports.isDistributedEpoch = exports.isDistributedEpochData = void 0;
 const arweave_js_1 = require("../utils/arweave.js");
+const isDistributedEpochData = (data) => {
+    return data.distributedTimestamp !== undefined;
+};
+exports.isDistributedEpochData = isDistributedEpochData;
+const isDistributedEpoch = (data) => {
+    return (data !== undefined &&
+        data.distributions !== undefined &&
+        (0, exports.isDistributedEpochData)(data.distributions));
+};
+exports.isDistributedEpoch = isDistributedEpoch;
 exports.validIntents = [
     'Buy-Name',
     'Buy-Record', // for backwards compatibility

package/lib/cjs/utils/arweave.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.epochDistributionNoticeGqlQuery = exports.getEpochDataFromGql = exports.paginationParamsToTags = exports.pruneTags = exports.isBlockHeight = exports.validateArweaveId = void 0;
+exports.removeEligibleRewardsFromEpochData = exports.sortAndPaginateEpochDataIntoEligibleDistributions = exports.epochDistributionNoticeGqlQuery = exports.getEpochDataFromGql = exports.paginationParamsToTags = exports.pruneTags = exports.isBlockHeight = exports.validateArweaveId = void 0;
 const constants_js_1 = require("../constants.js");
+const io_js_1 = require("../types/io.js");
 const ao_js_1 = require("./ao.js");
 const validateArweaveId = (id) => {
     return constants_js_1.ARWEAVE_TX_REGEX.test(id);
@@ -103,3 +104,85 @@ const epochDistributionNoticeGqlQuery = ({ epochIndex, processId = constants_js_
     return gqlQuery;
 };
 exports.epochDistributionNoticeGqlQuery = epochDistributionNoticeGqlQuery;
+function sortAndPaginateEpochDataIntoEligibleDistributions(epochData, params) {
+    const rewards = [];
+    const sortBy = params?.sortBy ?? 'eligibleReward';
+    const sortOrder = params?.sortOrder ?? 'desc';
+    const limit = params?.limit ?? 100;
+    if (!(0, io_js_1.isDistributedEpoch)(epochData)) {
+        return {
+            hasMore: false,
+            items: [],
+            totalItems: 0,
+            limit,
+            sortOrder,
+            sortBy,
+        };
+    }
+    const eligibleDistributions = epochData?.distributions.rewards.eligible;
+    for (const [gatewayAddress, reward] of Object.entries(eligibleDistributions)) {
+        rewards.push({
+            type: 'operatorReward',
+            recipient: gatewayAddress,
+            eligibleReward: reward.operatorReward,
+            cursorId: gatewayAddress + '_' + gatewayAddress,
+            gatewayAddress,
+        });
+        for (const [delegateAddress, delegateRewardQty] of Object.entries(reward.delegateRewards)) {
+            rewards.push({
+                type: 'delegateReward',
+                recipient: delegateAddress,
+                eligibleReward: delegateRewardQty,
+                cursorId: gatewayAddress + '_' + delegateAddress,
+                gatewayAddress,
+            });
+        }
+    }
+    // sort the rewards by the sortBy
+    rewards.sort((a, b) => {
+        const aSort = a[sortBy];
+        const bSort = b[sortBy];
+        if (aSort === bSort || aSort === undefined || bSort === undefined) {
+            return 0;
+        }
+        if (sortOrder === 'asc') {
+            return aSort > bSort ? 1 : -1;
+        }
+        return aSort < bSort ? 1 : -1;
+    });
+    // paginate the rewards
+    const start = params?.cursor !== undefined
+        ? rewards.findIndex((r) => r.cursorId === params.cursor) + 1
+        : 0;
+    const end = limit ? start + limit : rewards.length;
+    return {
+        hasMore: end < rewards.length,
+        items: rewards.slice(start, end),
+        totalItems: rewards.length,
+        limit,
+        sortOrder,
+        nextCursor: rewards[end]?.cursorId,
+        sortBy,
+    };
+}
+exports.sortAndPaginateEpochDataIntoEligibleDistributions = sortAndPaginateEpochDataIntoEligibleDistributions;
+function removeEligibleRewardsFromEpochData(epochData) {
+    if (epochData === undefined) {
+        return undefined;
+    }
+    if (!(0, io_js_1.isDistributedEpoch)(epochData)) {
+        return epochData;
+    }
+    return {
+        ...epochData,
+        distributions: {
+            ...epochData.distributions,
+            rewards: {
+                ...epochData.distributions.rewards,
+                // @ts-expect-error -- remove eligible rewards
+                eligible: undefined,
+            },
+        },
+    };
+}
+exports.removeEligibleRewardsFromEpochData = removeEligibleRewardsFromEpochData;

package/lib/cjs/utils/utils.test.js

@@ -104,3 +104,101 @@ const index_js_1 = require("./index.js");
         node_assert_1.strict.equal(errorMessage, 'Already registered (line 128)');
     });
 });
+(0, node_test_1.describe)('sortAndPaginateEpochDataIntoEligibleDistributions', () => {
+    const mockEpochData = {
+        distributions: {
+            distributedTimestamp: 1234567890,
+            rewards: {
+                eligible: {
+                    gateway1: {
+                        operatorReward: 50,
+                        delegateRewards: {
+                            delegate1: 20,
+                            delegate2: 30,
+                        },
+                    },
+                    gateway2: {
+                        operatorReward: 70,
+                        delegateRewards: {
+                            delegate3: 40,
+                        },
+                    },
+                },
+            },
+        },
+    };
+    (0, node_test_1.it)('returns empty results when epochData is undefined', () => {
+        node_assert_1.strict.deepEqual((0, arweave_js_1.sortAndPaginateEpochDataIntoEligibleDistributions)(undefined), {
+            hasMore: false,
+            items: [],
+            totalItems: 0,
+            limit: 100,
+            sortOrder: 'desc',
+            sortBy: 'eligibleReward',
+        });
+    });
+    (0, node_test_1.it)('sorts rewards in descending order by eligibleReward', () => {
+        const result = (0, arweave_js_1.sortAndPaginateEpochDataIntoEligibleDistributions)(mockEpochData);
+        node_assert_1.strict.deepEqual(result.items, [
+            {
+                type: 'operatorReward',
+                recipient: 'gateway2',
+                eligibleReward: 70,
+                cursorId: 'gateway2_gateway2',
+                gatewayAddress: 'gateway2',
+            },
+            {
+                type: 'operatorReward',
+                recipient: 'gateway1',
+                eligibleReward: 50,
+                cursorId: 'gateway1_gateway1',
+                gatewayAddress: 'gateway1',
+            },
+            {
+                type: 'delegateReward',
+                recipient: 'delegate3',
+                eligibleReward: 40,
+                cursorId: 'gateway2_delegate3',
+                gatewayAddress: 'gateway2',
+            },
+            {
+                type: 'delegateReward',
+                recipient: 'delegate2',
+                eligibleReward: 30,
+                cursorId: 'gateway1_delegate2',
+                gatewayAddress: 'gateway1',
+            },
+            {
+                type: 'delegateReward',
+                recipient: 'delegate1',
+                eligibleReward: 20,
+                cursorId: 'gateway1_delegate1',
+                gatewayAddress: 'gateway1',
+            },
+        ]);
+    });
+    (0, node_test_1.it)('supports sorting in ascending order', () => {
+        const result = (0, arweave_js_1.sortAndPaginateEpochDataIntoEligibleDistributions)(mockEpochData, {
+            sortOrder: 'asc',
+        });
+        node_assert_1.strict.equal(result.items[0].eligibleReward, 20);
+        node_assert_1.strict.equal(result.items[result.items.length - 1].eligibleReward, 70);
+    });
+    (0, node_test_1.it)('paginates results correctly', () => {
+        const result = (0, arweave_js_1.sortAndPaginateEpochDataIntoEligibleDistributions)(mockEpochData, {
+            limit: 2,
+        });
+        node_assert_1.strict.equal(result.items.length, 2);
+        node_assert_1.strict.equal(result.hasMore, true);
+        node_assert_1.strict.equal(result.nextCursor, 'gateway2_delegate3');
+    });
+    (0, node_test_1.it)('resumes pagination from cursor', () => {
+        const firstPage = (0, arweave_js_1.sortAndPaginateEpochDataIntoEligibleDistributions)(mockEpochData, { limit: 2 });
+        const secondPage = (0, arweave_js_1.sortAndPaginateEpochDataIntoEligibleDistributions)(mockEpochData, {
+            limit: 2,
+            cursor: firstPage.nextCursor,
+        });
+        node_assert_1.strict.equal(secondPage.items.length, 2);
+        node_assert_1.strict.equal(secondPage.items[0].cursorId, 'gateway1_delegate2');
+    });
+});

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