@skate-org/amm-evm-v2 2.0.0-beta.2 → 2.0.0-beta.21

package/CHANGELOG.md

@@ -1,138 +1,64 @@
 # @skate-org/amm-evm-v2
 
-## 2.0.0-beta.2 — 2026-05-17
+## 2.0.0-beta.13 — 2026-05-30
 
-Lockstep bump — paired with the SVM Solana DEV wire-up
-(`@skate-org/amm-svm-v2`) and the SUI_ENV legacy-address wipe
-(`@skate-org/amm-sui-v2`). This package's source is unchanged versus
-`2.0.0-beta.1`.
+Lockstep — no source changes. Paired with `@skate-org/amm-core-v2@2.0.0-beta.13`
+fix for `getLiquidityForAmount0` canonical two-step `mulDiv`.
 
-## 2.0.0-beta.1 — 2026-05-07
+## 2.0.0-beta.12 — 2026-05-30
 
-Lockstep bump — paired with the `findTokensBySymbol` /
-`getTokenSymbol` additions in `@skate-org/amm-core-v2`. This package's
-source is unchanged versus `2.0.0-beta.0`.
+Lockstep — no source changes. Paired with `@skate-org/amm-core-v2@2.0.0-beta.12`
+hotfix for `normalizeAmount` / `deNormalizeAmount` on tokens with >18 decimals.
 
-## 2.0.0-beta.0 — 2026-05-07
+## 2.0.0-beta.11 — 2026-05-30
 
-First **beta**. Promoted under the `beta` dist-tag; `latest` stays at
-`1.0.0` (v1 line) per the policy in `CLAUDE.md`. **Loose beta** —
-documented breaking changes are still allowed within `2.0.0-beta.x`;
-`2.0.0` final is the strict surface freeze.
+Adds the periphery calldata-builder surface needed by the backend v1 → v2
+port (quote routes that need to mirror on-chain calldata without
+submitting), plus a kernel-side balances reader.
 
-**Breaking — internal-leak surface pull.**
+- `periphery/calldata.ts` (new module): `getSwapCalldata`,
+  `getMintCalldata`, `getBurnCalldata`, `getIncreaseLiquidityCalldata`,
+  `getDecreaseLiquidityCalldata`. Pure ABI encoders over `PeripheryPoolABI`
+  — no client / no signing / no submission. Use submitters in `submit.ts`
+  for the full build-and-send flow.
+- `kernel/reader.ts`: `readKernelBalances(kernelPool, mode)` returning
+  `{ balance0, balance1 }`. Parallel reads; mirrors the `readPool` style.
+- Note: `getMintCalldata` uses correct camelCase (v1 was `getMintcalldata`,
+  a typo); the rest match v1 names verbatim.
 
-- `DEFAULT_DEV_API_ENDPOINT` is no longer re-exported from the package
-  barrel. It was `createDevConfig`'s private default value and
-  duplicated the canonical URL in `@skate-org/amm-api-v2`. Use
-  `createDevConfig({...})` (which still accepts a custom
-  `apiEndpoint`); the previously-public string was never needed.
+## 2.0.0-beta.10 — 2026-05-29
 
-Surface count: 28 → 27. See `STABILITY.md` (repo root) for the full
-classification.
+Lockstep — no source changes. `KernelManagerAddress(mode)` / `PeripheryDeploymentFor(chain, mode)`
+re-exported from `@skate-org/amm-core-v2@2.0.0-beta.10` now resolve for STAGING/PRODUCTION
+(alias DEV) instead of throwing `notDeployed`. EVM readers/writers that route on `EnvMode`
+get coverage for all three modes without call-site changes.
 
-## 2.0.0-alpha.8 — 2026-05-07
+## 2.0.0-beta.9 — 2026-05-26
 
-Lockstep bump — paired with the api `streamSwapQuote` going live as a
-polling stub for the deferred WebSocket. This package's source is
-unchanged versus `2.0.0-alpha.7`.
+Lockstep — no source changes. Paired with `@skate-org/amm-core-v2@2.0.0-beta.9`
+which added STAGING/PRODUCTION env support to the deployment maps.
 
