@boostxyz/sdk 0.0.0-alpha.8 → 0.0.0-alpha.9

package/src/AllowLists/SimpleDenyList.ts

@@ -10,6 +10,7 @@ import {
   type Address,
   type ContractEventName,
   type Hex,
+  encodeAbiParameters,
   zeroAddress,
   zeroHash,
 } from 'viem';
@@ -23,13 +24,32 @@ import {
   type GenericLog,
   type ReadParams,
   RegistryType,
-  type SimpleDenyListPayload,
   type WriteParams,
-  prepareSimpleDenyListPayload,
 } from '../utils';
 
 export { simpleDenyListAbi };
-export type { SimpleDenyListPayload };
+
+/**
+ * Object representation of a {@link SimpleDenyList} initialization payload.
+ *
+ * @export
+ * @interface SimpleDenyListPayload
+ * @typedef {SimpleDenyListPayload}
+ */
+export interface SimpleDenyListPayload {
+  /**
+   * The allow list's owner
+   *
+   * @type {Address}
+   */
+  owner: Address;
+  /**
+   * List of denied addresses.
+   *
+   * @type {Address[]}
+   */
+  denied: Address[];
+}
 
 /**
  * A generic `viem.Log` event with support for `SimpleDenyList` event types.
@@ -114,7 +134,9 @@ export class SimpleDenyList extends DeployableTarget<
     allowed: boolean[],
     params?: WriteParams<typeof simpleDenyListAbi, 'setDenied'>,
   ) {
-    return this.awaitResult(this.setDeniedRaw(addresses, allowed, params));
+    return await this.awaitResult(
+      this.setDeniedRaw(addresses, allowed, params),
+    );
   }
 
   /**
@@ -146,111 +168,6 @@ export class SimpleDenyList extends DeployableTarget<
     return { hash, result };
   }
 
-  // /**
-  //  * A typed wrapper for (viem.getLogs)[https://viem.sh/docs/actions/public/getLogs#getlogs].
-  //  * Accepts `eventName` and `eventNames` as optional parameters to narrow the returned log types.
-  //  * @example
-  //  * ```ts
-  //  * const logs = contract.getLogs({ eventName: 'EventName' })
-  //  * const logs = contract.getLogs({ eventNames: ['EventName'] })
-  //  * ```
-  //  * @public
-  //  * @async
-  //  * @template {ContractEventName<typeof simpleDenyListAbi>} event
-  //  * @template {ExtractAbiEvent<
-  //  *       typeof simpleDenyListAbi,
-  //  *       event
-  //  *     >} [abiEvent=ExtractAbiEvent<typeof simpleDenyListAbi, event>]
-  //  * @param {?Omit<
-  //  *       GetLogsParams<typeof simpleDenyListAbi, event, abiEvent, abiEvent[]>,
-  //  *       'event' | 'events'
-  //  *     > & {
-  //  *       eventName?: event;
-  //  *       eventNames?: event[];
-  //  *     }} [params]
-  //  * @returns {Promise<GetLogsReturnType<abiEvent, abiEvent[]>>}
-  //  */
-  // public async getLogs<
-  //   event extends ContractEventName<typeof simpleDenyListAbi>,
-  //   const abiEvent extends ExtractAbiEvent<
-  //     typeof simpleDenyListAbi,
-  //     event
-  //   > = ExtractAbiEvent<typeof simpleDenyListAbi, event>,
-  // >(
-  //   params?: Omit<
-  //     GetLogsParams<typeof simpleDenyListAbi, event, abiEvent, abiEvent[]>,
-  //     'event' | 'events'
-  //   > & {
-  //     eventName?: event;
-  //     eventNames?: event[];
-  //   },
-  // ): Promise<GetLogsReturnType<abiEvent, abiEvent[]>> {
-  //   return getLogs(this._config.getClient({ chainId: params?.chainId }), {
-  //     // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wag
-  //     ...(params as any),
-  //     ...(params?.eventName
-  //       ? {
-  //           event: getAbiItem({
-  //             abi: simpleDenyListAbi,
-  //             name: params.eventName,
-  //             // biome-ignore lint/suspicious/noExplicitAny: awkward abi intersection issue
-  //           } as any),
-  //         }
-  //       : {}),
-  //     ...(params?.eventNames
-  //       ? {
-  //           events: params.eventNames.map((name) =>
-  //             getAbiItem({
-  //               abi: simpleDenyListAbi,
-  //               name,
-  //               // biome-ignore lint/suspicious/noExplicitAny: awkward abi intersection issue
-  //             } as any),
-  //           ),
-  //         }
-  //       : {}),
-  //     address: this.assertValidAddress(),
-  //   });
-  // }
-
-  // /**
-  //  * A typed wrapper for `wagmi.watchContractEvent`
-  //  *
-  //  * @public
-  //  * @async
-  //  * @template {ContractEventName<typeof simpleDenyListAbi>} event
-  //  * @param {(log: SimpleDenyListLog<event>) => unknown} cb
-  //  * @param {?WatchParams<typeof simpleDenyListAbi, event> & {
-  //  *       eventName?: event;
-  //  *     }} [params]
-  //  * @returns {unknown, params?: any) => unknown} Unsubscribe function
-  //  */
-  // public async subscribe<
-  //   event extends ContractEventName<typeof simpleDenyListAbi>,
-  // >(
-  //   cb: (log: SimpleDenyListLog<event>) => unknown,
-  //   params?: WatchParams<typeof simpleDenyListAbi, event> & {
-  //     eventName?: event;
-  //   },
-  // ) {
-  //   return watchContractEvent<
-  //     typeof this._config,
-  //     (typeof this._config)['chains'][number]['id'],
-  //     typeof simpleDenyListAbi,
-  //     event
-  //   >(this._config, {
-  //     // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
-  //     ...(params as any),
-  //     eventName: params?.eventName,
-  //     abi: simpleDenyListAbi,
-  //     address: this.assertValidAddress(),
-  //     onLogs: (logs) => {
-  //       for (let l of logs) {
-  //         cb(l as unknown as SimpleDenyListLog<event>);
-  //       }
-  //     },
-  //   });
-  // }
-
   /**
    * @inheritdoc
    *
@@ -287,3 +204,24 @@ export class SimpleDenyList extends DeployableTarget<
     };
   }
 }
+
+/**
+ * Given a {@link SimpleDenyListPayload}, properly encode the initialization payload.
+ *
+ * @param {SimpleDenyListPayload} param0
+ * @param {Address} param0.owner - The allow list's owner
+ * @param {Address[]} param0.denied - List of denied addresses.
+ * @returns {Hex}
+ */
+export function prepareSimpleDenyListPayload({
+  owner,
+  denied,
+}: SimpleDenyListPayload) {
+  return encodeAbiParameters(
+    [
+      { type: 'address', name: 'owner' },
+      { type: 'address[]', name: 'denied' },
+    ],
+    [owner, denied],
+  );
+}

