@boostxyz/sdk 0.0.0-alpha.8 → 1.1.0-alpha.22

package/src/Incentives/ERC1155Incentive.ts

@@ -16,7 +16,13 @@ import {
   writeErc1155IncentiveClawback,
 } from '@boostxyz/evm';
 import { bytecode } from '@boostxyz/evm/artifacts/contracts/incentives/ERC1155Incentive.sol/ERC1155Incentive.json';
-import type { Address, ContractEventName, Hex } from 'viem';
+import {
+  type Address,
+  type ContractEventName,
+  type Hex,
+  encodeAbiParameters,
+  parseAbiParameters,
+} from 'viem';
 import type {
   DeployableOptions,
   GenericDeployableParams,
@@ -24,19 +30,68 @@ import type {
 import { DeployableTarget } from '../Deployable/DeployableTarget';
 import {
   type ClaimPayload,
-  type ERC1155IncentivePayload,
-  ERC1155StrategyType,
+  type StrategyType,
+  prepareClaimPayload,
+} from '../claiming';
+import {
   type GenericLog,
   type ReadParams,
   RegistryType,
-  type StrategyType,
   type WriteParams,
-  prepareClaimPayload,
-  prepareERC1155IncentivePayload,
 } from '../utils';
 
-export { ERC1155StrategyType, erc1155IncentiveAbi };
-export type { ERC1155IncentivePayload };
+export { erc1155IncentiveAbi };
+
+/**
+ * Enum representing inventive disbursement strategies for {@link ERC1155Incentive}
+ *
+ * @export
+ * @enum {number}
+ */
+export enum ERC1155StrategyType {
+  POOL = 0,
+  MINT = 1,
+}
+
+/**
+ * The object representation of a `ERC1155Incentive.InitPayload`
+ *
+ * @export
+ * @interface ERC1155IncentivePayload
+ * @typedef {ERC1155IncentivePayload}
+ */
+export interface ERC1155IncentivePayload {
+  /**
+   * The address of the `ERC1155` asset
+   *
+   * @type {Address}
+   */
+  asset: Address;
+  /**
+   * Should be `Strategy.POOL`
+   *
+   * @type {ERC1155StrategyType}
+   */
+  strategy: ERC1155StrategyType;
+  /**
+   * The token ID to target
+   *
+   * @type {bigint}
+   */
+  tokenId: bigint;
+  /**
+   *  The maximum number of claims that can be made (one per address)
+   *
+   * @type {bigint}
+   */
+  limit: bigint;
+  /**
+   *  Any extra data to accompany the claim, if applicable.
+   *
+   * @type {Hex}
+   */
+  extraData: Hex;
+}
 
 /**
  * A generic `viem.Log` event with support for `ERC1155Incentive` event types.
@@ -72,10 +127,9 @@ export class ERC1155Incentive extends DeployableTarget<
    *
    * @public
    * @static
-   * @type {Address}
+   * @type {Record<number, Address>}
    */
-  public static override base: Address = import.meta.env
-    .VITE_ERC1155_INCENTIVE_BASE;
+  public static override bases: Record<number, Address> = {};
   /**
    * @inheritdoc
    *
@@ -90,13 +144,13 @@ export class ERC1155Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof erc1155IncentiveAbi, 'claims'>} [params]
-   * @returns {unknown}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<bigint>}
    */
   public async claims(
     params?: ReadParams<typeof erc1155IncentiveAbi, 'claims'>,
   ) {
-    return readErc1155IncentiveClaims(this._config, {
+    return await readErc1155IncentiveClaims(this._config, {
       address: this.assertValidAddress(),
       args: [],
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
@@ -109,13 +163,13 @@ export class ERC1155Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof erc1155IncentiveAbi, 'reward'>} [params]
-   * @returns {unknown}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<bigint>}
    */
   public async reward(
     params?: ReadParams<typeof erc1155IncentiveAbi, 'reward'>,
   ) {
-    return readErc1155IncentiveReward(this._config, {
+    return await readErc1155IncentiveReward(this._config, {
       address: this.assertValidAddress(),
       args: [],
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
@@ -129,14 +183,14 @@ export class ERC1155Incentive extends DeployableTarget<
    * @public
    * @async
    * @param {Address} address
-   * @param {?ReadParams<typeof erc1155IncentiveAbi, 'claimed'>} [params]
-   * @returns {unknown}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<boolean>}
    */
   public async claimed(
     address: Address,
     params?: ReadParams<typeof erc1155IncentiveAbi, 'claimed'>,
   ) {
-    return readErc1155IncentiveClaimed(this._config, {
+    return await readErc1155IncentiveClaimed(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
@@ -149,11 +203,11 @@ export class ERC1155Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof erc1155IncentiveAbi, 'asset'>} [params]
-   * @returns {unknown}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<Address>}
    */
   public async asset(params?: ReadParams<typeof erc1155IncentiveAbi, 'asset'>) {
-    return readErc1155IncentiveAsset(this._config, {
+    return await readErc1155IncentiveAsset(this._config, {
       address: this.assertValidAddress(),
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
       ...(params as any),
@@ -165,10 +219,10 @@ export class ERC1155Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof erc1155IncentiveAbi, 'strategy'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<StrategyType>}
    */
-  public async strategy(
+  public strategy(
     params?: ReadParams<typeof erc1155IncentiveAbi, 'strategy'>,
   ): Promise<StrategyType> {
     return readErc1155IncentiveStrategy(this._config, {
@@ -183,11 +237,11 @@ export class ERC1155Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof erc1155IncentiveAbi, 'limit'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {unknown}
    */
   public async limit(params?: ReadParams<typeof erc1155IncentiveAbi, 'limit'>) {
-    return readErc1155IncentiveLimit(this._config, {
+    return await readErc1155IncentiveLimit(this._config, {
       address: this.assertValidAddress(),
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
       ...(params as any),
@@ -199,13 +253,13 @@ export class ERC1155Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof erc1155IncentiveAbi, 'tokenId'>} [params]
-   * @returns {unknown}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<bigint>}
    */
   public async tokenId(
     params?: ReadParams<typeof erc1155IncentiveAbi, 'tokenId'>,
   ) {
-    return readErc1155IncentiveTokenId(this._config, {
+    return await readErc1155IncentiveTokenId(this._config, {
       address: this.assertValidAddress(),
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
       ...(params as any),
@@ -217,13 +271,13 @@ export class ERC1155Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof erc1155IncentiveAbi, 'extraData'>} [params]
-   * @returns {unknown}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<Hex>}
    */
   public async extraData(
     params?: ReadParams<typeof erc1155IncentiveAbi, 'extraData'>,
   ) {
-    return readErc1155IncentiveExtraData(this._config, {
+    return await readErc1155IncentiveExtraData(this._config, {
       address: this.assertValidAddress(),
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
       ...(params as any),
@@ -236,14 +290,14 @@ export class ERC1155Incentive extends DeployableTarget<
    * @public
    * @async
    * @param {ClaimPayload} payload
-   * @param {?WriteParams<typeof erc1155IncentiveAbi, 'claim'>} [params]
-   * @returns {unknown}
+   * @param {?WriteParams} [params]
+   * @returns {Promise<boolean>}
    */
-  public async claim(
+  protected async claim(
     payload: ClaimPayload,
     params?: WriteParams<typeof erc1155IncentiveAbi, 'claim'>,
   ) {
-    return this.awaitResult(this.claimRaw(payload, params));
+    return await this.awaitResult(this.claimRaw(payload, params));
   }
 
   /**
@@ -252,10 +306,10 @@ export class ERC1155Incentive extends DeployableTarget<
    * @public
    * @async
    * @param {ClaimPayload} payload
-   * @param {?WriteParams<typeof erc1155IncentiveAbi, 'claim'>} [params]
-   * @returns {unknown}
+   * @param {?WriteParams} [params]
+   * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>}
    */
-  public async claimRaw(
+  protected async claimRaw(
     payload: ClaimPayload,
     params?: WriteParams<typeof erc1155IncentiveAbi, 'claim'>,
   ) {
@@ -279,14 +333,14 @@ export class ERC1155Incentive extends DeployableTarget<
    * @public
    * @async
    * @param {ClaimPayload} payload
-   * @param {?WriteParams<typeof erc1155IncentiveAbi, 'clawback'>} [params]
-   * @returns {unknown}
+   * @param {?WriteParams} [params]
+   * @returns {Promise<boolean>}
    */
   public async clawback(
     payload: ClaimPayload,
     params?: WriteParams<typeof erc1155IncentiveAbi, 'clawback'>,
   ) {
-    return this.awaitResult(this.clawbackRaw(payload, params));
+    return await this.awaitResult(this.clawbackRaw(payload, params));
   }
 
   /**
@@ -295,8 +349,8 @@ export class ERC1155Incentive extends DeployableTarget<
    * @public
    * @async
    * @param {ClaimPayload} payload
-   * @param {?WriteParams<typeof erc1155IncentiveAbi, 'clawback'>} [params]
-   * @returns {unknown}
+   * @param {?WriteParams} [params]
+   * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>}
    */
   public async clawbackRaw(
     payload: ClaimPayload,
@@ -322,14 +376,14 @@ export class ERC1155Incentive extends DeployableTarget<
    * @public
    * @async
    * @param {ClaimPayload} payload
-   * @param {?ReadParams<typeof erc1155IncentiveAbi, 'isClaimable'>} [params]
-   * @returns {unknown}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<boolean>}
    */
   public async isClaimable(
     payload: ClaimPayload,
     params?: ReadParams<typeof erc1155IncentiveAbi, 'isClaimable'>,
   ) {
-    return readErc1155IncentiveIsClaimable(this._config, {
+    return await readErc1155IncentiveIsClaimable(this._config, {
       address: this.assertValidAddress(),
       args: [prepareClaimPayload(payload)],
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
@@ -343,14 +397,14 @@ export class ERC1155Incentive extends DeployableTarget<
    * @public
    * @async
    * @param {ERC1155IncentivePayload} data
-   * @param {?ReadParams<typeof erc1155IncentiveAbi, 'preflight'>} [params]
-   * @returns {unknown}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<Hex>}
    */
   public async preflight(
     data: ERC1155IncentivePayload,
     params?: ReadParams<typeof erc1155IncentiveAbi, 'preflight'>,
   ) {
-    return readErc1155IncentivePreflight(this._config, {
+    return await readErc1155IncentivePreflight(this._config, {
       address: this.assertValidAddress(),
       args: [prepareERC1155IncentivePayload(data)],
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
@@ -382,3 +436,30 @@ export class ERC1155Incentive extends DeployableTarget<
     };
   }
 }
+
+/**
+ * Given a {@link ERC1155IncentivePayload}, properly encode a `ERC1155Incentive.InitPayload` for use with {@link ERC1155Incentive} initialization.
+ *
+ * @param {ERC1155IncentivePayload} param0
+ * @param {Address} param0.asset - The address of the `ERC1155` asset
+ * @param {ERC1155StrategyType} param0.strategy - Should be `Strategy.POOL`
+ * @param {bigint} param0.tokenId - The token ID to target
+ * @param {bigint} param0.limit -  The maximum number of claims that can be made (one per address)
+ * @param {Hex} param0.extraData - Any extra data to accompany the claim, if applicable.
+ * @returns {Hex}
+ */
+export const prepareERC1155IncentivePayload = ({
+  asset,
+  strategy,
+  tokenId,
+  limit,
+  extraData,
+}: ERC1155IncentivePayload) => {
+  return encodeAbiParameters(
+    parseAbiParameters([
+      'InitPayload payload',
+      'struct InitPayload { address asset; uint8 strategy; uint256 tokenId; uint256 limit; bytes extraData; }',
+    ]),
+    [{ asset, strategy, tokenId, limit, extraData }],
+  );
+};

package/src/Incentives/ERC20Incentive.test.ts

@@ -1,16 +1,8 @@
 import { readMockErc20BalanceOf } from '@boostxyz/evm';
 import { loadFixture } from '@nomicfoundation/hardhat-network-helpers';
-import { signMessage } from '@wagmi/core';
-import {
-  encodePacked,
-  isAddress,
-  keccak256,
-  pad,
-  parseEther,
-  zeroAddress,
-} from 'viem';
+import { isAddress, pad, parseEther, zeroAddress } from 'viem';
 import { beforeAll, beforeEach, describe, expect, test } from 'vitest';
-import { accounts } from '../../test/accounts';
+import { accounts } from '@boostxyz/test/accounts';
 import {
   type BudgetFixtures,
   type Fixtures,
@@ -18,17 +10,16 @@ import {
   deployFixtures,
   freshBoost,
   fundBudget,
-} from '../../test/helpers';
-import { StrategyType, prepareSignerValidatorClaimDataPayload } from '../utils';
+} from '@boostxyz/test/helpers';
+import { BOOST_CORE_CLAIM_FEE } from '../BoostCore';
+import { StrategyType } from '../claiming';
 import { ERC20Incentive } from './ERC20Incentive';
 
-const BOOST_CORE_CLAIM_FEE = parseEther('0.000075');
-
 let fixtures: Fixtures, budgets: BudgetFixtures;
 
 describe('ERC20Incentive', () => {
   beforeAll(async () => {
-    fixtures = await loadFixture(deployFixtures);
+    fixtures = await loadFixture(deployFixtures(defaultOptions));
   });
 
   beforeEach(async () => {
@@ -41,6 +32,7 @@ describe('ERC20Incentive', () => {
       strategy: StrategyType.POOL,
       reward: 1n,
       limit: 1n,
+      manager: zeroAddress,
     });
     await action.deploy();
     expect(isAddress(action.assertValidAddress())).toBe(true);
@@ -51,11 +43,12 @@ describe('ERC20Incentive', () => {
     const referrer = accounts.at(1)!.account!,
       // biome-ignore lint/style/noNonNullAssertion: we know this is defined
       trustedSigner = accounts.at(0)!;
-    const erc20Incentive = new fixtures.bases.ERC20Incentive(defaultOptions, {
+    const erc20Incentive = fixtures.core.ERC20Incentive({
       asset: budgets.erc20.assertValidAddress(),
       strategy: StrategyType.POOL,
       reward: 1n,
       limit: 1n,
+      manager: budgets.budget.assertValidAddress(),
     });
     const boost = await freshBoost(fixtures, {
       budget: budgets.budget,
@@ -63,13 +56,12 @@ describe('ERC20Incentive', () => {
     });
 
     const claimant = trustedSigner.account;
-    const incentiveData = pad('0xdef456232173821931823712381232131391321934');
+    const incentiveData = erc20Incentive.buildClaimData();
     const incentiveQuantity = 1;
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+    const claimDataPayload = await boost.validator.encodeClaimData({
       signer: trustedSigner,
       incentiveData,
       chainId: defaultOptions.config.chains[0].id,
-      validator: boost.validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
       boostId: boost.id,
@@ -95,11 +87,12 @@ describe('ERC20Incentive', () => {
     const referrer = accounts.at(1)!.account!;
     // biome-ignore lint/style/noNonNullAssertion: we know this is defined
     const trustedSigner = accounts.at(0)!;
-    const erc20Incentive = new fixtures.bases.ERC20Incentive(defaultOptions, {
+    const erc20Incentive = fixtures.core.ERC20Incentive({
       asset: budgets.erc20.assertValidAddress(),
       strategy: StrategyType.POOL,
       reward: 1n,
       limit: 1n,
+      manager: budgets.budget.assertValidAddress(),
     });
     const boost = await freshBoost(fixtures, {
       budget: budgets.budget,
@@ -109,11 +102,10 @@ describe('ERC20Incentive', () => {
     const claimant = trustedSigner.account;
     const incentiveData = pad('0xdef456232173821931823712381232131391321934');
     const incentiveQuantity = 1;
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+    const claimDataPayload = await boost.validator.encodeClaimData({
       signer: trustedSigner,
       incentiveData,
       chainId: defaultOptions.config.chains[0].id,
-      validator: boost.validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
       boostId: boost.id,
@@ -124,7 +116,7 @@ describe('ERC20Incentive', () => {
       0n,
       referrer,
       claimDataPayload,
-      { value: parseEther('0.000075') },
+      { value: BOOST_CORE_CLAIM_FEE },
     );
     try {
       await fixtures.core.claimIncentive(