-## 2.0.0-alpha.7 — 2026-05-07
+## 2.0.0-beta.8 — 2026-05-21
 
-Lockstep bump — paired with the api action-by-user clients, polling
-`subscribeSwapQuote` helper, and svm browser-bundle build fix.
-This package's source is unchanged versus `2.0.0-alpha.6`.
+Lockstep — no source changes. Paired with `@skate-org/amm-sui-v2@2.0.0-beta.8`.
 
-## 2.0.0-alpha.6 — 2026-05-07
+## 2.0.0-beta.7 — 2026-05-21
 
-- `getKernelPublicClient(mode)` now reads the kernel chain from
-  `KernelChain(mode)` (the new `KERNEL_CHAIN_BY_MODE` table in core)
-  instead of hardcoding `megaethChain`. Default behavior is unchanged
-  (every env still resolves to MegaETH today); future per-env kernel-chain
-  switches are one-line edits in core.
-- Lens helpers + readers continue to call `KernelManagerAddress(mode)`,
-  which now throws for STAGING / PRODUCTION (see `@skate-org/amm-core-v2`
-  alpha.6 notes). DEV behavior unchanged.
+Made `DEFAULT_DEV_API_ENDPOINT` module-private in `devConfig.ts`
+(already off the barrel since beta.0; this drops the `export`
+keyword). No public surface change.
 
-## 2.0.0-alpha.5 — 2026-05-06
+## 2.0.0-beta (cumulative, 2026-05-07 → 2026-05-21)
 
-- **Kernel lens helpers ported from v1.** Adds `simulateSwap`,
-  `simulateMint`, `simulateBurn`, `simulateDecreaseLiquidity` —
-  static-call wrappers around `KernelManager.lens{Swap,Mint,Burn,DecreaseLiquidity}`.
-  Each returns named fields matching the ABI output (e.g.
-  `simulateMint` → `{ amount0Used, amount1Used, liquidityAmount, returnData }`)
-  and accepts an optional viem client for test injection. Errors flow
-  through the read-path (`EvmReadError`) since lens calls don't write
-  state. Same DEV/STAGING/PRODUCTION mode handling as the readers.
-- Internal: extracted `resolveKernelClient` to `kernel/_client.ts` so
-  readers and lens helpers share the same client-resolution logic.
-- Internal (tests): extracted the `mockKernelClient` helper to
-  `test/_helpers.ts`. Reader and lens test suites now share one
-  union-ABI mock transport instead of duplicating the implementation.
+- **Surface pull (beta.0):** `DEFAULT_DEV_API_ENDPOINT` removed
+  from the package barrel; only the per-pool / per-chain DEV config
+  helpers are public.
+- **Kernel lens helpers (alpha.5 → beta):** `simulateSwap`,
+  `simulateMint`, `simulateBurn`, `simulateDecreaseLiquidity`
+  static-call wrappers over `KernelManager.lens*`. Now consumed by
+  the api package's quote routes.
+- **Per-env kernel chain (alpha.6 → beta):** `getKernelPublicClient(mode)`
+  reads `KernelChain(mode)` instead of hardcoding `megaethChain`.
+  DEV resolves to MegaETH today.
 
