# Changelog

All notable changes to `liquid-sdk` will be documented in this file.

## [1.7.6] - 2026-06-11

### Changed
- **Breaking (fail-closed):** `deployToken` now **throws** when `pairedToken` is not WETH and no `tickIfToken0IsLiquid` is provided. The default starting tick (`-230400`) prices full supply at ~10 of the *paired* token — only meaningful for WETH (~10 ETH market cap); for any other pair it silently pegs the launch FDV to 10× that token's market price (e.g. ~$13.7k for DIEM at $1,375 — an accident, not a choice). Since LP is permanently locked, a mispriced pool cannot be fixed. Compute the anchor with `createLiquidPositionsUSD(startingMarketCapUSD, pairedTokenPriceUSD)` and pass its `tickIfToken0IsLiquid` + positions explicitly.

## [1.7.5] - 2026-06-09

### Security
- `bidInAuction` now approves WETH to `SniperUtilV2` for **exactly `amountIn`** (previously `amountIn * 10n`). Each bid's `transferFrom` consumes the full allowance, so **no standing WETH allowance survives** — removing the "drain via standing approval" surface that hit a sibling Clanker fork in 2026-05. Complements the protocol-level `paymentPerGasUnit == 0` mitigation already live on the auction contract. (#18)
  - **Action for existing users:** if you bid through an older SDK that approved a multiplier, **revoke your residual WETH allowance to `SniperUtilV2` (`0x2B6cd5Be183c388Dd0074d53c52317df1414cd9f`)**.
  - **Trade-off:** prior versions pre-approved 10× so 9 subsequent bids skipped the approve. Bots relying on that should either `WETH.approve(SNIPER_UTIL_V2, amountIn)` ahead of the auction window or start `bidInAuction` ~1 block earlier so the approve confirms in time.

## [1.7.4] - 2026-04-23

### Added
- `EXTERNAL.DIEM` — the DIEM token address on Base, for DIEM-paired token launches.
- `shiftPositions(positions, shiftBy)` — re-anchor a fixed-shape position layout to a different starting tick, preserving `positionBps`.
- `createLiquidPositionsUSD(startingMarketCapUSD, pairedTokenPriceUSD, tickSpacing?)` — the canonical 5-position "Liquid" layout re-anchored to a starting market cap, denominated in the *paired token's* USD price. Works for any pair token (WETH or DIEM); unlike `createDefaultPositions` (3-tranche), it preserves the exact `POOL_POSITIONS.Liquid` curve `deployToken()` uses by default.

### Fixed
- `deployToken` gas estimation no longer silently swallows on-chain revert errors. Previously a failing `eth_estimateGas` (e.g., insufficient msg.value, paused factory, pre-flight check revert) would be caught and replaced with a 6M fallback, causing the tx to be broadcast and burn real gas for nothing. Now a revert-shaped error bubbles to the caller; only transport-level failures fall back. Non-revert fallbacks log a warning via `console.warn`.

## [1.7.3] - 2026-04-22

### Added
- `buildAirdropExtension({ admin, merkleRoot, allocationBps, lockupDuration, vestingDuration })` — creates a `LiquidAirdropV2` extension config for use in `deployToken({ extensions: [...] })`. Double-hashed leaf format compatible with OpenZeppelin `MerkleProof`. Contract minimums enforced (1-day lockup, ≤90% allocation).

### Fixed
- `deployToken` no longer uses a hard-coded `gas: 5_000_000n` — real mainnet deploys currently require ~5.04M gas. Now uses `estimateContractGas * 1.2` with a 6M fallback so the SDK auto-adjusts as the factory evolves. Previous versions could OOG on mainnet.

