@whetstone-research/doppler-sdk 1.0.36 → 1.0.37

package/README.md

@@ -15,7 +15,7 @@ The Doppler SDK exposes network-specific entrypoints for creating, managing, and
 - **Solana Clients and React**: Read clients, PDA helpers, generated codecs, and optional React bindings
 - **Token Management**: Built-in EVM support for DERC20 tokens with vesting
 - **Type Safety**: Full TypeScript support across EVM and Solana entrypoints
-- **Network Support**: EVM deployments on Base, Unichain, Ink, and other supported chains; Solana/SVM support via explicit Solana program deployments
+- **Network Support**: EVM deployments on Base, Arbitrum One, Unichain, Ink, and other supported chains; Solana/SVM support via explicit Solana program deployments
 
 ## Installation
 
@@ -1180,53 +1180,43 @@ console.log('Expected output:', quote.amountOut);
 console.log('Price after swap:', quote.sqrtPriceX96After);
 ```
 
-## Atomic Create + Pre‑Buy (Bundle)
+## Atomic Multicurve Dev Buy
 
-For static auctions, you can create the pool and execute a pre‑buy in a single transaction via the Bundler.
+Multicurve dev buys create the market and execute one exact-input purchase through Bundler in the same transaction. They support DopplerHookInitializer and Rehype initializer families; standard, scheduled, and decay initializers reject them. Production use is intended for compatible Rehype launches with no-op governance and no-op migration.
 
-High‑level flow:
-
-- Simulate create to get `CreateParams` and the predicted token address
-- Decide `amountOut` to buy, simulate `amountIn` with `simulateBundleExactOutput(...)`
-- Build Universal Router commands (e.g., via `doppler-router`)
-- Call `factory.bundle(createParams, commands, inputs, { value })`
+```ts
+const params = sdk
+  .buildMulticurveAuction()
+  // Configure token, sale, curves, and Rehype initializer as usual.
+  .withGovernance({ type: 'noOp' })
+  .withMigration({ type: 'noOp' })
+  .withDevBuy({
+    exactAmountIn: parseEther('0.01'),
+    recipient: user,
+    vesting: {
+      vestingDuration: 7n * 24n * 60n * 60n,
+      cliffDuration: 24n * 60n * 60n,
+      permissionlessClaim: false,
+    },
+  })
+  .build();
 
-See docs/quotes-and-swaps.md for a full example.
+const simulated = await sdk.factory.simulateCreateMulticurve(params);
+const result = await simulated.execute();
 
-### Multicurve Bundler Helpers
+console.log('Simulated output:', simulated.devBuy?.simulatedAmountOut);
+console.log('Actual output:', result.devBuy?.amountOut);
+```
 
-Multicurve auctions expose similar helpers that work with the Doppler Bundler once it has been upgraded
-with multicurve support (selector check added in `0.0.1-alpha.47`). The SDK now verifies the bundler bytecode
-before attempting these flows; if you see
-`Bundler at <address> does not support multicurve bundling`, deploy or point at the latest bundler release.
+Omit `vesting` to deliver the purchased tokens directly to `recipient`. When vesting is configured, Bundler holds the output and releases it under the specified schedule; this is independent from `.withVesting(...)`, which configures token allocation vesting. `cliffDuration` defaults to zero and `permissionlessClaim` defaults to `false`.
 
-```ts
-// Prepare multicurve CreateParams up front
-const createParams = sdk.factory.encodeCreateMulticurveParams(multicurveConfig);
-
-// Quote an exact-out bundle
-const exactOutQuote = await sdk.factory.simulateMulticurveBundleExactOut(
-  createParams,
-  {
-    exactAmountOut: parseEther('100'),
-  },
-);
+Native numeraire sends exactly `exactAmountIn` with the Bundler transaction. ERC-20 numeraire may require a separate exact approval transaction before the atomic create-and-buy transaction; the wallet must already hold the input token. Permit2 and Universal Router commands are not part of this flow.
 
-// Quote an exact-in bundle
-const exactInQuote = await sdk.factory.simulateMulticurveBundleExactIn(
-  createParams,
-  {
-    exactAmountIn: parseEther('25'),
-  },
-);
+Use `.withBundler(address)` for a compatible custom deployment. Read custody with `sdk.getBundler(address).getVesting(asset)` and `getClaimable(asset)`, then submit a vested claim with `claim(asset)`. Claims always pay the recorded recipient, including when `permissionlessClaim` allows another account to trigger them.
 
