auctionflow-sdk 1.3.0 → 2.0.1

package/dist/index.js

@@ -27,18 +27,23 @@ __export(index_exports, {
   DEFAULT_LIQUIDITY_BPS: () => DEFAULT_LIQUIDITY_BPS,
   DEFAULT_SLIPPAGE_BPS: () => DEFAULT_SLIPPAGE_BPS,
   MIN_LIQUIDITY_BPS: () => MIN_LIQUIDITY_BPS,
+  PRICE_SCALE: () => PRICE_SCALE,
   USDC_ADDRESSES: () => USDC_ADDRESSES,
+  applySellSlippage: () => applySellSlippage,
   applySlippage: () => applySlippage,
   calculateBuyCost: () => calculateBuyCost,
   calculateBuyQuote: () => calculateBuyQuote,
+  calculateSellProceeds: () => calculateSellProceeds,
   fillPurchase: () => fillPurchase,
+  formatCurvePrice: () => formatCurvePrice,
   maxBuyable: () => maxBuyable,
+  parseCurvePrice: () => parseCurvePrice,
   spotPrice: () => spotPrice
 });
 module.exports = __toCommonJS(index_exports);
 
 // src/client.ts
-var import_viem = require("viem");
+var import_viem2 = require("viem");
 
 // src/constants/protocol.ts
 var MIN_LIQUIDITY_BPS = 2e3;
@@ -62,6 +67,7 @@ var AuctionBuilder = class {
     this.config.slope = slope;
     return this;
   }
