@pafi-dev/trading 0.9.0 → 0.10.1

package/README.md

@@ -57,7 +57,7 @@ import { getContractAddresses } from "@pafi-dev/core";
 
 const provider = createPublicClient({ transport: http("https://mainnet.base.org") });
 const trading = new TradingHandlers({ provider, chainId: 8453 });
-const { usdt } = getContractAddresses(8453);
+const { usdt, usdc } = getContractAddresses(8453);  // usdc is optional, used by perp-deposit fee path
 
 // Pool discovery — loop call when both sides are PT (PT0 → PT1 multi-hop).
 const pools = await fetchPafiPools(8453, POINT_TOKEN);
@@ -92,11 +92,13 @@ const swap = await trading.handleSwap(userAddress, {
 
 ## Direction matrix
 
-| Direction | Use case | Hop count | Fee | Operator fee token |
-| --- | --- | --- | --- | --- |
-| `PT → USDT` | Cashout | 1 | 0.3% pool fee | USDT (output) |
-| `USDT → PT` | Buy PT | 1 | 0.3% pool fee | PT (output) |
-| `PT0 → PT1` | Multi-token swap | 2 (via USDT) | 0.3% × 2 hops | output PT |
+| Direction | Use case | Hops | Operator fee token |
+| --- | --- | --- | --- |
+| `PT → USDT` | Cashout | 1 | USDT (output) |
+| `USDT → PT` | Buy PT | 1 | PT (output) |
+| `PT0 → PT1` | Multi-token swap | 2 (via USDT) | output PT |
+
+Pool fee depends on which V3 tier the pool was created at (typically 0.05% or 0.3% — `COMMON_POOLS` carries both). `findBestQuote` picks the route with the best amountOut across all tiers.
 
 **Cross-issuer OK** for PT0 → PT1 (e.g. TPT ↔ LTR if both issuers ship
 V3 pools with USDT). The router auto-routes through `USDT`.
@@ -204,7 +206,6 @@ import {
   buildUniversalRouterExecuteArgsExactOut,
   buildV3SwapInputExactIn,
   buildV3SwapInputExactOut,
-  buildSwapFromQuote,
   buildPermit2ApprovalCalldata,
   buildErc20ApprovalCalldata,
   checkAllowance,
@@ -217,6 +218,8 @@ import {
 Use these to build custom direction-agnostic swap flows or pre-flight
 simulations.
 
+> `buildSwapFromQuote` is also re-exported but `@deprecated` — pass `bestRoute.path` from `findBestQuote(...)` directly into `buildUniversalRouterExecuteArgs(...)` instead. Will be removed in a future minor.
+
 ---
 
 ## Direct path — no AA, no bundler, no sponsor-relayer
@@ -358,7 +361,7 @@ Methods:
 - `findBestQuoteExactOut(...)`
 - `quoteBestRoute`, `quoteBestRouteExactOut`, `quoteExactInput`, `quoteExactInputSingle`, `quoteExactOutput`, `quoteExactOutputSingle`
 - `buildSwapUserOp(params)` / `buildSwapUserOpExactOut(params)` — direction-agnostic UserOp builder
-- `buildUniversalRouterExecuteArgs`, `buildUniversalRouterExecuteArgsExactOut`, `buildV3SwapInputExactIn`, `buildV3SwapInputExactOut`, `buildSwapFromQuote`
+- `buildUniversalRouterExecuteArgs`, `buildUniversalRouterExecuteArgsExactOut`, `buildV3SwapInputExactIn`, `buildV3SwapInputExactOut` (and the `@deprecated` `buildSwapFromQuote` alias)
 - `buildPermit2ApprovalCalldata`, `buildErc20ApprovalCalldata`, `checkAllowance`
 - `simulateSwap` — `eth_call` dry-run
 - `fetchPafiPools(chainId, pointTokenAddress, subgraphUrl?)` — re-exported from core
@@ -369,7 +372,7 @@ Methods:
 
 ## References
 
-- Fee math: [`docs/FEE_FLOW.md`](../../../docs/FEE_FLOW.md)
+- Fee math: see [`@pafi-dev/core` README — Operator fee quoter](../core/README.md#operator-fee-quoter)
 - Architecture: [`ARCHITECTURE.md`](../../ARCHITECTURE.md) at SDK root
 
 ## License