-## 2.0.0-alpha.4 — 2026-05-06
-
-Lockstep bump — paired with the `SwapQuote` schema fix in
-`@skate-org/amm-api-v2`. This package's source is unchanged versus
-`2.0.0-alpha.3`.
-
-## 2.0.0-alpha.3 — 2026-05-06
-
-Lockstep bump — paired with the SVM/Sui efficiency pass in
-`@skate-org/amm-svm-v2` and `@skate-org/amm-sui-v2`. This package's
-source is unchanged versus `2.0.0-alpha.2`.
-
-## 2.0.0-alpha.2 — 2026-05-05
-
-Plan C of the SVM/Sui integration. Adds `@skate-org/amm-sui-v2` to
-the workspace; this package's source is unchanged versus
-`2.0.0-alpha.1` (re-versioned in lockstep).
-
-## 2.0.0-alpha.1 — 2026-05-05
-
-Plan B of the SVM/Sui integration. Adds `@skate-org/amm-svm-v2` to
-the workspace; this package's source is unchanged versus
-`2.0.0-alpha.0` (re-versioned in lockstep).
-
-## 2.0.0-alpha.0 — 2026-05-05
-
-Plan A of the SVM/Sui integration.
-
-- **Breaking:** uniswap-v3 math no longer ships from
-  `@skate-org/amm-evm-v2`. Import from `@skate-org/amm-core-v2`
-  instead. All function names unchanged. Top-level barrel re-exports
-  via the umbrella (`@skate-org/amm-v2`) continue to work without
-  callsite changes.
-- Removed: `packages/evm/src/math/` directory and corresponding
-  tests (relocated to `core`).
-
-## 1.0.0 — 2026-05-04
-
-Realigning all four `@skate-org/amm-*-v2` packages at a single version
-for the coherent v1 SDK release. No source changes vs 0.4.1 — purely a
-versioning realignment so the four packages move together going forward.
-
-## 0.4.1 — 2026-04-29
-
-- Flip DEV MegaETH RPC default to `https://mainnet.megaeth.com/rpc` (the
-  carrot.megaeth.com endpoint is no longer the canonical DEV RPC).
-- Extend DEV smoke to exercise `readPool` (kernel) and `readPeripheryPool`
-  (Arbitrum) against real contracts.
-
-## 0.4.0 — 2026-04-25
-
-- Phase 4: kernel + periphery event-decoding framework. `decodeKernel*`
-  / `decodePeriphery*` helpers; `watch*` event subscription utilities.
-
-## 0.3.0 — 2026-04-23
-
-- Phase 3: `readPool`, `readPeripheryPool`, `readPosition` reader helpers;
-  uniswap-v3 tick math; action submitters.
-
-## 0.2.0 — 2026-04-22
-
-- `createPublicClient` factory; `createDevConfig` for DEV mode tuples.
-
-## 0.1.0 — 2026-04-21
-
-- Initial scaffold: viem chain definitions, RPC defaults, `chain-clients.ts`.
+Surface count: 28 → 27 (one-time pull at beta.0).

package/README.md

@@ -11,16 +11,66 @@ periphery readers, action submitters, and the event-decoding framework.
 
 ## Surface
 
-- `getKernelPublicClient(mode?)` / `getSourcePublicClient(chain, mode?)` —
+- `getKernelPublicClient(mode, transport?)` / `getSourcePublicClient(chain, mode, transport?)` —
   viem `PublicClient` factories with Skate's RPC defaults baked in.
 - `createDevConfig({...})` — produces the DEV `{ mode, config }` tuple.
-- **Readers:** `readPool` (kernel side), `readPeripheryPool` (periphery
-  side), `readPosition`, `readTick`, `readTickBitmap`, `readUserPoolBalances`.
+- **Readers (object-param, `mode` field required):** `readPool({ kernelPool, mode, client? })`,
+  `readPeripheryPool({ chain, kernelPool, mode, client? })` → `PeripheryPoolState`,
+  `readUserPoolBalances({ user, poolKey, chain, mode, client? })` → `UserPoolBalances`,
+  `readPosition`, `readTick`, `readTickBitmap`.
+- **Calldata builders → `Promise<CalldataCall>` (`{ target, calldata }`):**
+  `buildSwap`, `buildMint`, `buildBurn`, `buildIncreaseLiquidity`, `buildDecreaseLiquidity`.
+  All accept a single object param including `mode`. No RPC call.
+- **Kernel simulators (object-param):** `simulateSwap`, `simulateMint`,
+  `simulateBurn`, `simulateDecreaseLiquidity`.
 - **Events:** `parseKernelEventLog`, `parsePeripheryEventLog`,
   `watchKernelEvents`, `watchPeripheryEvents`.
 - **Submitters:** `submitAction`, `submitApproval`, `submitSwap`.
 - **Errors:** `EvmReadError`, `EvmWriteError` (both extend `SdkError`).
 