+  /** Graduation threshold: once this much is raised, trading moves to Uniswap. */
   withMaxRaise(maxRaise) {
     this.config.maxRaise = maxRaise;
     return this;
@@ -76,9 +82,9 @@ var AuctionBuilder = class {
     this.config.liquidityBps = BigInt(liquidityBps);
     return this;
   }
-  withSchedule(startTime, endTime) {
-    this.config.startTime = startTime;
-    this.config.endTime = endTime;
+  /** Off-chain metadata for the token, such as its image (e.g. an IPFS URI). */
+  withMetadata(metadataURI) {
+    this.config.metadataURI = metadataURI;
     return this;
   }
   build() {
@@ -89,9 +95,7 @@ var AuctionBuilder = class {
       "paymentToken",
       "basePrice",
       "slope",
-      "maxRaise",
-      "startTime",
-      "endTime"
+      "maxRaise"
     ];
     for (const key of required) {
       if (this.config[key] === void 0) {
@@ -107,16 +111,13 @@ var AuctionBuilder = class {
     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");
-    }
     return config;
   }
 };
 
 // src/constants/addresses.ts
 var AUCTION_ADDRESSES = {
-  84532: "0x722f4521b96aca1df7c65a1dbe3b1713803ccea9",
+  84532: "0x24a702f10f17a522b9b5511ec2970ee029195ee4",
   8453: "0x0000000000000000000000000000000000000000"
   // not yet deployed
 };
@@ -254,16 +255,6 @@ var tokenAuctionAbi = [
             "type": "uint256",
             "internalType": "uint256"
           },
-          {
-            "name": "startTime",
-            "type": "uint256",
-            "internalType": "uint256"
-          },
-          {
-            "name": "endTime",
-            "type": "uint256",
-            "internalType": "uint256"
-          },
           {
             "name": "creator",
             "type": "address",
@@ -351,19 +342,6 @@ var tokenAuctionAbi = [
     ],
     "stateMutability": "nonpayable"
   },
-  {
-    "type": "function",
-    "name": "completeAuction",
-    "inputs": [
-      {
-        "name": "auctionId",
-        "type": "uint256",
-        "internalType": "uint256"
-      }
-    ],
-    "outputs": [],
-    "stateMutability": "nonpayable"
-  },
   {
     "type": "function",
     "name": "createAuction",
@@ -383,6 +361,11 @@ var tokenAuctionAbi = [
             "type": "string",
             "internalType": "string"
           },
+          {
+            "name": "metadataURI",
+            "type": "string",
+            "internalType": "string"
+          },
           {
             "name": "maxSupply",
             "type": "uint256",
@@ -408,16 +391,6 @@ var tokenAuctionAbi = [
             "type": "uint256",
             "internalType": "uint256"
           },
-          {
-            "name": "startTime",
-            "type": "uint256",
-            "internalType": "uint256"
-          },
-          {
-            "name": "endTime",
-            "type": "uint256",
-            "internalType": "uint256"
-          },
           {
             "name": "liquidityBps",
             "type": "uint256",
@@ -528,6 +501,73 @@ var tokenAuctionAbi = [
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "launch",
+    "inputs": [
+      {
+        "name": "name",
+        "type": "string",
+        "internalType": "string"
+      },
+      {
+        "name": "symbol",
+        "type": "string",
+        "internalType": "string"
+      },
+      {
+        "name": "metadataURI",
+        "type": "string",
+        "internalType": "string"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "launchPreset",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "paymentToken",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "maxSupply",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "basePrice",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "slope",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "maxRaise",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "liquidityBps",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "migrate",
@@ -644,6 +684,29 @@ var tokenAuctionAbi = [
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "sellTokens",
+    "inputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "amount",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "minProceeds",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "setDefaultFeeBps",
@@ -670,6 +733,51 @@ var tokenAuctionAbi = [
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "setLaunchPreset",
+    "inputs": [
+      {
+        "name": "preset",
+        "type": "tuple",
+        "internalType": "struct TokenAuction.LaunchPreset",
+        "components": [
+          {
+            "name": "paymentToken",
+            "type": "address",
+            "internalType": "address"
+          },
+          {
+            "name": "maxSupply",
+            "type": "uint256",
+            "internalType": "uint256"
+          },
+          {
+            "name": "basePrice",
+            "type": "uint256",
+            "internalType": "uint256"
+          },
+          {
+            "name": "slope",
+            "type": "uint256",
+            "internalType": "uint256"
+          },
+          {
+            "name": "maxRaise",
+            "type": "uint256",
+            "internalType": "uint256"
+          },
+          {
+            "name": "liquidityBps",
+            "type": "uint256",
+            "internalType": "uint256"
+          }
+        ]
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "setProtocolFeeRecipient",
@@ -846,22 +954,16 @@ var tokenAuctionAbi = [
         "internalType": "uint256"
       },
       {
-        "name": "startTime",
-        "type": "uint256",
-        "indexed": false,
-        "internalType": "uint256"
-      },
-      {
-        "name": "endTime",
+        "name": "liquidityBps",
         "type": "uint256",
         "indexed": false,
         "internalType": "uint256"
       },
       {
-        "name": "liquidityBps",
-        "type": "uint256",
+        "name": "metadataURI",
+        "type": "string",
         "indexed": false,
-        "internalType": "uint256"
+        "internalType": "string"
       }
     ],
     "anonymous": false
@@ -941,6 +1043,49 @@ var tokenAuctionAbi = [
     ],
     "anonymous": false
   },
+  {
+    "type": "event",
+    "name": "LaunchPresetUpdated",
+    "inputs": [
+      {
+        "name": "paymentToken",
+        "type": "address",
+        "indexed": false,
+        "internalType": "address"
+      },
+      {
+        "name": "maxSupply",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "basePrice",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "slope",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "maxRaise",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "liquidityBps",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      }
+    ],
+    "anonymous": false
+  },
   {
     "type": "event",
     "name": "LpFeesCollected",
@@ -1115,6 +1260,55 @@ var tokenAuctionAbi = [
     ],
     "anonymous": false
   },
+  {
+    "type": "event",
+    "name": "TokensSold",
+    "inputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "indexed": true,
+        "internalType": "uint256"
+      },
+      {
+        "name": "seller",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "amount",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "proceeds",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "protocolFee",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "newTotalRaised",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "newTotalSold",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      }
+    ],
+    "anonymous": false
+  },
   {
     "type": "error",
     "name": "OwnableInvalidOwner",
@@ -1156,16 +1350,32 @@ var tokenAuctionAbi = [
 ];
 
 // src/utils/bonding-curve.ts
+var import_viem = require("viem");
 var TOKEN_SCALE = 10n ** 18n;
+var PRICE_SCALE = 10n ** 18n;
+var SCALE = TOKEN_SCALE * PRICE_SCALE;
+function parseCurvePrice(price, paymentDecimals) {
+  return (0, import_viem.parseUnits)(price, paymentDecimals + 18);
+}
+function formatCurvePrice(price, paymentDecimals) {
+  return (0, import_viem.formatUnits)(price, paymentDecimals + 18);
+}
 var ceilDiv = (a, b) => (a + b - 1n) / b;
 function calculateBuyCost(currentSupply, amount, basePrice, slope) {
-  const linearCost = ceilDiv(basePrice * amount, TOKEN_SCALE);
+  const linearCost = ceilDiv(basePrice * amount, SCALE);
   const curveCost = ceilDiv(
     slope * amount * (2n * currentSupply + amount),
-    2n * TOKEN_SCALE * TOKEN_SCALE
+    2n * SCALE * TOKEN_SCALE
   );
   return linearCost + curveCost;
 }
+function calculateSellProceeds(currentSupply, amount, basePrice, slope) {
+  if (amount > currentSupply) throw new Error("Cannot sell more than is outstanding");
+  const from = currentSupply - amount;
+  const linear = basePrice * amount / SCALE;
+  const curve = slope * amount * (2n * from + amount) / (2n * SCALE * TOKEN_SCALE);
+  return linear + curve;
+}
 function spotPrice(currentSupply, basePrice, slope) {
   return basePrice + slope * currentSupply / TOKEN_SCALE;
 }
@@ -1187,7 +1397,7 @@ function applySlippage(total, slippageBps) {
   return (total * BigInt(1e4 + slippageBps) + 9999n) / 10000n;
 }
 function maxBuyable(currentSupply, budget, basePrice, slope, upperBound) {
-  let hi = budget * TOKEN_SCALE / basePrice + 1n;
+  let hi = budget * SCALE / basePrice + 1n;
   if (hi > upperBound) hi = upperBound;
   let lo = 0n;
   while (lo < hi) {
@@ -1210,6 +1420,12 @@ function fillPurchase(currentSupply, requested, basePrice, slope, totalRaised, m
     fillsAuction: true
   };
 }
+function applySellSlippage(netProceeds, slippageBps) {
+  if (!Number.isInteger(slippageBps) || slippageBps < 0 || slippageBps > 1e4) {
+    throw new Error("slippageBps must be an integer between 0 and 10000");
+  }
+  return netProceeds * BigInt(1e4 - slippageBps) / 10000n;
+}
 
 // src/utils/chains.ts
 var import_chains = require("viem/chains");
@@ -1229,19 +1445,19 @@ var AuctionFlowSDK = class {
     this.chainId = params.chainId;
     this.chain = CHAINS[params.chainId];
     this.auctionAddress = params.auctionAddress ?? AUCTION_ADDRESSES[params.chainId];
-    if (params.auctionAddress === import_viem.zeroAddress) {
+    if (params.auctionAddress === import_viem2.zeroAddress) {
       throw new Error(
         "auctionAddress must not be the zero address."
       );
     }
-    if (this.auctionAddress === import_viem.zeroAddress) {
+    if (this.auctionAddress === import_viem2.zeroAddress) {
       throw new Error(
-        `AuctionFlow has no canonical deployment on chain ${params.chainId}. Chains with a built-in deployment: ${Object.entries(AUCTION_ADDRESSES).filter(([, addr]) => addr !== import_viem.zeroAddress).map(([id]) => id).join(", ")}. Pass \`auctionAddress\` to use your own deployment.`
+        `AuctionFlow has no canonical deployment on chain ${params.chainId}. Chains with a built-in deployment: ${Object.entries(AUCTION_ADDRESSES).filter(([, addr]) => addr !== import_viem2.zeroAddress).map(([id]) => id).join(", ")}. Pass \`auctionAddress\` to use your own deployment.`
       );
     }
-    this.publicClient = (0, import_viem.createPublicClient)({
+    this.publicClient = (0, import_viem2.createPublicClient)({
       chain: this.chain,
-      transport: (0, import_viem.http)(params.rpcUrl)
+      transport: (0, import_viem2.http)(params.rpcUrl)
     });
     this.walletClient = params.walletClient;
   }
@@ -1261,19 +1477,66 @@ var AuctionFlowSDK = class {
         {
           name: config.name,
           symbol: config.symbol,
+          metadataURI: config.metadataURI ?? "",
           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;
   }
+  /**
+   * One-click launch: a token with the protocol's standard curve, threshold
+   * and liquidity share. Trading starts immediately.
+   */
+  async launch(name, symbol, metadataURI = "") {
+    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: "launch",
+      args: [name, symbol, metadataURI]
+    });
+  }
+  /**
+   * Sell `amount` tokens (in token wei) back to the curve before graduation.
+   * The contract reverts if the price fell below the bound before the
+   * transaction landed: pass `minProceeds` to set it exactly, or `slippageBps`
+   * to derive it from a fresh quote (default 100 = 1% below it).
+   */
+  async sellTokens(auctionId, amount, options = {}) {
+    if (!this.walletClient) throw new Error("Wallet client required");
+    const minProceeds = options.minProceeds ?? applySellSlippage(
+      (await this.getSellQuote(auctionId, amount)).netProceeds,
+      options.slippageBps ?? DEFAULT_SLIPPAGE_BPS
+    );
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account,
+      address: this.auctionAddress,
+      abi: tokenAuctionAbi,
+      functionName: "sellTokens",
+      args: [auctionId, amount, minProceeds]
+    });
+  }
+  /** What selling `amount` tokens back to the curve would pay right now. */
+  async getSellQuote(auctionId, amount) {
+    const auction = await this.getAuction(auctionId);
+    const proceeds = calculateSellProceeds(auction.totalSold, amount, auction.basePrice, auction.slope);
+    const fee = proceeds * auction.protocolFeeBps / 10000n;
+    return {
+      proceeds,
+      fee,
+      netProceeds: proceeds - fee,
+      spotPriceAfter: spotPrice(auction.totalSold - amount, auction.basePrice, auction.slope)
+    };
+  }
   /**
    * 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
@@ -1347,7 +1610,7 @@ var AuctionFlowSDK = class {
       })
     ]);
     return {
-      pool: pool === import_viem.zeroAddress ? null : pool,
+      pool: pool === import_viem2.zeroAddress ? null : pool,
       positionId: positionId === 0n ? null : positionId
     };
   }
@@ -1420,8 +1683,6 @@ var AuctionFlowSDK = class {
       basePrice: raw.config.basePrice,
       slope: raw.config.slope,
       maxRaise: raw.config.maxRaise,
-      startTime: raw.config.startTime,
-      endTime: raw.config.endTime,
       state: raw.state,
       totalRaised: raw.totalRaised,
       totalSold: raw.totalSold,
@@ -1449,12 +1710,17 @@ var AuctionState = /* @__PURE__ */ ((AuctionState2) => {
   DEFAULT_LIQUIDITY_BPS,
   DEFAULT_SLIPPAGE_BPS,
   MIN_LIQUIDITY_BPS,
+  PRICE_SCALE,
   USDC_ADDRESSES,
+  applySellSlippage,
   applySlippage,
   calculateBuyCost,
   calculateBuyQuote,
+  calculateSellProceeds,
   fillPurchase,
+  formatCurvePrice,
   maxBuyable,
+  parseCurvePrice,
   spotPrice
 });
 //# sourceMappingURL=index.js.map