@circle-fin/app-kit 1.15.3 → 1.17.0

package/CHANGELOG.md

@@ -1,5 +1,96 @@
 # @circle-fin/app-kit
 
+## 1.17.0
+
+### Minor Changes
+
+- Add Cronos and Morph as swap networks. Cronos supports the native CRO, USDC,
+  EURC, USDT, WETH, DAI, and WBTC aliases. Morph supports the native ETH, USDC,
+  USDT, and WETH aliases.
+- Update the Borrow Kit dependency to the release that adds the `@circle-fin/borrow-kit/chains` subpath. No changes are needed for `kit.borrow` calls: `@circle-fin/app-kit/chains` already exports `Arc` and `ArcTestnet`.
+- Show how a swap is routed, and which fees the route charges.
+
+  - Swap estimates and results include an optional `route`: the provider that routed the swap (for example `lifi` or `circle`) and each swap or bridge step, with its tool, tokens, and amounts. Types: `SwapRoute`, `SwapRouteStep`, `SwapRouteStepEstimate`, `SwapRouteToken`.
+  - Treat `route.provider` as an opaque string. New providers can appear without an SDK update.
+  - Provider-specific details are on the optional `metadata` field of the route and of each step. For example, Circle CCTP steps include the source and destination domains.
+  - Route details are for display only. If the SDK does not recognise a step, `steps` is empty rather than incomplete, and an unrecognised route is omitted. The estimate or swap still succeeds.
+  - Each entry in `fees` can include `component`, the provider's name for the fee (for example `FORWARD` or `PRE_FINALITY`), and `chain`, the chain where it is charged.
+  - Estimates for direct Circle CCTP routes now show an approximate gas fee instead of zero. The actual gas is still estimated when the swap runs.
+  - `getSwapStatus` and `waitForSwap` track Circle-routed swaps with no code changes.
+
+- Add `EarnError.SHARES_LOCKED` (`EARN_SHARES_LOCKED`, code 1107). Earn
+  operations throw it when a Veda vault rejects the call because the vault
+  shares are still inside the share lock period after a deposit. The error is
+  not retryable right away: wait for the lock period to end, then try again.
+
+  Veda vault reverts now give readable messages instead of raw error
+  selectors. For example, a revert now says that the vault is paused or that
+  the deposit would exceed the vault deposit cap. This works with both the
+  default and `/next` adapter entries, and with browser wallets.
+
+- Add `batchTransactions` to `SwapConfig`. Swaps that need an ERC-20 approval send the approval and the swap as one atomic batch when the connected wallet supports it, which is the default. Set `config: { batchTransactions: false }` to send them as two transactions instead, approval first. Use this if your wallet rejects batched calls or under-estimates gas on complex routes. Non-boolean values are now rejected with a validation error.
+
+### Patch Changes
+
+- Respect Circle's per-route availability for CCTPx. When Circle disables CCTPx for a token on a source or destination chain:
+
+  - `supportsRoute` returns `false` for that route, so the kit no longer selects CCTPx for a transfer the service would refuse to quote.
+  - A quote request for that route throws a `FATAL` `InputError.UNSUPPORTED_ROUTE` instead of a `RETRYABLE` `ServiceError.INTERNAL_ERROR`, so retry loops stop instead of waiting for a recovery that will not come.
+  - `CCTPXTokenDeployment` exposes an optional `enabled?: boolean` field, so custom UIs can show whether a deployment is available. Responses that omit the field are treated as enabled.
+
+## 1.16.0
+
+### Minor Changes
+
+- Add Borrow Kit to App Kit under `kit.borrow`:
+
+  ```ts
+  import { AppKit, BorrowChain } from "@circle-fin/app-kit";
+
+  const kit = new AppKit();
+
+  const result = await kit.borrow.borrow({
+    from: { adapter, chain: BorrowChain.Arc },
+    marketId: "0x...",
+    borrowAmount: "100",
+  });
+  ```
+
+  - Every Borrow Kit operation except `getSupportedChains` is available on
+    `kit.borrow`, including `retry`, and forwards App Kit's `disableAnalytics`
+    and `disableErrorReporting`.
+  - List borrow chains with `kit.getSupportedChains('borrow')`. Calling
+    `kit.getSupportedChains()` with no operation type now includes them, and
+    the standalone operation is exported as `borrowGetSupportedChains`.
+  - Borrow step events are namespaced: `kit.on('borrow.execute', handler)` and
+    `kit.on('*', handler)` both receive borrow progress.
+  - `@circle-fin/app-kit/borrow` exports the same operations as standalone
+    functions for tree-shaking.
+  - Borrow Kit's types, schemas and standalone operations are re-exported from
+    the package root, prefixed with `Borrow` wherever the name does not already
+    contain it (for example `BorrowLoanInfo`, `borrowRepay`).
+
+- Default the destination of FAST cross-chain deposits to Arc. When `config.transferSpeed` is `'FAST'` and `to` is omitted, `deposit`, `depositFor`, and `estimateDeposit` now credit the Gateway balance on `Arc` for mainnet sources and `Arc_Testnet` for testnet sources instead of throwing. Passing `to` explicitly still selects any other supported fast-finality destination, and `estimateDeposit` echoes the resolved `to` so `deposit({ ...estimate, from })` targets the same chain.
+
+  Setting `allowanceStrategy` on a FAST deposit now fails with "cannot be set for FAST cross-chain deposits". A STANDARD deposit that sets both `to` and `allowanceStrategy` now reports the invalid `to` instead.
+
+### Patch Changes
+
+- Stop replacing a validation error with a `TypeError` when the rejected value
+  holds a `bigint`.
+
+  Building a validation error serializes the offending value into the message.
+  `JSON.stringify` refuses `bigint` and circular structures, so a value that
+  carried either — an on-chain read, or a transaction receipt log, both of which
+  routinely hold `bigint` fields — threw
+  `TypeError: Do not know how to serialize a BigInt` from inside the error
+  constructor. The real error never surfaced, and callers saw an unrelated crash
+  in its place.
+
+  Such values now render with their `bigint` fields as strings, and a value that
+  still cannot be serialized renders as `[unserializable object]`. The error's
+  `cause.trace.value` is unchanged and still carries the raw value.
+
 ## 1.15.3
 
 ### Patch Changes

