@ar.io/sdk 3.3.0-alpha.6 → 3.3.0-alpha.7

package/lib/cjs/common/ant-registry.js

@@ -22,12 +22,8 @@ const ao_js_1 = require("../utils/ao.js");
 const index_js_2 = require("./index.js");
 class ANTRegistry {
     static init(config) {
-        if (config && config.signer) {
-            const { signer, ...rest } = config;
-            return new AoANTRegistryWriteable({
-                ...rest,
-                signer,
-            });
+        if (config !== undefined && 'signer' in config) {
+            return new AoANTRegistryWriteable(config);
         }
         return new AoANTRegistryReadable(config);
     }
@@ -36,25 +32,22 @@ exports.ANTRegistry = ANTRegistry;
 class AoANTRegistryReadable {
     process;
     constructor(config) {
-        if (config &&
-            ((0, index_js_1.isProcessIdConfiguration)(config) || (0, index_js_1.isProcessConfiguration)(config))) {
-            if ((0, index_js_1.isProcessConfiguration)(config)) {
-                this.process = config.process;
-            }
-            else if ((0, index_js_1.isProcessIdConfiguration)(config)) {
-                this.process = new index_js_2.AOProcess({
-                    processId: config.processId,
-                });
-            }
-            else {
-                throw new index_js_2.InvalidContractConfigurationError();
-            }
-        }
-        else {
+        if (config === undefined || Object.keys(config).length === 0) {
             this.process = new index_js_2.AOProcess({
                 processId: constants_js_1.ANT_REGISTRY_ID,
             });
         }
+        else if ((0, index_js_1.isProcessConfiguration)(config)) {
+            this.process = config.process;
+        }
+        else if ((0, index_js_1.isProcessIdConfiguration)(config)) {
+            this.process = new index_js_2.AOProcess({
+                processId: config.processId,
+            });
+        }
+        else {
+            throw new index_js_2.InvalidContractConfigurationError();
+        }
     }
     // Should we rename this to "getANTsByAddress"? seems more clear, though not same as handler name
     async accessControlList({ address, }) {

package/lib/cjs/common/ant.js

@@ -23,15 +23,12 @@ const ao_js_1 = require("../utils/ao.js");
 const schema_js_1 = require("../utils/schema.js");
 const index_js_2 = require("./index.js");
 class ANT {
-    static init({ signer, strict = false, ...config }) {
-        // ao supported implementation
-        if ((0, index_js_1.isProcessConfiguration)(config) || (0, index_js_1.isProcessIdConfiguration)(config)) {
-            if (!signer) {
-                return new AoANTReadable({ strict, ...config });
-            }
-            return new AoANTWriteable({ signer, strict, ...config });
+    // implementation
+    static init(config) {
+        if (config !== undefined && 'signer' in config) {
+            return new AoANTWriteable(config);
         }
-        throw new index_js_2.InvalidContractConfigurationError();
+        return new AoANTReadable(config);
     }
 }
 exports.ANT = ANT;

package/lib/cjs/common/io.js

@@ -9,19 +9,12 @@ const arweave_js_2 = require("./arweave.js");
 const ao_process_js_1 = require("./contracts/ao-process.js");
 const error_js_1 = require("./error.js");
 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);
     }
 }
 exports.ARIO = ARIO;
@@ -29,8 +22,9 @@ class ARIOReadable {
     process;
     epochSettings;
     arweave;
-    constructor({ arweave = arweave_js_2.defaultArweave, ...config }) {
-        if (config === undefined) {
+    constructor(config) {
+        this.arweave = config?.arweave ?? arweave_js_2.defaultArweave;
+        if (config === undefined || Object.keys(config).length === 0) {
             this.process = new ao_process_js_1.AOProcess({
                 processId: constants_js_1.ARIO_TESTNET_PROCESS_ID,
             });
@@ -46,7 +40,6 @@ class ARIOReadable {
         else {
             throw new error_js_1.InvalidContractConfigurationError();
         }
-        this.arweave = arweave;
     }
     async getInfo() {
         return this.process.read({
@@ -460,32 +453,18 @@ class ARIOReadable {
 exports.ARIOReadable = ARIOReadable;
 class ARIOWriteable extends ARIOReadable {
     signer;
-    constructor({ signer, arweave, ...config }) {
-        if (Object.keys(config).length === 0) {
+    constructor({ signer, ...config }) {
+        if (config === undefined) {
             super({
                 process: new ao_process_js_1.AOProcess({
                     processId: constants_js_1.ARIO_TESTNET_PROCESS_ID,
                 }),
-                arweave: arweave,
             });
-            this.signer = (0, ao_js_1.createAoSigner)(signer);
-        }
-        else if ((0, io_js_1.isProcessConfiguration)(config)) {
-            super({ process: config.process });
-            this.signer = (0, ao_js_1.createAoSigner)(signer);
-        }
-        else if ((0, io_js_1.isProcessIdConfiguration)(config)) {
-            super({
-                process: new ao_process_js_1.AOProcess({
-                    processId: config.processId,
-                }),
-                arweave: arweave,
-            });
-            this.signer = (0, ao_js_1.createAoSigner)(signer);
         }
         else {
-            throw new error_js_1.InvalidContractConfigurationError();
+            super(config);
         }
+        this.signer = (0, ao_js_1.createAoSigner)(signer);
     }
     async transfer({ target, qty, }, options) {
         const { tags = [] } = options || {};

package/lib/cjs/version.js

@@ -17,4 +17,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '3.3.0-alpha.6';
+exports.version = '3.3.0-alpha.7';

package/lib/esm/common/ant-registry.js

@@ -19,12 +19,8 @@ import { createAoSigner } from '../utils/ao.js';
 import { AOProcess, InvalidContractConfigurationError } from './index.js';
 export class ANTRegistry {
     static init(config) {
-        if (config && config.signer) {
-            const { signer, ...rest } = config;
-            return new AoANTRegistryWriteable({
-                ...rest,
-                signer,
-            });
+        if (config !== undefined && 'signer' in config) {
+            return new AoANTRegistryWriteable(config);
         }
         return new AoANTRegistryReadable(config);
     }
@@ -32,25 +28,22 @@ export class ANTRegistry {
 export class AoANTRegistryReadable {
     process;
     constructor(config) {
-        if (config &&
-            (isProcessIdConfiguration(config) || isProcessConfiguration(config))) {
-            if (isProcessConfiguration(config)) {
-                this.process = config.process;
-            }
-            else if (isProcessIdConfiguration(config)) {
-                this.process = new AOProcess({
-                    processId: config.processId,
-                });
-            }
-            else {
-                throw new InvalidContractConfigurationError();
-            }
-        }
-        else {
+        if (config === undefined || Object.keys(config).length === 0) {
             this.process = new AOProcess({
                 processId: ANT_REGISTRY_ID,
             });
         }
+        else if (isProcessConfiguration(config)) {
+            this.process = config.process;
+        }
+        else if (isProcessIdConfiguration(config)) {
+            this.process = new AOProcess({
+                processId: config.processId,
+            });
+        }
+        else {
+            throw new InvalidContractConfigurationError();
+        }
     }
     // Should we rename this to "getANTsByAddress"? seems more clear, though not same as handler name
     async accessControlList({ address, }) {

package/lib/esm/common/ant.js

@@ -20,15 +20,12 @@ import { createAoSigner } from '../utils/ao.js';
 import { parseSchemaResult } from '../utils/schema.js';
 import { AOProcess, InvalidContractConfigurationError } from './index.js';
 export class ANT {
-    static init({ signer, strict = false, ...config }) {
-        // ao supported implementation
-        if (isProcessConfiguration(config) || isProcessIdConfiguration(config)) {
-            if (!signer) {
-                return new AoANTReadable({ strict, ...config });
-            }
-            return new AoANTWriteable({ signer, strict, ...config });
+    // implementation
+    static init(config) {
+        if (config !== undefined && 'signer' in config) {
+            return new AoANTWriteable(config);
         }
-        throw new InvalidContractConfigurationError();
+        return new AoANTReadable(config);
     }
 }
 export class AoANTReadable {

package/lib/esm/common/io.js

@@ -6,27 +6,21 @@ 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 = defaultArweave, ...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,
             });
@@ -42,7 +36,6 @@ export class ARIOReadable {
         else {
             throw new InvalidContractConfigurationError();
         }
-        this.arweave = arweave;
     }
     async getInfo() {
         return this.process.read({
@@ -455,32 +448,18 @@ export class ARIOReadable {
 }
 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/version.js

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

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 { 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;
@@ -155,13 +141,7 @@ export declare class ARIOReadable implements AoARIORead {
 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;
@@ -254,3 +234,4 @@ export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
         vaultId?: string;
     }, options?: WriteOptions): Promise<AoMessageResult>;
 }
+export {};

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 = {
@@ -465,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.3.0-alpha.5";
+export declare const version = "3.3.0-alpha.6";

package/package.json

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