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

package/lib/esm/common/io.js

@@ -1,51 +1,26 @@
-/**
- * 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 { ARIO_TESTNET_PROCESS_ID } from '../constants.js';
 import { isProcessConfiguration, isProcessIdConfiguration, } from '../types/io.js';
 import { createAoSigner } from '../utils/ao.js';
 import { getEpochDataFromGql, paginationParamsToTags, pruneTags, } from '../utils/arweave.js';
+import { defaultArweave } from './arweave.js';
 import { AOProcess } from './contracts/ao-process.js';
 import { InvalidContractConfigurationError } from './error.js';
 export class ARIO {
-    static init({ arweave, ...config } = {}) {
-        if (config !== undefined && config.signer) {
-            const { signer, ...rest } = config;
-            return new ARIOWriteable({
-                ...rest,
-                signer,
-                arweave,
-            });
+    // Implementation
+    static init(config) {
+        if (config !== undefined && 'signer' in config) {
+            return new ARIOWriteable(config);
         }
-        return new ARIOReadable({
-            arweave,
-            ...config,
-        });
+        return new ARIOReadable(config);
     }
 }
 export class ARIOReadable {
     process;
     epochSettings;
     arweave;
-    constructor({ arweave = Arweave.init({
-        host: 'arweave.net',
-        port: 443,
-        protocol: 'https',
-    }), ...config }) {
-        if (config === undefined) {
+    constructor(config) {
+        this.arweave = config?.arweave ?? defaultArweave;
+        if (config === undefined || Object.keys(config).length === 0) {
             this.process = new AOProcess({
                 processId: ARIO_TESTNET_PROCESS_ID,
             });
@@ -61,7 +36,6 @@ export class ARIOReadable {
         else {
             throw new InvalidContractConfigurationError();
         }
-        this.arweave = arweave;
     }
     async getInfo() {
         return this.process.read({
@@ -463,35 +437,29 @@ export class ARIOReadable {
             tags: [{ name: 'Action', value: 'Gateway-Registry-Settings' }],
         });
     }
+    async getAllDelegates(params) {
+        return this.process.read({
+            tags: [
+                { name: 'Action', value: 'All-Paginated-Delegates' },
+                ...paginationParamsToTags(params),
+            ],
+        });
+    }
 }
 export class ARIOWriteable extends ARIOReadable {
     signer;
-    constructor({ signer, arweave, ...config }) {
-        if (Object.keys(config).length === 0) {
+    constructor({ signer, ...config }) {
+        if (config === undefined) {
             super({
                 process: new AOProcess({
                     processId: ARIO_TESTNET_PROCESS_ID,
                 }),
-                arweave: arweave,
             });
-            this.signer = createAoSigner(signer);
-        }
-        else if (isProcessConfiguration(config)) {
-            super({ process: config.process });
-            this.signer = createAoSigner(signer);
-        }
-        else if (isProcessIdConfiguration(config)) {
-            super({
-                process: new AOProcess({
-                    processId: config.processId,
-                }),
-                arweave: arweave,
-            });
-            this.signer = createAoSigner(signer);
         }
         else {
-            throw new InvalidContractConfigurationError();
+            super(config);
         }
+        this.signer = createAoSigner(signer);
     }
     async transfer({ target, qty, }, options) {
         const { tags = [] } = options || {};

package/lib/esm/constants.js

@@ -26,6 +26,6 @@ export const arioDevnetProcessId = ARIO_DEVNET_PROCESS_ID;
 export const ARIO_TESTNET_PROCESS_ID = 'agYcCFJtrMG6cqMuZfskIkFTGvUPddICmtQSBIoPdiA';
 export const ANT_REGISTRY_ID = 'i_le_yKKPVstLTDSmkHRqf-wYphMnwB9OhleiTgMkWc';
 export const MARIO_PER_ARIO = 1_000_000;
-export const AOS_MODULE_ID = 'tyojTpJ9fIva_7BjTA9ruGM4uk2vyTfhVUulnbVxR8I';
-export const ANT_LUA_ID = '16_FyX-V2QU0RPSh1GIaEETSaUjNb0oVjCFpVbAfQq4';
+export const AOS_MODULE_ID = 'BRyNPIJWZaQ4IudfNnsfvMrZBO2YDPjgKqg_wCYT2U8';
+export const ANT_LUA_ID = 'k9tQkbnFYZOGp6ist1yFuaqk_wOkzM5KUSNDtWzCLtg';
 export const DEFAULT_SCHEDULER_ID = '_GQ33BkPtZrqxA84vM8Zk-N2aO0toNNu_C-l-rawrBA';

package/lib/esm/utils/ao.js

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { createData } from '@dha-team/arbundles';
+import { ArconnectSigner, DataItem, createData } from '@dha-team/arbundles';
 import { connect, createDataItemSigner } from '@permaweb/aoconnect';
 import { z } from 'zod';
 import { defaultArweave } from '../common/arweave.js';
@@ -147,6 +147,20 @@ export function createAoSigner(signer) {
             typeof signer.setPublicKey === 'function') {
             await signer.setPublicKey();
         }
+        if (signer instanceof ArconnectSigner) {
+            // Sign using Arconnect signDataItem API
+            const signedDataItem = await signer['signer'].signDataItem({
+                data,
+                tags,
+                target,
+                anchor,
+            });
+            const dataItem = new DataItem(Buffer.from(signedDataItem));
+            return {
+                id: await dataItem.id,
+                raw: await dataItem.getRaw(),
+            };
+        }
         const dataItem = createData(data, signer, { tags, target, anchor });
         const signedData = dataItem.sign(signer).then(async () => ({
             id: await dataItem.id,

package/lib/esm/version.js

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '3.3.0-alpha.1';
+export const version = '3.3.0-alpha.10';

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

@@ -21,6 +21,9 @@ export declare function getGateway(o: AddressCLIOptions): Promise<import("../../
 export declare function listGateways(o: PaginationCLIOptions): Promise<import("../../types/io.js").PaginationResult<import("../../types/io.js").AoGatewayWithAddress> | {
     message: string;
 }>;
+export declare function listAllDelegatesCLICommand(o: PaginationCLIOptions): Promise<import("../../types/io.js").PaginationResult<import("../../types/io.js").AoAllDelegates> | {
+    message: string;
+}>;
 export declare function getGatewayDelegates(o: AddressCLIOptions): Promise<import("../../types/io.js").PaginationResult<import("../../types/io.js").AoGatewayDelegateWithAddress> | {
     message: string;
 }>;

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

@@ -1,12 +1,12 @@
 import { AoANTRegistryRead, AoANTRegistryWrite } from '../types/ant-registry.js';
 import { AoMessageResult, ProcessConfiguration, WithSigner } from '../types/index.js';
 import { AOProcess } from './index.js';
+type ANTRegistryNoSigner = ProcessConfiguration;
+type ANTRegistryWithSigner = WithSigner<ProcessConfiguration>;
 export declare class ANTRegistry {
     static init(): AoANTRegistryRead;
-    static init(config: Required<ProcessConfiguration> & {
-        signer?: undefined;
-    }): AoANTRegistryRead;
-    static init({ signer, ...config }: WithSigner<Required<ProcessConfiguration>>): AoANTRegistryWrite;
+    static init(config: ANTRegistryNoSigner): AoANTRegistryRead;
+    static init(config: ANTRegistryWithSigner): AoANTRegistryWrite;
 }
 export declare class AoANTRegistryReadable implements AoANTRegistryRead {
     protected process: AOProcess;
@@ -25,3 +25,4 @@ export declare class AoANTRegistryWriteable extends AoANTRegistryReadable implem
         processId: string;
     }): Promise<AoMessageResult>;
 }
+export {};

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/io.d.ts

@@ -14,36 +14,22 @@
  * limitations under the License.
  */
 import Arweave from 'arweave';
-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';
+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;
     protected arweave: Arweave;
-    constructor({ arweave, ...config }: ProcessConfiguration & {
-        arweave?: Arweave;
-    });
+    constructor(config?: OptionalArweave<ProcessConfiguration>);
     getInfo(): Promise<{
         Name: string;
         Ticker: string;
@@ -150,17 +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, arweave, ...config }: WithSigner<{
-        process?: AOProcess;
-    } | {
-        processId?: string;
-    }> & {
-        arweave?: Arweave;
-    });
+    constructor({ signer, ...config }: ARIOConfigWithSigner);
     transfer({ target, qty, }: {
         target: string;
         qty: number | mARIOToken;
@@ -253,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 = "tyojTpJ9fIva_7BjTA9ruGM4uk2vyTfhVUulnbVxR8I";
-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 = {
@@ -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/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";
+export declare const version = "3.3.0-alpha.9";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "3.3.0-alpha.1",
+  "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",