package/README.md

@@ -266,7 +266,7 @@ console.log(
 Check which chains support specific operations:
 
 ```typescript
-// Get all chains (bridge, swap, earn, and unified balance)
+// Get all chains (bridge, swap, earn, borrow, and unified balance)
 const allChains = kit.getSupportedChains()
 
 // Get all chains that support bridging
@@ -278,6 +278,9 @@ const swapChains = kit.getSupportedChains('swap')
 // Get chains that support earn vault operations
 const earnChains = kit.getSupportedChains('earn')
 
+// Get chains that support borrow operations
+const borrowChains = kit.getSupportedChains('borrow')
+
 // Get chains that support unified balance operations
 const ubChains = kit.getSupportedChains('unifiedBalance')
 ```
@@ -793,7 +796,7 @@ await kit.bridge({
 - `kit.getSwapStatus(params)` - Fetch the current status of a swap
 - `kit.waitForSwap(params)` - Poll until a swap reaches a terminal status
 - `kit.getTokenRates(params)` - Fetch cached token USD rates
-- `kit.getSupportedChains(operationType?)` - Query supported chains by operation type (`'bridge'`, `'swap'`, `'earn'`, `'unifiedBalance'`)
+- `kit.getSupportedChains(operationType?)` - Query supported chains by operation type (`'bridge'`, `'swap'`, `'earn'`, `'borrow'`, `'unifiedBalance'`)
 - `kit.setCustomFeePolicy(policy)` - Set operation-scoped custom fee policies
 - `kit.removeCustomFeePolicy(operation)` - Remove an operation-scoped custom fee policy
 - `kit.on(event, handler)` - Listen to operation events