@ar.io/sdk 2.4.0-alpha.8 → 2.4.0

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

@@ -16,17 +16,17 @@
 import { AOProcess } from '../common/index.js';
 import { AoMessageResult, AtLeastOne, BlockHeight, ProcessId, Timestamp, TransactionId, WalletAddress, WriteOptions } from './index.js';
 import { mIOToken } from './token.js';
-export type PaginationParams = {
+export type PaginationParams<T = Record<string, never>> = {
     cursor?: string;
     limit?: number;
-    sortBy?: string;
+    sortBy?: keyof T extends never ? string : keyof T;
     sortOrder?: 'asc' | 'desc';
 };
 export type PaginationResult<T> = {
     items: T[];
     nextCursor: string | undefined;
     totalItems: number;
-    sortBy: keyof T;
+    sortBy?: keyof T;
     sortOrder: 'asc' | 'desc';
     hasMore: boolean;
 };
@@ -65,7 +65,7 @@ export type AoEpochObservationData = {
 };
 export type AoVaultData = {
     balance: number;
-    locked: number;
+    startTimestamp: Timestamp;
     endTimestamp: Timestamp;
 };
 export type AoEpochDistributionRewards = {
@@ -142,10 +142,16 @@ export type AoGatewayService = {
 export type AoGatewayServices = {
     bundlers: AoGatewayService[];
 } | undefined;
+export type AoGatewayDelegates = Record<WalletAddress, AoGatewayDelegate>;
+export type AoGatewayDelegateAllowList = WalletAddress[];
+export type AoWalletVault = AoVaultData & {
+    address: WalletAddress;
+    vaultId: string;
+};
 export type AoGateway = {
     settings: AoGatewaySettings;
+    delegates: AoGatewayDelegates;
     stats: AoGatewayStats;
-    delegates: Record<WalletAddress, AoGatewayDelegate>;
     totalDelegatedStake: number;
     vaults: Record<WalletAddress, AoVaultData>;
     startTimestamp: Timestamp;
@@ -187,9 +193,13 @@ export type AoGatewayDelegate = {
     startTimestamp: Timestamp;
     vaults: Record<WalletAddress, AoVaultData>;
 };
+export type AoGatewayDelegateWithAddress = AoGatewayDelegate & {
+    address: WalletAddress;
+};
 export type AoGatewaySettings = {
-    allowDelegatedStaking: boolean;
+    allowDelegatedStaking: boolean | 'allowlist';
     delegateRewardShareRatio: number;
+    allowedDelegates: WalletAddress[];
     minDelegatedStake: number;
     autoStake: boolean;
     label: string;
@@ -240,19 +250,34 @@ export interface AoIORead {
     getGateway({ address, }: {
         address: WalletAddress;
     }): Promise<AoGateway | undefined>;
-    getGateways(params?: PaginationParams): Promise<PaginationResult<AoGatewayWithAddress>>;
+    getGatewayDelegates({ address, ...pageParams }: {
+        address: WalletAddress;
+    } & PaginationParams<AoGatewayDelegateWithAddress>): Promise<PaginationResult<AoGatewayDelegateWithAddress>>;
+    getGatewayDelegateAllowList(params?: PaginationParams<WalletAddress>): Promise<PaginationResult<WalletAddress>>;
+    getGateways(params?: PaginationParams<AoGatewayWithAddress>): Promise<PaginationResult<AoGatewayWithAddress>>;
     getBalance(params: {
         address: WalletAddress;
     }): Promise<number>;
-    getBalances(params?: PaginationParams): Promise<PaginationResult<AoBalanceWithAddress>>;
+    getBalances(params?: PaginationParams<AoBalanceWithAddress>): Promise<PaginationResult<AoBalanceWithAddress>>;
     getArNSRecord({ name, }: {
         name: string;
     }): Promise<AoArNSNameData | undefined>;
-    getArNSRecords(params?: PaginationParams): Promise<PaginationResult<AoArNSNameDataWithName>>;
+    getArNSRecords(params?: PaginationParams<AoArNSNameDataWithName>): Promise<PaginationResult<AoArNSNameDataWithName>>;
     getArNSReservedNames(): Promise<Record<string, AoArNSReservedNameData> | Record<string, never>>;
     getArNSReservedName({ name, }: {
         name: string;
     }): Promise<AoArNSReservedNameData | undefined>;
+    getArNSAuctions(params?: PaginationParams<AoAuction>): Promise<PaginationResult<AoAuction>>;
+    getArNSAuction({ name }: {
+        name: string;
+    }): Promise<AoAuction | undefined>;
+    getArNSAuctionPrices({ name, type, years, timestamp, intervalMs, }: {
+        name: string;
+        type: 'lease' | 'permabuy';
+        years?: number;
+        timestamp?: number;
+        intervalMs?: number;
+    }): Promise<AoAuctionPriceData>;
     getEpoch(epoch?: EpochInput): Promise<AoEpochData>;
     getCurrentEpoch(): Promise<AoEpochData>;
     getPrescribedObservers(epoch?: EpochInput): Promise<AoWeightedObserver[]>;
@@ -268,26 +293,20 @@ export interface AoIORead {
     }): Promise<number>;
     getRegistrationFees(): Promise<AoRegistrationFees>;
     getDemandFactor(): Promise<number>;
-    getAuctions(params?: PaginationParams): Promise<PaginationResult<AoAuction>>;
-    getAuction({ name }: {
-        name: string;
-    }): Promise<AoAuction | undefined>;
-    getAuctionPrices({ name, type, years, timestamp, intervalMs, }: {
-        name: string;
-        type: 'lease' | 'permabuy';
-        years?: number;
-        timestamp?: number;
-        intervalMs?: number;
-    }): Promise<AoAuctionPriceData>;
+    getVaults(params?: PaginationParams<AoWalletVault>): Promise<PaginationResult<AoWalletVault>>;
+    getVault({ address, vaultId, }: {
+        address: WalletAddress;
+        vaultId: string;
+    }): Promise<AoVaultData>;
 }
 export interface AoIOWrite extends AoIORead {
     transfer({ target, qty, }: {
         target: WalletAddress;
         qty: number;
     }, options?: WriteOptions): Promise<AoMessageResult>;
-    joinNetwork({ operatorStake, allowDelegatedStaking, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }: AoJoinNetworkParams, options?: WriteOptions): Promise<AoMessageResult>;
+    joinNetwork(params: AoJoinNetworkParams, options?: WriteOptions): Promise<AoMessageResult>;
     leaveNetwork(options?: WriteOptions): Promise<AoMessageResult>;
-    updateGatewaySettings({ allowDelegatedStaking, delegateRewardShareRatio, fqdn, label, minDelegatedStake, note, port, properties, protocol, autoStake, observerAddress, }: AoUpdateGatewaySettingsParams, options?: WriteOptions): Promise<AoMessageResult>;
+    updateGatewaySettings(params: AoUpdateGatewaySettingsParams, options?: WriteOptions): Promise<AoMessageResult>;
     increaseOperatorStake(params: {
         increaseQty: number | mIOToken;
     }, options?: WriteOptions): Promise<AoMessageResult>;

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

@@ -1,3 +1,27 @@
-import { BlockHeight } from '../types/common.js';
+/**
+ * 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';
 export declare const validateArweaveId: (id: string) => boolean;
 export declare function isBlockHeight(height: string | number): height is BlockHeight;
+export declare const pruneTags: (tags: {
+    name: string;
+    value: string | undefined;
+}[]) => {
+    name: string;
+    value: string;
+}[];
+export declare const getCurrentBlockUnixTimestampMs: (arweave: Arweave) => Promise<Timestamp>;

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

@@ -13,9 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export * from './arweave.js';
-export * from './http-client.js';
 export * from './ao.js';
+export * from './arweave.js';
+export * from './base64.js';
 export * from './json.js';
 export * from './processes.js';
 export * from './schema.js';

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

@@ -29,11 +29,13 @@ export declare class ArNSEventEmitter extends EventEmitter {
     private timeoutMs;
     private throttle;
     private logger;
-    constructor({ contract, timeoutMs, concurrency, logger, }?: {
+    private strict;
+    constructor({ contract, timeoutMs, concurrency, logger, strict, }?: {
         contract?: AoIORead;
         timeoutMs?: number;
         concurrency?: number;
         logger?: ILogger;
+        strict?: boolean;
     });
     fetchProcessesOwnedByWallet({ address, pageSize, antRegistry, }: {
         address: WalletAddress;

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-alpha.7";
+export declare const version = "2.4.0-alpha.16";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "2.4.0-alpha.8",
+  "version": "2.4.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"
@@ -66,17 +66,18 @@
     "format": "prettier --check .",
     "format:fix": "prettier --write .",
     "test": "yarn test:unit && yarn test:e2e",
-    "test:cjs": "yarn test:link && cd ./tests/e2e/cjs && yarn && yarn test",
-    "test:esm": "yarn test:link && cd ./tests/e2e/esm && yarn && yarn test",
-    "test:web": "yarn test:link && cd ./tests/e2e/web && yarn && yarn test",
+    "test:cjs": "yarn build:cjs && yarn link && cd ./tests/e2e/cjs && yarn && yarn test",
+    "test:esm": "yarn build:esm && yarn link && cd ./tests/e2e/esm && yarn && yarn test",
+    "test:web": "yarn build:esm && yarn link && cd ./tests/e2e/web && yarn && yarn test",
     "test:unit": "NODE_OPTIONS=\"--import=./register.mjs\" node --test tests/unit/**.test.ts",
     "test:link": "yarn build && yarn link",
     "test:e2e": "yarn test:cjs && yarn test:esm && yarn test:web",
     "prepare": "husky install",
     "docs:update": "markdown-toc-gen insert README.md",
     "example:esm": "cd examples/esm && yarn && node index.mjs",
-    "example:cjs": "yarn test:link && cd examples/cjs && yarn && node index.cjs",
-    "example:web": "yarn test:link && build:web && http-server --port 8080 --host -o examples/web"
+    "example:cjs": "yarn build:cjs && yarn link && cd examples/cjs && yarn && node index.cjs",
+    "example:web": "yarn build:web && http-server --port 8080 --host -o examples/web",
+    "example:vite": "yarn build:esm && yarn link && cd examples/vite && yarn && yarn start"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.1.2",
@@ -108,6 +109,7 @@
     "husky": "^8.0.3",
     "lint-staged": "^15.2.2",
     "markdown-toc-gen": "^1.0.1",
+    "nock": "^13.5.5",
     "prettier": "^3.0.2",
     "rimraf": "^5.0.1",
     "semantic-release": "^21.0.7",