auctionflow-sdk 3.0.0 → 3.1.0

package/README.md

@@ -217,10 +217,12 @@ await sdk.claim(tokenAddress);
 **Migration** pairs the auction's liquidity share of the raise with newly
 minted tokens and opens a 1% Uniswap v3 pool **at the auction's final price**,
 so there is no price jump to arbitrage. If someone initialised the pool
-beforehand at a different price, migration corrects it first. The position NFT
-stays in the auction contract forever, so the liquidity can never be pulled.
-Tokens Uniswap doesn't use are burned, and leftover funds are credited to the
-creator to `claim`.
+beforehand below that price, migration raises it first; if above, the reserve's
+funds go in at or below the final price and its tokens above the pool's price,
+so neither can be traded against at a better price than the auction's. The
+position NFT stays in the auction contract forever, so the liquidity can never
+be pulled. Tokens Uniswap doesn't use are burned. Migration never pays the
+creator: if Uniswap refuses the position, it reverts and can be retried.
 
 **Withdrawal** pays the creator everything not reserved for liquidity: with the
 default 50% share, half the raise. It works before or after migration.
@@ -277,7 +279,7 @@ Early buyers pay less; later buyers pay more.
 | `getMigration(auctionId)` | The pool address and position NFT id, or `null` before migration. |
 | `withdrawProceeds(auctionId)` | Pay the creator their share of the raise (what isn't reserved for liquidity). Creator-only, once. |
 | `collectFees(auctionId)` | Collect the pool's trading fees: the protocol's share accrues to the protocol and the rest is credited to the creator. Anyone may call. |
-| `claim(token)` | Withdraw everything credited to the connected account in `token`: a creator's share of pool fees, and any reserve migration couldn't place. |
+| `claim(token)` | Withdraw everything credited to the connected account in `token`: a creator's share of pool fees. |
 | `getClaimable(token, account)` | How much of `token` is credited to `account`. |
 | `claimProtocolFees(token)` | Send the protocol's unclaimed fees in `token` to the fee recipient. Anyone may call. |
 | `getProtocolFees(token)` | The protocol's unclaimed fees in `token`. |

package/dist/index.d.mts

@@ -183,7 +183,7 @@ declare class AuctionFlowSDK {
     collectFees(auctionId: bigint): Promise<Hash>;
     /**
      * Withdraw everything credited to the connected account in `token`: a
-     * creator's share of pool fees, and any reserve migration couldn't place.
+     * creator's share of pool fees.
      */
     claim(token: Address): Promise<Hash>;
     /** Send the protocol's unclaimed fees in `token` to the fee recipient. Anyone may call it. */
@@ -208,6 +208,11 @@ declare const WETH_ADDRESSES: Record<SupportedChainId, Address>;
 
 /** Smallest share of the raise an auction may commit to Uniswap liquidity (20%). Mirrors TokenAuction.MIN_LIQUIDITY_BPS. */
 declare const MIN_LIQUIDITY_BPS = 2000;
+/**
+ * Lowest base price a curve may start at, in payment units × 1e18 per whole
+ * token. Mirrors TokenAuction.MIN_BASE_PRICE.
+ */
+declare const MIN_BASE_PRICE = 1000000n;
 /** Liquidity share the builder uses when none is given (50%). */
 declare const DEFAULT_LIQUIDITY_BPS = 5000;
 
@@ -1499,4 +1504,4 @@ declare const tokenAuctionAbi: readonly [{
     }];
 }];
 
-export { AUCTION_ADDRESSES, AuctionBuilder, type AuctionConfig, type AuctionData, AuctionFlowSDK, AuctionState, type BuyQuote, DEFAULT_LIQUIDITY_BPS, DEFAULT_SLIPPAGE_BPS, type LaunchPreset, MIN_LIQUIDITY_BPS, type MigrationInfo, PRICE_SCALE, type SellQuote, type SupportedChainId, type TransactionResult, USDC_ADDRESSES, WETH_ADDRESSES, applySellSlippage, applySlippage, calculateBuyCost, calculateBuyQuote, calculateSellProceeds, fillPurchase, formatCurvePrice, maxBuyable, parseCurvePrice, spotPrice, tokenAuctionAbi };
+export { AUCTION_ADDRESSES, AuctionBuilder, type AuctionConfig, type AuctionData, AuctionFlowSDK, AuctionState, type BuyQuote, DEFAULT_LIQUIDITY_BPS, DEFAULT_SLIPPAGE_BPS, type LaunchPreset, MIN_BASE_PRICE, MIN_LIQUIDITY_BPS, type MigrationInfo, PRICE_SCALE, type SellQuote, type SupportedChainId, type TransactionResult, USDC_ADDRESSES, WETH_ADDRESSES, applySellSlippage, applySlippage, calculateBuyCost, calculateBuyQuote, calculateSellProceeds, fillPurchase, formatCurvePrice, maxBuyable, parseCurvePrice, spotPrice, tokenAuctionAbi };

package/dist/index.d.ts

