@whetstone-research/doppler-sdk 1.0.2 → 1.0.5

package/README.md

@@ -26,10 +26,14 @@ yarn add @whetstone-research/doppler-sdk viem
 pnpm add @whetstone-research/doppler-sdk viem
 ```
 
+Import EVM APIs from `@whetstone-research/doppler-sdk/evm`. Solana APIs live under
+`@whetstone-research/doppler-sdk/solana` and React bindings under
+`@whetstone-research/doppler-sdk/solana/react`.
+
 ## Quick Start
 
 ```typescript
-import { DopplerSDK } from '@whetstone-research/doppler-sdk';
+import { DopplerSDK } from '@whetstone-research/doppler-sdk/evm';
 import { createPublicClient, createWalletClient, http } from 'viem';
 import { base } from 'viem/chains';
 
@@ -60,7 +64,7 @@ const sdk = new DopplerSDK({
 Static auctions use Uniswap V3 pools with concentrated liquidity in a fixed price range. They're ideal for simple, predictable price discovery.
 
 ```typescript
-import { StaticAuctionBuilder } from '@whetstone-research/doppler-sdk';
+import { StaticAuctionBuilder } from '@whetstone-research/doppler-sdk/evm';
 
 const params = new StaticAuctionBuilder()
   .tokenConfig({
@@ -94,6 +98,8 @@ console.log('Pool address:', result.poolAddress);
 console.log('Token address:', result.tokenAddress);
 ```
 
+If you set `cliffDuration > 0`, the SDK now automatically uses the DERC20 V2 factory and exposes schedule-aware token reads via `sdk.getDerc20V2(tokenAddress)`.
+
 > **Tick spacing reminder:** When you provide ticks manually via `poolByTicks`, make sure both `startTick` and `endTick` are exact multiples of the fee tier's tick spacing (100→1, 500→10, 3000→60, 10000→200). The SDK now validates this locally and will fail fast if the ticks are misaligned.
 
 ### Static Auction with Lockable Beneficiaries (V3)
@@ -105,7 +111,7 @@ import {
   StaticAuctionBuilder,
   WAD,
   getAirlockOwner,
-} from '@whetstone-research/doppler-sdk';
+} from '@whetstone-research/doppler-sdk/evm';
 import { parseEther } from 'viem';
 
 // Get the protocol owner (required beneficiary with min 5%)
@@ -164,7 +170,7 @@ Dynamic auctions use Uniswap V4 hooks to implement gradual Dutch auctions where
 import {
   DynamicAuctionBuilder,
   DAY_SECONDS,
-} from '@whetstone-research/doppler-sdk';
+} from '@whetstone-research/doppler-sdk/evm';
 
 const params = new DynamicAuctionBuilder()
   .tokenConfig({
@@ -299,7 +305,7 @@ Multicurve auctions use a Uniswap V4-style initializer that seeds liquidity acro
 **Standard Multicurve with Migration:**
 
 ```typescript
-import { MulticurveBuilder } from '@whetstone-research/doppler-sdk';
+import { MulticurveBuilder } from '@whetstone-research/doppler-sdk/evm';
 import { parseEther } from 'viem';
 import { base } from 'viem/chains';
 
@@ -346,7 +352,7 @@ console.log('Token address:', result.tokenAddress);
 **Market Cap Presets (Low / Medium / High):**
 
 ```typescript
-import { MulticurveBuilder, FEE_TIERS } from '@whetstone-research/doppler-sdk';
+import { MulticurveBuilder, FEE_TIERS } from '@whetstone-research/doppler-sdk/evm';
 import { parseEther } from 'viem';
 import { base } from 'viem/chains';
 
@@ -387,7 +393,7 @@ Pass `presets` to pick a subset (e.g. `['medium', 'high']`) or provide `override
 **Scheduled Multicurve Launch:**
 
 ```typescript
-import { MulticurveBuilder } from '@whetstone-research/doppler-sdk';
+import { MulticurveBuilder } from '@whetstone-research/doppler-sdk/evm';
 import { parseEther } from 'viem';
 import { base } from 'viem/chains';
 
@@ -438,7 +444,7 @@ Ensure the target chain has the scheduled multicurve initializer whitelisted. If
 **Decay Multicurve Launch (Dynamic Fee):**
 
 ```typescript
-import { MulticurveBuilder } from '@whetstone-research/doppler-sdk';
+import { MulticurveBuilder } from '@whetstone-research/doppler-sdk/evm';
 import { parseEther } from 'viem';
 import { baseSepolia } from 'viem/chains';
 
@@ -495,7 +501,7 @@ For decay pools, `pool.fee` is always the terminal fee (`endFee`) of the schedul
 When you want fee revenue to flow to specific addresses without migrating liquidity after the auction, use lockable beneficiaries with NoOp migration:
 
 ```typescript
-import { WAD } from '@whetstone-research/doppler-sdk';
+import { WAD } from '@whetstone-research/doppler-sdk/evm';
 
 // Define beneficiaries with shares that sum to WAD (1e18 = 100%)
 // IMPORTANT: Protocol owner must be included with at least 5% shares
@@ -575,7 +581,7 @@ Prefer using the builders to construct `CreateStaticAuctionParams` and `CreateDy
 import {
   StaticAuctionBuilder,
   DynamicAuctionBuilder,
-} from '@whetstone-research/doppler-sdk';
+} from '@whetstone-research/doppler-sdk/evm';
 import { parseEther } from 'viem';
 
 // Dynamic auction via builder
@@ -807,7 +813,7 @@ await token.release();
 Alternatively, you can instantiate directly if needed:
 
 ```typescript
-import { Derc20 } from '@whetstone-research/doppler-sdk';
+import { Derc20 } from '@whetstone-research/doppler-sdk/evm';
 const tokenDirect = new Derc20(publicClient, walletClient, tokenAddress);
 ```
 
@@ -818,7 +824,7 @@ DERC20 extends OpenZeppelin's ERC20Votes. Voting power is tracked via checkpoint
 Basics:
 
 ```ts
-import { Derc20 } from '@whetstone-research/doppler-sdk';
+import { Derc20 } from '@whetstone-research/doppler-sdk/evm';
 
 const token = sdk.getDerc20(tokenAddress);
 
@@ -924,7 +930,7 @@ Notes
 The SDK also provides an ETH wrapper with ERC20-like interface:
 
 ```typescript
-import { Eth } from '@whetstone-research/doppler-sdk';
+import { Eth } from '@whetstone-research/doppler-sdk/evm';
 
 const eth = new Eth(publicClient, walletClient);
 const balance = await eth.getBalanceOf(address);
@@ -1138,7 +1144,7 @@ import {
   DopplerSDK,
   createAirlockBeneficiary,
   getAirlockOwner,
-} from '@whetstone-research/doppler-sdk';
+} from '@whetstone-research/doppler-sdk/evm';
 import { parseEther } from 'viem';
 
 const sdk = new DopplerSDK({ publicClient, chainId });
@@ -1177,7 +1183,7 @@ import {
   isSupportedChainId,
   type SupportedChainId,
   type ChainAddresses,
-} from '@whetstone-research/doppler-sdk';
+} from '@whetstone-research/doppler-sdk/evm';
 
 // Validate and narrow a chain ID
 function ensureSupported(id: number): SupportedChainId {
@@ -1228,7 +1234,7 @@ import {
   StaticAuctionBuilder,
   mineTokenAddress,
   getAddresses,
-} from '@whetstone-research/doppler-sdk';
+} from '@whetstone-research/doppler-sdk/evm';
 import { parseEther } from 'viem';
 import { base } from 'viem/chains';
 
@@ -1296,7 +1302,7 @@ import {
   getAddresses,
   DopplerBytecode,
   DAY_SECONDS,
-} from '@whetstone-research/doppler-sdk';
+} from '@whetstone-research/doppler-sdk/evm';
 import { parseEther, keccak256, encodePacked, encodeAbiParameters } from 'viem';
 import { base } from 'viem/chains';
 
@@ -1391,7 +1397,7 @@ import {
   MulticurveBuilder,
   mineTokenAddress,
   getAddresses,
-} from '@whetstone-research/doppler-sdk';
+} from '@whetstone-research/doppler-sdk/evm';
 import { parseEther } from 'viem';
 import { base } from 'viem/chains';
 
@@ -1521,7 +1527,7 @@ import type {
   PoolInfo,
   HookInfo,
   VestingConfig,
-} from '@whetstone-research/doppler-sdk';
+} from '@whetstone-research/doppler-sdk/evm';
 ```
 
 ## Development