auctionflow-sdk 1.2.0 → 1.3.0

package/dist/index.mjs

@@ -5,6 +5,10 @@ import {
   zeroAddress
 } from "viem";
 
+// src/constants/protocol.ts
+var MIN_LIQUIDITY_BPS = 2e3;
+var DEFAULT_LIQUIDITY_BPS = 5e3;
+
 // src/builders/auction-builder.ts
 var AuctionBuilder = class {
   config = {};
@@ -27,6 +31,16 @@ var AuctionBuilder = class {
     this.config.maxRaise = maxRaise;
     return this;
   }
+  /**
+   * Share of the raise, in basis points, seeded into a Uniswap pool when the
+   * auction migrates (5000 = 50%). The rest goes to the creator. Defaults to
+   * 50%; must be between 20% and 100%.
+   */
+  withLiquidity(liquidityBps) {
+    if (!Number.isInteger(liquidityBps)) throw new Error("liquidityBps must be an integer");
+    this.config.liquidityBps = BigInt(liquidityBps);
+    return this;
+  }
   withSchedule(startTime, endTime) {
     this.config.startTime = startTime;
     this.config.endTime = endTime;
@@ -49,11 +63,15 @@ var AuctionBuilder = class {
         throw new Error(`Missing required field: ${key}`);
       }
     }
-    const config = this.config;
+    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.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;
+    if (liquidityBps < BigInt(MIN_LIQUIDITY_BPS) || liquidityBps > 10000n) {
+      throw new Error(`liquidityBps must be between ${MIN_LIQUIDITY_BPS} and 10000`);
+    }
     if (config.startTime >= config.endTime) {
       throw new Error("startTime must be before endTime");
     }
@@ -63,7 +81,7 @@ var AuctionBuilder = class {
 
 // src/constants/addresses.ts
 var AUCTION_ADDRESSES = {
-  84532: "0x91519ca6c0b7a0e116a590c89a095199ff9f0054",
+  84532: "0x722f4521b96aca1df7c65a1dbe3b1713803ccea9",
   8453: "0x0000000000000000000000000000000000000000"
   // not yet deployed
 };
@@ -86,10 +104,67 @@ var tokenAuctionAbi = [
         "name": "defaultFeeBps_",
         "type": "uint256",
         "internalType": "uint256"
+      },
+      {
+        "name": "positionManager_",
+        "type": "address",
+        "internalType": "contract INonfungiblePositionManager"
       }
     ],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "MAX_FEE_BPS",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "MAX_LP_FEE_SHARE_BPS",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "MIN_LIQUIDITY_BPS",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "POOL_FEE",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint24",
+        "internalType": "uint24"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "auctionCount",
@@ -163,6 +238,16 @@ var tokenAuctionAbi = [
             "name": "protocolFeeBps",
             "type": "uint256",
             "internalType": "uint256"
+          },
+          {
+            "name": "liquidityBps",
+            "type": "uint256",
+            "internalType": "uint256"
+          },
+          {
+            "name": "lpFeeShareBps",
+            "type": "uint256",
+            "internalType": "uint256"
           }
         ]
       },