@@ -183,7 +183,7 @@ declare class AuctionFlowSDK {
     collectFees(auctionId: bigint): Promise<Hash>;
     /**
      * Withdraw everything credited to the connected account in `token`: a
-     * creator's share of pool fees, and any reserve migration couldn't place.
+     * creator's share of pool fees.
      */
     claim(token: Address): Promise<Hash>;
     /** Send the protocol's unclaimed fees in `token` to the fee recipient. Anyone may call it. */
@@ -208,6 +208,11 @@ declare const WETH_ADDRESSES: Record<SupportedChainId, Address>;
 
 /** Smallest share of the raise an auction may commit to Uniswap liquidity (20%). Mirrors TokenAuction.MIN_LIQUIDITY_BPS. */
 declare const MIN_LIQUIDITY_BPS = 2000;
+/**
+ * Lowest base price a curve may start at, in payment units × 1e18 per whole
+ * token. Mirrors TokenAuction.MIN_BASE_PRICE.
+ */
+declare const MIN_BASE_PRICE = 1000000n;
 /** Liquidity share the builder uses when none is given (50%). */
 declare const DEFAULT_LIQUIDITY_BPS = 5000;
 
@@ -1499,4 +1504,4 @@ declare const tokenAuctionAbi: readonly [{
     }];
 }];
 
-export { AUCTION_ADDRESSES, AuctionBuilder, type AuctionConfig, type AuctionData, AuctionFlowSDK, AuctionState, type BuyQuote, DEFAULT_LIQUIDITY_BPS, DEFAULT_SLIPPAGE_BPS, type LaunchPreset, MIN_LIQUIDITY_BPS, type MigrationInfo, PRICE_SCALE, type SellQuote, type SupportedChainId, type TransactionResult, USDC_ADDRESSES, WETH_ADDRESSES, applySellSlippage, applySlippage, calculateBuyCost, calculateBuyQuote, calculateSellProceeds, fillPurchase, formatCurvePrice, maxBuyable, parseCurvePrice, spotPrice, tokenAuctionAbi };
+export { AUCTION_ADDRESSES, AuctionBuilder, type AuctionConfig, type AuctionData, AuctionFlowSDK, AuctionState, type BuyQuote, DEFAULT_LIQUIDITY_BPS, DEFAULT_SLIPPAGE_BPS, type LaunchPreset, MIN_BASE_PRICE, MIN_LIQUIDITY_BPS, type MigrationInfo, PRICE_SCALE, type SellQuote, type SupportedChainId, type TransactionResult, USDC_ADDRESSES, WETH_ADDRESSES, applySellSlippage, applySlippage, calculateBuyCost, calculateBuyQuote, calculateSellProceeds, fillPurchase, formatCurvePrice, maxBuyable, parseCurvePrice, spotPrice, tokenAuctionAbi };

package/dist/index.js

@@ -26,6 +26,7 @@ __export(index_exports, {
   AuctionState: () => AuctionState,
   DEFAULT_LIQUIDITY_BPS: () => DEFAULT_LIQUIDITY_BPS,
   DEFAULT_SLIPPAGE_BPS: () => DEFAULT_SLIPPAGE_BPS,
+  MIN_BASE_PRICE: () => MIN_BASE_PRICE,
   MIN_LIQUIDITY_BPS: () => MIN_LIQUIDITY_BPS,
   PRICE_SCALE: () => PRICE_SCALE,
   USDC_ADDRESSES: () => USDC_ADDRESSES,
@@ -49,6 +50,7 @@ var import_viem2 = require("viem");
 
 // src/constants/protocol.ts
 var MIN_LIQUIDITY_BPS = 2e3;
+var MIN_BASE_PRICE = 1000000n;
 var DEFAULT_LIQUIDITY_BPS = 5e3;
 
 // src/builders/auction-builder.ts
@@ -106,7 +108,7 @@ var AuctionBuilder = class {
     }
     const config = { liquidityBps: BigInt(DEFAULT_LIQUIDITY_BPS), ...this.config };
     if (config.maxSupply <= 0n) throw new Error("maxSupply must be greater than 0");
-    if (config.basePrice <= 0n) throw new Error("basePrice must be greater than 0");
+    if (config.basePrice < MIN_BASE_PRICE) throw new Error(`basePrice must be at least ${MIN_BASE_PRICE}`);
     if (config.slope < 0n) throw new Error("slope must not be negative");
     if (config.maxRaise <= 0n) throw new Error("maxRaise must be greater than 0");
     const liquidityBps = config.liquidityBps;
@@ -119,7 +121,7 @@ var AuctionBuilder = class {
 
 // src/constants/addresses.ts
 var AUCTION_ADDRESSES = {
-  84532: "0x990a04ffe0d49356321271629889fa0413ad1bdc",
+  84532: "0xad786651dcf1405bf636ce7dcdc9c8afbab420c2",
   8453: "0x0000000000000000000000000000000000000000"
   // not yet deployed
 };
@@ -2023,7 +2025,7 @@ var AuctionFlowSDK = class {
   }
   /**
    * Withdraw everything credited to the connected account in `token`: a
-   * creator's share of pool fees, and any reserve migration couldn't place.
+   * creator's share of pool fees.
    */
   async claim(token) {
     return this.write("claim", [token]);
@@ -2182,6 +2184,7 @@ var AuctionState = /* @__PURE__ */ ((AuctionState2) => {
   AuctionState,
   DEFAULT_LIQUIDITY_BPS,
   DEFAULT_SLIPPAGE_BPS,
+  MIN_BASE_PRICE,
   MIN_LIQUIDITY_BPS,
   PRICE_SCALE,
   USDC_ADDRESSES,