@liquidium/client 0.2.0 → 0.2.1

package/README.md

@@ -14,7 +14,7 @@
 <p align="center">
   <a href="https://liquidium-inc.github.io/liquidium-sdk/"><b>SDK Docs</b></a> ·
   <a href="https://github.com/Liquidium-Inc/liquidium-sdk/tree/main/examples/instant-loans-flow"><b>Instant Loan Example</b></a> ·
-  <a href="https://github.com/Liquidium-Inc/liquidium-sdk/tree/main/examples/vite-react-dynamic"><b>SDK Method Query Example</b></a> ·
+  <a href="https://github.com/Liquidium-Inc/liquidium-sdk/tree/main/examples/sdk-method-query"><b>SDK Method Query Example</b></a> ·
   <a href="#core-api"><b>Core API</b></a>
 </p>
 
@@ -148,7 +148,7 @@ Instant-loan integrations use this sequence:
 | Step | SDK call | What your app does |
 | --- | --- | --- |
 | Load market data | `client.market.listPools()` and `client.market.getAssetPrices()` | Show supported collateral and borrow assets |
-| Validate amounts | `client.quote.calculateLtv(...)` | Block invalid LTV or frozen-pool input before creating a loan |
+| Validate amounts | `client.quote.calculateLtv(...)` | Block too-small borrow amounts, invalid LTV, or frozen-pool input before creating a loan |
 | Create loan | `client.instantLoans.create(...)` | Store `loan.ref` and show `loan.initialDeposit.amount` plus `loan.initialDeposit.target` |
 | Track loan | `client.instantLoans.get({ ref })` and `client.activities.list({ shortRef: ref })` | Reload loan state, initial deposit quote, and repayment activity |
 | Repay loan | Read `loan.repayment` | Ask the user to send `loan.repayment.amount` to `loan.repayment.target`; amount is `0n` when no repayment is due |
@@ -168,7 +168,7 @@ Creates an accountless instant loan and returns generated transfer targets.
 | `collateralAsset` | Collateral asset symbol, for example `"BTC"` |
 | `borrowAsset` | Borrow asset symbol, for example `"USDC"` |
 | `collateralAmount` | Intended credited collateral amount in base units, before deposit/inflow fees |
-| `borrowAmount` | Borrow amount in base units |
+| `borrowAmount` | Borrow amount in base units. The SDK rejects values below the asset minimum. |
 | `ltvMaxBps` | Maximum LTV in basis points, where `6_000n` is 60% |
 | `depositWindowSeconds` | How long the user has to send collateral |
 | `borrowDestination` | External address that receives borrowed funds |
@@ -200,6 +200,18 @@ Calculates implied LTV from selected pools, prices, borrow amount, and collatera
 
 Use this before `client.instantLoans.create(...)` so your app can block invalid input and choose a safe `ltvMaxBps`.
 
+### Borrow minimums
+
+The SDK enforces product minimums before borrow creation:
+
+| Asset | Minimum borrow amount |
+| --- | --- |
+| BTC | `5_100n` sats |
+| USDC | `1_000_000n` base units |
+| USDT | `1_000_000n` base units |
+
+Use `getMinimumBorrowAmount(asset)` to display the same minimum that `client.quote.calculateLtv(...)`, `client.quote.getQuote(...)`, `client.instantLoans.create(...)`, and `client.lending.prepareBorrow(...)` enforce.
+
 ## Response Fields
 
 Most instant-loan UIs show or store these fields:
