@apex_labs/sdk 0.1.1 → 0.2.0

package/README.md

@@ -1,6 +1,6 @@
 # Apex SDK
 
-SDK for Apex CL and Classic pools. It vendors a pinned `@pancakeswap/v3-sdk@3.10.0` snapshot as an Apex-owned fork, then adds Apex fee tiers, Apex CREATE2 address helpers, Classic AMM quoting, mixed CL/Classic path encoding, and exact ABI exports for the Apex contracts.
+SDK for Apex CL and Classic pools. It provides Apex fee tiers, deterministic pool address helpers, Classic AMM quoting, mixed CL/Classic path encoding, transaction builders, and exact ABI exports for Apex contracts.
 
 ## Setup
 
@@ -49,7 +49,6 @@ export const apex: ApexDeploymentConfig = {
 import {
   CLFeeAmount,
   APEX_CL_POOL_INIT_CODE_HASH,
-  APEX_CL_TICK_SPACINGS,
   APEX_CLASSIC_PAIR_INIT_CODE_HASH,
   ClassicChef,
   CLMasterChef,
@@ -61,7 +60,7 @@ import {
   computeClassicPoolAddress,
   quoteClassicExactInput,
   encodeMixedRouteToPath,
-  encodeMixedRouteToPancakeQuoteParams,
+  encodeMixedRouteToQuoteParams,
   decodeMixedRoutePath,
   parseProtocolFeePacked,
   clPoolAbi,
@@ -111,7 +110,7 @@ const pool = createCLPool({
 });
 ```
 
-`createCLPool` returns the forked Pancake `Pool`, with Apex fee tiers installed. Position, trade, route, quoter, swap-router, and NFT-position-manager logic should use the classes re-exported by `@apex_labs/sdk`.
+`createCLPool` returns an Apex CL `Pool` model with Apex fee tiers installed. Position, trade, route, quoter, swap-router, and NFT-position-manager logic should use the classes exported by `@apex_labs/sdk`.
 
 ### Periphery ABIs
 
@@ -198,8 +197,7 @@ const path = encodeMixedRouteToPath([
 ```
 
 Quote that path through `MixedQuoter.quoteExactInput(path, amountIn)`, then execute it with
-`SmartRouter`. The high-level helpers follow Pancake SmartRouter’s safety pattern:
-they encode the swap, then wrap it in `SmartRouter.multicall(deadlineOrPreviousBlockhash, data)`.
+`SmartRouter`. The high-level helpers encode the swap, then wrap it in `SmartRouter.multicall(deadlineOrPreviousBlockhash, data)`.
 
 ```ts
 const swap = SmartRouter.mixedExactInputCallParameters(
@@ -208,10 +206,10 @@ const swap = SmartRouter.mixedExactInputCallParameters(
 );
 ```
 
-If you fork Pancake SmartRouter’s mixed quote provider, use Pancake-style quote params:
+For `MixedQuoter.quoteExactInput`, encode the route path and Classic-hop flags:
 
 ```ts
-const { path, flags } = encodeMixedRouteToPancakeQuoteParams(hops);
+const { path, flags } = encodeMixedRouteToQuoteParams(hops);
 const quote = await publicClient.readContract({
   address: apex.mixedQuoter,
   abi: mixedQuoterAbi,
@@ -220,7 +218,7 @@ const quote = await publicClient.readContract({
 });
 ```
 
-For routes that Pancake SmartRouter partitions by protocol:
+For routes split by protocol:
 
 ```ts
 // Classic volatile section
@@ -242,7 +240,9 @@ SmartRouter.exactInputCallParameters(
 );
 ```
 
-Use the raw `encode*` helpers only when deliberately assembling a custom multicall. User-facing swaps should use `*CallParameters`, or `SmartRouter.swapCallParameters(rawCalls, options)` for custom batches. These require a deadline or previous blockhash and support cleanup calls such as `refundETH`, `sweepToken`, and `unwrapWETH9`.
+Use the raw `encode*` helpers only when deliberately assembling a custom multicall. User-facing swaps should use `*CallParameters`, or `SmartRouter.swapCallParameters(rawCalls, options)` for custom batches. These require a deadline or previous blockhash.
+
+When `value` is nonzero, `SmartRouter` call-parameter helpers append `refundETH()` automatically. Token sweeps and WETH unwraps require explicit cleanup entries because the SDK cannot infer the intended token, recipient, or minimum amount for every route.
 
 The mixed periphery is exact-input only. Use the CL-only `SwapRouter`/`QuoterV2` for CL exact-output routes.
 
@@ -301,7 +301,7 @@ const close = CLMasterChef.closeAndBurnCallParameters(
 );
 ```
 
-This encodes `harvest -> decreaseLiquidity -> collectTo -> burn`. The harvest happens before liquidity is removed, so it is safe even when rewards are zero and keeps `burn` compatible with Pancake-style strict empty-position semantics.
+This encodes `harvest -> decreaseLiquidity -> collectTo -> burn`. The harvest happens before liquidity is removed, so it is safe even when rewards are zero and keeps `burn` compatible with strict empty-position semantics.
 
 ### ApexVault UX
 
@@ -363,10 +363,8 @@ npm run build --prefix apex-sdk
 
 ## Notes
 
-- Apex CL callbacks remain Pancake-compatible, so Pancake v3 periphery assumptions are preserved.
-- The Pancake v3 SDK base is vendored under `vendor/pancake-v3-sdk`; Apex does not depend on the live `@pancakeswap/v3-sdk` npm package at runtime.
 - Apex periphery exports include `NonfungiblePositionManager`, `SwapRouter`, `SmartRouter`, `Quoter`, `QuoterV2`, `MixedQuoter`, `TickLens`, and `InterfaceMulticall`.
-- `MixedQuoter` supports both Apex-native `quoteExactInput(bytes,uint256)` and Pancake SmartRouter-style `quoteExactInput(bytes,uint256[],uint256)` for Classic+CL route discovery.
+- `MixedQuoter` supports `quoteExactInput(bytes,uint256)` and `quoteExactInput(bytes,uint256[],uint256)` for Classic+CL route discovery.
 - Apex CL pool addresses use the Apex `CLPoolDeployer`, not the factory, matching the contract salt `keccak256(abi.encode(token0, token1, fee))`.
 - Apex Classic pair addresses use the Classic factory salt `keccak256(abi.encodePacked(token0, token1, stable))`.
 - `APEX_CL_POOL_INIT_CODE_HASH` and `APEX_CLASSIC_PAIR_INIT_CODE_HASH` are exported and used by default; override them only if the compiled contract bytecode changes.