auctionflow-sdk 1.0.0

package/dist/index.mjs

@@ -0,0 +1,863 @@
+// src/client.ts
+import {
+  createPublicClient,
+  http,
+  zeroAddress
+} from "viem";
+
+// src/builders/auction-builder.ts
+var AuctionBuilder = class {
+  config = {};
+  withToken(name, symbol, maxSupply) {
+    this.config.name = name;
+    this.config.symbol = symbol;
+    this.config.maxSupply = maxSupply;
+    return this;
+  }
+  withPaymentToken(address) {
+    this.config.paymentToken = address;
+    return this;
+  }
+  withBondingCurve(basePrice, slope) {
+    this.config.basePrice = basePrice;
+    this.config.slope = slope;
+    return this;
+  }
+  withMaxRaise(maxRaise) {
+    this.config.maxRaise = maxRaise;
+    return this;
+  }
+  withSchedule(startTime, endTime) {
+    this.config.startTime = startTime;
+    this.config.endTime = endTime;
+    return this;
+  }
+  build() {
+    const required = [
+      "name",
+      "symbol",
+      "maxSupply",
+      "paymentToken",
+      "basePrice",
+      "slope",
+      "maxRaise",
+      "startTime",
+      "endTime"
+    ];
+    for (const key of required) {
+      if (this.config[key] === void 0) {
+        throw new Error(`Missing required field: ${key}`);
+      }
+    }
+    const config = 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");
+    if (config.startTime >= config.endTime) {
+      throw new Error("startTime must be before endTime");
+    }
+    return config;
+  }
+};
+
+// src/constants/addresses.ts
+var AUCTION_ADDRESSES = {
+  84532: "0xadc3e02e962eed3856d7bee0315f84d187be1fea",
+  8453: "0x0000000000000000000000000000000000000000"
+  // not yet deployed
+};
+var USDC_ADDRESSES = {
+  84532: "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
+  8453: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"
+};
+
+// src/abis/token-auction.ts
+var tokenAuctionAbi = [
+  {
+    "type": "constructor",
+    "inputs": [
+      {
+        "name": "feeRecipient_",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "defaultFeeBps_",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "auctionCount",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "auctions",
+    "inputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "config",
+        "type": "tuple",
+        "internalType": "struct TokenAuction.AuctionConfig",
+        "components": [
+          {
+            "name": "token",
+            "type": "address",
+            "internalType": "contract AuctionToken"
+          },
+          {
+            "name": "paymentToken",
+            "type": "address",
+            "internalType": "contract IERC20"
+          },
+          {
+            "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": "creator",
+            "type": "address",
+            "internalType": "address"
+          },
+          {
+            "name": "protocolFeeBps",
+            "type": "uint256",
+            "internalType": "uint256"
+          }
+        ]
+      },
+      {
+        "name": "state",
+        "type": "uint8",
+        "internalType": "enum TokenAuction.AuctionState"
+      },
+      {
+        "name": "totalRaised",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "totalSold",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "buyTokens",
+    "inputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "amount",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "completeAuction",
+    "inputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "createAuction",
+    "inputs": [
+      {
+        "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"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "defaultFeeBps",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "getBuyCost",
+    "inputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "amount",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "cost",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "fee",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "getSpotPrice",
+    "inputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "owner",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "proceedsWithdrawn",
+    "inputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "bool",
+        "internalType": "bool"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "protocolFeeRecipient",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "renounceOwnership",
+    "inputs": [],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "transferOwnership",
+    "inputs": [
+      {
+        "name": "newOwner",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "userPurchases",
+    "inputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      },
+      {
+        "name": "",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "withdrawProceeds",
+    "inputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "internalType": "uint256"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "event",
+    "name": "AuctionCompleted",
+    "inputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "indexed": true,
+        "internalType": "uint256"
+      },
+      {
+        "name": "totalRaised",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "totalSold",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "event",
+    "name": "AuctionCreated",
+    "inputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "indexed": true,
+        "internalType": "uint256"
+      },
+      {
+        "name": "creator",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "token",
+        "type": "address",
+        "indexed": false,
+        "internalType": "address"
+      },
+      {
+        "name": "paymentToken",
+        "type": "address",
+        "indexed": false,
+        "internalType": "address"
+      },
+      {
+        "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": "startTime",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "endTime",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "event",
+    "name": "AuctionMigrated",
+    "inputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "indexed": true,
+        "internalType": "uint256"
+      },
+      {
+        "name": "liquidityPool",
+        "type": "address",
+        "indexed": false,
+        "internalType": "address"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "event",
+    "name": "OwnershipTransferred",
+    "inputs": [
+      {
+        "name": "previousOwner",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "newOwner",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "event",
+    "name": "ProceedsWithdrawn",
+    "inputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "indexed": true,
+        "internalType": "uint256"
+      },
+      {
+        "name": "creator",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "amount",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "event",
+    "name": "TokensPurchased",
+    "inputs": [
+      {
+        "name": "auctionId",
+        "type": "uint256",
+        "indexed": true,
+        "internalType": "uint256"
+      },
+      {
+        "name": "buyer",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "amount",
+        "type": "uint256",
+        "indexed": false,
+        "internalType": "uint256"
+      },
+      {
+        "name": "cost",
+        "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",
+    "inputs": [
+      {
+        "name": "owner",
+        "type": "address",
+        "internalType": "address"
+      }
+    ]
+  },
+  {
+    "type": "error",
+    "name": "OwnableUnauthorizedAccount",
+    "inputs": [
+      {
+        "name": "account",
+        "type": "address",
+        "internalType": "address"
+      }
+    ]
+  },
+  {
+    "type": "error",
+    "name": "ReentrancyGuardReentrantCall",
+    "inputs": []
+  },
+  {
+    "type": "error",
+    "name": "SafeERC20FailedOperation",
+    "inputs": [
+      {
+        "name": "token",
+        "type": "address",
+        "internalType": "address"
+      }
+    ]
+  }
+];
+
+// src/utils/bonding-curve.ts
+function calculateBuyCost(currentSupply, amount, basePrice, slope) {
+  const linearCost = basePrice * amount;
+  const curveCost = slope * amount * (2n * currentSupply + amount) / 2n;
+  return linearCost + curveCost;
+}
+function spotPrice(currentSupply, basePrice, slope) {
+  return basePrice + slope * currentSupply;
+}
+function calculateBuyQuote(currentSupply, amount, basePrice, slope, feeBps) {
+  const cost = calculateBuyCost(currentSupply, amount, basePrice, slope);
+  const fee = cost * feeBps / 10000n;
+  return {
+    cost,
+    fee,
+    total: cost + fee,
+    spotPriceAfter: spotPrice(currentSupply + amount, basePrice, slope)
+  };
+}
+
+// src/utils/chains.ts
+import { base, baseSepolia } from "viem/chains";
+var CHAINS = {
+  84532: baseSepolia,
+  8453: base
+};
+
+// src/client.ts
+var AuctionFlowSDK = class {
+  publicClient;
+  walletClient;
+  auctionAddress;
+  chainId;
+  chain;
+  constructor(params) {
+    this.chainId = params.chainId;
+    this.chain = CHAINS[params.chainId];
+    this.auctionAddress = AUCTION_ADDRESSES[params.chainId];
+    if (this.auctionAddress === zeroAddress) {
+      throw new Error(
+        `AuctionFlow is not yet deployed on chain ${params.chainId}. Supported chains: ${Object.entries(AUCTION_ADDRESSES).filter(([, addr]) => addr !== zeroAddress).map(([id]) => id).join(", ")}.`
+      );
+    }
+    this.publicClient = createPublicClient({
+      chain: this.chain,
+      transport: http(params.rpcUrl)
+    });
+    this.walletClient = params.walletClient;
+  }
+  // Builder
+  buildAuction() {
+    return new AuctionBuilder();
+  }
+  async createAuction(config) {
+    if (!this.walletClient) throw new Error("Wallet client required");
+    const hash = await this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account,
+      address: this.auctionAddress,
+      abi: tokenAuctionAbi,
+      functionName: "createAuction",
+      args: [
+        config.name,
+        config.symbol,
+        config.maxSupply,
+        config.paymentToken,
+        config.basePrice,
+        config.slope,
+        config.maxRaise,
+        config.startTime,
+        config.endTime
+      ]
+    });
+    return hash;
+  }
+  async buyTokens(auctionId, amount) {
+    if (!this.walletClient) throw new Error("Wallet client required");
+    const hash = await this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account,
+      address: this.auctionAddress,
+      abi: tokenAuctionAbi,
+      functionName: "buyTokens",
+      args: [auctionId, amount]
+    });
+    return hash;
+  }
+  /**
+   * Withdraw a completed auction's raised payment tokens to its creator.
+   * Only the auction's creator can call this, and only once.
+   */
+  async withdrawProceeds(auctionId) {
+    if (!this.walletClient) throw new Error("Wallet client required");
+    const hash = await this.walletClient.writeContract({
+      chain: this.chain,
+      account: this.walletClient.account,
+      address: this.auctionAddress,
+      abi: tokenAuctionAbi,
+      functionName: "withdrawProceeds",
+      args: [auctionId]
+    });
+    return hash;
+  }
+  // Read: Has an auction's creator already withdrawn its proceeds?
+  async hasWithdrawnProceeds(auctionId) {
+    return this.publicClient.readContract({
+      address: this.auctionAddress,
+      abi: tokenAuctionAbi,
+      functionName: "proceedsWithdrawn",
+      args: [auctionId]
+    });
+  }
+  // Read: Get auction data
+  async getAuction(auctionId) {
+    const result = await this.publicClient.readContract({
+      address: this.auctionAddress,
+      abi: tokenAuctionAbi,
+      functionName: "auctions",
+      args: [auctionId]
+    });
+    return this.parseAuctionResult(auctionId, result);
+  }
+  // Read: Get buy quote (off-chain calculation)
+  async getQuote(auctionId, amount) {
+    const auction = await this.getAuction(auctionId);
+    const quote = calculateBuyQuote(
+      auction.totalSold,
+      amount,
+      auction.basePrice,
+      auction.slope,
+      auction.protocolFeeBps
+    );
+    return {
+      cost: quote.cost,
+      fee: quote.fee,
+      totalCost: quote.total,
+      spotPriceAfter: quote.spotPriceAfter
+    };
+  }
+  // Read: Get spot price
+  async getSpotPrice(auctionId) {
+    return this.publicClient.readContract({
+      address: this.auctionAddress,
+      abi: tokenAuctionAbi,
+      functionName: "getSpotPrice",
+      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,
+      startTime: raw.config.startTime,
+      endTime: raw.config.endTime,
+      state: raw.state,
+      totalRaised: raw.totalRaised,
+      totalSold: raw.totalSold,
+      protocolFeeBps: raw.config.protocolFeeBps
+    };
+  }
+};
+
+// src/types/index.ts
+var AuctionState = /* @__PURE__ */ ((AuctionState2) => {
+  AuctionState2[AuctionState2["PENDING"] = 0] = "PENDING";
+  AuctionState2[AuctionState2["ACTIVE"] = 1] = "ACTIVE";
+  AuctionState2[AuctionState2["COMPLETED"] = 2] = "COMPLETED";
+  AuctionState2[AuctionState2["MIGRATED"] = 3] = "MIGRATED";
+  return AuctionState2;
+})(AuctionState || {});
+export {
+  AUCTION_ADDRESSES,
+  AuctionBuilder,
+  AuctionFlowSDK,
+  AuctionState,
+  USDC_ADDRESSES,
+  calculateBuyCost,
+  calculateBuyQuote,
+  spotPrice
+};
+//# sourceMappingURL=index.mjs.map