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

package/lib/types/cli/commands/readCommands.d.ts

@@ -51,7 +51,7 @@ export declare function getArNSReturnedName(o: NameCLIOptions): Promise<import("
 export declare function listArNSReturnedNames(o: PaginationCLIOptions): Promise<import("../../types/io.js").PaginationResult<import("../../types/io.js").AoReturnedName> | {
     message: string;
 }>;
-export declare function getEpoch(o: EpochCLIOptions): Promise<import("../../types/io.js").AoEpochData | {
+export declare function getEpoch(o: EpochCLIOptions): Promise<import("../../types/io.js").AoEpochData<import("../../types/io.js").AoEpochDistributionData> | {
     message: string;
 }>;
 export declare function getPrescribedObservers(o: EpochCLIOptions): Promise<import("../../types/io.js").AoWeightedObserver[] | {

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

@@ -39,7 +39,7 @@ export declare function requiredAddressFromOptions<O extends AddressCLIOptions>(
 export declare function paginationParamsFromOptions<O extends PaginationCLIOptions, R>(options: O): PaginationParams<R>;
 export declare function epochInputFromOptions(options: EpochCLIOptions): EpochInput;
 export declare function requiredInitiatorFromOptions(options: InitiatorCLIOptions): string;
-export declare function writeActionTagsFromOptions<O extends WriteActionCLIOptions>(options: O): WriteOptions;
+export declare function customTagsFromOptions<O extends WriteActionCLIOptions>(options: O): WriteOptions;
 export declare function gatewaySettingsFromOptions({ allowDelegatedStaking, autoStake, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, observerAddress, port, properties, allowedDelegates, }: UpdateGatewaySettingsCLIOptions): AoUpdateGatewaySettingsParams;
 export declare function requiredTargetAndQuantityFromOptions(options: TransferCLIOptions): {
     target: string;

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

@@ -15,7 +15,7 @@
  */
 import Arweave from 'arweave';
 import { AoArNSNameDataWithName, AoArNSReservedNameData, AoBalanceWithAddress, AoEpochDistributionData, AoEpochObservationData, AoGatewayWithAddress, AoJoinNetworkParams, AoMessageResult, AoPrimaryName, AoPrimaryNameRequest, AoRedelegationFeeInfo, AoReturnedName, AoTokenSupplyData, AoUpdateGatewaySettingsParams, AoWeightedObserver, OptionalArweave, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
-import { AoARIORead, AoARIOWrite, AoAllDelegates, AoAllGatewayVaults, AoArNSNameData, AoArNSPurchaseParams, AoArNSReservedNameDataWithName, AoBuyRecordParams, AoCreateVaultParams, AoDelegation, AoEpochData, AoEpochSettings, AoExtendLeaseParams, AoExtendVaultParams, AoGateway, AoGatewayDelegateWithAddress, AoGatewayRegistrySettings, AoGatewayVault, AoGetCostDetailsParams, AoIncreaseUndernameLimitParams, AoIncreaseVaultParams, AoPaginatedAddressParams, AoRegistrationFees, AoRevokeVaultParams, AoVaultData, AoVaultedTransferParams, AoWalletVault, CostDetailsResult, DemandFactorSettings, EpochInput } from '../types/io.js';
+import { AoARIORead, AoARIOWrite, AoAllDelegates, AoAllGatewayVaults, AoArNSNameData, AoArNSPurchaseParams, AoArNSReservedNameDataWithName, AoBuyRecordParams, AoCreateVaultParams, AoDelegation, AoEligibleDistribution, AoEpochData, AoEpochSettings, AoExtendLeaseParams, AoExtendVaultParams, AoGateway, AoGatewayDelegateWithAddress, AoGatewayRegistrySettings, AoGatewayVault, AoGetCostDetailsParams, AoIncreaseUndernameLimitParams, AoIncreaseVaultParams, AoPaginatedAddressParams, AoRegistrationFees, AoRevokeVaultParams, AoVaultData, AoVaultedTransferParams, AoWalletVault, CostDetailsResult, DemandFactorSettings, EpochInput } from '../types/io.js';
 import { mARIOToken } from '../types/token.js';
 import { AOProcess } from './contracts/ao-process.js';
 type ARIOConfigNoSigner = OptionalArweave<ProcessConfiguration>;
@@ -76,6 +76,7 @@ export declare class ARIOReadable implements AoARIORead {
     getPrescribedNames(epoch?: EpochInput): Promise<string[] | undefined>;
     getObservations(epoch?: EpochInput): Promise<AoEpochObservationData | undefined>;
     getDistributions(epoch?: EpochInput): Promise<AoEpochDistributionData | undefined>;
+    getEligibleEpochRewards(epoch?: EpochInput, params?: PaginationParams<AoEligibleDistribution>): Promise<PaginationResult<AoEligibleDistribution>>;
     getTokenCost(params: {
         intent: 'Buy-Record' | 'Buy-Name';
         type: 'permabuy' | 'lease';

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

@@ -65,22 +65,6 @@ export type AoVaultData = {
     startTimestamp: Timestamp;
     endTimestamp: Timestamp;
 };
-export type AoEpochDistributionRewards = {
-    eligible: Record<WalletAddress, {
-        delegateRewards: Record<WalletAddress, number>;
-        operatorReward: number;
-    }>;
-    distributed?: Record<WalletAddress, number>;
-};
-export type AoEpochDistributionData = {
-    rewards: AoEpochDistributionRewards;
-    totalEligibleGateways: number;
-    totalEligibleRewards: number;
-    totalEligibleObserverReward: number;
-    totalEligibleGatewayReward: number;
-    distributedTimestamp?: Timestamp;
-    totalDistributedRewards?: number;
-};
 export type AoArNSReservedNameData = {
     target?: string;
     endTimestamp?: number;
@@ -112,7 +96,28 @@ export type AoEpochSettings = {
     prescribedNameCount: number;
     maxObservers: number;
 };
-export type AoEpochData = {
+export type AoEpochDistributionTotalsData = {
+    totalEligibleGateways: number;
+    totalEligibleRewards: number;
+    totalEligibleObserverReward: number;
+    totalEligibleGatewayReward: number;
+};
+/** @deprecated Use getEligibleEpochRewards getEpochDistributions, will be removed in a future release  */
+export type AoEpochDistributionRewards = {
+    eligible: Record<WalletAddress, {
+        delegateRewards: Record<WalletAddress, number>;
+        operatorReward: number;
+    }>;
+    distributed: Record<WalletAddress, number>;
+};
+export type AoEpochDistributed = AoEpochDistributionTotalsData & {
+    /** @deprecated Use getEligibleEpochRewards getEpochDistributions, will be removed in a future release  */
+    rewards: AoEpochDistributionRewards;
+    distributedTimestamp: Timestamp;
+    totalDistributedRewards: number;
+};
+export type AoEpochDistributionData = AoEpochDistributionTotalsData | AoEpochDistributed;
+export type AoEpochData<D = AoEpochDistributionData> = {
     epochIndex: AoEpochIndex;
     startHeight: BlockHeight;
     observations: AoEpochObservationData;
@@ -121,8 +126,7 @@ export type AoEpochData = {
     startTimestamp: Timestamp;
     endTimestamp: Timestamp;
     distributionTimestamp: Timestamp;
-    /** @deprecated - use `getDistributions` to get distribution data for a given epoch **/
-    distributions: AoEpochDistributionData;
+    distributions: D;
     arnsStats: {
         totalReturnedNames: number;
         totalActiveNames: number;
@@ -130,6 +134,19 @@ export type AoEpochData = {
         totalReservedNames: number;
     };
 };
+export declare const isDistributedEpochData: (data: AoEpochDistributed | AoEpochDistributionTotalsData) => data is AoEpochDistributed;
+export declare const isDistributedEpoch: (data: AoEpochData | undefined) => data is AoEpochData<AoEpochDistributed> & {
+    distributions: {
+        rewards: object;
+    };
+};
+export type AoEligibleDistribution = {
+    type: 'operatorReward' | 'delegateReward';
+    recipient: WalletAddress;
+    eligibleReward: number;
+    gatewayAddress: WalletAddress;
+    cursorId: string;
+};
 export type AoTokenSupplyData = {
     total: number;
     circulating: number;
@@ -445,6 +462,7 @@ export interface AoARIORead {
     getPrescribedNames(epoch?: EpochInput): Promise<string[] | undefined>;
     getObservations(epoch?: EpochInput): Promise<AoEpochObservationData | undefined>;
     getDistributions(epoch?: EpochInput): Promise<AoEpochDistributionData | undefined>;
+    getEligibleEpochRewards(epoch?: EpochInput, params?: PaginationParams<AoEligibleDistribution>): Promise<PaginationResult<AoEligibleDistribution> | undefined>;
     getTokenCost({ intent, type, years, name, quantity, }: AoTokenCostParams): Promise<number>;
     getCostDetails({ intent, type, years, name, quantity, fundFrom, }: AoGetCostDetailsParams): Promise<CostDetailsResult>;
     getRegistrationFees(): Promise<AoRegistrationFees>;

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

@@ -15,7 +15,7 @@
  */
 import Arweave from 'arweave';
 import { BlockHeight } from '../types/common.js';
-import { AoEpochData, PaginationParams } from '../types/io.js';
+import { AoEligibleDistribution, AoEpochData, PaginationParams, PaginationResult } from '../types/io.js';
 export declare const validateArweaveId: (id: string) => boolean;
 export declare function isBlockHeight(height: string | number): height is BlockHeight;
 /**
@@ -58,3 +58,5 @@ export declare const epochDistributionNoticeGqlQuery: ({ epochIndex, processId,
     processId?: string | undefined;
     authorities?: string[] | undefined;
 }) => string;
+export declare function sortAndPaginateEpochDataIntoEligibleDistributions(epochData?: AoEpochData, params?: PaginationParams<AoEligibleDistribution>): PaginationResult<AoEligibleDistribution>;
+export declare function removeEligibleRewardsFromEpochData(epochData?: AoEpochData): AoEpochData | undefined;

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

package/package.json

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