@ar.io/sdk 3.1.0-alpha.1 → 3.1.0-alpha.11

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

@@ -25,6 +25,7 @@ export type PaginationParams<T = Record<string, never>> = {
 export type PaginationResult<T> = {
     items: T[];
     nextCursor?: string;
+    limit: number;
     totalItems: number;
     sortBy?: T extends string ? string : keyof T;
     sortOrder: 'asc' | 'desc';
@@ -50,6 +51,7 @@ export type AoEpochObservationData = {
     failureSummaries: Record<WalletAddress, WalletAddress[]>;
     reports: Record<WalletAddress, TransactionId>;
 };
+export type AoEpochPrescribedObservers = Record<WalletAddress, WalletAddress[]>;
 export type AoVaultData = {
     balance: number;
     startTimestamp: Timestamp;
@@ -103,12 +105,15 @@ export type AoEpochSettings = {
     rewardPercentage: number;
     maxObservers: number;
     distributionDelayMs: number;
+    epochZeroTimestamp: Timestamp;
+    pruneEpochsCount: number;
 };
 export type AoEpochData = {
     epochIndex: AoEpochIndex;
     startHeight: BlockHeight;
     observations: AoEpochObservationData;
     prescribedObservers: AoWeightedObserver[];
+    prescribedNames: string[];
     startTimestamp: Timestamp;
     endTimestamp: Timestamp;
     distributionTimestamp: Timestamp;
@@ -274,7 +279,7 @@ export type AoFundingPlan = {
     address: WalletAddress;
     balance: number;
     stakes: Record<WalletAddress, {
-        vaults: string[];
+        vaults: Record<string, number>[];
         delegatedStake: number;
     }>;
     /** Any remaining shortfall will indicate an insufficient balance for the action */
@@ -294,15 +299,18 @@ export type AoGetVaultParams = {
     address: WalletAddress;
     vaultId: string;
 };
-export type AoBuyRecordParams = AoArNSNameParams & {
+export type AoArNSPurchaseParams = AoArNSNameParams & {
+    fundFrom?: FundFrom;
+};
+export type AoBuyRecordParams = AoArNSPurchaseParams & {
     years?: number;
     type: 'lease' | 'permabuy';
     processId: string;
 };
-export type AoExtendLeaseParams = AoArNSNameParams & {
+export type AoExtendLeaseParams = AoArNSPurchaseParams & {
     years: number;
 };
-export type AoIncreaseUndernameLimitParams = AoArNSNameParams & {
+export type AoIncreaseUndernameLimitParams = AoArNSPurchaseParams & {
     increaseCount: number;
 };
 export type AoGatewayRegistrySettings = {
@@ -345,7 +353,7 @@ export interface AoARIORead {
         LastTickedEpochIndex: number;
     }>;
     getTokenSupply(): Promise<AoTokenSupplyData>;
-    getEpochSettings(params?: EpochInput): Promise<AoEpochSettings>;
+    getEpochSettings(): Promise<AoEpochSettings>;
     getGateway({ address }: AoAddressParams): Promise<AoGateway | undefined>;
     getGatewayDelegates({ address, ...pageParams }: AoAddressParams & PaginationParams<AoGatewayDelegateWithAddress>): Promise<PaginationResult<AoGatewayDelegateWithAddress>>;
     getGatewayDelegateAllowList(params: AoPaginatedAddressParams): Promise<PaginationResult<WalletAddress>>;
@@ -389,7 +397,7 @@ export interface AoARIORead {
     getPrimaryNameRequest(params: {
         initiator: WalletAddress;
     }): Promise<AoPrimaryNameRequest>;
-    getPrimaryNameRequests(params: PaginationParams<AoPrimaryNameRequest>): Promise<PaginationResult<AoPrimaryNameRequest>>;
+    getPrimaryNameRequests(params?: PaginationParams<AoPrimaryNameRequest>): Promise<PaginationResult<AoPrimaryNameRequest>>;
     getPrimaryName(params: {
         address: WalletAddress;
     } | {
@@ -434,16 +442,14 @@ export interface AoARIOWrite extends AoARIORead {
         failedGateways: WalletAddress[];
     }, options?: WriteOptions): Promise<AoMessageResult>;
     buyRecord(params: AoBuyRecordParams, options?: WriteOptions): Promise<AoMessageResult>;
-    upgradeRecord(params: AoArNSNameParams, options?: WriteOptions): Promise<AoMessageResult>;
+    upgradeRecord(params: AoArNSPurchaseParams, options?: WriteOptions): Promise<AoMessageResult>;
     extendLease(params: AoExtendLeaseParams, options?: WriteOptions): Promise<AoMessageResult>;
     increaseUndernameLimit(params: AoIncreaseUndernameLimitParams, options?: WriteOptions): Promise<AoMessageResult>;
     cancelWithdrawal(params: {
         gatewayAddress?: WalletAddress;
         vaultId: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
-    requestPrimaryName(params: {
-        name: string;
-    }): Promise<AoMessageResult>;
+    requestPrimaryName(params: AoArNSPurchaseParams, options?: WriteOptions): Promise<AoMessageResult>;
     redelegateStake(params: AoRedelegateStakeParams, options?: WriteOptions): Promise<AoMessageResult>;
 }
 export declare function isProcessConfiguration(config: object): config is {

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

@@ -1,23 +1,12 @@
-/**
- * Copyright (C) 2022-2024 Permanent Data Solutions, Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import Arweave from 'arweave';
-import { BlockHeight, Timestamp } from '../types/common.js';
+import { BlockHeight } from '../types/common.js';
 import { PaginationParams } from '../types/io.js';
 export declare const validateArweaveId: (id: string) => boolean;
 export declare function isBlockHeight(height: string | number): height is BlockHeight;
+/**
+ * Prune tags that are undefined or empty.
+ * @param tags - The tags to prune.
+ * @returns The pruned tags.
+ */
 export declare const pruneTags: (tags: {
     name: string;
     value: string | undefined;
@@ -25,7 +14,6 @@ export declare const pruneTags: (tags: {
     name: string;
     value: string;
 }[];
-export declare const getCurrentBlockUnixTimestampMs: (arweave: Arweave) => Promise<Timestamp>;
 export declare const paginationParamsToTags: <T>(params?: PaginationParams<T>) => {
     name: string;
     value: string;

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.0.1-alpha.1";
+export declare const version = "3.1.0-alpha.10";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "3.1.0-alpha.1",
+  "version": "3.1.0-alpha.11",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"
@@ -127,7 +127,7 @@
     "@dha-team/arbundles": "^1.0.1",
     "@permaweb/aoconnect": "^0.0.57",
     "arweave": "1.14.4",
-    "axios": "1.7.8",
+    "axios": "1.7.9",
     "axios-retry": "^4.3.0",
     "commander": "^12.1.0",
     "eventemitter3": "^5.0.1",