+**`SkateAmm` class (headline entry point)**
+
+One object that composes `AmmCore` (pool catalog), `AmmApi` (quotes +
+actions), and `AmmEvm` (build/submit/read). Expose escape hatches via
+`.core`, `.api`, `.vm`.
+
+```ts
+const amm = new SkateAmm("PRODUCTION");
+
+// Quotes
+const quote  = await amm.quote.swap({ poolKey: "USDC_USDT", ... });
+const ranges = await amm.quote.boostedRange();
+
+// Actions
+const action = await amm.actions.get({ srcChain: CHAIN.ARBITRUM, srcHash: "0x..." });
+await amm.actions.waitForExecuted({ srcChain: CHAIN.ARBITRUM, srcHash: "0x..." });
+
+// Build + submit
+const call   = await amm.buildSwap({ poolKey: "USDC_USDT", chain: CHAIN.ARBITRUM, ... });
+const hash   = await amm.submitSwap(walletClient, { ... });
+
+// Pool catalog
+const keys   = amm.pools.keys();
+const info   = amm.pools.byKey("USDC_USDT");
+
+// EVM extras
+const pool   = await amm.readPool({ kernelPool: "0x2c23..." });
+const sim    = await amm.simulateSwap({ params: { ... } });
+```
+
+**`AmmEvm` class (env-bound)**
+
+Construct once; all methods take object params **without the `mode` field**:
+
+```ts
+const evm = new AmmEvm("PRODUCTION");
+const pool   = await evm.readPool({ kernelPool: "0x2c23..." });
+const pPool  = await evm.readPeripheryPool({ chain: CHAIN.ARBITRUM, kernelPool: "0x2c23..." });
+const bals   = await evm.readUserPoolBalances({ user: "0x...", poolKey: "USDC_USDT", chain: CHAIN.ARBITRUM });
+const call   = await evm.buildSwap({ poolKey: "USDC_USDT", chain: CHAIN.ARBITRUM, ... });
+// call → { target: "0x...", calldata: "0x..." }
+```
+
 ## Install
 
 ```bash
@@ -29,10 +79,12 @@ pnpm add @skate-org/amm-evm-v2
 
 Peer deps: `@skate-org/amm-core-v2`, `@skate-org/amm-bindings`, `viem`.
 
-## DEV defaults (as of 2026-04-29)
+## DEV defaults
 
 - MegaETH RPC: `https://mainnet.megaeth.com/rpc`
 - Kernel manager: `0x17B7207837e8884f7f687f1f4057751BDAf70a01`
 - USDC/USDT kernel pool: `0x2c23334eE3b030e6bacEDEDf7C511eEA08Cf7E7e`
 
+STAGING + PRODUCTION on-chain addresses alias DEV as of `2.0.0-beta.10`.
+
 See `CHANGELOG.md` for version history.

package/dist/chain-clients.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chain-clients.d.ts","sourceRoot":"","sources":["../src/chain-clients.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,KAAK,EACV,KAAK,YAAY,EACjB,KAAK,SAAS,EACf,MAAM,MAAM,CAAC;AAEd,OAAO,EAEL,KAAK,EAKL,KAAK,iBAAiB,EACvB,MAAM,wBAAwB,CAAC;AAEhC;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,EAAE,KAYzB,CAAC;AA4CH;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,iBAAiB,EACvB,SAAS,CAAC,EAAE,SAAS,GACpB,YAAY,CAcd;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,iBAAiB,EACvB,SAAS,CAAC,EAAE,SAAS,GACpB,YAAY,CAsBd"}
+{"version":3,"file":"chain-clients.d.ts","sourceRoot":"","sources":["../src/chain-clients.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,KAAK,EACV,KAAK,YAAY,EACjB,KAAK,SAAS,EACf,MAAM,MAAM,CAAC;AAEd,OAAO,EAEL,KAAK,EAKL,KAAK,iBAAiB,EACvB,MAAM,wBAAwB,CAAC;AAEhC;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,EAAE,KAYzB,CAAC;AA+CH;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,iBAAiB,EACvB,SAAS,CAAC,EAAE,SAAS,GACpB,YAAY,CAcd;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,iBAAiB,EACvB,SAAS,CAAC,EAAE,SAAS,GACpB,YAAY,CAsBd"}