-console.log('Predicted asset:', exactOutQuote.asset);
-console.log('PoolKey:', exactOutQuote.poolKey);
-console.log('Input required:', exactOutQuote.amountIn);
-```
+Bundler is exact-input only and provides no minimum output, deadline, or slippage guard. `simulateCreateMulticurve` returns the informational `simulatedAmountOut`; execution returns the amount verified from the Bundler receipt.
 
-The multicurve helpers automatically normalise the returned PoolKey to maintain canonical token ordering and
-hash the result when collecting fees, so consumers no longer need to manually assemble the PoolId.
+See [docs/quotes-and-swaps.md](./docs/quotes-and-swaps.md) and [examples/multicurve-dev-buy-weth.ts](./examples/multicurve-dev-buy-weth.ts) for complete flows.
 
 ## Migration Configuration
 
@@ -1498,6 +1488,9 @@ for (const id of SUPPORTED_CHAIN_IDS) {
 }
 ```
 
+Arbitrum One is available as `CHAIN_IDS.ARBITRUM` (`42161`) with a viem chain
+definition included in `SupportedChain`.
+
 Robinhood Chain is available as `CHAIN_IDS.ROBINHOOD` (`4663`). The SDK exposes
 addresses and support checks for it, but does not export a viem chain definition;
 use your application's chain/client setup when constructing clients.
@@ -1857,7 +1850,7 @@ pnpm dev
 
 The SDK includes comprehensive tests covering:
 
-- **Airlock Whitelisting**: Verifies that all modules are properly whitelisted on Ethereum Mainnet, Monad Mainnet, Base Mainnet, Base Sepolia, and Robinhood Chain
+- **Airlock Whitelisting**: Verifies that all modules are properly whitelisted on Ethereum Mainnet, Arbitrum One, Monad Mainnet, Base Mainnet, Base Sepolia, and Robinhood Chain
 - **Multicurve Functionality**: Tests multicurve auction creation and quoting
 - **Token Address Mining**: Tests for generating optimized token addresses
 
@@ -1871,14 +1864,14 @@ pnpm test:whitelisting
 ALCHEMY_API_KEY=your_key_here pnpm test:whitelisting
 
 # Limit to specific whitelist-audit chains when needed
-TEST_CHAINS=mainnet,base,base-sepolia,monad-mainnet,robinhood pnpm test:whitelisting
+TEST_CHAINS=mainnet,base,base-sepolia,arbitrum,monad-mainnet,robinhood pnpm test:whitelisting
 ```
 
-The whitelisting suite is scoped to the release-audit chains: Ethereum Mainnet, Monad Mainnet, Base Mainnet, Base Sepolia, and Robinhood Chain.
+The whitelisting suite is scoped to the release-audit chains: Ethereum Mainnet, Arbitrum One, Monad Mainnet, Base Mainnet, Base Sepolia, and Robinhood Chain.
 
 Whitelisting test RPC priority is:
 
-1. Chain-specific RPC URL env var (`ETH_MAINNET_RPC_URL`, `BASE_RPC_URL`, `BASE_SEPOLIA_RPC_URL`, `MONAD_MAINNET_RPC_URL`)
+1. Chain-specific RPC URL env var (`ETH_MAINNET_RPC_URL`, `ARBITRUM_RPC_URL`, `BASE_RPC_URL`, `BASE_SEPOLIA_RPC_URL`)
 2. `ALCHEMY_API_KEY` fallback for supported Alchemy networks, including Monad Mainnet
 3. Public/default RPC URL
 
@@ -1899,6 +1892,7 @@ You can also provide chain-specific RPC URLs directly:
 
 ```bash
 ETH_MAINNET_RPC_URL=https://... TEST_CHAIN=mainnet pnpm test:fork
+ARBITRUM_RPC_URL=https://... TEST_CHAIN=arbitrum pnpm test:fork
 ETH_SEPOLIA_RPC_URL=https://... TEST_CHAIN=eth-sepolia pnpm test:fork
 ```