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

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

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { AoAddressParams, AoArNSNameParams, AoBuyRecordParams, AoExtendLeaseParams, AoGetVaultParams, AoIncreaseUndernameLimitParams, AoJoinNetworkParams, AoTokenCostParams, PaginationParams } from '../types/io.js';
+import { AoAddressParams, AoArNSNameParams, AoGetVaultParams, AoJoinNetworkParams, AoTokenCostParams, PaginationParams } from '../types/io.js';
 export type WalletCLIOptions = {
     walletFile?: string;
     privateKey?: string;
@@ -47,6 +47,8 @@ export type ProcessIdWriteActionCLIOptions = WriteActionCLIOptions & {
 export type CLIOptionsFromAoParams<T> = {
     [K in keyof T]?: T[K] extends number | undefined ? string | undefined : T[K] extends string | boolean | symbol ? string : T[K] extends ReadonlyArray<infer U> ? ReadonlyArray<U> : T[K] extends object ? CLIOptionsFromAoParams<T[K]> : T[K];
 };
+export type CLIReadOptionsFromAoParams<T> = CLIOptionsFromAoParams<T> & GlobalCLIOptions;
+export type CLIWriteOptionsFromAoParams<T> = WriteActionCLIOptions & CLIOptionsFromAoParams<T>;
 export type PaginationCLIOptions = GlobalCLIOptions & CLIOptionsFromAoParams<PaginationParams>;
 export type AddressCLIOptions = GlobalCLIOptions & CLIOptionsFromAoParams<AoAddressParams>;
 export type ProcessIdCLIOptions = GlobalCLIOptions & {
@@ -86,10 +88,6 @@ export type OperatorStakeCLIOptions = WriteActionCLIOptions & {
 export type DecreaseDelegateStakeCLIOptions = DelegateStakeCLIOptions & {
     instant: boolean;
 };
-export type BuyRecordCLIOptions = WriteActionCLIOptions & CLIOptionsFromAoParams<AoBuyRecordParams>;
-export type UpgradeRecordCLIOptions = NameWriteCLIOptions;
-export type ExtendLeaseCLIOptions = WriteActionCLIOptions & CLIOptionsFromAoParams<AoExtendLeaseParams>;
-export type IncreaseUndernameLimitCLIOptions = WriteActionCLIOptions & CLIOptionsFromAoParams<AoIncreaseUndernameLimitParams>;
 export type ANTStateCLIOptions = WriteActionCLIOptions & {
     target?: string;
     keywords?: string[];

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

@@ -1,6 +1,6 @@
 import { JWKInterface } from 'arweave/node/lib/wallet.js';
 import { Command, OptionValues } from 'commander';
-import { ARIOToken, AoANTRead, AoANTWrite, AoARIORead, AoARIOWrite, AoRedelegateStakeParams, AoSigner, AoUpdateGatewaySettingsParams, ContractSigner, EpochInput, Logger, PaginationParams, SpawnANTState, WriteOptions, mARIOToken } from '../node/index.js';
+import { ARIOToken, AoANTRead, AoANTWrite, AoARIORead, AoARIOWrite, AoGetCostDetailsParams, AoRedelegateStakeParams, AoSigner, AoUpdateGatewaySettingsParams, ContractSigner, EpochInput, FundFrom, Logger, PaginationParams, SpawnANTState, WriteOptions, mARIOToken } from '../node/index.js';
 import { ANTStateCLIOptions, AddressCLIOptions, EpochCLIOptions, GetTokenCostCLIOptions, GlobalCLIOptions, InitiatorCLIOptions, JsonSerializable, PaginationCLIOptions, ProcessIdCLIOptions, RedelegateStakeCLIOptions, TransferCLIOptions, UpdateGatewaySettingsCLIOptions, WalletCLIOptions, WriteActionCLIOptions } from './types.js';
 export declare function stringifyJsonForCLIDisplay(json: JsonSerializable | unknown): string;
 export declare function runCommand<O extends OptionValues>(command: Command, action: (options: O) => Promise<JsonSerializable>): Promise<void>;
@@ -31,6 +31,7 @@ export declare function writeARIOFromOptions(options: GlobalCLIOptions): {
     signerAddress: string;
 };
 export declare function formatARIOWithCommas(value: ARIOToken): string;
+export declare function formatMARIOToARIOWithCommas(value: mARIOToken): string;
 /** helper to get address from --address option first, then check wallet options  */
 export declare function addressFromOptions<O extends AddressCLIOptions>(options: O): string | undefined;
 export declare function requiredAddressFromOptions<O extends AddressCLIOptions>(options: O): string;
@@ -51,8 +52,17 @@ export declare function redelegateParamsFromOptions(options: RedelegateStakeCLIO
 export declare function recordTypeFromOptions<O extends {
     type?: string;
 }>(options: O): 'lease' | 'permabuy';
-export declare function requiredMIOFromOptions<O extends GlobalCLIOptions>(options: O, key: string): mARIOToken;
-export declare function assertEnoughBalance(ario: AoARIORead, address: string, arioQuantity: ARIOToken): Promise<void>;
+export declare function requiredMARIOFromOptions<O extends GlobalCLIOptions>(options: O, key: string): mARIOToken;
+export declare function assertEnoughBalanceForArNSPurchase({ ario, address, costDetailsParams, }: {
+    ario: AoARIORead;
+    address: string;
+    costDetailsParams: AoGetCostDetailsParams;
+}): Promise<void>;
+export declare function assertEnoughMARIOBalance({ address, ario, mARIOQuantity, }: {
+    ario: AoARIORead;
+    address: string;
+    mARIOQuantity: mARIOToken | number;
+}): Promise<void>;
 export declare function confirmationPrompt(message: string): Promise<boolean>;
 export declare function assertConfirmationPrompt<O extends {
     skipConfirmation?: boolean;
@@ -73,3 +83,6 @@ export declare function getTokenCostParamsFromOptions(o: GetTokenCostCLIOptions)
     name: string;
     fromAddress: string | undefined;
 };
+export declare function fundFromFromOptions<O extends {
+    fundFrom?: string;
+}>(o: O): FundFrom;

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

@@ -15,7 +15,7 @@
  */
 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, AoArNSReservedNameDataWithName, AoDelegation, AoEpochData, AoEpochSettings, AoGateway, AoGatewayDelegateWithAddress, AoGatewayRegistrySettings, AoGatewayVault, AoGetCostDetailsParams, AoPaginatedAddressParams, AoRegistrationFees, AoVaultData, AoWalletVault, CostDetailsResult, DemandFactorSettings, EpochInput } from '../types/io.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 { mARIOToken } from '../types/token.js';
 import { AOProcess } from './contracts/ao-process.js';
 export declare class ARIO {
@@ -27,7 +27,7 @@ export declare class ARIO {
         process: AOProcess;
     }>): AoARIOWrite;
     static init({ processId, signer, }: WithSigner<{
-        processId: string;
+        processId?: string;
     }>): AoARIOWrite;
     static init({ processId, signer, }: {
         signer?: ContractSigner | undefined;
@@ -125,7 +125,7 @@ export declare class ARIOReadable implements 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;
     } | {
@@ -191,12 +191,7 @@ export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
         reportTxId: TransactionId;
         failedGateways: WalletAddress[];
     }, options?: WriteOptions): Promise<AoMessageResult>;
-    buyRecord(params: {
-        name: string;
-        years?: number;
-        type: 'lease' | 'permabuy';
-        processId: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
+    buyRecord(params: AoBuyRecordParams, options?: WriteOptions): Promise<AoMessageResult>;
     /**
      * Upgrades an existing leased record to a permabuy.
      *
@@ -205,9 +200,7 @@ export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
      * @param {Object} [options] - The options for the upgrade
      * @returns {Promise<AoMessageResult>} The result of the upgrade
      */
-    upgradeRecord(params: {
-        name: string;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
+    upgradeRecord(params: AoArNSPurchaseParams, options?: WriteOptions): Promise<AoMessageResult>;
     /**
      * Extends the lease of an existing leased record.
      *
@@ -217,14 +210,8 @@ export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
      * @param {Object} [options] - The options for the extension
      * @returns {Promise<AoMessageResult>} The result of the extension
      */
-    extendLease(params: {
-        name: string;
-        years: number;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
-    increaseUndernameLimit(params: {
-        name: string;
-        increaseCount: number;
-    }, options?: WriteOptions): Promise<AoMessageResult>;
+    extendLease(params: AoExtendLeaseParams, options?: WriteOptions): Promise<AoMessageResult>;
+    increaseUndernameLimit(params: AoIncreaseUndernameLimitParams, options?: WriteOptions): Promise<AoMessageResult>;
     /**
      * Cancel a withdrawal from a gateway.
      *
@@ -238,9 +225,7 @@ export declare class ARIOWriteable extends ARIOReadable implements AoARIOWrite {
         gatewayAddress?: WalletAddress;
         vaultId: string;
     }, options?: WriteOptions | undefined): Promise<AoMessageResult>;
-    requestPrimaryName(params: {
-        name: string;
-    }): Promise<AoMessageResult>;
+    requestPrimaryName(params: AoArNSPurchaseParams, options?: WriteOptions): Promise<AoMessageResult>;
     /**
      * Redelegate stake from one gateway to another gateway.
      *

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

@@ -52,6 +52,7 @@ export type AoPrimaryNameRequest = {
 };
 export type AoPrimaryName = {
     owner: WalletAddress;
+    processId: ProcessId;
     name: string;
     startTimestamp: Timestamp;
 };

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';
@@ -294,15 +295,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 = {
@@ -389,7 +393,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 +438,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/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.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ar.io/sdk",
-  "version": "3.1.0-alpha.1",
+  "version": "3.1.0-alpha.3",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ar-io/ar-io-sdk.git"