auctionflow-sdk 2.0.0 → 2.1.0

package/README.md

@@ -186,8 +186,11 @@ if (!(await sdk.hasWithdrawnProceeds(0n))) {
   await sdk.withdrawProceeds(0n);
 }
 
-// 3. Later, collect the pool's trading fees.
+// 3. Later, collect the pool's trading fees. The creator's share is
+//    credited to them, and they withdraw it (in both tokens) with claim.
 await sdk.collectFees(0n);
+await sdk.claim(usdcAddress);
+await sdk.claim(tokenAddress);
 ```
 
 **Migration** pairs the auction's liquidity share of the raise with newly
@@ -195,13 +198,16 @@ 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 go to the creator.
+Tokens Uniswap doesn't use are burned, and leftover funds are credited to the
+creator to `claim`.
 
 **Withdrawal** pays the creator everything not reserved for liquidity: with the
 default 50% share, half the raise. It works before or after migration.
 
-**Trading fees** from the pool go to the creator, minus the protocol's share
-(`lpFeeShareBps`, at most 50%), fixed when the auction is created.
+**Trading fees** from the pool are credited to the creator, minus the
+protocol's share (`lpFeeShareBps`, at most 50%), fixed when the auction is
+created. Payouts are claimed rather than sent, so no recipient (for example an
+address USDC has blacklisted) can block a trade or a migration.
 
 ## How the bonding curve works
 
@@ -245,8 +251,14 @@ Early buyers pay less; later buyers pay more.
 | `migrate(auctionId)` | Open the Uniswap v3 pool at the final price, lock the liquidity, unlock the token. Anyone may call. |
 | `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: protocol share to the protocol, the rest to the creator. Anyone may call. |
+| `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. |
+| `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`. |
+| `isPaymentTokenAllowed(token)` | Whether new auctions may be priced in `token`. Only owner-approved tokens (USDC) can be used. |
 | `hasWithdrawnProceeds(auctionId)` | Whether the creator has already claimed the proceeds. |
+| `isPaused()` | Whether the protocol is paused. While paused, `launch`, `createAuction` and `buyTokens` revert; selling back, migration, withdrawals, fee collection and claims still work. |
 
 ## License
 

package/dist/index.d.mts

@@ -142,14 +142,26 @@ declare class AuctionFlowSDK {
      */
     migrate(auctionId: bigint): Promise<Hash>;
     /**
-     * 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.
      */
     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.
+     */
+    claim(token: Address): Promise<Hash>;
+    /** Send the protocol's unclaimed fees in `token` to the fee recipient. Anyone may call it. */
+    claimProtocolFees(token: Address): Promise<Hash>;
     /** The Uniswap pool and position for a migrated auction. */
     getMigration(auctionId: bigint): Promise<MigrationInfo>;
     private write;
     hasWithdrawnProceeds(auctionId: bigint): Promise<boolean>;
+    isPaused(): Promise<boolean>;
+    getClaimable(token: Address, account: Address): Promise<bigint>;
+    getProtocolFees(token: Address): Promise<bigint>;
+    isPaymentTokenAllowed(token: Address): Promise<boolean>;
     getAuction(auctionId: bigint): Promise<AuctionData>;
     getQuote(auctionId: bigint, amount: bigint): Promise<BuyQuote>;
     getSpotPrice(auctionId: bigint): Promise<bigint>;

package/dist/index.d.ts

@@ -142,14 +142,26 @@ declare class AuctionFlowSDK {
      */
     migrate(auctionId: bigint): Promise<Hash>;
     /**
-     * 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.
      */
     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.
+     */
+    claim(token: Address): Promise<Hash>;
+    /** Send the protocol's unclaimed fees in `token` to the fee recipient. Anyone may call it. */
+    claimProtocolFees(token: Address): Promise<Hash>;
     /** The Uniswap pool and position for a migrated auction. */
     getMigration(auctionId: bigint): Promise<MigrationInfo>;
     private write;
     hasWithdrawnProceeds(auctionId: bigint): Promise<boolean>;
+    isPaused(): Promise<boolean>;
+    getClaimable(token: Address, account: Address): Promise<bigint>;
+    getProtocolFees(token: Address): Promise<bigint>;
+    isPaymentTokenAllowed(token: Address): Promise<boolean>;
     getAuction(auctionId: bigint): Promise<AuctionData>;
     getQuote(auctionId: bigint, amount: bigint): Promise<BuyQuote>;
     getSpotPrice(auctionId: bigint): Promise<bigint>;

package/dist/index.js

@@ -117,7 +117,7 @@ var AuctionBuilder = class {
 
 // src/constants/addresses.ts
 var AUCTION_ADDRESSES = {
-  84532: "0xc6db1c900faeb4079281ecd6ec538c027cd18c28",
+  84532: "0xe57fe62e31666a9b749e89086a8a5487a530153b",
   8453: "0x0000000000000000000000000000000000000000"
   // not yet deployed
 };
@@ -201,6 +201,13 @@ var tokenAuctionAbi = [
     ],
     "stateMutability": "view"
   },
+  {
+    "type": "function",
+    "name": "acceptOwnership",
+    "inputs": [],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "auctionCount",
@@ -318,6 +325,68 @@ var tokenAuctionAbi = [
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "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",
@@ -594,6 +663,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",
@@ -677,6 +798,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",
@@ -778,6 +918,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",
@@ -845,6 +1003,13 @@ var tokenAuctionAbi = [
     "outputs": [],
     "stateMutability": "nonpayable"
   },
+  {
+    "type": "function",
+    "name": "unpause",
+    "inputs": [],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
   {
     "type": "function",
     "name": "userPurchases",
@@ -1005,6 +1170,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",
@@ -1123,6 +1313,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",
@@ -1142,6 +1351,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",
@@ -1186,6 +1427,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",
@@ -1309,6 +1575,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",
@@ -1587,12 +1876,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([
@@ -1634,6 +1935,43 @@ 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({