@pafi-dev/issuer 0.20.0 → 0.22.0

package/README.md

@@ -14,20 +14,61 @@ interfaces. Don't bundle into a browser app — use
 
 ---
 
-## v0.15.0 — Uniswap V3 migration (breaking)
-
-- `createSubgraphPoolsProvider` now returns the V3 `PoolKey` shape (`{ token0, token1, fee }`) instead of the V4 shape (`{ currency0, currency1, fee, tickSpacing, hooks }`). Pulls through from `@pafi-dev/core`.
+## v0.20.x — Bundler-driven gas estimate
+
+**v0.20.0** — operator fee gasUnits now come from a Pimlico bundler
+estimate cached server-side at PAFI's sponsor-relayer
+(`POST /v1/estimate-gas-fee`). Eliminates the hardcoded
+`SCENARIO_GAS_UNITS` table at the consumer layer.
+
+- **New**: `FeeManagerConfig.bundlerClient?: BundlerEstimatorClient`. When
+  set, `feeManager.estimateGasFee({ partialUserOp, scenario,
+  contractAddress })` fetches gas units from the wired estimator
+  instead of running the legacy `gasUnits × premium` math.
+  Backwards-compatible — omit `bundlerClient` and the legacy hardcoded
+  path runs.
+- **New**: `createPafiEstimatorClient({ baseUrl, apiKey, issuerId })`
+  HTTP adapter — POSTs to PAFI sponsor-relayer's
+  `/v1/estimate-gas-fee`. Pimlico key never touches issuer infra; the
+  bundler call happens server-side at PAFI.
+- **New**: `RelayService.previewMintUserOp` / `previewBurnUserOp` —
+  build a dummy partial UserOp (placeholder 65-byte sig, no HSM call)
+  for the bundler estimate. `PTClaimHandler` / `PTRedeemHandler` wire
+  these automatically.
+- **Changed**: `DEFAULT_PREMIUM_BPS` 12_000 → 10_000 (100%, no
+  double-pad). PAFI sponsor-relayer applies its own 110% premium
+  upstream; adding another SDK-side pad would over-charge users by
+  ~21% vs. actual gas.
+- **Changed**: `PTClaimHandler` now passes the FeeManager-computed
+  `feeAmount` explicitly into `RelayService.prepareMint`, so the
+  in-batch PT transfer matches the value returned in the response.
+  Pre-v0.20 the handler relied on `RelayService.resolveFee` falling
+  back to `quoteOperatorFeePt` (which uses the legacy 120% premium) —
+  causing a ~20% mismatch between displayed fee and actual transfer.
+
+**v0.21.0** — bug fix follow-up to v0.20: closes the resolveFee
+mismatch in `PTClaimHandler` (above). Strongly recommended over
+v0.20.0 for any new consumer wiring.
+
+## v0.15.x — Uniswap V3 migration (breaking)
+
+**v0.15.0** — initial V3 migration:
+- `createSubgraphPoolsProvider` returns the Uniswap V3 `PoolKey` shape (`{ token0, token1, fee }`) — sourced from `@pafi-dev/core`. Any consumer typed against an older shape with extra fields will see compile-time type errors and must be updated.
 - New `onError?: (err: Error) => void` option — forward recoverable errors (network, GraphQL, parse) to your observability stack. Throws inside the callback are swallowed so the provider stays total.
 - `feeTier` is range-checked (uint24, < 1_000_000) before building the `PoolKey`; invalid values are skipped with a console.error + `onError` invocation.
-- Subgraph endpoint default → `…/pafi-subgraph-v4` (PAFI V3-fork DEX + extensions); see `@pafi-dev/core` for the constant.
+- Subgraph endpoint default → `…/pafi-subgraph-v4` (the active PAFI Base-mainnet subgraph; see `@pafi-dev/core` for the constant).
 - Bumps peer-deps on `@pafi-dev/core` to `^0.13.0` (V3 types + ABIs).
 
+**v0.15.1** — documentation-only cleanup: refreshed JSDoc comments in `nativePtQuoter`, `feeManager`, `relayService` to match the V3 implementation. No behavior change.
+
+**v0.15.2** — `POINT_TOKEN_V2_ABI` → `POINT_TOKEN_ABI` rename across core+issuer (canonical name, no version suffix). Breaking export name change; the back-compat alias was removed. Requires `@pafi-dev/core` `^0.14.0`.
+
 ## Requirements
 
 - Node.js ≥ 18
 - TypeScript ≥ 5.0
 - `viem` ^2.0.0 (peer)
-- `@pafi-dev/core` ^0.13.0 (transitive — re-exported)
+- `@pafi-dev/core` ^0.14.0 (transitive — re-exported)
 
 ## Installation
 
@@ -156,7 +197,7 @@ export const issuerApiAdapterProvider: Provider = {
   provide: ISSUER_API_ADAPTER,
   useFactory: (issuerService, provider, walletClient, dataSource, config) => {
     const ledger = new PostgresPointLedger(dataSource);
-    const { issuerRegistry, batchExecutor } = getContractAddresses(8453);
+    const { issuerRegistry, batchExecutor, usdc } = getContractAddresses(8453);
     const chainId = config.get<number>("CHAIN_ID");
     const pointToken = config.get<`0x${string}`>("POINT_TOKEN_ADDRESS");
 
@@ -369,7 +410,7 @@ All SDK errors inherit `PafiSdkError`. Subclasses + HTTP mapping:
 ## References
 
 - Architecture: [`ARCHITECTURE.md`](../../ARCHITECTURE.md) at SDK root
-- Fee flow & math: [`docs/FEE_FLOW.md`](../../../docs/FEE_FLOW.md)
+- Fee flow & math: see [`@pafi-dev/core` README — Operator fee quoter](../core/README.md#operator-fee-quoter)
 
 ## License