@@ -255,7 +267,7 @@ Start browser integrations with the examples.
 | Example | What it shows |
 | --- | --- |
 | [`examples/instant-loans-flow`](https://github.com/Liquidium-Inc/liquidium-sdk/tree/main/examples/instant-loans-flow) | Accountless instant loan UX with manual destination addresses, pool selection, LTV preview, loan creation, status reload, activity status, and address recovery |
-| [`examples/vite-react-dynamic`](https://github.com/Liquidium-Inc/liquidium-sdk/tree/main/examples/vite-react-dynamic) | Developer tool for calling SDK methods, including instant loan method templates |
+| [`examples/sdk-method-query`](https://github.com/Liquidium-Inc/liquidium-sdk/tree/main/examples/sdk-method-query) | Developer tool for calling SDK methods, including instant loan method templates |
 
 Run the instant loan example:
 

package/dist/index.cjs

@@ -3107,6 +3107,39 @@ function assertSupportsIcrcAccountInflowTarget(asset) {
   );
 }
 
+// src/core/borrow-minimums.ts
+var MIN_BORROW_AMOUNTS_BY_ASSET = {
+  BTC: 5100n,
+  // 5,100 sats = 0.000051 BTC
+  USDC: 1000000n,
+  // 1 USDC
+  USDT: 1000000n
+  // 1 USDT
+};
+function getMinimumBorrowAmount(asset) {
+  if (!isMinimumBorrowAsset(asset)) {
+    return 0n;
+  }
+  return MIN_BORROW_AMOUNTS_BY_ASSET[asset];
+}
+function getBorrowAmountMinimumValidationError(params) {
+  const minimumAmount = getMinimumBorrowAmount(params.asset);
+  if (minimumAmount <= 0n || params.amount >= minimumAmount) {
+    return null;
+  }
+  return {
+    asset: params.asset,
+    minimumAmount,
+    message: formatMinimumBorrowAmountMessage(params.asset, minimumAmount)
+  };
+}
+function formatMinimumBorrowAmountMessage(asset, minimumAmount) {
+  return `Borrow amount must be at least ${minimumAmount} base units for ${asset}`;
+}
+function isMinimumBorrowAsset(asset) {
+  return Object.hasOwn(MIN_BORROW_AMOUNTS_BY_ASSET, asset);
+}
+
 // src/modules/quote/types.ts
 var QuoteValidationErrorCode = /* @__PURE__ */ ((QuoteValidationErrorCode2) => {
   QuoteValidationErrorCode2["INVALID_LTV"] = "INVALID_LTV";
@@ -3129,7 +3162,6 @@ var BASIS_POINTS_DENOMINATOR = 10000n;
 var BPS_PER_PERCENT = 100n;
 var MIN_LTV_BPS = 0n;
 var HIGH_LTV_WARNING_THRESHOLD_BPS = 8000n;
-var MIN_BORROW_AMOUNT_BASE_UNITS = 5000n;
 var INTERNAL_USD_DECIMAL_PLACES = 8;
 var PRICE_SCALE_DECIMAL_PLACES = 8;
 var QuoteModule = class {
@@ -3187,11 +3219,12 @@ var QuoteModule = class {
         message: `Price not available for collateral asset: ${collateralPool.asset}`
       });
     }
-    if (request.borrowAmount <= 0n) {
-      validationErrors.push({
-        code: "BORROW_AMOUNT_TOO_LOW" /* BORROW_AMOUNT_TOO_LOW */,
-        message: "Borrow amount must be greater than 0"
-      });
+    const borrowAmountError = createBorrowAmountValidationError({
+      amount: request.borrowAmount,
+      asset: borrowPool.asset
+    });
+    if (borrowAmountError) {
+      validationErrors.push(borrowAmountError);
     }
     if (request.collateralAmount <= 0n) {
       validationErrors.push({
@@ -3313,16 +3346,12 @@ var QuoteModule = class {
         message: `Price not available for collateral asset: ${collateralAsset}`
       });
     }
-    if (borrowAmount < 0n) {
-      validationErrors.push({
-        code: "BORROW_AMOUNT_TOO_LOW" /* BORROW_AMOUNT_TOO_LOW */,
-        message: `Borrow amount must be non-negative`
-      });
-    } else if (borrowAmount < MIN_BORROW_AMOUNT_BASE_UNITS) {
-      validationErrors.push({
-        code: "BORROW_AMOUNT_TOO_LOW" /* BORROW_AMOUNT_TOO_LOW */,
-        message: `Borrow amount must be at least ${MIN_BORROW_AMOUNT_BASE_UNITS} base units`
-      });
+    const borrowAmountError = createBorrowAmountValidationError({
+      amount: borrowAmount,
+      asset: borrowAsset
+    });
+    if (borrowAmountError) {
+      validationErrors.push(borrowAmountError);
     }
     if (targetLtvBps <= MIN_LTV_BPS) {
       validationErrors.push({
@@ -3445,6 +3474,22 @@ function createQuoteResult(params) {
     warnings: params.warnings
   };
 }
+function createBorrowAmountValidationError(params) {
+  if (params.amount <= 0n) {
+    return {
+      code: "BORROW_AMOUNT_TOO_LOW" /* BORROW_AMOUNT_TOO_LOW */,
+      message: "Borrow amount must be greater than 0"
+    };
+  }
+  const minimumBorrowAmountError = getBorrowAmountMinimumValidationError(params);
+  if (!minimumBorrowAmountError) {
+    return null;
+  }
+  return {
+    code: "BORROW_AMOUNT_TOO_LOW" /* BORROW_AMOUNT_TOO_LOW */,
+    message: minimumBorrowAmountError.message
+  };
+}
 function computeUsdInternalFromBaseUnits(params) {
   const { amountBaseUnits, priceScaled, assetDecimalPlaces } = params;
   const scaleDiff = INTERNAL_USD_DECIMAL_PLACES - PRICE_SCALE_DECIMAL_PLACES;
@@ -3770,7 +3815,9 @@ var InstantLoansModule = class {
       );
     }
     const apiClient = this.requireApi("Instant loan address lookup");
-    const response = await apiClient.get(buildInstantLoanAddressLookupPath({ address: trimmedAddress }));
+    const response = await apiClient.get(
+      buildInstantLoanAddressLookupPath({ address: trimmedAddress })
+    );
     return (response.candidates ?? response.loans ?? []).map(mapCandidateWire);
   }
   async mapLoanRecord(record, collateralAmount) {
@@ -3791,7 +3838,9 @@ var InstantLoansModule = class {
   }
   async getCollateralAmountHint(loanId) {
     const apiClient = this.requireApi("Instant loan lookup");
-    const response = await apiClient.get(buildInstantLoanCollateralHintPath({ loanId }));
+    const response = await apiClient.get(
+      buildInstantLoanCollateralHintPath({ loanId })
+    );
     return parseBigintWire(response.collateralAmountHint, "collateral amount");
   }
   async mapLoanWire(loan) {
@@ -4715,9 +4764,28 @@ var LendingModule = class {
         "Borrow requires a signer account"
       );
     }
-    const receiverAddress = await this.normalizeOutflowReceiverAddress({
-      poolId: request.poolId,
-      receiverAddress: destinationAccount
+    if (request.amount <= 0n) {
+      throw new LiquidiumError(
+        LiquidiumErrorCode.VALIDATION_ERROR,
+        "Borrow amount must be greater than 0"
+      );
+    }
+    const selectedPool = await this.getPoolById(request.poolId);
+    const selectedAsset = getVariantKey(selectedPool.asset);
+    const minimumBorrowAmountError = getBorrowAmountMinimumValidationError({
+      amount: request.amount,
+      asset: selectedAsset
+    });
+    if (minimumBorrowAmountError) {
+      throw new LiquidiumError(
+        LiquidiumErrorCode.VALIDATION_ERROR,
+        minimumBorrowAmountError.message
+      );
+    }
+    const receiverAddress = normalizeExternalAddress({
+      address: destinationAccount,
+      asset: selectedAsset,
+      chain: getVariantKey(selectedPool.chain)
     });
     const lendingActor = createLendingActor(this.canisterContext);
     try {
@@ -5985,6 +6053,7 @@ exports.LendingModule = LendingModule;
 exports.LiquidiumClient = LiquidiumClient;
 exports.LiquidiumError = LiquidiumError;
 exports.LiquidiumErrorCode = LiquidiumErrorCode;
+exports.MIN_BORROW_AMOUNTS_BY_ASSET = MIN_BORROW_AMOUNTS_BY_ASSET;
 exports.MarketModule = MarketModule;
 exports.OutflowType = OutflowType;
 exports.PositionsModule = PositionsModule;
@@ -6002,6 +6071,7 @@ exports.UserHistoryStatus = UserHistoryStatus;
 exports.WalletExecutionKind = WalletExecutionKind;
 exports.createTransferErc20Transaction = createTransferErc20Transaction;
 exports.executeWith = executeWith;
+exports.getMinimumBorrowAmount = getMinimumBorrowAmount;
 exports.intFromPublicId = intFromPublicId;
 exports.publicIdFromInt = publicIdFromInt;
 //# sourceMappingURL=index.cjs.map