@liquidium/client 0.8.2 → 0.9.0

package/dist/index.d.cts

@@ -417,6 +417,8 @@ declare class AccountsModule {
      *
      * @param options - `account` is the wallet address that will own the new profile.
      * @returns A signable {@link CreateAccountAction} with `submit` wired to the canister.
+     * @throws {@link LiquidiumError} If account validation or protocol
+     * preparation fails.
      */
     prepareCreateProfile(options: PrepareCreateProfileOptions): Promise<CreateAccountAction>;
     /**
@@ -426,6 +428,9 @@ declare class AccountsModule {
      *
      * @param params - Wallet `account`, signing `chain`, and `walletAdapter` with `signMessage`.
      * @returns The new profile principal as text.
+     * @throws {@link LiquidiumError} If SDK validation or protocol submission
+     * fails.
+     * @throws `Error` If the wallet adapter rejects message signing.
      */
     createProfile(params: CreateProfileParams): Promise<string>;
     /**
@@ -1087,6 +1092,8 @@ declare class LendingModule {
      * Use this when you need explicit control over signing and submission.
      * @param request - Profile, pool, amount (pool asset base units), outflow address, and signer wallet.
      * @returns A signable {@link WithdrawAction} with `submit` wired to the canister.
+     * @throws {@link LiquidiumError} If request validation, destination
+     * validation, or protocol preparation fails.
      */
     prepareWithdraw(request: CreateWithdrawRequest): Promise<WithdrawAction>;
     private submitWithdraw;
@@ -1097,6 +1104,9 @@ declare class LendingModule {
      *
      * @param params - Withdraw request fields plus `signerChain` and `signerWalletAdapter`.
      * @returns The canister {@link OutflowDetails} for the completed withdraw.
+     * @throws {@link LiquidiumError} If SDK validation or protocol submission
+     * fails.
+     * @throws `Error` If the wallet adapter rejects message signing.
      */
     withdraw(params: CreateWithdrawRequest & WalletExecutionParams): Promise<WithdrawOutflowDetails>;
     /**
@@ -1108,6 +1118,8 @@ declare class LendingModule {
      *
      * @param request - Profile, pool, amount (borrow asset base units), outflow address, and signer wallet.
      * @returns A signable {@link BorrowAction} with `submit` wired to the canister.
+     * @throws {@link LiquidiumError} If request validation, destination
+     * validation, or protocol preparation fails.
      */
     prepareBorrow(request: CreateBorrowRequest): Promise<BorrowAction>;
     private submitBorrow;
@@ -1119,6 +1131,9 @@ declare class LendingModule {
      *
      * @param params - Borrow request fields plus `signerChain` and `signerWalletAdapter`.
      * @returns The lending canister receipt as {@link OutflowDetails}.
+     * @throws {@link LiquidiumError} If SDK validation or protocol submission
+     * fails.
+     * @throws `Error` If the wallet adapter rejects message signing.
      *
      * @remarks
      * `id` is always present. `txid` may be missing on the first response; the SDK does not
@@ -1137,6 +1152,10 @@ declare class LendingModule {
      *
      * @returns A {@link SupplyFlow} receipt with `type`, `target`, `submit`, and
      *   an optional `txid` present when the SDK broadcast for you.
+     * @throws {@link LiquidiumError} If validation, transfer planning, or
+     * protocol submission fails.
+     * @throws `Error` If the wallet adapter rejects or fails to broadcast a
+     * transaction.
      */
     supply(request: SupplyFlowRequest): Promise<SupplyFlow>;
     /**
@@ -1179,6 +1198,8 @@ declare class LendingModule {
      *
      * @param request - Broadcast `txid` plus inflow `operation` and optional `chain`.
      * @returns Acknowledgement including the submitted `txid`.
+     * @throws {@link LiquidiumError} If the chain is unsupported or the API
+     * request fails.
      */
     submitInflow(request: SubmitInflowRequest): Promise<SubmitInflowResponse>;
     /**
@@ -1226,6 +1247,8 @@ interface Pool {
     protocolLiquidationFee: bigint;
     /** Reserve factor in basis points. */
     reserveFactor: bigint;
+    /** Borrow activation fee in basis points; zero on canisters without this field. */
+    activationFee: bigint;
     /** Decimal scale used by APR and utilization fields. */
     rateDecimals: bigint;
     /** Current supply APR, scaled by `rateDecimals`. */
@@ -1593,7 +1616,7 @@ declare enum QuoteWarningCode {
 interface QuoteResult {
     /** Requested borrow amount in borrow asset base units. */
     borrowAmount: bigint;
-    /** Borrow value in internal USD units. */
+    /** Opening debt value, including the activation fee, in internal USD units. */
     borrowUsd: bigint;
     /** Required collateral amount in collateral asset base units. */
     requiredCollateralAmount: bigint;
@@ -1622,7 +1645,7 @@ interface LtvCalculation {
     borrowAmount: bigint;
     /** Collateral amount in collateral asset base units. */
     collateralAmount: bigint;
-    /** Borrow value in internal USD units. */
+    /** Opening debt value, including the activation fee, in internal USD units. */
     borrowUsd: bigint;
     /** Collateral value in internal USD units. */
     collateralUsd: bigint;
@@ -1813,7 +1836,7 @@ interface CreateSimpleLoanRequest {
      * Maximum allowed loan-to-value ratio in basis points.
      *
      * `6_000n` means 60%. Use `client.quote.calculateLtv(...)` to calculate the
-     * implied LTV for the selected amounts and pass the policy value your app is
+     * fee-inclusive LTV for the selected amounts and pass the policy value your app is
      * willing to accept. Creation is rejected if the requested borrow would exceed
      * this limit.
      */
@@ -2156,6 +2179,10 @@ declare class SimpleLoansModule {
      *
      * @param request - Collateral, borrow, refund, LTV limit, timeout, and inflow options.
      * @returns Hydrated loan state plus generated initial-deposit and repayment quote targets.
+     * @throws {@link LiquidiumError} If request validation, API transport, or
+     * protocol validation fails before creation.
+     * @throws {@link SimpleLoanCreatedError} If the remote loan is created but
+     * the SDK cannot load its hydrated state.
      */
     create(request: CreateSimpleLoanRequest): Promise<SimpleLoan>;
     /**
@@ -2449,6 +2476,10 @@ interface ExecuteWithOptions {
  *
  * @param options - Adapter and optional chain/account overrides.
  * @returns A function that accepts a `WalletAction` and resolves with its submit result.
+ * @throws {@link LiquidiumError} with code `LiquidiumErrorCode.VALIDATION_ERROR`
+ * if a required wallet capability or signing chain is missing, or if
+ * `action.executionKind` is unsupported.
+ * @throws `Error` If the wallet adapter or action submission fails.
  */
 declare function executeWith(options: ExecuteWithOptions): <TResult>(action: WalletAction<TResult>) => Promise<TResult>;
 

package/dist/index.d.ts

@@ -417,6 +417,8 @@ declare class AccountsModule {
      *
      * @param options - `account` is the wallet address that will own the new profile.
      * @returns A signable {@link CreateAccountAction} with `submit` wired to the canister.
+     * @throws {@link LiquidiumError} If account validation or protocol
+     * preparation fails.
      */
     prepareCreateProfile(options: PrepareCreateProfileOptions): Promise<CreateAccountAction>;
     /**
@@ -426,6 +428,9 @@ declare class AccountsModule {
      *
      * @param params - Wallet `account`, signing `chain`, and `walletAdapter` with `signMessage`.
      * @returns The new profile principal as text.
+     * @throws {@link LiquidiumError} If SDK validation or protocol submission
+     * fails.
+     * @throws `Error` If the wallet adapter rejects message signing.
      */
     createProfile(params: CreateProfileParams): Promise<string>;
     /**
@@ -1087,6 +1092,8 @@ declare class LendingModule {
      * Use this when you need explicit control over signing and submission.
      * @param request - Profile, pool, amount (pool asset base units), outflow address, and signer wallet.
      * @returns A signable {@link WithdrawAction} with `submit` wired to the canister.
+     * @throws {@link LiquidiumError} If request validation, destination
+     * validation, or protocol preparation fails.
      */
     prepareWithdraw(request: CreateWithdrawRequest): Promise<WithdrawAction>;
     private submitWithdraw;
@@ -1097,6 +1104,9 @@ declare class LendingModule {
      *
      * @param params - Withdraw request fields plus `signerChain` and `signerWalletAdapter`.
      * @returns The canister {@link OutflowDetails} for the completed withdraw.
+     * @throws {@link LiquidiumError} If SDK validation or protocol submission
+     * fails.
+     * @throws `Error` If the wallet adapter rejects message signing.
      */
     withdraw(params: CreateWithdrawRequest & WalletExecutionParams): Promise<WithdrawOutflowDetails>;
     /**
@@ -1108,6 +1118,8 @@ declare class LendingModule {
      *
      * @param request - Profile, pool, amount (borrow asset base units), outflow address, and signer wallet.
      * @returns A signable {@link BorrowAction} with `submit` wired to the canister.
+     * @throws {@link LiquidiumError} If request validation, destination
+     * validation, or protocol preparation fails.
      */
     prepareBorrow(request: CreateBorrowRequest): Promise<BorrowAction>;
     private submitBorrow;
@@ -1119,6 +1131,9 @@ declare class LendingModule {
      *
      * @param params - Borrow request fields plus `signerChain` and `signerWalletAdapter`.
      * @returns The lending canister receipt as {@link OutflowDetails}.
+     * @throws {@link LiquidiumError} If SDK validation or protocol submission
+     * fails.
+     * @throws `Error` If the wallet adapter rejects message signing.
      *
      * @remarks
      * `id` is always present. `txid` may be missing on the first response; the SDK does not
@@ -1137,6 +1152,10 @@ declare class LendingModule {
      *
      * @returns A {@link SupplyFlow} receipt with `type`, `target`, `submit`, and
      *   an optional `txid` present when the SDK broadcast for you.
+     * @throws {@link LiquidiumError} If validation, transfer planning, or
+     * protocol submission fails.
+     * @throws `Error` If the wallet adapter rejects or fails to broadcast a
+     * transaction.
      */
     supply(request: SupplyFlowRequest): Promise<SupplyFlow>;
     /**
@@ -1179,6 +1198,8 @@ declare class LendingModule {
      *
      * @param request - Broadcast `txid` plus inflow `operation` and optional `chain`.
      * @returns Acknowledgement including the submitted `txid`.
+     * @throws {@link LiquidiumError} If the chain is unsupported or the API
+     * request fails.
      */
     submitInflow(request: SubmitInflowRequest): Promise<SubmitInflowResponse>;
     /**
@@ -1226,6 +1247,8 @@ interface Pool {
     protocolLiquidationFee: bigint;
     /** Reserve factor in basis points. */
     reserveFactor: bigint;
+    /** Borrow activation fee in basis points; zero on canisters without this field. */
+    activationFee: bigint;
     /** Decimal scale used by APR and utilization fields. */
     rateDecimals: bigint;
     /** Current supply APR, scaled by `rateDecimals`. */
@@ -1593,7 +1616,7 @@ declare enum QuoteWarningCode {
 interface QuoteResult {
     /** Requested borrow amount in borrow asset base units. */
     borrowAmount: bigint;
-    /** Borrow value in internal USD units. */
+    /** Opening debt value, including the activation fee, in internal USD units. */
     borrowUsd: bigint;
     /** Required collateral amount in collateral asset base units. */
     requiredCollateralAmount: bigint;
@@ -1622,7 +1645,7 @@ interface LtvCalculation {
     borrowAmount: bigint;
     /** Collateral amount in collateral asset base units. */
     collateralAmount: bigint;
-    /** Borrow value in internal USD units. */
+    /** Opening debt value, including the activation fee, in internal USD units. */
     borrowUsd: bigint;
     /** Collateral value in internal USD units. */
     collateralUsd: bigint;
@@ -1813,7 +1836,7 @@ interface CreateSimpleLoanRequest {
      * Maximum allowed loan-to-value ratio in basis points.
      *
      * `6_000n` means 60%. Use `client.quote.calculateLtv(...)` to calculate the
-     * implied LTV for the selected amounts and pass the policy value your app is
+     * fee-inclusive LTV for the selected amounts and pass the policy value your app is
      * willing to accept. Creation is rejected if the requested borrow would exceed
      * this limit.
      */
@@ -2156,6 +2179,10 @@ declare class SimpleLoansModule {
      *
      * @param request - Collateral, borrow, refund, LTV limit, timeout, and inflow options.
      * @returns Hydrated loan state plus generated initial-deposit and repayment quote targets.
+     * @throws {@link LiquidiumError} If request validation, API transport, or
+     * protocol validation fails before creation.
+     * @throws {@link SimpleLoanCreatedError} If the remote loan is created but
+     * the SDK cannot load its hydrated state.
      */
     create(request: CreateSimpleLoanRequest): Promise<SimpleLoan>;
     /**
@@ -2449,6 +2476,10 @@ interface ExecuteWithOptions {
  *
  * @param options - Adapter and optional chain/account overrides.
  * @returns A function that accepts a `WalletAction` and resolves with its submit result.
+ * @throws {@link LiquidiumError} with code `LiquidiumErrorCode.VALIDATION_ERROR`
+ * if a required wallet capability or signing chain is missing, or if
+ * `action.executionKind` is unsupported.
+ * @throws `Error` If the wallet adapter or action submission fails.
  */
 declare function executeWith(options: ExecuteWithOptions): <TResult>(action: WalletAction<TResult>) => Promise<TResult>;
 

package/dist/index.js

@@ -1263,6 +1263,8 @@ var AccountsModule = class {
    *
    * @param options - `account` is the wallet address that will own the new profile.
    * @returns A signable {@link CreateAccountAction} with `submit` wired to the canister.
+   * @throws {@link LiquidiumError} If account validation or protocol
+   * preparation fails.
    */
   async prepareCreateProfile(options) {
     return await this.buildCreateProfileAction(options.account);
@@ -1274,6 +1276,9 @@ var AccountsModule = class {
    *
    * @param params - Wallet `account`, signing `chain`, and `walletAdapter` with `signMessage`.
    * @returns The new profile principal as text.
+   * @throws {@link LiquidiumError} If SDK validation or protocol submission
+   * fails.
+   * @throws `Error` If the wallet adapter rejects message signing.
    */
   async createProfile(params) {
     const account = normalizeProfileAccount(params.account);
@@ -1558,6 +1563,7 @@ var flexibleSimpleLoansIdlFactory = ({ IDL }) => {
   });
   const SimpleLoansError = IDL.Variant({
     BorrowAmountRequired: IDL.Null,
+    AnonymousPrincipalNotAllowed: IDL.Null,
     NoCollateralPosition: IDL.Record({ loan_id: IDL.Nat }),
     LtvTimerOutOfRange: IDL.Record({ max: IDL.Nat64 }),
     LtvMaxExceeded: IDL.Record({
@@ -1571,6 +1577,11 @@ var flexibleSimpleLoansIdlFactory = ({ IDL }) => {
       CallRejected: IDL.Record({ method: IDL.Text, reason: IDL.Text }),
       DecodeFailed: IDL.Record({ method: IDL.Text, reason: IDL.Text })
     }),
+    PoolNotFound: IDL.Record({ pool_id: IDL.Principal }),
+    LendingCanisterImmutable: IDL.Record({
+      requested: IDL.Principal,
+      configured: IDL.Principal
+    }),
     LtvMaxOutOfRange: IDL.Record({ max: IDL.Nat64 }),
     AccountRequired: IDL.Record({ label: IDL.Text }),
     DepositTimerExceeded: IDL.Record({ loan_id: IDL.Nat }),
@@ -1583,8 +1594,14 @@ var flexibleSimpleLoansIdlFactory = ({ IDL }) => {
     DepositAlreadyProcessed: IDL.Record({ loan_id: IDL.Nat }),
     MissingPrice: IDL.Record({ symbol: IDL.Text }),
     InvalidLtvTimerS: IDL.Null,
+    PoolLendingDisabled: IDL.Record({ pool_id: IDL.Principal }),
     DebtNotFullyRepaid: IDL.Record({ loan_id: IDL.Nat }),
     EmptyCollateralPosition: IDL.Null,
+    PoolAssetMismatch: IDL.Record({
+      configured_asset: IDL.Unknown,
+      requested_asset: IDL.Unknown,
+      pool_id: IDL.Principal
+    }),
     SigningFailed: IDL.Record({ reason: IDL.Text })
   });
   const CreateLoanRequest = IDL.Record({
@@ -3190,7 +3207,8 @@ var flexibleLendingIdlFactory = ({ IDL }) => {
     same_asset_borrowing: IDL.Opt(IDL.Bool),
     same_asset_borrowing_dust_threshold: IDL.Nat,
     frozen: IDL.Bool,
-    last_updated: IDL.Opt(IDL.Nat64)
+    last_updated: IDL.Opt(IDL.Nat64),
+    activation_fee: IDL.Opt(IDL.Nat64)
   });
   const BorrowingPowerRecord = IDL.Record({
     max_borrowable_usd: IDL.Nat,
@@ -3296,7 +3314,8 @@ function decodeFlexiblePool(pool) {
     same_asset_borrowing: pool.same_asset_borrowing,
     same_asset_borrowing_dust_threshold: pool.same_asset_borrowing_dust_threshold,
     frozen: pool.frozen,
-    last_updated: pool.last_updated
+    last_updated: pool.last_updated,
+    activation_fee: pool.activation_fee ?? []
   };
 }
 function decodeFlexiblePosition(position) {
@@ -4791,6 +4810,8 @@ var LendingModule = class {
    * Use this when you need explicit control over signing and submission.
    * @param request - Profile, pool, amount (pool asset base units), outflow address, and signer wallet.
    * @returns A signable {@link WithdrawAction} with `submit` wired to the canister.
+   * @throws {@link LiquidiumError} If request validation, destination
+   * validation, or protocol preparation fails.
    */
   async prepareWithdraw(request) {
     const destination = resolveOutflowDestinationInput({
@@ -4943,6 +4964,9 @@ var LendingModule = class {
    *
    * @param params - Withdraw request fields plus `signerChain` and `signerWalletAdapter`.
    * @returns The canister {@link OutflowDetails} for the completed withdraw.
+   * @throws {@link LiquidiumError} If SDK validation or protocol submission
+   * fails.
+   * @throws `Error` If the wallet adapter rejects message signing.
    */
   async withdraw(params) {
     const action = await this.prepareWithdraw(params);
@@ -4961,6 +4985,8 @@ var LendingModule = class {
    *
    * @param request - Profile, pool, amount (borrow asset base units), outflow address, and signer wallet.
    * @returns A signable {@link BorrowAction} with `submit` wired to the canister.
+   * @throws {@link LiquidiumError} If request validation, destination
+   * validation, or protocol preparation fails.
    */
   async prepareBorrow(request) {
     const destination = resolveOutflowDestinationInput({
@@ -5114,6 +5140,9 @@ var LendingModule = class {
    *
    * @param params - Borrow request fields plus `signerChain` and `signerWalletAdapter`.
    * @returns The lending canister receipt as {@link OutflowDetails}.
+   * @throws {@link LiquidiumError} If SDK validation or protocol submission
+   * fails.
+   * @throws `Error` If the wallet adapter rejects message signing.
    *
    * @remarks
    * `id` is always present. `txid` may be missing on the first response; the SDK does not
@@ -5139,6 +5168,10 @@ var LendingModule = class {
    *
    * @returns A {@link SupplyFlow} receipt with `type`, `target`, `submit`, and
    *   an optional `txid` present when the SDK broadcast for you.
+   * @throws {@link LiquidiumError} If validation, transfer planning, or
+   * protocol submission fails.
+   * @throws `Error` If the wallet adapter rejects or fails to broadcast a
+   * transaction.
    */
   async supply(request) {
     return await this.createSupplyFlowExecutor().create(request);
@@ -5263,6 +5296,8 @@ var LendingModule = class {
    *
    * @param request - Broadcast `txid` plus inflow `operation` and optional `chain`.
    * @returns Acknowledgement including the submitted `txid`.
+   * @throws {@link LiquidiumError} If the chain is unsupported or the API
+   * request fails.
    */
   async submitInflow(request) {
     if (request.chain !== void 0 && request.chain !== Chain.BTC && request.chain !== Chain.ETH) {
@@ -5508,6 +5543,7 @@ function mapDecodedPoolToPool(pool, rate) {
     liquidationBonus: pool.liquidation_bonus,
     protocolLiquidationFee: pool.protocol_liquidation_fee,
     reserveFactor: pool.reserve_factor,
+    activationFee: pool.activation_fee[0] ?? 0n,
     rateDecimals: RATE_DECIMALS,
     lendingRate: rate[1],
     estimatedLendingApy: estimateSupplyApy(rate[1]),
@@ -6154,7 +6190,7 @@ var QuoteModule = class {
       });
     }
     const borrowUsd = computeUsdInternalFromBaseUnits({
-      amountBaseUnits: request.borrowAmount,
+      amountBaseUnits: getOpeningDebt(request.borrowAmount, borrowPool),
       priceScaled: scalePriceUsdToBigint(borrowPrice),
       assetDecimalPlaces: getPoolDecimalPlaces(borrowPool)
     });
@@ -6311,7 +6347,7 @@ var QuoteModule = class {
       collateralPrice
     );
     const borrowUsdInternal = computeUsdInternalFromBaseUnits({
-      amountBaseUnits: borrowAmount,
+      amountBaseUnits: getOpeningDebt(borrowAmount, borrowPool),
       priceScaled: borrowPriceScaled,
       assetDecimalPlaces: borrowAssetDecimals
     });
@@ -6359,6 +6395,9 @@ var QuoteModule = class {
     });
   }
 };
+function getOpeningDebt(borrowAmount, borrowPool) {
+  return borrowAmount + borrowAmount * borrowPool.activationFee / BASIS_POINTS_DENOMINATOR;
+}
 function createLtvCalculation(params) {
   return {
     borrowAmount: params.request.borrowAmount,
@@ -6569,6 +6608,10 @@ var SimpleLoansModule = class {
    *
    * @param request - Collateral, borrow, refund, LTV limit, timeout, and inflow options.
    * @returns Hydrated loan state plus generated initial-deposit and repayment quote targets.
+   * @throws {@link LiquidiumError} If request validation, API transport, or
+   * protocol validation fails before creation.
+   * @throws {@link SimpleLoanCreatedError} If the remote loan is created but
+   * the SDK cannot load its hydrated state.
    */
   async create(request) {
     validateCreateRequest(request);