auctionflow-sdk 2.0.1 → 3.0.0

package/dist/index.mjs

@@ -77,7 +77,7 @@ var AuctionBuilder = class {
 
 // src/constants/addresses.ts
 var AUCTION_ADDRESSES = {
-  84532: "0x24a702f10f17a522b9b5511ec2970ee029195ee4",
+  84532: "0x990a04ffe0d49356321271629889fa0413ad1bdc",
   8453: "0x0000000000000000000000000000000000000000"
   // not yet deployed
 };
@@ -85,6 +85,10 @@ var USDC_ADDRESSES = {
   84532: "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
   8453: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
 };
+var WETH_ADDRESSES = {
+  84532: "0x4200000000000000000000000000000000000006",
+  8453: "0x4200000000000000000000000000000000000006"
+};
 
 // src/abis/token-auction.ts
 var tokenAuctionAbi = [
@@ -105,10 +109,19 @@ var tokenAuctionAbi = [
         "name": "positionManager_",
         "type": "address",
         "internalType": "contract INonfungiblePositionManager"
+      },
+      {
+        "name": "weth_",
+        "type": "address",
+        "internalType": "contract IWETH9"
       }
     ],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "receive",
+    "stateMutability": "payable"
+  },
   {
     "type": "function",
     "name": "MAX_FEE_BPS",
@@ -161,6 +174,13 @@ var tokenAuctionAbi = [
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "acceptOwnership",
+    "inputs": [],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "auctionCount",
@@ -278,6 +298,86 @@ var tokenAuctionAbi = [
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "buyTokensWithETH",
+    "inputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "amount",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "payable"
+  },
+  {
+    "type": "function",
+    "name": "claim",
+    "inputs": [
+      {
+        "name": "token",
+        "type": "address",
+        "internalType": "contract IERC20"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "amount",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "claimProtocolFees",
+    "inputs": [
+      {
+        "name": "token",
+        "type": "address",
+        "internalType": "contract IERC20"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "amount",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "claimable",
+    "inputs": [
+      {
+        "name": "",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "collectFees",
@@ -479,6 +579,11 @@ var tokenAuctionAbi = [
         "name": "metadataURI",
         "type": "string",
         "internalType": "string"
+      },
+      {
+        "name": "paymentToken",
+        "type": "address",
+        "internalType": "address"
       }
     ],
     "outputs": [
@@ -492,8 +597,14 @@ var tokenAuctionAbi = [
   },
   {
     "type": "function",
-    "name": "launchPreset",
-    "inputs": [],
+    "name": "launchPresets",
+    "inputs": [
+      {
+        "name": "",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
     "outputs": [
       {
         "name": "paymentToken",
@@ -554,6 +665,58 @@ var tokenAuctionAbi = [
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "pause",
+    "inputs": [],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "paused",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "bool",
+        "internalType": "bool"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "paymentTokenAllowed",
+    "inputs": [
+      {
+        "name": "",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "bool",
+        "internalType": "bool"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "pendingOwner",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "poolOf",
@@ -637,6 +800,25 @@ var tokenAuctionAbi = [
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "protocolFees",
+    "inputs": [
+      {
+        "name": "",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "renounceOwnership",
@@ -667,6 +849,29 @@ var tokenAuctionAbi = [
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "sellTokensForETH",
+    "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",
@@ -738,6 +943,24 @@ var tokenAuctionAbi = [
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "setPaymentTokenAllowed",
+    "inputs": [
+      {
+        "name": "token",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "allowed",
+        "type": "bool",
+        "internalType": "bool"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "setProtocolFeeRecipient",
@@ -805,6 +1028,13 @@ var tokenAuctionAbi = [
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "unpause",
+    "inputs": [],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "userPurchases",
@@ -829,6 +1059,19 @@ var tokenAuctionAbi = [
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "weth",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "address",
+        "internalType": "contract IWETH9"
+      }
+    ],
+    "stateMutability": "view"
+  },
   {
     "type": "function",
     "name": "withdrawProceeds",
@@ -965,6 +1208,31 @@ var tokenAuctionAbi = [
     ],
     "anonymous": false
   },
+  {
+    "type": "event",
+    "name": "Claimed",
+    "inputs": [
+      {
+        "name": "token",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "account",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "amount",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      }
+    ],
+    "anonymous": false
+  },
   {
     "type": "event",
     "name": "DefaultFeeBpsUpdated",
@@ -1083,6 +1351,25 @@ var tokenAuctionAbi = [
     ],
     "anonymous": false
   },
+  {
+    "type": "event",
+    "name": "OwnershipTransferStarted",
+    "inputs": [
+      {
+        "name": "previousOwner",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "newOwner",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      }
+    ],
+    "anonymous": false
+  },
   {
     "type": "event",
     "name": "OwnershipTransferred",
@@ -1102,6 +1389,38 @@ var tokenAuctionAbi = [
     ],
     "anonymous": false
   },
+  {
+    "type": "event",
+    "name": "Paused",
+    "inputs": [
+      {
+        "name": "account",
+        "type": "address",
+        "indexed": false,
+        "internalType": "address"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "event",
+    "name": "PaymentTokenAllowedUpdated",
+    "inputs": [
+      {
+        "name": "token",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "allowed",
+        "type": "bool",
+        "indexed": false,
+        "internalType": "bool"
+      }
+    ],
+    "anonymous": false
+  },
   {
     "type": "event",
     "name": "ProceedsWithdrawn",
@@ -1146,6 +1465,31 @@ var tokenAuctionAbi = [
     ],
     "anonymous": false
   },
+  {
+    "type": "event",
+    "name": "ProtocolFeesClaimed",
+    "inputs": [
+      {
+        "name": "token",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "recipient",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "amount",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      }
+    ],
+    "anonymous": false
+  },
   {
     "type": "event",
     "name": "Swept",
@@ -1269,6 +1613,29 @@ var tokenAuctionAbi = [
     ],
     "anonymous": false
   },
+  {
+    "type": "event",
+    "name": "Unpaused",
+    "inputs": [
+      {
+        "name": "account",
+        "type": "address",
+        "indexed": false,
+        "internalType": "address"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "error",
+    "name": "EnforcedPause",
+    "inputs": []
+  },
+  {
+    "type": "error",
+    "name": "ExpectedPause",
+    "inputs": []
+  },
   {
     "type": "error",
     "name": "OwnableInvalidOwner",
@@ -1373,7 +1740,7 @@ function fillPurchase(currentSupply, requested, basePrice, slope, totalRaised, m
   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");
+  if (amount === 0n) return { amount: 0n, cost: 0n, fillsAuction: true };
   return {
     amount,
     cost: calculateBuyCost(currentSupply, amount, basePrice, slope),
@@ -1451,9 +1818,10 @@ var AuctionFlowSDK = class {
   }
   /**
    * One-click launch: a token with the protocol's standard curve, threshold
-   * and liquidity share. Trading starts immediately.
+   * and liquidity share for `paymentToken`. Trading starts immediately.
+   * Defaults to WETH, so the token trades in plain ETH (see `buyTokensWithETH`).
    */
-  async launch(name, symbol, metadataURI = "") {
+  async launch(name, symbol, metadataURI = "", paymentToken = WETH_ADDRESSES[this.chainId]) {
     if (!this.walletClient) throw new Error("Wallet client required");
     return this.walletClient.writeContract({
       chain: this.chain,
@@ -1461,9 +1829,20 @@ var AuctionFlowSDK = class {
       address: this.auctionAddress,
       abi: tokenAuctionAbi,
       functionName: "launch",
-      args: [name, symbol, metadataURI]
+      args: [name, symbol, metadataURI, paymentToken]
     });
   }
+  /** The standard launch for `paymentToken`, or null if none is configured. */
+  async getLaunchPreset(paymentToken) {
+    const [token, maxSupply, basePrice, slope, maxRaise, liquidityBps] = await this.publicClient.readContract({
+      address: this.auctionAddress,
+      abi: tokenAuctionAbi,
+      functionName: "launchPresets",
+      args: [paymentToken]
+    });
+    if (token === zeroAddress) return null;
+    return { paymentToken: token, maxSupply, basePrice, slope, maxRaise, liquidityBps };
+  }
   /**
    * Sell `amount` tokens (in token wei) back to the curve before graduation.
    * The contract reverts if the price fell below the bound before the
@@ -1485,6 +1864,25 @@ var AuctionFlowSDK = class {
       args: [auctionId, amount, minProceeds]
     });
   }
+  /**
+   * `sellTokens` for an auction priced in WETH, paid out in plain ETH. Takes
+   * the same `minProceeds` / `slippageBps` options.
+   */
+  async sellTokensForETH(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: "sellTokensForETH",
+      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);
@@ -1521,6 +1919,33 @@ var AuctionFlowSDK = class {
     });
     return hash;
   }
+  /**
+   * `buyTokens` for an auction priced in WETH, paid in plain ETH, with no
+   * token approval. The ETH sent is the most the purchase may cost (`maxCost`,
+   * or a fresh quote plus `slippageBps`); whatever it doesn't use is refunded
+   * in the same transaction.
+   */
+  async buyTokensWithETH(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
+    );
+    return this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account,
+      address: this.auctionAddress,
+      abi: tokenAuctionAbi,
+      functionName: "buyTokensWithETH",
+      args: [auctionId, amount],
+      value: maxCost
+    });
+  }
+  /** Is this auction priced in WETH, so it can be bought and sold with plain ETH? */
+  async isPricedInETH(auctionId) {
+    const auction = await this.getAuction(auctionId);
+    return auction.paymentToken.toLowerCase() === WETH_ADDRESSES[this.chainId].toLowerCase();
+  }
   /**
    * Pay a completed auction's creator their share of the raise: everything
    * not reserved for Uniswap liquidity. Creator only, once, before or after
@@ -1547,12 +1972,24 @@ var AuctionFlowSDK = class {
     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.
+   * Collect the migrated pool's trading fees. The protocol's share accrues to
+   * the protocol and the rest is credited to the creator, who withdraws it
+   * with `claim`. Anyone may call it.
    */
   async collectFees(auctionId) {
     return this.write("collectFees", [auctionId]);
   }
+  /**
+   * Withdraw everything credited to the connected account in `token`: a
+   * creator's share of pool fees, and any reserve migration couldn't place.
+   */
+  async claim(token) {
+    return this.write("claim", [token]);
+  }
+  /** Send the protocol's unclaimed fees in `token` to the fee recipient. Anyone may call it. */
+  async claimProtocolFees(token) {
+    return this.write("claimProtocolFees", [token]);
+  }
   /** The Uniswap pool and position for a migrated auction. */
   async getMigration(auctionId) {
     const [pool, positionId] = await Promise.all([
@@ -1594,15 +2031,66 @@ var AuctionFlowSDK = class {
       args: [auctionId]
     });
   }
+  // Read: Is the protocol paused? While paused, launches and curve buys
+  // revert; selling back, migration, withdrawals, fee collection and claims
+  // still work.
+  async isPaused() {
+    return this.publicClient.readContract({
+      address: this.auctionAddress,
+      abi: tokenAuctionAbi,
+      functionName: "paused"
+    });
+  }
+  // Read: How much of `token` is credited to `account`, waiting for `claim`?
+  async getClaimable(token, account) {
+    return this.publicClient.readContract({
+      address: this.auctionAddress,
+      abi: tokenAuctionAbi,
+      functionName: "claimable",
+      args: [token, account]
+    });
+  }
+  // Read: Protocol fees in `token` earned and not yet claimed.
+  async getProtocolFees(token) {
+    return this.publicClient.readContract({
+      address: this.auctionAddress,
+      abi: tokenAuctionAbi,
+      functionName: "protocolFees",
+      args: [token]
+    });
+  }
+  // Read: May new auctions be priced in `token`?
+  async isPaymentTokenAllowed(token) {
+    return this.publicClient.readContract({
+      address: this.auctionAddress,
+      abi: tokenAuctionAbi,
+      functionName: "paymentTokenAllowed",
+      args: [token]
+    });
+  }
   // Read: Get auction data
   async getAuction(auctionId) {
-    const result = await this.publicClient.readContract({
+    const [config, state, totalRaised, totalSold] = await this.publicClient.readContract({
       address: this.auctionAddress,
       abi: tokenAuctionAbi,
       functionName: "auctions",
       args: [auctionId]
     });
-    return this.parseAuctionResult(auctionId, result);
+    return {
+      id: auctionId,
+      token: config.token,
+      paymentToken: config.paymentToken,
+      creator: config.creator,
+      basePrice: config.basePrice,
+      slope: config.slope,
+      maxRaise: config.maxRaise,
+      state,
+      totalRaised,
+      totalSold,
+      protocolFeeBps: config.protocolFeeBps,
+      liquidityBps: config.liquidityBps,
+      lpFeeShareBps: config.lpFeeShareBps
+    };
   }
   // Read: Get buy quote (off-chain calculation)
   async getQuote(auctionId, amount) {
@@ -1634,23 +2122,6 @@ var AuctionFlowSDK = class {
       args: [auctionId]
     });
   }
-  parseAuctionResult(id, raw) {
-    return {
-      id,
-      token: raw.config.token,
-      paymentToken: raw.config.paymentToken,
-      creator: raw.config.creator,
-      basePrice: raw.config.basePrice,
-      slope: raw.config.slope,
-      maxRaise: raw.config.maxRaise,
-      state: raw.state,
-      totalRaised: raw.totalRaised,
-      totalSold: raw.totalSold,
-      protocolFeeBps: raw.config.protocolFeeBps,
-      liquidityBps: raw.config.liquidityBps,
-      lpFeeShareBps: raw.config.lpFeeShareBps
-    };
-  }
 };
 
 // src/types/index.ts
@@ -1671,6 +2142,7 @@ export {
   MIN_LIQUIDITY_BPS,
   PRICE_SCALE,
   USDC_ADDRESSES,
+  WETH_ADDRESSES,
   applySellSlippage,
   applySlippage,
   calculateBuyCost,
@@ -1680,6 +2152,7 @@ export {
   formatCurvePrice,
   maxBuyable,
   parseCurvePrice,
-  spotPrice
+  spotPrice,
+  tokenAuctionAbi
 };
 //# sourceMappingURL=index.mjs.map