@boostxyz/sdk 0.0.0-alpha.20 → 0.0.0-alpha.21

package/dist/BoostCore.d.ts

@@ -8,7 +8,7 @@ import { OpenAllowList } from './AllowLists/OpenAllowList';
 import { SimpleAllowList, type SimpleAllowListPayload } from './AllowLists/SimpleAllowList';
 import { SimpleDenyList, type SimpleDenyListPayload } from './AllowLists/SimpleDenyList';
 import { type Auth, PassthroughAuth } from './Auth/Auth';
-import { Boost } from './Boost';
+import { Boost, type RawBoost } from './Boost';
 import { type Budget } from './Budgets/Budget';
 import { ManagedBudget, type ManagedBudgetPayload } from './Budgets/ManagedBudget';
 import { Deployable, type DeployableOptions, type DeployablePayloadOrAddress, type GenericDeployableParams } from './Deployable/Deployable';
@@ -115,7 +115,6 @@ export type CreateBoostPayload = {
     allowList: AllowList;
     incentives: Array<Incentive>;
     protocolFee?: bigint;
-    referralFee?: bigint;
     maxParticipants?: bigint;
     owner?: Address;
 };
@@ -163,10 +162,637 @@ export declare class BoostCore extends Deployable<[
      * @public
      * @async
      * @param {CreateBoostPayload} _boostPayload
-     * @param {?DeployableOptions} [_options]
+     * @param {?DeployableOptions} [_params]
      * @returns {Promise<Boost>}
      */
     createBoost(_boostPayload: CreateBoostPayload, _params?: DeployableOptions & WriteParams<typeof boostCoreAbi, 'createBoost'>): Promise<Boost>;
+    /**
+     * Returns a simulated Boost creation.
+     *
+     * @public
+     * @async
+     * @param {CreateBoostPayload} _boostPayload
+     * @param {?DeployableOptions} [_params]
+     * @returns {Promise<SimulateContractReturnType>}
+     */
+    simulateCreateBoost(_boostPayload: CreateBoostPayload, _params?: DeployableOptions & WriteParams<typeof boostCoreAbi, 'createBoost'>): Promise<import("viem").SimulateContractReturnType<readonly [{
+        readonly type: "constructor";
+        readonly inputs: readonly [{
+            readonly name: "registry_";
+            readonly internalType: "contract BoostRegistry";
+            readonly type: "address";
+        }, {
+            readonly name: "protocolFeeReceiver_";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "AlreadyInitialized";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [{
+            readonly name: "caller";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "data";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "ClaimFailed";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [{
+            readonly name: "caller";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "data";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "ClawbackFailed";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "InvalidInitialization";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [{
+            readonly name: "expectedInterface";
+            readonly internalType: "bytes4";
+            readonly type: "bytes4";
+        }, {
+            readonly name: "instance";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "InvalidInstance";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "NewOwnerIsZeroAddress";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "NoHandoverRequest";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "NotImplemented";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "Reentrancy";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "Unauthorized";
+    }, {
+        readonly type: "error";
+        readonly inputs: readonly [];
+        readonly name: "Unauthorized";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "boostId";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: true;
+        }, {
+            readonly name: "incentiveId";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: true;
+        }, {
+            readonly name: "claimant";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "referrer";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: false;
+        }, {
+            readonly name: "data";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+            readonly indexed: false;
+        }];
+        readonly name: "BoostClaimed";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "boostId";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: true;
+        }, {
+            readonly name: "owner";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "action";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "incentiveCount";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "validator";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: false;
+        }, {
+            readonly name: "allowList";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: false;
+        }, {
+            readonly name: "budget";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: false;
+        }];
+        readonly name: "BoostCreated";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "pendingOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }];
+        readonly name: "OwnershipHandoverCanceled";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "pendingOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }];
+        readonly name: "OwnershipHandoverRequested";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "oldOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "newOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }];
+        readonly name: "OwnershipTransferred";
+    }, {
+        readonly type: "event";
+        readonly anonymous: false;
+        readonly inputs: readonly [{
+            readonly name: "boostId";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: true;
+        }, {
+            readonly name: "incentiveId";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: true;
+        }, {
+            readonly name: "amount";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "recipient";
+            readonly internalType: "address";
+            readonly type: "address";
+            readonly indexed: true;
+        }];
+        readonly name: "ProtocolFeesCollected";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "FEE_DENOMINATOR";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint64";
+            readonly type: "uint64";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "cancelOwnershipHandover";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "boostId_";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "incentiveId_";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "referrer_";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "data_";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "claimIncentive";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "boostId_";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "incentiveId_";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "referrer_";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "data_";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }, {
+            readonly name: "claimant";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "claimIncentiveFor";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "data_";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }, {
+            readonly name: "boostId";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "incentiveId";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "clawback";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "pendingOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "completeOwnershipHandover";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "data_";
+            readonly internalType: "bytes";
+            readonly type: "bytes";
+        }];
+        readonly name: "createBoost";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "struct BoostLib.Boost";
+            readonly type: "tuple";
+            readonly components: readonly [{
+                readonly name: "action";
+                readonly internalType: "contract AAction";
+                readonly type: "address";
+            }, {
+                readonly name: "validator";
+                readonly internalType: "contract AValidator";
+                readonly type: "address";
+            }, {
+                readonly name: "allowList";
+                readonly internalType: "contract AAllowList";
+                readonly type: "address";
+            }, {
+                readonly name: "budget";
+                readonly internalType: "contract ABudget";
+                readonly type: "address";
+            }, {
+                readonly name: "incentives";
+                readonly internalType: "contract AIncentive[]";
+                readonly type: "address[]";
+            }, {
+                readonly name: "protocolFee";
+                readonly internalType: "uint64";
+                readonly type: "uint64";
+            }, {
+                readonly name: "maxParticipants";
+                readonly internalType: "uint256";
+                readonly type: "uint256";
+            }, {
+                readonly name: "owner";
+                readonly internalType: "address";
+                readonly type: "address";
+            }];
+        }];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "createBoostAuth";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "contract IAuth";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "index";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "getBoost";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "struct BoostLib.Boost";
+            readonly type: "tuple";
+            readonly components: readonly [{
+                readonly name: "action";
+                readonly internalType: "contract AAction";
+                readonly type: "address";
+            }, {
+                readonly name: "validator";
+                readonly internalType: "contract AValidator";
+                readonly type: "address";
+            }, {
+                readonly name: "allowList";
+                readonly internalType: "contract AAllowList";
+                readonly type: "address";
+            }, {
+                readonly name: "budget";
+                readonly internalType: "contract ABudget";
+                readonly type: "address";
+            }, {
+                readonly name: "incentives";
+                readonly internalType: "contract AIncentive[]";
+                readonly type: "address[]";
+            }, {
+                readonly name: "protocolFee";
+                readonly internalType: "uint64";
+                readonly type: "uint64";
+            }, {
+                readonly name: "maxParticipants";
+                readonly internalType: "uint256";
+                readonly type: "uint256";
+            }, {
+                readonly name: "owner";
+                readonly internalType: "address";
+                readonly type: "address";
+            }];
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "getBoostCount";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "key";
+            readonly internalType: "bytes32";
+            readonly type: "bytes32";
+        }];
+        readonly name: "getIncentive";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "struct BoostCore.IncentiveDisbursalInfo";
+            readonly type: "tuple";
+            readonly components: readonly [{
+                readonly name: "assetType";
+                readonly internalType: "enum ABudget.AssetType";
+                readonly type: "uint8";
+            }, {
+                readonly name: "asset";
+                readonly internalType: "address";
+                readonly type: "address";
+            }, {
+                readonly name: "protocolFeesRemaining";
+                readonly internalType: "uint256";
+                readonly type: "uint256";
+            }, {
+                readonly name: "protocolFee";
+                readonly internalType: "uint256";
+                readonly type: "uint256";
+            }, {
+                readonly name: "tokenId";
+                readonly internalType: "uint256";
+                readonly type: "uint256";
+            }];
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "";
+            readonly internalType: "bytes32";
+            readonly type: "bytes32";
+        }];
+        readonly name: "incentives";
+        readonly outputs: readonly [{
+            readonly name: "assetType";
+            readonly internalType: "enum ABudget.AssetType";
+            readonly type: "uint8";
+        }, {
+            readonly name: "asset";
+            readonly internalType: "address";
+            readonly type: "address";
+        }, {
+            readonly name: "protocolFeesRemaining";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "protocolFee";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "tokenId";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "owner";
+        readonly outputs: readonly [{
+            readonly name: "result";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "pendingOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "ownershipHandoverExpiresAt";
+        readonly outputs: readonly [{
+            readonly name: "result";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "protocolFee";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "uint64";
+            readonly type: "uint64";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "protocolFeeReceiver";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "registry";
+        readonly outputs: readonly [{
+            readonly name: "";
+            readonly internalType: "contract BoostRegistry";
+            readonly type: "address";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "renounceOwnership";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [];
+        readonly name: "requestOwnershipHandover";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "auth_";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "setCreateBoostAuth";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "protocolFee_";
+            readonly internalType: "uint64";
+            readonly type: "uint64";
+        }];
+        readonly name: "setProtocolFee";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "protocolFeeReceiver_";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "setProtocolFeeReceiver";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "boostId";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }, {
+            readonly name: "incentiveId";
+            readonly internalType: "uint256";
+            readonly type: "uint256";
+        }];
+        readonly name: "settleProtocolFees";
+        readonly outputs: readonly [];
+        readonly stateMutability: "nonpayable";
+    }, {
+        readonly type: "function";
+        readonly inputs: readonly [{
+            readonly name: "newOwner";
+            readonly internalType: "address";
+            readonly type: "address";
+        }];
+        readonly name: "transferOwnership";
+        readonly outputs: readonly [];
+        readonly stateMutability: "payable";
+    }], "createBoost", readonly [`0x${string}`], import("viem").Chain, import("viem").Account, import("viem").Chain> & {
+        chainId: number;
+        request: {
+            chainId?: undefined;
+            __mode: "prepared";
+            chain: import("viem").Chain;
+        };
+    }>;
+    private prepareCreateBoostPayload;
     /**
      * Claims one incentive from a given `Boost` by `boostId` and `incentiveId`
      *
@@ -232,21 +858,12 @@ export declare class BoostCore extends Deployable<[
      *
      * @public
      * @async
-     * @param {bigint} id
+     * @param {bigint | string} id
      * @param {?ReadParams} [params]
      * @returns {Promise<RawBoost>}
+     * @throws {@link BoostNotFoundError}
      */
-    readBoost(id: bigint, params?: ReadParams<typeof boostCoreAbi, 'getBoost'>): Promise<{
-        action: `0x${string}`;
-        validator: `0x${string}`;
-        allowList: `0x${string}`;
-        budget: `0x${string}`;
-        incentives: readonly `0x${string}`[];
-        protocolFee: bigint;
-        referralFee: bigint;
-        maxParticipants: bigint;
-        owner: `0x${string}`;
-    }>;
+    readBoost(_id: string | bigint, params?: ReadParams<typeof boostCoreAbi, 'getBoost'>): Promise<RawBoost>;
     /**
      * Get a Boost by index, will return a new {@link Boost} with correct target implementations instantiated, ie `(await core.getBoost(0n)).allowList instanceof SimpleAllowList` vs `SimpleDenyList`
      *
@@ -255,6 +872,7 @@ export declare class BoostCore extends Deployable<[
      * @param {(string | bigint)} _id
      * @param {?ReadParams} [params]
      * @returns {Promise<Boost>}
+     * @throws {@link BoostNotFoundError}
      */
     getBoost(_id: string | bigint, params?: ReadParams<typeof boostCoreAbi, 'getBoost'>): Promise<Boost>;
     /**
@@ -350,38 +968,6 @@ export declare class BoostCore extends Deployable<[
         hash: `0x${string}`;
         result: void;
     }>;
-    /**
-     * Get the claim fee.
-     *
-     * @public
-     * @async
-     * @param {?ReadParams} [params]
-     * @returns {Promise<bigint>}
-     */
-    claimFee(params?: ReadParams<typeof boostCoreAbi, 'claimFee'>): Promise<bigint>;
-    /**
-     * Sets the claim fee.
-     *
-     * @public
-     * @async
-     * @param {bigint} claimFee
-     * @param {?WriteParams} [params]
-     * @returns {Promise<void>}
-     */
-    setClaimFee(claimFee: bigint, params?: WriteParams<typeof boostCoreAbi, 'setClaimFee'>): Promise<void>;
-    /**
-     * Sets the claim fee.
-     *
-     * @public
-     * @async
-     * @param {bigint} claimFee
-     * @param {?WriteParams} [params]
-     * @returns {Promise<{ hash: `0x${string}`; result: void; }>}
-     */
-    setClaimFeeRaw(claimFee: bigint, params?: WriteParams<typeof boostCoreAbi, 'setClaimFee'>): Promise<{
-        hash: `0x${string}`;
-        result: void;
-    }>;
     /**
      * Retrieves the claim information from a transaction receipt.
      *