@liquidium/client 0.8.1 → 0.8.3

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>;
     /**
@@ -2156,6 +2177,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 +2474,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>;
     /**
@@ -2156,6 +2177,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 +2474,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

@@ -350,7 +350,14 @@ var idlFactory = ({ IDL }) => {
     "chain": Chains,
     "account": IDL.Text
   });
-  const SignatureScheme = IDL.Variant({ "Wallet": SignatureInfo });
+  const IcpCallerAuth = IDL.Record({
+    "principal": IDL.Principal,
+    "subaccount": IDL.Opt(IDL.Vec(IDL.Nat8))
+  });
+  const SignatureScheme = IDL.Variant({
+    "Wallet": SignatureInfo,
+    "IcpCaller": IcpCallerAuth
+  });
   const AddAccountRequest = IDL.Record({
     "target_principal": IDL.Principal,
     "chain": WalletType,
@@ -363,12 +370,15 @@ var idlFactory = ({ IDL }) => {
   });
   const SignatureVerificationError = IDL.Variant({
     "InvalidEthSignature": IDL.Null,
+    "IcpCallerMismatch": IDL.Null,
     "UnsupportedChain": IDL.Null,
     "InvalidSolSignature": IDL.Null,
     "InvalidEthAddress": IDL.Null,
     "CouldNotDecode": IDL.Text,
     "ProfileNotFound": IDL.Null,
-    "InvalidBtcSignature": IDL.Null
+    "InvalidBtcSignature": IDL.Null,
+    "AnonymousIcpCaller": IDL.Null,
+    "InvalidIcpSubaccount": IDL.Null
   });
   const ProtocolError = IDL.Variant({
     "PositionNotFound": IDL.Null,
@@ -936,6 +946,18 @@ var LENDING_CANISTER_SIGNATURE_VERIFICATION_ERROR_MAP = {
   InvalidBtcSignature: { code: LiquidiumErrorCode.INVALID_BTC_SIGNATURE },
   InvalidEthAddress: { code: LiquidiumErrorCode.INVALID_ETH_ADDRESS },
   UnsupportedChain: { code: LiquidiumErrorCode.UNSUPPORTED_CHAIN },
+  AnonymousIcpCaller: {
+    code: LiquidiumErrorCode.SIGNATURE_ERROR,
+    fallbackMessage: "Anonymous ICP caller"
+  },
+  InvalidIcpSubaccount: {
+    code: LiquidiumErrorCode.SIGNATURE_ERROR,
+    fallbackMessage: "Invalid ICP subaccount"
+  },
+  IcpCallerMismatch: {
+    code: LiquidiumErrorCode.SIGNATURE_ERROR,
+    fallbackMessage: "ICP caller mismatch"
+  },
   ProfileNotFound: { code: LiquidiumErrorCode.PROFILE_NOT_FOUND },
   CouldNotDecode: {
     code: LiquidiumErrorCode.SIGNATURE_ERROR,
@@ -1241,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);
@@ -1252,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);
@@ -1503,7 +1530,8 @@ var flexibleSimpleLoansIdlFactory = ({ IDL }) => {
     ProfileNotFound: IDL.Null,
     InvalidBtcSignature: IDL.Null,
     AnonymousIcpCaller: IDL.Null,
-    InvalidIcpSubaccount: IDL.Null
+    InvalidIcpSubaccount: IDL.Null,
+    IcpCallerMismatch: IDL.Null
   });
   const ProtocolError = IDL.Variant({
     PositionNotFound: IDL.Null,
@@ -1535,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({
@@ -1548,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 }),
@@ -1560,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({
@@ -4768,6 +4808,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({
@@ -4920,6 +4962,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);
@@ -4938,6 +4983,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({
@@ -5091,6 +5138,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
@@ -5116,6 +5166,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);
@@ -5240,6 +5294,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) {
@@ -6546,6 +6602,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);