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

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

@@ -1,4 +1,20 @@
-import { AddressAndNameCLIOptions, AddressAndVaultIdCLIOptions, AddressCLIOptions, EpochCLIOptions, GetTokenCostCLIOptions, NameCLIOptions, PaginationAddressCLIOptions, PaginationCLIOptions } from '../types.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 { AoGetCostDetailsParams } from '../../types/io.js';
+import { AddressAndNameCLIOptions, AddressAndVaultIdCLIOptions, AddressCLIOptions, CLIOptionsFromAoParams, EpochCLIOptions, GetTokenCostCLIOptions, GlobalCLIOptions, NameCLIOptions, PaginationAddressCLIOptions, PaginationCLIOptions } from '../types.js';
 export declare function getGateway(o: AddressCLIOptions): Promise<import("../../types/io.js").AoGateway | {
     message: string;
 }>;
@@ -42,9 +58,15 @@ export declare function getPrescribedNames(o: EpochCLIOptions): Promise<string[]
     message: string;
 }>;
 export declare function getTokenCost(o: GetTokenCostCLIOptions): Promise<{
-    mIOTokenCost: number;
+    mARIOTokenCost: number;
     message: string;
 }>;
+export declare function getCostDetails(o: GlobalCLIOptions & CLIOptionsFromAoParams<AoGetCostDetailsParams>): Promise<{
+    message: string;
+    tokenCost: number;
+    discounts: import("../../types/io.js").CostDiscount[];
+    fundingPlan?: import("../../types/io.js").AoFundingPlan | undefined;
+}>;
 export declare function getPrimaryName(o: AddressAndNameCLIOptions): Promise<import("../../types/common.js").AoPrimaryName | {
     message: string;
 }>;

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

@@ -230,6 +230,10 @@ export declare const optionMap: {
         description: string;
         type: string;
     };
+    fundFrom: {
+        alias: string;
+        description: string;
+    };
 };
 export declare const walletOptions: {
     alias: string;

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

@@ -1,7 +1,7 @@
 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 { ANTStateCLIOptions, AddressCLIOptions, EpochCLIOptions, GlobalCLIOptions, InitiatorCLIOptions, JsonSerializable, PaginationCLIOptions, ProcessIdCLIOptions, RedelegateStakeCLIOptions, TransferCLIOptions, UpdateGatewaySettingsCLIOptions, WalletCLIOptions, WriteActionCLIOptions } from './types.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>;
 export interface CommanderOption {
@@ -65,3 +65,11 @@ export declare function requiredStringArrayFromOptions<O extends GlobalCLIOption
 export declare function positiveIntegerFromOptions<O extends GlobalCLIOptions>(options: O, key: string): number | undefined;
 export declare function requiredPositiveIntegerFromOptions<O extends GlobalCLIOptions>(options: O, key: string): number;
 export declare function getANTStateFromOptions(options: ANTStateCLIOptions): SpawnANTState;
+export declare function getTokenCostParamsFromOptions(o: GetTokenCostCLIOptions): {
+    type: "lease" | "permabuy";
+    quantity: number | undefined;
+    years: number;
+    intent: "Buy-Record" | "Extend-Lease" | "Increase-Undername-Limit" | "Upgrade-Name" | "Primary-Name-Request";
+    name: string;
+    fromAddress: string | undefined;
+};

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

@@ -9,12 +9,13 @@ export declare class AOProcess implements AOContract {
         ao?: AoClient;
         logger?: ILogger;
     });
-    read<K>({ tags, retries, }: {
+    read<K>({ tags, retries, fromAddress, }: {
         tags?: Array<{
             name: string;
             value: string;
         }>;
         retries?: number;
+        fromAddress?: string;
     }): Promise<K>;
     send<K>({ tags, data, signer, retries, }: {
         tags: Array<{

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, AoPaginatedAddressParams, AoRegistrationFees, AoVaultData, AoWalletVault, DemandFactorSettings, EpochInput } from '../types/io.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 { mARIOToken } from '../types/token.js';
 import { AOProcess } from './contracts/ao-process.js';
 export declare class ARIO {
@@ -107,6 +107,7 @@ export declare class ARIOReadable implements AoARIORead {
         intent: 'Primary-Name-Request';
         name: string;
     }): Promise<number>;
+    getCostDetails({ intent, type, years, name, quantity, fromAddress, fundFrom, }: AoGetCostDetailsParams): Promise<CostDetailsResult>;
     getRegistrationFees(): Promise<AoRegistrationFees>;
     getDemandFactor(): Promise<number>;
     getDemandFactorSettings(): Promise<DemandFactorSettings>;

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

@@ -252,16 +252,43 @@ export type AoRedelegateStakeParams = {
     stakeQty: number | mARIOToken;
     vaultId?: string;
 };
-export declare const validIntents: string[];
-export declare const intentsUsingYears: string[];
+export declare const validIntents: readonly ["Buy-Record", "Extend-Lease", "Increase-Undername-Limit", "Upgrade-Name", "Primary-Name-Request"];
+export declare const intentsUsingYears: readonly ["Buy-Record", "Extend-Lease"];
 export type Intent = (typeof validIntents)[number];
-export declare const isValidIntent: (intent: string) => intent is string;
+export declare const isValidIntent: (intent: string) => intent is "Buy-Record" | "Extend-Lease" | "Increase-Undername-Limit" | "Upgrade-Name" | "Primary-Name-Request";
 export type AoTokenCostParams = {
     intent: Intent;
     type?: 'permabuy' | 'lease';
     years?: number;
     name: string;
     quantity?: number;
+    fromAddress?: WalletAddress;
+};
+export declare const fundFromOptions: readonly ["balance", "stakes", "any"];
+export type FundFrom = (typeof fundFromOptions)[number];
+export declare const isValidFundFrom: (fundFrom: string) => fundFrom is "balance" | "stakes" | "any";
+export type AoGetCostDetailsParams = AoTokenCostParams & {
+    fundFrom?: FundFrom;
+};
+export type AoFundingPlan = {
+    address: WalletAddress;
+    balance: number;
+    stakes: Record<WalletAddress, {
+        vaults: string[];
+        delegatedStake: number;
+    }>;
+    /** Any remaining shortfall will indicate an insufficient balance for the action */
+    shortfall: number;
+};
+export type CostDiscount = {
+    name: string;
+    discountTotal: number;
+    multiplier: number;
+};
+export type CostDetailsResult = {
+    tokenCost: number;
+    discounts: CostDiscount[];
+    fundingPlan?: AoFundingPlan;
 };
 export type AoGetVaultParams = {
     address: WalletAddress;
@@ -353,6 +380,7 @@ export interface AoARIORead {
     getObservations(epoch?: EpochInput): Promise<AoEpochObservationData>;
     getDistributions(epoch?: EpochInput): Promise<AoEpochDistributionData>;
     getTokenCost({ intent, type, years, name, quantity, }: AoTokenCostParams): Promise<number>;
+    getCostDetails({ intent, type, years, name, quantity, fundFrom, }: AoGetCostDetailsParams): Promise<CostDetailsResult>;
     getRegistrationFees(): Promise<AoRegistrationFees>;
     getDemandFactor(): Promise<number>;
     getDemandFactorSettings(): Promise<DemandFactorSettings>;

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

@@ -2,3 +2,4 @@
 export declare function fromB64Url(str: string): Buffer;
 export declare function toB64Url(buffer: Buffer): string;
 export declare function sha256B64Url(input: Buffer): string;
+export declare function getRandomText(length?: number): 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.0.0-alpha.1";
+export declare const version = "3.0.1-alpha.1";

package/package.json

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