@liquidium/client 0.3.4 → 0.4.1

package/README.md

@@ -160,6 +160,8 @@ Instant-loan integrations use this sequence:
 
 `client.instantLoans.create(...)` and `client.instantLoans.get(...)` return the generated Liquidium profile, current position state, an initial deposit quote with its transfer target, and a repayment quote with its transfer target. Repayment amount fields are zero when the loan has no debt. Users do not manage the generated profile.
 
+`client.market.listPools()` returns only pools whose asset and chain variants are supported by this SDK version. Canister pools for unsupported variants such as `ICP` or `SOL` are omitted from the returned list.
+
 ## Core API
 
 ### `client.instantLoans.create(request)`
@@ -239,6 +241,18 @@ The SDK enforces product minimums before borrow creation:
 
 Use `getMinimumBorrowAmount(asset)` to display the same minimum that `client.quote.calculateLtv(...)`, `client.quote.getQuote(...)`, `client.instantLoans.create(...)`, and `client.lending.prepareBorrow(...)` enforce.
 
+### Withdraw minimums
+
+The SDK enforces product minimums before withdraw creation:
+
+| Asset | Minimum withdraw amount |
+| --- | --- |
+| BTC | `5_000n` sats |
+| USDC | `1_000_000n` base units |
+| USDT | `1_000_000n` base units |
+
+Use `getMinimumWithdrawAmount(asset)` to display the same minimum that `client.lending.prepareWithdraw(...)` enforces.
+
 ### Profile full withdraw amounts
 
 For profile-based withdraw flows, call `client.positions.getFullWithdrawAmount(profileId, poolId)` before building the withdraw request. The helper returns `{ amount, decimals }`: pass `amount` to `client.lending.withdraw(...)` or `client.lending.prepareWithdraw(...)`, and use `decimals` for display formatting. Do not add `earnedInterest`; the returned amount already uses the current supplied balance.
@@ -250,7 +264,7 @@ Most instant-loan UIs show or store these fields:
 | Field | Use |
 | --- | --- |
 | `loan.ref` | Save and show this reference so the loan can be restored later |
-| `loan.status` | Show the lifecycle: `awaiting_deposit`, `deposit_detected`, `active`, `settling`, `closed`, or `expired` |
+| `loan.status` | Shared lifecycle status: `{ operation, state, confirmations, requiredConfirmations }` |
 | `loan.initialDeposit.amount` | Fee-inclusive collateral amount to send after creation or restore |
 | `loan.initialDeposit.collateralAmount` | Intended credited collateral target used for LTV |
 | `loan.initialDeposit.target` | Address or ICRC account where the user sends collateral |
@@ -260,7 +274,7 @@ Most instant-loan UIs show or store these fields:
 | `loan.repayment.target` | Address or ICRC account where the user sends repayment |
 | `loan.position` | Current collateral, debt, and interest state for the generated profile |
 
-`client.instantLoans.find(...)` returns lightweight search matches with `loanId`, `ref`, `createdAt`, `profileId`, `collateral`, and `borrow`. Use `client.instantLoans.get(...)` to load full loan fields, and use `client.activities.list(...)` separately when you need deposit, borrow, repay, or withdraw activity.
+`client.instantLoans.find(...)` returns lightweight search matches with `loanId`, `ref`, `createdAt`, `profileId`, `collateral`, and `borrow`. Use `client.instantLoans.get(...)` to load full loan fields, and use `client.activities.list(...)` separately when you need deposit, borrow, repayment, or withdrawal activity.
 
 ## Amounts
 
@@ -277,7 +291,22 @@ Use `Pool.decimals` from `client.market.listPools()` when converting user-entere
 
 Reload loans with `client.instantLoans.get({ ref })` when you need current state, transfer targets, or the latest repayment quote.
 
-Use activities to track collateral deposits, borrow outflows, repayment deposits, confirmations, and fee top-ups. The activities module accepts the saved instant-loan reference and resolves the generated profile for you:
+Status-returning methods use the same `LiquidiumStatus` shape:
+
+```ts
+type LiquidiumStatus = {
+  operation: "deposit" | "borrow" | "repayment" | "withdrawal" | "liquidation";
+  state: "action_required" | "confirming" | "processing" | "active" | "completed" | "failed" | "expired";
+  confirmations: number | null;
+  requiredConfirmations: number | null;
+};
+```
+
+`action_required` means the user or app must do something, such as sending funds. `confirming` means a tx is known but still needs confirmations. `processing` means confirmations are sufficient and Liquidium or the protocol is still processing. `active` means the loan is live and waiting for the next repayment action.
+
+Use activities to track collateral deposits, borrow outflows, repayment deposits, confirmations, and fee top-ups. Activity confirmations are exposed on `activity.status`. Activity lists default to active items; pass `filter: "all"` when you need completed activity too. The activities module accepts the saved instant-loan reference and resolves the generated profile for you:
+
+Activities expose chain transaction ids on `activity.txids` when ids are available.
 
 ```ts
 const activities = await client.activities.list({
@@ -310,12 +339,9 @@ Run the instant loan example:
 git clone https://github.com/Liquidium-Inc/liquidium-sdk.git
 cd liquidium-sdk
 pnpm install
-cp examples/instant-loans-flow/.env.example examples/instant-loans-flow/.env
 pnpm --filter @liquidium/example-instant-loans-flow dev
 ```
 
-Set `VITE_INFURA_API_KEY` when your flow needs Ethereum reads through Infura.
-
 ## Browser And Runtime Support
 
 Use the SDK in browser apps and modern TypeScript runtimes.