@ar.io/sdk 3.0.1-alpha.1 → 3.1.0-alpha.2

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

@@ -252,30 +252,60 @@ 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;
     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 = {
@@ -353,6 +383,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>;
@@ -406,16 +437,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.0";
+export declare const version = "3.1.0-alpha.1";

package/package.json

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