package/src/Auth/PassthroughAuth.ts

@@ -48,7 +48,7 @@ export class PassthroughAuth extends Deployable<
     address: Address,
     params?: ReadParams<typeof passthroughAuthAbi, 'isAuthorized'>,
   ) {
-    return readPassthroughAuthIsAuthorized(this._config, {
+    return await readPassthroughAuthIsAuthorized(this._config, {
       address: this.assertValidAddress(),
       args: [address],
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally

package/src/Boost.ts

@@ -1,4 +1,11 @@
-import { type Address, zeroAddress } from 'viem';
+import { LibZip } from 'solady';
+import {
+  type Address,
+  type Hex,
+  encodeAbiParameters,
+  parseAbiParameters,
+  zeroAddress,
+} from 'viem';
 import type { Action } from './Actions/Action';
 import type { AllowList } from './AllowLists/AllowList';
 import type { Budget } from './Budgets/Budget';
@@ -153,3 +160,131 @@ export class Boost {
     this.owner = config.owner || zeroAddress;
   }
 }
+
+/**
+ * Object representation of `BoostLib.Target` struct. Used for low level Boost creation operations.
+ * This is used to pass the base contract and its initialization parameters in an efficient manner
+ *
+ * @export
+ * @typedef {Target}
+ */
+export type Target = {
+  isBase: boolean;
+  instance: Address;
+  parameters: Hex;
+};
+
+/**
+ * Object representation of `BoostCore.InitPayload` struct.
+ *
+ * @export
+ * @interface BoostPayload
+ * @typedef {BoostPayload}
+ */
+export interface BoostPayload {
+  /**
+   * Address to valid budget.
+   *
+   * @type {Address}
+   */
+  budget: Address;
+  /**
+   * Target for existing action, or base with initialization payload.
+   *
+   * @type {Target}
+   */
+  action: Target;
+  /**
+   * Target for existing validator, or base with initialization payload.
+   *
+   * @type {Target}
+   */
+  validator: Target;
+  /**
+   * Target for existing allowList, or base with initialization payload.
+   *
+   * @type {Target}
+   */
+  allowList: Target;
+  /**
+   * Targets for new incentives, with initialization payloads.
+   *
+   * @type {Target[]}
+   */
+  incentives: Target[];
+  /**
+   * The base protocol fee (in bps)
+   *
+   * @type {?bigint}
+   */
+  protocolFee?: bigint;
+  /**
+   * The base referral fee (in bps)
+   *
+   * @type {?bigint}
+   */
+  referralFee?: bigint;
+  /**
+   * Optional maximum amount of participants in the Boost.
+   *
+   * @type {?bigint}
+   */
+  maxParticipants?: bigint;
+  /**
+   * The owner of the Boost.
+   *
+   * @type {Address}
+   */
+  owner: Address;
+}
+
+/**
+ * Given a valid {@link BoostPayload}, properly encode and compress the payload for use with `createBoost`
+ *
+ * @export
+ * @param {BoostPayload} param0
+ * @param {Address} param0.budget - Address to valid budget.
+ * @param {Target} param0.action - Target for existing action, or base with initialization payload.
+ * @param {Target} param0.validator - Target for existing validator, or base with initialization payload.
+ * @param {Target} param0.allowList - Target for existing allowList, or base with initialization payload.
+ * @param {Target[]} param0.incentives - Targets for new incentives, with initialization payloads.
+ * @param {bigint} [param0.protocolFee=0n] - The base protocol fee (in bps)
+ * @param {bigint} [param0.referralFee=0n] - The base referral fee (in bps)
+ * @param {bigint} [param0.maxParticipants=0n] - Optional maximum amount of participants in the Boost.
+ * @param {Address} param0.owner - The owner of the Boost.
+ * @returns {Hex}
+ */
+export function prepareBoostPayload({
+  budget,
+  action,
+  validator,
+  allowList,
+  incentives,
+  protocolFee = 0n,
+  referralFee = 0n,
+  maxParticipants = 0n,
+  owner,
+}: BoostPayload): Hex {
+  return LibZip.cdCompress(
+    encodeAbiParameters(
+      parseAbiParameters([
+        'BoostPayload payload',
+        'struct BoostPayload { address budget; Target action; Target validator; Target allowList; Target[] incentives; uint64 protocolFee; uint64 referralFee; uint256 maxParticipants; address owner; }',
+        'struct Target { bool isBase; address instance; bytes parameters; }',
+      ]),
+      [
+        {
+          budget,
+          action,
+          validator,
+          allowList,
+          incentives,
+          protocolFee,
+          referralFee,
+          maxParticipants,
+          owner,
+        },
+      ],
+    ),
+  ) as Hex;
+}

package/src/BoostCore.test.ts

@@ -10,19 +10,12 @@ import {
   makeMockEventActionPayload,
 } from '../test/helpers';
 import { ContractAction } from './Actions/ContractAction';
-import { PassthroughAuth } from './Auth/PassthroughAuth';
 import { BoostCore } from './BoostCore';
 import type { ERC20Incentive } from './Incentives/ERC20Incentive';
+import { ERC1155StrategyType } from './Incentives/ERC1155Incentive';
+import { StrategyType } from './claiming';
 import { IncentiveNotCloneableError } from './errors';
-import {
-  ActionStep,
-  ERC1155StrategyType,
-  FilterType,
-  PrimitiveType,
-  SignatureType,
-  StrategyType,
-  bytes4,
-} from './utils';
+import { bytes4 } from './utils';
 
 let fixtures: Fixtures, budgets: BudgetFixtures;
 
@@ -683,7 +676,7 @@ describe('BoostCore', () => {
     expect(await client.claimFee()).toBe(100n);
   });
 
-  test('binds all actions, budgets, allowlists, incentives, and validators to reuse core options and account', async () => {
+  test('binds all actions, budgets, allowlists, incentives, and validators to reuse core options and account', () => {
     const { core } = fixtures;
 
     // const contractAction = core.ContractAction(zeroAddress);

package/src/BoostCore.ts

@@ -26,12 +26,13 @@ import {
   type Address,
   type ContractEventName,
   type Hex,
+  parseEther,
   parseEventLogs,
   zeroAddress,
   zeroHash,
 } from 'viem';
 import { type Action, actionFromAddress } from './Actions/Action';
-import { EventAction } from './Actions/EventAction';
+import { EventAction, type EventActionPayload } from './Actions/EventAction';
 import { type AllowList, allowListFromAddress } from './AllowLists/AllowList';
 import {
   SimpleAllowList,
@@ -42,7 +43,12 @@ import {
   type SimpleDenyListPayload,
 } from './AllowLists/SimpleDenyList';
 import { type Auth, PassthroughAuth } from './Auth/Auth';
-import { Boost } from './Boost';
+import {
+  Boost,
+  type BoostPayload,
+  type Target,
+  prepareBoostPayload,
+} from './Boost';
 import { type Budget, budgetFromAddress } from './Budgets/Budget';
 import {
   ManagedBudget,
@@ -66,6 +72,7 @@ import {
   ERC20Incentive,
   type ERC20IncentivePayload,
 } from './Incentives/ERC20Incentive';
+import type { ERC20VariableIncentivePayload } from './Incentives/ERC20VariableIncentive';
 import {
   ERC20VariableIncentive,
   type Incentive,
@@ -86,21 +93,18 @@ import {
   DeployableUnknownOwnerProvidedError,
   IncentiveNotCloneableError,
   MustInitializeBudgetError,
-  NoContractAddressUponReceiptError,
 } from './errors';
-import {
-  type ERC20VariableIncentivePayload,
-  type EventActionPayload,
-  type GenericLog,
-  type BoostPayload as OnChainBoostPayload,
-  type ReadParams,
-  type Target,
-  type WriteParams,
-  prepareBoostPayload,
-} from './utils';
+import type { GenericLog, ReadParams, WriteParams } from './utils';
 
 export { boostCoreAbi };
 
+/**
+ * The fee (in wei) required to claim each incentive, must be provided for the `claimIncentive` transaction
+ *
+ * @type {bigint}
+ */
+export const BOOST_CORE_CLAIM_FEE = parseEther('0.000075');
+
 /**
  * The fixed address for the deployed Boost Core.
  * By default, `new BoostCore` will use this address if not otherwise provided.
@@ -298,7 +302,7 @@ export class BoostCore extends Deployable<
       }
     }
 
-    let budgetPayload: OnChainBoostPayload['budget'] = zeroAddress;
+    let budgetPayload: BoostPayload['budget'] = zeroAddress;
     if (budget.address) {
       budgetPayload = budget.address;
       if (!(await budget.isAuthorized(coreAddress))) {
@@ -310,7 +314,7 @@ export class BoostCore extends Deployable<
 
     // if we're supplying an address, it could be a pre-initialized target
     // if base is explicitly set to false, then it will not be initialized, and it will be referenced as is if it implements interface correctly
-    let actionPayload: OnChainBoostPayload['action'] = {
+    let actionPayload: BoostPayload['action'] = {
       instance: zeroAddress,
       isBase: true,
       parameters: zeroHash,
@@ -330,7 +334,7 @@ export class BoostCore extends Deployable<
       actionPayload.instance = action.base;
     }
 
-    let validatorPayload: OnChainBoostPayload['validator'] = {
+    let validatorPayload: BoostPayload['validator'] = {
       instance: zeroAddress,
       isBase: true,
       parameters: zeroHash,
@@ -366,7 +370,7 @@ export class BoostCore extends Deployable<
       validatorPayload.instance = validator.base;
     }
 
-    let allowListPayload: OnChainBoostPayload['allowList'] = {
+    let allowListPayload: BoostPayload['allowList'] = {
       instance: zeroAddress,
       isBase: true,
       parameters: zeroHash,
@@ -406,8 +410,10 @@ export class BoostCore extends Deployable<
             : zeroHash,
         };
       } else {
+        // biome-ignore lint/style/noNonNullAssertion: this will never be undefined
         incentivesPayloads[i]!.parameters =
           incentive.buildParameters(undefined, options).args.at(0) || zeroHash;
+        // biome-ignore lint/style/noNonNullAssertion: this will never be undefined
         incentivesPayloads[i]!.instance = incentive.base;
       }
     }
@@ -447,6 +453,7 @@ export class BoostCore extends Deployable<
       validator: validator.at(boost.validator),
       allowList: allowList.at(boost.allowList),
       incentives: incentives.map((incentive, i) =>
+        // biome-ignore lint/style/noNonNullAssertion: this will never be undefined
         incentive.at(boost.incentives.at(i)!),
       ),
       protocolFee: boost.protocolFee,
@@ -475,7 +482,7 @@ export class BoostCore extends Deployable<
     data: Hex,
     params?: WriteParams<typeof boostCoreAbi, 'claimIncentive'>,
   ) {
-    return this.awaitResult(
+    return await this.awaitResult(
       this.claimIncentiveRaw(boostId, incentiveId, address, data, params),
     );
   }
@@ -487,7 +494,7 @@ export class BoostCore extends Deployable<
    * @async
    * @param {bigint} boostId - The ID of the Boost
    * @param {bigint} incentiveId - The ID of the Incentive
-   * @param {Address} address - The address of the referrer (if any)
+   * @param {Address} referrer - The address of the referrer (if any)
    * @param {Hex} data- The data for the claim
    * @param {?WriteParams<typeof boostCoreAbi, 'claimIncentive'>} [params]
    * @returns {unknown}
@@ -495,7 +502,7 @@ export class BoostCore extends Deployable<
   public async claimIncentiveRaw(
     boostId: bigint,
     incentiveId: bigint,
-    address: Address,
+    referrer: Address,
     data: Hex,
     params?: WriteParams<typeof boostCoreAbi, 'claimIncentive'>,
   ) {
@@ -503,7 +510,7 @@ export class BoostCore extends Deployable<
       this._config,
       {
         address: this.assertValidAddress(),
-        args: [boostId, incentiveId, address, data],
+        args: [boostId, incentiveId, referrer, data],
         ...this.optionallyAttachAccount(),
         // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
         ...(params as any),
@@ -534,7 +541,7 @@ export class BoostCore extends Deployable<
     claimant: Address,
     params?: WriteParams<typeof boostCoreAbi, 'claimIncentiveFor'>,
   ) {
-    return this.awaitResult(
+    return await this.awaitResult(
       this.claimIncentiveForRaw(
         boostId,
         incentiveId,
@@ -594,7 +601,7 @@ export class BoostCore extends Deployable<
     id: bigint,
     params?: ReadParams<typeof boostCoreAbi, 'getBoost'>,
   ) {
-    return readBoostCoreGetBoost(this._config, {
+    return await readBoostCoreGetBoost(this._config, {
       address: this.assertValidAddress(),
       args: [id],
       ...this.optionallyAttachAccount(),
@@ -668,7 +675,7 @@ export class BoostCore extends Deployable<
   public async getBoostCount(
     params?: ReadParams<typeof boostCoreAbi, 'getBoostCount'>,
   ) {
-    return readBoostCoreGetBoostCount(this._config, {
+    return await readBoostCoreGetBoostCount(this._config, {
       address: this.assertValidAddress(),
       args: [],
       ...this.optionallyAttachAccount(),
@@ -713,7 +720,7 @@ export class BoostCore extends Deployable<
   public async createBoostAuth(
     params?: ReadParams<typeof boostCoreAbi, 'createBoostAuth'>,
   ) {
-    return readBoostCoreCreateBoostAuth(this._config, {
+    return await readBoostCoreCreateBoostAuth(this._config, {
       address: this.assertValidAddress(),
       args: [],
       ...this.optionallyAttachAccount(),
@@ -735,7 +742,7 @@ export class BoostCore extends Deployable<
     auth: Auth,
     params?: WriteParams<typeof boostCoreAbi, 'setCreateBoostAuth'>,
   ) {
-    return this.awaitResult(
+    return await this.awaitResult(
       this.setCreateBoostAuthRaw(auth.assertValidAddress(), {
         ...params,
       }),
@@ -780,7 +787,7 @@ export class BoostCore extends Deployable<
   public async protocolFee(
     params?: ReadParams<typeof boostCoreAbi, 'protocolFee'>,
   ) {
-    return readBoostCoreProtocolFee(this._config, {
+    return await readBoostCoreProtocolFee(this._config, {
       address: this.assertValidAddress(),
       args: [],
       ...this.optionallyAttachAccount(),
@@ -800,7 +807,7 @@ export class BoostCore extends Deployable<
   public async protocolFeeReceiver(
     params?: ReadParams<typeof boostCoreAbi, 'protocolFeeReceiver'>,
   ) {
-    return readBoostCoreProtocolFeeReceiver(this._config, {
+    return await readBoostCoreProtocolFeeReceiver(this._config, {
       address: this.assertValidAddress(),
       args: [],
       ...this.optionallyAttachAccount(),
@@ -822,7 +829,7 @@ export class BoostCore extends Deployable<
     address: Address,
     params?: WriteParams<typeof boostCoreAbi, 'setProtocolFeeReceiver'>,
   ) {
-    return this.awaitResult(
+    return await this.awaitResult(
       this.setProcolFeeReceiverRaw(address, {
         ...params,
       }),
@@ -868,7 +875,7 @@ export class BoostCore extends Deployable<
    * @returns {unknown}
    */
   public async claimFee(params?: ReadParams<typeof boostCoreAbi, 'claimFee'>) {
-    return readBoostCoreClaimFee(this._config, {
+    return await readBoostCoreClaimFee(this._config, {
       address: this.assertValidAddress(),
       args: [],
       ...this.optionallyAttachAccount(),
@@ -890,7 +897,7 @@ export class BoostCore extends Deployable<
     claimFee: bigint,
     params?: WriteParams<typeof boostCoreAbi, 'setClaimFee'>,
   ) {
-    return this.awaitResult(this.setClaimFeeRaw(claimFee, params));
+    return await this.awaitResult(this.setClaimFeeRaw(claimFee, params));
   }
 
   /**
@@ -928,8 +935,7 @@ export class BoostCore extends Deployable<
    * const auth = core.PassthroughAuth('0x') // is roughly equivalent to
    * const auth = new PassthroughAuth({ config: core._config, account: core._account }, '0x')
    * ```
-   * @param {DeployablePayloadOrAddress<{}>} options
-   * @param {?boolean} [isBase]
+   * @param {Address} address
    * @returns {PassthroughAuth}
    */
   PassthroughAuth(address?: Address) {