@@ -197,11 +282,40 @@ var tokenAuctionAbi = [
         "name": "amount",
         "type": "uint256",
         "internalType": "uint256"
+      },
+      {
+        "name": "maxCost",
+        "type": "uint256",
+        "internalType": "uint256"
       }
     ],
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "collectFees",
+    "inputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "tokenFees",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "paymentFees",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "completeAuction",
@@ -220,63 +334,107 @@ var tokenAuctionAbi = [
     "name": "createAuction",
     "inputs": [
       {
-        "name": "name",
-        "type": "string",
-        "internalType": "string"
-      },
-      {
-        "name": "symbol",
-        "type": "string",
-        "internalType": "string"
-      },
+        "name": "p",
+        "type": "tuple",
+        "internalType": "struct TokenAuction.AuctionParams",
+        "components": [
+          {
+            "name": "name",
+            "type": "string",
+            "internalType": "string"
+          },
+          {
+            "name": "symbol",
+            "type": "string",
+            "internalType": "string"
+          },
+          {
+            "name": "maxSupply",
+            "type": "uint256",
+            "internalType": "uint256"
+          },
+          {
+            "name": "paymentToken",
+            "type": "address",
+            "internalType": "address"
+          },
+          {
+            "name": "basePrice",
+            "type": "uint256",
+            "internalType": "uint256"
+          },
+          {
+            "name": "slope",
+            "type": "uint256",
+            "internalType": "uint256"
+          },
+          {
+            "name": "maxRaise",
+            "type": "uint256",
+            "internalType": "uint256"
+          },
+          {
+            "name": "startTime",
+            "type": "uint256",
+            "internalType": "uint256"
+          },
+          {
+            "name": "endTime",
+            "type": "uint256",
+            "internalType": "uint256"
+          },
+          {
+            "name": "liquidityBps",
+            "type": "uint256",
+            "internalType": "uint256"
+          }
+        ]
+      }
+    ],
+    "outputs": [
       {
-        "name": "maxSupply",
+        "name": "auctionId",
         "type": "uint256",
         "internalType": "uint256"
-      },
+      }
+    ],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "custodied",
+    "inputs": [
       {
-        "name": "paymentToken",
+        "name": "",
         "type": "address",
         "internalType": "address"
-      },
-      {
-        "name": "basePrice",
-        "type": "uint256",
-        "internalType": "uint256"
-      },
-      {
-        "name": "slope",
-        "type": "uint256",
-        "internalType": "uint256"
-      },
-      {
-        "name": "maxRaise",
-        "type": "uint256",
-        "internalType": "uint256"
-      },
-      {
-        "name": "startTime",
-        "type": "uint256",
-        "internalType": "uint256"
-      },
+      }
+    ],
+    "outputs": [
       {
-        "name": "endTime",
+        "name": "",
         "type": "uint256",
         "internalType": "uint256"
       }
     ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "defaultFeeBps",
+    "inputs": [],
     "outputs": [
       {
-        "name": "auctionId",
+        "name": "",
         "type": "uint256",
         "internalType": "uint256"
       }
     ],
-    "stateMutability": "nonpayable"
+    "stateMutability": "view"
   },
   {
     "type": "function",
-    "name": "defaultFeeBps",
+    "name": "defaultLpFeeShareBps",
     "inputs": [],
     "outputs": [
       {
@@ -335,6 +493,19 @@ var tokenAuctionAbi = [
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "migrate",
+    "inputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "owner",
@@ -348,6 +519,57 @@ var tokenAuctionAbi = [
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "poolOf",
+    "inputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "positionId",
+    "inputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "positionManager",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "address",
+        "internalType": "contract INonfungiblePositionManager"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "proceedsWithdrawn",
@@ -387,6 +609,63 @@ var tokenAuctionAbi = [
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "setDefaultFeeBps",
+    "inputs": [
+      {
+        "name": "feeBps",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "setDefaultLpFeeShareBps",
+    "inputs": [
+      {
+        "name": "shareBps",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "setProtocolFeeRecipient",
+    "inputs": [
+      {
+        "name": "recipient",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "sweep",
+    "inputs": [
+      {
+        "name": "token",
+        "type": "address",
+        "internalType": "contract IERC20"
+      },
+      {
+        "name": "to",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "transferOwnership",
@@ -400,6 +679,29 @@ var tokenAuctionAbi = [
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "uniswapV3SwapCallback",
+    "inputs": [
+      {
+        "name": "amount0Delta",
+        "type": "int256",
+        "internalType": "int256"
+      },
+      {
+        "name": "amount1Delta",
+        "type": "int256",
+        "internalType": "int256"
+      },
+      {
+        "name": "data",
+        "type": "bytes",
+        "internalType": "bytes"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "userPurchases",
@@ -519,6 +821,12 @@ var tokenAuctionAbi = [
         "type": "uint256",
         "indexed": false,
         "internalType": "uint256"
+      },
+      {
+        "name": "liquidityBps",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
       }
     ],
     "anonymous": false
@@ -534,10 +842,103 @@ var tokenAuctionAbi = [
         "internalType": "uint256"
       },
       {
-        "name": "liquidityPool",
+        "name": "pool",
         "type": "address",
         "indexed": false,
         "internalType": "address"
+      },
+      {
+        "name": "positionId",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "tokenLiquidity",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "paymentLiquidity",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "event",
+    "name": "DefaultFeeBpsUpdated",
+    "inputs": [
+      {
+        "name": "previous",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "current",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "event",
+    "name": "DefaultLpFeeShareBpsUpdated",
+    "inputs": [
+      {
+        "name": "previous",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "current",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "event",
+    "name": "LpFeesCollected",
+    "inputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "indexed": true,
+        "internalType": "uint256"
+      },
+      {
+        "name": "creatorTokenFees",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "creatorPaymentFees",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "protocolTokenFees",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "protocolPaymentFees",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
       }
     ],
     "anonymous": false
@@ -586,6 +987,50 @@ var tokenAuctionAbi = [
     ],
     "anonymous": false
   },
+  {
+    "type": "event",
+    "name": "ProtocolFeeRecipientUpdated",
+    "inputs": [
+      {
+        "name": "previous",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "current",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "event",
+    "name": "Swept",
+    "inputs": [
+      {
+        "name": "token",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "to",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "amount",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      }
+    ],
+    "anonymous": false
+  },
   {
     "type": "event",
     "name": "TokensPurchased",
@@ -677,9 +1122,13 @@ var tokenAuctionAbi = [
 
 // src/utils/bonding-curve.ts
 var TOKEN_SCALE = 10n ** 18n;
+var ceilDiv = (a, b) => (a + b - 1n) / b;
 function calculateBuyCost(currentSupply, amount, basePrice, slope) {
-  const linearCost = basePrice * amount / TOKEN_SCALE;
-  const curveCost = slope * amount * (2n * currentSupply + amount) / (2n * TOKEN_SCALE * TOKEN_SCALE);
+  const linearCost = ceilDiv(basePrice * amount, TOKEN_SCALE);
+  const curveCost = ceilDiv(
+    slope * amount * (2n * currentSupply + amount),
+    2n * TOKEN_SCALE * TOKEN_SCALE
+  );
   return linearCost + curveCost;
 }
 function spotPrice(currentSupply, basePrice, slope) {
@@ -695,6 +1144,37 @@ function calculateBuyQuote(currentSupply, amount, basePrice, slope, feeBps) {
     spotPriceAfter: spotPrice(currentSupply + amount, basePrice, slope)
   };
 }
+var DEFAULT_SLIPPAGE_BPS = 100;
+function applySlippage(total, slippageBps) {
+  if (!Number.isInteger(slippageBps) || slippageBps < 0 || slippageBps > 1e4) {
+    throw new Error("slippageBps must be an integer between 0 and 10000");
+  }
+  return (total * BigInt(1e4 + slippageBps) + 9999n) / 10000n;
+}
+function maxBuyable(currentSupply, budget, basePrice, slope, upperBound) {
+  let hi = budget * TOKEN_SCALE / basePrice + 1n;
+  if (hi > upperBound) hi = upperBound;
+  let lo = 0n;
+  while (lo < hi) {
+    const mid = (lo + hi + 1n) / 2n;
+    if (calculateBuyCost(currentSupply, mid, basePrice, slope) <= budget) lo = mid;
+    else hi = mid - 1n;
+  }
+  return lo;
+}
+function fillPurchase(currentSupply, requested, basePrice, slope, totalRaised, maxRaise) {
+  const remaining = maxRaise - totalRaised;
+  const cost = calculateBuyCost(currentSupply, requested, basePrice, slope);
+  if (cost < remaining) return { amount: requested, cost, fillsAuction: false };
+  if (cost === remaining) return { amount: requested, cost, fillsAuction: true };
+  const amount = maxBuyable(currentSupply, remaining, basePrice, slope, requested);
+  if (amount === 0n) throw new Error("Auction is sold out");
+  return {
+    amount,
+    cost: calculateBuyCost(currentSupply, amount, basePrice, slope),
+    fillsAuction: true
+  };
+}
 
 // src/utils/chains.ts
 import { base, baseSepolia } from "viem/chains";
@@ -743,34 +1223,50 @@ var AuctionFlowSDK = class {
       abi: tokenAuctionAbi,
       functionName: "createAuction",
       args: [
-        config.name,
-        config.symbol,
-        config.maxSupply,
-        config.paymentToken,
-        config.basePrice,
-        config.slope,
-        config.maxRaise,
-        config.startTime,
-        config.endTime
+        {
+          name: config.name,
+          symbol: config.symbol,
+          maxSupply: config.maxSupply,
+          paymentToken: config.paymentToken,
+          basePrice: config.basePrice,
+          slope: config.slope,
+          maxRaise: config.maxRaise,
+          startTime: config.startTime,
+          endTime: config.endTime,
+          liquidityBps: config.liquidityBps ?? BigInt(DEFAULT_LIQUIDITY_BPS)
+        }
       ]
     });
     return hash;
   }
-  async buyTokens(auctionId, amount) {
+  /**
+   * Buy `amount` tokens (in token wei). The price rises with every purchase, so
+   * the contract takes a maximum total cost and reverts if the price moved past
+   * it before the transaction landed.
+   *
+   * Pass `maxCost` to set that bound exactly, or `slippageBps` to derive it
+   * from a fresh quote (default 100 = 1% above the quoted total).
+   */
+  async buyTokens(auctionId, amount, options = {}) {
     if (!this.walletClient) throw new Error("Wallet client required");
+    const maxCost = options.maxCost ?? applySlippage(
+      (await this.getQuote(auctionId, amount)).totalCost,
+      options.slippageBps ?? DEFAULT_SLIPPAGE_BPS
+    );
     const hash = await this.walletClient.writeContract({
       chain: this.chain,
       account: this.walletClient.account,
       address: this.auctionAddress,
       abi: tokenAuctionAbi,
       functionName: "buyTokens",
-      args: [auctionId, amount]
+      args: [auctionId, amount, maxCost]
     });
     return hash;
   }
   /**
-   * Withdraw a completed auction's raised payment tokens to its creator.
-   * Only the auction's creator can call this, and only once.
+   * Pay a completed auction's creator their share of the raise: everything
+   * not reserved for Uniswap liquidity. Creator only, once, before or after
+   * migration.
    */
   async withdrawProceeds(auctionId) {
     if (!this.walletClient) throw new Error("Wallet client required");
@@ -784,6 +1280,53 @@ var AuctionFlowSDK = class {
     });
     return hash;
   }
+  /**
+   * Move a completed auction's liquidity into a Uniswap v3 pool at the
+   * auction's final price, lock it, and unlock the token for trading. Anyone
+   * may call it.
+   */
+  async migrate(auctionId) {
+    return this.write("migrate", [auctionId]);
+  }
+  /**
+   * Collect the migrated pool's trading fees. The protocol takes its share and
+   * the creator receives the rest. Anyone may call it.
+   */
+  async collectFees(auctionId) {
+    return this.write("collectFees", [auctionId]);
+  }
+  /** The Uniswap pool and position for a migrated auction. */
+  async getMigration(auctionId) {
+    const [pool, positionId] = await Promise.all([
+      this.publicClient.readContract({
+        address: this.auctionAddress,
+        abi: tokenAuctionAbi,
+        functionName: "poolOf",
+        args: [auctionId]
+      }),
+      this.publicClient.readContract({
+        address: this.auctionAddress,
+        abi: tokenAuctionAbi,
+        functionName: "positionId",
+        args: [auctionId]
+      })
+    ]);
+    return {
+      pool: pool === zeroAddress ? null : pool,
+      positionId: positionId === 0n ? null : positionId
+    };
+  }
+  async write(functionName, args) {
+    if (!this.walletClient) throw new Error("Wallet client required");
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account,
+      address: this.auctionAddress,
+      abi: tokenAuctionAbi,
+      functionName,
+      args
+    });
+  }
   // Read: Has an auction's creator already withdrawn its proceeds?
   async hasWithdrawnProceeds(auctionId) {
     return this.publicClient.readContract({
@@ -806,18 +1349,22 @@ var AuctionFlowSDK = class {
   // Read: Get buy quote (off-chain calculation)
   async getQuote(auctionId, amount) {
     const auction = await this.getAuction(auctionId);
-    const quote = calculateBuyQuote(
+    const fill = fillPurchase(
       auction.totalSold,
       amount,
       auction.basePrice,
       auction.slope,
-      auction.protocolFeeBps
+      auction.totalRaised,
+      auction.maxRaise
     );
+    const fee = fill.cost * auction.protocolFeeBps / 10000n;
     return {
-      cost: quote.cost,
-      fee: quote.fee,
-      totalCost: quote.total,
-      spotPriceAfter: quote.spotPriceAfter
+      amount: fill.amount,
+      cost: fill.cost,
+      fee,
+      totalCost: fill.cost + fee,
+      spotPriceAfter: spotPrice(auction.totalSold + fill.amount, auction.basePrice, auction.slope),
+      fillsAuction: fill.fillsAuction
     };
   }
   // Read: Get spot price
@@ -843,7 +1390,9 @@ var AuctionFlowSDK = class {
       state: raw.state,
       totalRaised: raw.totalRaised,
       totalSold: raw.totalSold,
-      protocolFeeBps: raw.config.protocolFeeBps
+      protocolFeeBps: raw.config.protocolFeeBps,
+      liquidityBps: raw.config.liquidityBps,
+      lpFeeShareBps: raw.config.lpFeeShareBps
     };
   }
 };
@@ -861,9 +1410,15 @@ export {
   AuctionBuilder,
   AuctionFlowSDK,
   AuctionState,
+  DEFAULT_LIQUIDITY_BPS,
+  DEFAULT_SLIPPAGE_BPS,
+  MIN_LIQUIDITY_BPS,
   USDC_ADDRESSES,
+  applySlippage,
   calculateBuyCost,
   calculateBuyQuote,
+  fillPurchase,
+  maxBuyable,
   spotPrice
 };
 //# sourceMappingURL=index.mjs.map