### Verified
- End-to-end airdrop flow fork-tested against Base mainnet (real `LiquidAirdropV2` at `0x1423974d48f525462f1c087cBFdCC20BDBc33CdD`): deploy → state register → claim with single-leaf proof all confirmed.
- Mainnet dry-run deploy confirmed on-chain state encoding: [basescan tx](https://basescan.org/tx/0x1807c1e3eb92ccb0c32779855cd35d5581e6143d4232f4ab66d39517ee86e3d0).

## [1.2.0] - 2025-03-10

### Added
- `getDeployedTokens(deployer, fromBlock?, toBlock?)` — query all tokens deployed by an address via on-chain events
- `buildContext()` / `buildMetadata()` helpers for structured on-chain context and metadata
- `parseContext()` / `parseMetadata()` for reading context/metadata back from on-chain strings
- `LiquidContext` and `LiquidMetadata` type exports
- Auto-default `context` field to `{"interface":"SDK"}` when no context is provided to `deployToken()`
- `AGENT_README.md` — 700+ line reference optimized for AI agents and LLM-assisted development
- `llms.txt` — structured summary following the llms-txt.org specification
- `.cursor/skills/use-liquid-sdk/SKILL.md` — Cursor IDE auto-discovery skill
- 8 runnable examples in `examples/` directory

### Changed
- Expanded NPM keywords for better discoverability (erc20, deploy, defi, web3, etc.)
- Updated package description to highlight zero-API-key, single-dependency value prop
- `files` array now includes README.md, AGENT_README.md, CHANGELOG.md, and llms.txt

## [1.1.0] - 2025-02-28

### Added
- Custom position builders: `createPositions()`, `createPositionsUSD()`, `createDefaultPositions()`
- `describePositions()` for human-readable market cap range descriptions
- Tick ↔ market cap conversion utilities: `getTickFromMarketCapETH`, `getTickFromMarketCapUSD`, `marketCapFromTickETH`, `marketCapFromTickUSD`
- Dynamic fee pool data encoding: `encodeDynamicFeePoolData()`
- Sniper auction data encoding: `encodeSniperAuctionData()`
- `DEFAULT_TRANCHES_USD` preset (40% @ $500K, 50% @ $10M, 10% @ $1B)
- Pool reads: `getPoolConfig()`, `getPoolFeeState()`, `getPoolCreationTimestamp()`, `isLiquidToken0()`
- Sniper auction reads: `getAuctionState()`, `getAuctionFeeConfig()`, `getAuctionDecayStartTime()`, `getAuctionMaxRounds()`, `getAuctionGasPriceForBid()`
- MEV protection reads: `getMevBlockDelay()`, `getPoolUnlockTime()`
- Comprehensive client-side validation in `deployToken()` with clear error messages

### Changed
- Default hook switched to `HOOK_STATIC_FEE_V2` with proper two-layer pool data encoding
- Default positions changed from single full-range to 3-tranche Liquid preset
- Default MEV module switched to `SNIPER_AUCTION_V2` with 80%→40% decay over 20s

## [1.0.0] - 2025-02-15

### Added
- Initial release of `liquid-sdk`
- `LiquidSDK` class with full token lifecycle support
- `deployToken()` — deploy ERC-20 tokens with Uniswap V4 liquidity on Base
- Dev buy support — buy tokens with ETH in the same deployment transaction
- Fee management: `getAvailableFees()`, `getFeesToClaim()`, `claimFees()`
- LP reward management: `getTokenRewards()`, `collectRewards()`, `collectRewardsWithoutUnlock()`, `updateRewardRecipient()`
- Vault management: `getVaultAllocation()`, `getVaultClaimable()`, `claimVault()`
- Airdrop support: `getAirdropInfo()`, `getAirdropClaimable()`, `claimAirdrop()`
- Token info: `getTokenInfo()`, `getDeploymentInfo()`
- Token metadata updates: `updateImage()`, `updateMetadata()`
- Factory status checks: `isFactoryDeprecated()`, `isLockerEnabled()`, `isExtensionEnabled()`
- Static fee pool data encoding: `encodeStaticFeePoolData()`
- All 13 contract ABIs exported
- All type definitions exported
- Dual build output: CJS + ESM with TypeScript declarations
- Single peer dependency: `viem ^2.0.0`