@ar.io/sdk 3.2.0 → 3.3.0-alpha.10

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

@@ -1,21 +1,19 @@
 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';
+type ANTConfigOptionalStrict = Required<ProcessConfiguration> & {
+    strict?: boolean;
+};
+type ANTConfigNoSigner = ANTConfigOptionalStrict;
+type ANTConfigWithSigner = WithSigner<ANTConfigOptionalStrict>;
 export declare class ANT {
-    static init(config: Required<ProcessConfiguration> & {
-        signer?: undefined;
-        strict?: boolean;
-    }): AoANTRead;
-    static init({ signer, ...config }: WithSigner<Required<ProcessConfiguration>> & {
-        strict?: boolean;
-    }): AoANTWrite;
+    static init(config: ANTConfigNoSigner): AoANTRead;
+    static init(config: ANTConfigWithSigner): AoANTWrite;
 }
 export declare class AoANTReadable implements AoANTRead {
     protected process: AOProcess;
     private strict;
-    constructor(config: Required<ProcessConfiguration> & {
-        strict?: boolean;
-    });
+    constructor(config: ANTConfigOptionalStrict);
     getState({ strict }?: AntReadOptions): Promise<AoANTState>;
     getInfo({ strict }?: AntReadOptions): Promise<AoANTInfo>;
     /**
@@ -273,3 +271,4 @@ export declare class AoANTWriteable extends AoANTReadable implements AoANTWrite
         notifyOwners?: boolean;
     }, options?: WriteOptions): Promise<AoMessageResult>;
 }
+export {};

package/lib/types/common/contracts/ao-process.d.ts

@@ -2,8 +2,8 @@ import { AOContract, AoClient, AoSigner } from '../../types/index.js';
 import { ILogger } from '../logger.js';
 export declare class AOProcess implements AOContract {
     private logger;
-    private processId;
     private ao;
+    readonly processId: string;
     constructor({ processId, ao, logger, }: {
         processId: string;
         ao?: AoClient;

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

@@ -1,30 +1,35 @@
-import { AoArNSNameDataWithName, AoArNSReservedNameData, AoBalanceWithAddress, AoEpochDistributionData, AoEpochObservationData, AoGatewayWithAddress, AoJoinNetworkParams, AoMessageResult, AoPrimaryName, AoPrimaryNameRequest, AoRedelegationFeeInfo, AoReturnedName, AoTokenSupplyData, AoUpdateGatewaySettingsParams, AoWeightedObserver, ContractSigner, PaginationParams, PaginationResult, ProcessConfiguration, TransactionId, WalletAddress, WithSigner, WriteOptions } from '../types/index.js';
-import { AoARIORead, AoARIOWrite, AoArNSNameData, AoArNSPurchaseParams, AoArNSReservedNameDataWithName, AoBuyRecordParams, AoDelegation, AoEpochData, AoEpochSettings, AoExtendLeaseParams, AoGateway, AoGatewayDelegateWithAddress, AoGatewayRegistrySettings, AoGatewayVault, AoGetCostDetailsParams, AoIncreaseUndernameLimitParams, AoPaginatedAddressParams, AoRegistrationFees, AoVaultData, AoWalletVault, CostDetailsResult, DemandFactorSettings, EpochInput } from '../types/io.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 { 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, AoArNSNameData, AoArNSPurchaseParams, AoArNSReservedNameDataWithName, AoBuyRecordParams, AoDelegation, AoEpochData, AoEpochSettings, AoExtendLeaseParams, AoGateway, AoGatewayDelegateWithAddress, AoGatewayRegistrySettings, AoGatewayVault, AoGetCostDetailsParams, AoIncreaseUndernameLimitParams, AoPaginatedAddressParams, AoRegistrationFees, AoVaultData, 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>;
+type ARIOConfigWithSigner = WithSigner<OptionalArweave<ProcessConfiguration>>;
 export declare class ARIO {
     static init(): AoARIORead;
-    static init({ process }: {
-        process: AOProcess;
-    }): AoARIORead;
-    static init({ process, signer, }: WithSigner<{
-        process: AOProcess;
-    }>): AoARIOWrite;
-    static init({ processId, signer, }: WithSigner<{
-        processId?: string;
-    }>): AoARIOWrite;
-    static init({ processId, signer, }: {
-        signer?: ContractSigner | undefined;
-        processId: string;
-    }): any;
-    static init({ processId }: {
-        processId: string;
-    }): AoARIORead;
+    static init(config: ARIOConfigWithSigner): AoARIOWrite;
+    static init(config: ARIOConfigNoSigner): AoARIORead;
 }
 export declare class ARIOReadable implements AoARIORead {
     protected process: AOProcess;
     protected epochSettings: AoEpochSettings | undefined;
-    constructor(config?: ProcessConfiguration);
+    protected arweave: Arweave;
+    constructor(config?: OptionalArweave<ProcessConfiguration>);
     getInfo(): Promise<{
         Name: string;
         Ticker: string;
@@ -36,9 +41,10 @@ export declare class ARIOReadable implements AoARIORead {
     }>;
     getTokenSupply(): Promise<AoTokenSupplyData>;
     private computeEpochIndexForTimestamp;
+    private computeCurrentEpochIndex;
     private computeEpochIndex;
     getEpochSettings(): Promise<AoEpochSettings>;
-    getEpoch(epoch?: EpochInput): Promise<AoEpochData>;
+    getEpoch(epoch?: EpochInput): Promise<AoEpochData | undefined>;
     getArNSRecord({ name, }: {
         name: string;
     }): Promise<AoArNSNameData | undefined>;
@@ -68,8 +74,8 @@ export declare class ARIOReadable implements AoARIORead {
     getCurrentEpoch(): Promise<AoEpochData>;
     getPrescribedObservers(epoch?: EpochInput): Promise<AoWeightedObserver[]>;
     getPrescribedNames(epoch?: EpochInput): Promise<string[]>;
-    getObservations(epoch?: EpochInput): Promise<AoEpochObservationData>;
-    getDistributions(epoch?: EpochInput): Promise<AoEpochDistributionData>;
+    getObservations(epoch?: EpochInput): Promise<AoEpochObservationData | undefined>;
+    getDistributions(epoch?: EpochInput): Promise<AoEpochDistributionData | undefined>;
     getTokenCost(params: {
         intent: 'Buy-Record';
         type: 'permabuy' | 'lease';
@@ -130,15 +136,12 @@ export declare class ARIOReadable implements AoARIORead {
         address: WalletAddress;
     }): Promise<AoRedelegationFeeInfo>;
     getGatewayRegistrySettings(): Promise<AoGatewayRegistrySettings>;
+    getAllDelegates(params?: PaginationParams<AoAllDelegates>): Promise<PaginationResult<AoAllDelegates>>;
 }
 export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
     protected process: AOProcess;
     private signer;
-    constructor({ signer, ...config }: WithSigner<{
-        process?: AOProcess;
-    } | {
-        processId?: string;
-    }>);
+    constructor({ signer, ...config }: ARIOConfigWithSigner);
     transfer({ target, qty, }: {
         target: string;
         qty: number | mARIOToken;
@@ -231,3 +234,4 @@ export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
         vaultId?: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
 }
+export {};

package/lib/types/constants.d.ts

@@ -24,6 +24,6 @@ export declare const arioDevnetProcessId = "GaQrvEMKBpkjofgnBi_B3IgIDmY_XYelVLB6
 export declare const ARIO_TESTNET_PROCESS_ID = "agYcCFJtrMG6cqMuZfskIkFTGvUPddICmtQSBIoPdiA";
 export declare const ANT_REGISTRY_ID = "i_le_yKKPVstLTDSmkHRqf-wYphMnwB9OhleiTgMkWc";
 export declare const MARIO_PER_ARIO = 1000000;
-export declare const AOS_MODULE_ID = "cbn0KKrBZH7hdNkNokuXLtGryrWM--PjSTBqIzw9Kkk";
-export declare const ANT_LUA_ID = "16_FyX-V2QU0RPSh1GIaEETSaUjNb0oVjCFpVbAfQq4";
+export declare const AOS_MODULE_ID = "BRyNPIJWZaQ4IudfNnsfvMrZBO2YDPjgKqg_wCYT2U8";
+export declare const ANT_LUA_ID = "k9tQkbnFYZOGp6ist1yFuaqk_wOkzM5KUSNDtWzCLtg";
 export declare const DEFAULT_SCHEDULER_ID = "_GQ33BkPtZrqxA84vM8Zk-N2aO0toNNu_C-l-rawrBA";

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

@@ -16,6 +16,7 @@
  */
 import { Signer } from '@dha-team/arbundles';
 import { dryrun, message, monitor, result, results, spawn, unmonitor } from '@permaweb/aoconnect';
+import Arweave from 'arweave';
 import { AoSigner } from './token.js';
 export type BlockHeight = number;
 export type SortKey = string;
@@ -23,6 +24,9 @@ export type Timestamp = number;
 export type WalletAddress = string;
 export type TransactionId = string;
 export type ProcessId = string;
+export type OptionalArweave<T = NonNullable<unknown>> = {
+    arweave?: Arweave;
+} & T;
 export type ContractSigner = Signer | Window['arweaveWallet'] | AoSigner;
 export type WithSigner<T = NonNullable<unknown>> = {
     signer: ContractSigner;

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

@@ -31,16 +31,20 @@ export type PaginationResult<T> = {
     sortOrder: 'asc' | 'desc';
     hasMore: boolean;
 };
-export type ProcessConfiguration = {
-    process?: AOProcess;
-} | {
+export type ProcessIdConfig = {
     processId?: string;
 };
-export type EpochInput = {
-    epochIndex: AoEpochIndex;
-} | {
+export type ProcessConfig = {
+    process?: AOProcess;
+};
+export type ProcessConfiguration = ProcessConfig | ProcessIdConfig;
+export type EpochTimestampInput = {
     timestamp: Timestamp;
-} | undefined;
+};
+export type EpochIndexInput = {
+    epochIndex: AoEpochIndex;
+};
+export type EpochInput = EpochTimestampInput | EpochIndexInput | undefined;
 export type AoBalances = Record<WalletAddress, number>;
 export type AoRegistrationFees = Record<number, {
     lease: Record<number, number>;
@@ -117,6 +121,7 @@ export type AoEpochData = {
     startTimestamp: Timestamp;
     endTimestamp: Timestamp;
     distributionTimestamp: Timestamp;
+    /** @deprecated - use `getDistributions` to get distribution data for a given epoch **/
     distributions: AoEpochDistributionData;
 };
 export type AoTokenSupplyData = {
@@ -389,8 +394,8 @@ export interface AoARIORead {
     getCurrentEpoch(): Promise<AoEpochData>;
     getPrescribedObservers(epoch?: EpochInput): Promise<AoWeightedObserver[]>;
     getPrescribedNames(epoch?: EpochInput): Promise<string[]>;
-    getObservations(epoch?: EpochInput): Promise<AoEpochObservationData>;
-    getDistributions(epoch?: EpochInput): Promise<AoEpochDistributionData>;
+    getObservations(epoch?: EpochInput): Promise<AoEpochObservationData | undefined>;
+    getDistributions(epoch?: EpochInput): Promise<AoEpochDistributionData | undefined>;
     getTokenCost({ intent, type, years, name, quantity, }: AoTokenCostParams): Promise<number>;
     getCostDetails({ intent, type, years, name, quantity, fundFrom, }: AoGetCostDetailsParams): Promise<CostDetailsResult>;
     getRegistrationFees(): Promise<AoRegistrationFees>;
@@ -412,7 +417,16 @@ export interface AoARIORead {
         address: WalletAddress;
     }): Promise<AoRedelegationFeeInfo>;
     getGatewayRegistrySettings(): Promise<AoGatewayRegistrySettings>;
+    getAllDelegates(params?: PaginationParams<AoAllDelegates>): Promise<PaginationResult<AoAllDelegates>>;
 }
+export type AoAllDelegates = {
+    address: WalletAddress;
+    gatewayAddress: WalletAddress;
+    delegatedStake: number;
+    startTimestamp: Timestamp;
+    vaultedStake: number;
+    cursorId: string;
+};
 export interface AoARIOWrite extends AoARIORead {
     transfer({ target, qty, }: {
         target: WalletAddress;
@@ -456,10 +470,6 @@ export interface AoARIOWrite extends AoARIORead {
     requestPrimaryName(params: AoArNSPurchaseParams, options?: WriteOptions): Promise<AoMessageResult>;
     redelegateStake(params: AoRedelegateStakeParams, options?: WriteOptions): Promise<AoMessageResult>;
 }
-export declare function isProcessConfiguration(config: object): config is {
-    process: AOProcess;
-};
-export declare function isProcessIdConfiguration(config: object): config is {
-    processId: string;
-};
+export declare function isProcessConfiguration(config: object): config is Required<ProcessConfiguration> & Record<string, never>;
+export declare function isProcessIdConfiguration(config: object): config is Required<ProcessIdConfig> & Record<string, never>;
 export declare function isLeasedArNSRecord(record: AoArNSNameData): record is AoArNSLeaseData;

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

@@ -1,7 +1,7 @@
 import Arweave from 'arweave';
 import { Logger } from '../common/index.js';
 import { AoANTRecord } from '../types/ant.js';
-import { AoClient, AoSigner, ContractSigner, WalletAddress } from '../types/index.js';
+import { AoClient, AoEpochData, AoSigner, ContractSigner, WalletAddress } from '../types/index.js';
 export type SpawnANTState = {
     owner: WalletAddress;
     controllers: WalletAddress[];
@@ -15,16 +15,22 @@ export type SpawnANTState = {
 export type SpawnANTParams = {
     signer: AoSigner;
     module?: string;
-    luaCodeTxId?: string;
     ao?: AoClient;
     scheduler?: string;
     state?: SpawnANTState;
     stateContractTxId?: string;
     antRegistryId?: string;
     logger?: Logger;
+    /**
+     * @deprecated Compiled modules are now being used instead of luaCodeTxId
+     */
+    luaCodeTxId?: string;
+    /**
+     * @deprecated no longer in use due to compiled modules being preferred
+     */
     arweave?: Arweave;
 };
-export declare function spawnANT({ signer, module, luaCodeTxId, ao, scheduler, state, stateContractTxId, antRegistryId, logger, arweave, }: SpawnANTParams): Promise<string>;
+export declare function spawnANT({ signer, module, ao, scheduler, state, stateContractTxId, antRegistryId, logger, }: SpawnANTParams): Promise<string>;
 export declare function evolveANT({ signer, processId, luaCodeTxId, ao, logger, arweave, }: {
     signer: AoSigner;
     processId: string;
@@ -41,3 +47,7 @@ export declare function initANTStateForAddress({ owner, targetId, ttlSeconds, ke
     ttlSeconds?: number;
     owner: WalletAddress;
 }): SpawnANTState;
+/**
+ * Uses zod schema to parse the epoch data
+ */
+export declare function parseAoEpochData(value: unknown): AoEpochData;

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

@@ -1,5 +1,21 @@
+/**
+ * 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 } from '../types/common.js';
-import { PaginationParams } from '../types/io.js';
+import { AoEpochData, PaginationParams } from '../types/io.js';
 export declare const validateArweaveId: (id: string) => boolean;
 export declare function isBlockHeight(height: string | number): height is BlockHeight;
 /**
@@ -18,3 +34,17 @@ export declare const paginationParamsToTags: <T>(params?: PaginationParams<T>) =
     name: string;
     value: string;
 }[];
+/**
+ * Get the epoch with distribution data for the current epoch
+ * @param arweave - The Arweave instance
+ * @returns The epoch with distribution data
+ */
+export declare const getEpochDataFromGql: ({ arweave, epochIndex, processId, }: {
+    arweave: Arweave;
+    epochIndex: number;
+    processId?: string;
+}) => Promise<AoEpochData | undefined>;
+export declare const epochDistributionNoticeGqlQuery: ({ epochIndex, processId, }: {
+    epochIndex: number;
+    processId?: string;
+}) => 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.2.0-alpha.3";
+export declare const version = "3.3.0-alpha.9";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "3.2.0",
+  "version": "3.3.0-alpha.10",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"
@@ -126,7 +126,7 @@
   "dependencies": {
     "@dha-team/arbundles": "^1.0.1",
     "@permaweb/aoconnect": "^0.0.57",
-    "arweave": "1.14.4",
+    "arweave": "1.15.5",
     "axios": "1.7.9",
     "axios-retry": "^4.3.0",
     "commander": "^12.1.0",