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

package/src/Incentives/ERC20Incentive.ts

@@ -18,7 +18,14 @@ import {
   writeErc20IncentiveDrawRaffle,
 } from '@boostxyz/evm';
 import { bytecode } from '@boostxyz/evm/artifacts/contracts/incentives/ERC20Incentive.sol/ERC20Incentive.json';
-import type { Address, ContractEventName, Hex } from 'viem';
+import {
+  type Address,
+  type ContractEventName,
+  type Hex,
+  encodeAbiParameters,
+  zeroHash,
+} from 'viem';
+import { ERC20Incentive as ERC20IncentiveBases } from '../../dist/deployments.json';
 import type {
   DeployableOptions,
   GenericDeployableParams,
@@ -26,18 +33,57 @@ import type {
 import { DeployableTarget } from '../Deployable/DeployableTarget';
 import {
   type ClaimPayload,
-  type ERC20IncentivePayload,
+  type StrategyType,
+  prepareClaimPayload,
+} from '../claiming';
+import {
   type GenericLog,
   type ReadParams,
   RegistryType,
-  type StrategyType,
   type WriteParams,
-  prepareClaimPayload,
-  prepareERC20IncentivePayload,
 } from '../utils';
 
 export { erc20IncentiveAbi };
-export type { ERC20IncentivePayload };
+
+/**
+ * The object representation of a `ERC20Incentive.InitPayload`
+ *
+ * @export
+ * @interface ERC20IncentivePayload
+ * @typedef {ERC20IncentivePayload}
+ */
+export interface ERC20IncentivePayload {
+  /**
+   * The address of the incentivized asset.
+   *
+   * @type {Address}
+   */
+  asset: Address;
+  /**
+   * The type of disbursement strategy for the incentive. `StrategyType.MINT` is not supported for `ERC20Incentives`
+   *
+   * @type {StrategyType}
+   */
+  strategy: StrategyType;
+  /**
+   * The amount of the asset to distribute.
+   *
+   * @type {bigint}
+   */
+  reward: bigint;
+  /**
+   * How many times can this incentive be claimed.
+   *
+   * @type {bigint}
+   */
+  limit: bigint;
+  /**
+   * The entity that can `clawback` funds
+   *
+   * @type {Address}
+   */
+  manager: Address;
+}
 
 /**
  * A generic `viem.Log` event with support for `ERC20Incentive` event types.
@@ -72,10 +118,11 @@ export class ERC20Incentive extends DeployableTarget<
    *
    * @public
    * @static
-   * @type {Address}
+   * @type {Record<number, Address>}
    */
-  public static override base: Address = import.meta.env
-    .VITE_ERC20_INCENTIVE_BASE;
+  public static override bases: Record<number, Address> = {
+    ...(ERC20IncentiveBases as Record<number, Address>),
+  };
   /**
    * @inheritdoc
    *
@@ -90,11 +137,11 @@ export class ERC20Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof erc20IncentiveAbi, 'owner'>} [params]
-   * @returns {unknown}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<Address>}
    */
   public async owner(params?: ReadParams<typeof erc20IncentiveAbi, 'owner'>) {
-    return readErc20IncentiveOwner(this._config, {
+    return await readErc20IncentiveOwner(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
@@ -107,13 +154,13 @@ export class ERC20Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof erc20IncentiveAbi, 'currentReward'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<bigint>} - The current reward
    */
   public async currentReward(
     params?: ReadParams<typeof erc20IncentiveAbi, 'currentReward'>,
   ) {
-    return readErc20IncentiveCurrentReward(this._config, {
+    return await readErc20IncentiveCurrentReward(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
@@ -126,11 +173,11 @@ export class ERC20Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof erc20IncentiveAbi, 'claims'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<bigint>}
    */
   public async claims(params?: ReadParams<typeof erc20IncentiveAbi, 'claims'>) {
-    return readErc20IncentiveClaims(this._config, {
+    return await readErc20IncentiveClaims(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
@@ -144,14 +191,14 @@ export class ERC20Incentive extends DeployableTarget<
    * @public
    * @async
    * @param {Address} address
-   * @param {?ReadParams<typeof erc20IncentiveAbi, 'claimed'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<boolean>}
    */
   public async claimed(
     address: Address,
     params?: ReadParams<typeof erc20IncentiveAbi, 'claimed'>,
   ) {
-    return readErc20IncentiveClaimed(this._config, {
+    return await readErc20IncentiveClaimed(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
@@ -164,11 +211,11 @@ export class ERC20Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof erc20IncentiveAbi, 'asset'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<Address>}
    */
   public async asset(params?: ReadParams<typeof erc20IncentiveAbi, 'asset'>) {
-    return readErc20IncentiveAsset(this._config, {
+    return await readErc20IncentiveAsset(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),
@@ -180,10 +227,10 @@ export class ERC20Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof erc20IncentiveAbi, 'strategy'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<StrategyType>}
    */
-  public async strategy(
+  public strategy(
     params?: ReadParams<typeof erc20IncentiveAbi, 'strategy'>,
   ): Promise<StrategyType> {
     return readErc20IncentiveStrategy(this._config, {
@@ -198,11 +245,11 @@ export class ERC20Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof erc20IncentiveAbi, 'reward'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<bigint>}
    */
   public async reward(params?: ReadParams<typeof erc20IncentiveAbi, 'reward'>) {
-    return readErc20IncentiveReward(this._config, {
+    return await readErc20IncentiveReward(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),
@@ -214,11 +261,11 @@ export class ERC20Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof erc20IncentiveAbi, 'limit'>} [params]
-   * @returns {unknown}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<bigint>}
    */
   public async limit(params?: ReadParams<typeof erc20IncentiveAbi, 'limit'>) {
-    return readErc20IncentiveLimit(this._config, {
+    return await readErc20IncentiveLimit(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),
@@ -231,14 +278,14 @@ export class ERC20Incentive extends DeployableTarget<
    * @public
    * @async
    * @param {bigint} i - Index of address
-   * @param {?ReadParams<typeof erc20IncentiveAbi, 'entries'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<Address>}
    */
   public async entries(
     i: bigint,
     params?: ReadParams<typeof erc20IncentiveAbi, 'entries'>,
   ) {
-    return readErc20IncentiveEntries(this._config, {
+    return await readErc20IncentiveEntries(this._config, {
       address: this.assertValidAddress(),
       args: [i],
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
@@ -252,14 +299,14 @@ export class ERC20Incentive extends DeployableTarget<
    * @public
    * @async
    * @param {ClaimPayload} payload
-   * @param {?WriteParams<typeof erc20IncentiveAbi, 'claim'>} [params]
+   * @param {?WriteParams} [params]
    * @returns {Promise<boolean>} - Returns true if successfully claimed
    */
-  public async claim(
+  protected async claim(
     payload: ClaimPayload,
     params?: WriteParams<typeof erc20IncentiveAbi, 'claim'>,
   ) {
-    return this.awaitResult(this.claimRaw(payload, params));
+    return await this.awaitResult(this.claimRaw(payload, params));
   }
 
   /**
@@ -268,10 +315,10 @@ export class ERC20Incentive extends DeployableTarget<
    * @public
    * @async
    * @param {ClaimPayload} payload
-   * @param {?WriteParams<typeof erc20IncentiveAbi, 'claim'>} [params]
-   * @returns {Promise<boolean>} - Returns true if successfully claimed
+   * @param {?WriteParams} [params]
+   * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - Returns true if successfully claimed
    */
-  public async claimRaw(
+  protected async claimRaw(
     payload: ClaimPayload,
     params?: WriteParams<typeof erc20IncentiveAbi, 'claim'>,
   ) {
@@ -295,14 +342,14 @@ export class ERC20Incentive extends DeployableTarget<
    * @public
    * @async
    * @param {ClaimPayload} payload
-   * @param {?WriteParams<typeof erc20IncentiveAbi, 'clawback'>} [params]
+   * @param {?WriteParams} [params]
    * @returns {Promise<boolean>} -  True if the assets were successfully clawbacked
    */
   public async clawback(
     payload: ClaimPayload,
     params?: WriteParams<typeof erc20IncentiveAbi, 'clawback'>,
   ) {
-    return this.awaitResult(this.clawbackRaw(payload, params));
+    return await this.awaitResult(this.clawbackRaw(payload, params));
   }
 
   /**
@@ -311,8 +358,8 @@ export class ERC20Incentive extends DeployableTarget<
    * @public
    * @async
    * @param {ClaimPayload} payload
-   * @param {?WriteParams<typeof erc20IncentiveAbi, 'clawback'>} [params]
-   * @returns {Promise<boolean>} -  True if the assets were successfully clawbacked
+   * @param {?WriteParams} [params]
+   * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} -  True if the assets were successfully clawbacked
    */
   public async clawbackRaw(
     payload: ClaimPayload,
@@ -338,14 +385,14 @@ export class ERC20Incentive extends DeployableTarget<
    * @public
    * @async
    * @param {ClaimPayload} payload
-   * @param {?ReadParams<typeof erc20IncentiveAbi, 'isClaimable'>} [params]
-   * @returns {unknown} = True if the incentive is claimable based on the data payload
+   * @param {?ReadParams} [params]
+   * @returns {Promise<boolean>} = True if the incentive is claimable based on the data payload
    */
   public async isClaimable(
     payload: ClaimPayload,
     params?: ReadParams<typeof erc20IncentiveAbi, 'isClaimable'>,
   ) {
-    return readErc20IncentiveIsClaimable(this._config, {
+    return await readErc20IncentiveIsClaimable(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
@@ -358,13 +405,13 @@ export class ERC20Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?WriteParams<typeof erc20IncentiveAbi, 'drawRaffle'>} [params]
+   * @param {?WriteParams} [params]
    * @returns {Promise<void>}
    */
   public async drawRaffle(
     params?: WriteParams<typeof erc20IncentiveAbi, 'drawRaffle'>,
   ) {
-    return this.awaitResult(this.drawRaffleRaw(params));
+    return await this.awaitResult(this.drawRaffleRaw(params));
   }
 
   /**
@@ -372,8 +419,8 @@ export class ERC20Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?WriteParams<typeof erc20IncentiveAbi, 'drawRaffle'>} [params]
-   * @returns {Promise<void>}
+   * @param {?WriteParams} [params]
+   * @returns {Promise<{ hash: `0x${string}`; result: void; }>}
    */
   public async drawRaffleRaw(
     params?: WriteParams<typeof erc20IncentiveAbi, 'drawRaffle'>,
@@ -414,4 +461,42 @@ export class ERC20Incentive extends DeployableTarget<
       ...this.optionallyAttachAccount(options.account),
     };
   }
+
+  /**
+   * Builds the claim data for the ERC20Incentive.
+   *
+   * @public
+   * @returns {Hash} A `zeroHash`, as ERC20Incentive doesn't require specific claim data.
+   * @description This function returns `zeroHash` because ERC20Incentive doesn't use any specific claim data.
+   */
+  public buildClaimData() {
+    return zeroHash;
+  }
+}
+
+/**
+ * Given a {@link ERC20IncentivePayload}, properly encode a `ERC20Incentive.InitPayload` for use with {@link ERC20Incentive} initialization.
+ *
+ * @param {ERC20IncentivePayload} param0
+ * @param {Address} param0.asset - The address of the incentivized asset.
+ * @param {StrategyType} param0.strategy - The type of disbursement strategy for the incentive. `StrategyType.MINT` is not supported for `ERC20Incentives`
+ * @param {bigint} param0.reward - The amount of the asset to distribute.
+ * @param {bigint} param0.limit - How many times can this incentive be claimed.
+ * @returns {Hex}
+ */
+export function prepareERC20IncentivePayload({
+  asset,
+  strategy,
+  reward,
+  limit,
+}: ERC20IncentivePayload) {
+  return encodeAbiParameters(
+    [
+      { type: 'address', name: 'asset' },
+      { type: 'uint8', name: 'strategy' },
+      { type: 'uint256', name: 'reward' },
+      { type: 'uint256', name: 'limit' },
+    ],
+    [asset, strategy, reward, limit],
+  );
 }

package/src/Incentives/ERC20VariableCriteriaIncentive.test.ts

@@ -0,0 +1,184 @@
+import { Mock } from 'node:test';
+import { selectors as eventSelectors } from '@boostxyz/signatures/events';
+import { selectors as funcSelectors } from '@boostxyz/signatures/functions';
+import type { MockERC20 } from '@boostxyz/test/MockERC20';
+import type { MockERC721 } from '@boostxyz/test/MockERC721';
+import { accounts } from '@boostxyz/test/accounts';
+import {
+  type BudgetFixtures,
+  type Fixtures,
+  defaultOptions,
+  deployFixtures,
+  freshBoost,
+  fundBudget,
+  fundErc20,
+  fundErc721,
+} from '@boostxyz/test/helpers';
+import { loadFixture } from '@nomicfoundation/hardhat-network-helpers';
+import { type Hex, isAddress, parseEther } from 'viem';
+import { beforeAll, beforeEach, describe, expect, test } from 'vitest';
+import { SignatureType } from '../Actions/EventAction';
+import type { Boost } from '../Boost';
+import type {
+  ERC20VariableCriteriaIncentive,
+  ERC20VariableCriteriaIncentivePayload,
+  IncentiveCriteria,
+} from './ERC20VariableCriteriaIncentive';
+
+/**
+ * A basic ERC721 mint scalar criteria for testing
+ *
+ * @param {MockERC721} erc721 - The ERC721 contract
+ * @returns {IncentiveCriteria} - Returns a basic incentive criteria
+ */
+export function basicErc721TransferScalarCriteria(
+  erc721: MockERC721,
+): IncentiveCriteria {
+  return {
+    criteriaType: SignatureType.FUNC,
+    signature: funcSelectors['transferFrom(address,address,uint256)'] as Hex, // Function selector for mint
+    fieldIndex: 2, // Field where the scalar value resides
+    targetContract: erc721.assertValidAddress(),
+  };
+}
+
+/**
+ * A basic ERC721 mint scalar criteria for testing
+ *
+ * @param {MockERC721} erc721 - The ERC721 contract
+ * @returns {IncentiveCriteria} - Returns a basic incentive criteria
+ */
+export function basicErc721MintScalarCriteria(
+  erc721: MockERC721,
+): IncentiveCriteria {
+  return {
+    criteriaType: SignatureType.EVENT,
+    signature: eventSelectors[
+      'Transfer(address indexed,address indexed,uint256 indexed)'
+    ] as Hex, // Function selector for mint
+    fieldIndex: 2, // Field where the scalar value resides
+    targetContract: erc721.assertValidAddress(),
+  };
+}
+
+/**
+ * A basic ERC721 mint scalar payload for testing
+ *
+ * @param {MockERC721} erc721 - The ERC721 contract
+ * @returns {ERC20VariableCriteriaIncentivePayload} - Returns a full variable criteria incentive payload
+ */
+export function basicErc721TransferScalarPayload(
+  erc721: MockERC721,
+): ERC20VariableCriteriaIncentivePayload {
+  return {
+    asset: erc721.assertValidAddress(),
+    reward: 1n,
+    limit: 1n,
+    criteria: basicErc721TransferScalarCriteria(erc721),
+  };
+}
+
+let fixtures: Fixtures,
+  erc20: MockERC20,
+  erc721: MockERC721,
+  erc20Incentive: ERC20VariableCriteriaIncentive,
+  budgets: BudgetFixtures,
+  boost: Boost;
+
+describe('ERC20VariableCriteriaIncentive', () => {
+  beforeAll(async () => {
+    fixtures = await loadFixture(deployFixtures(defaultOptions));
+  });
+
+  beforeEach(async () => {
+    budgets = await loadFixture(fundBudget(defaultOptions, fixtures));
+    erc20 = await loadFixture(fundErc20(defaultOptions));
+    erc721 = await loadFixture(fundErc721(defaultOptions));
+    erc20Incentive = fixtures.core.ERC20VariableCriteriaIncentive({
+      asset: budgets.erc20.assertValidAddress(),
+      reward: 1n,
+      limit: 1n,
+      criteria: basicErc721TransferScalarCriteria(erc721),
+    });
+
+    boost = await freshBoost(fixtures, {
+      budget: budgets.budget,
+      incentives: [erc20Incentive],
+    });
+    expect(isAddress(boost.incentives[0]!.assertValidAddress())).toBe(true);
+  });
+
+  describe('getIncentiveCriteria', () => {
+    test('should fetch incentive criteria successfully', async () => {
+      const incentive = boost.incentives[0] as ERC20VariableCriteriaIncentive;
+      const criteria = await incentive.getIncentiveCriteria();
+      expect(criteria).toMatchObject({
+        criteriaType: SignatureType.FUNC,
+        signature: expect.any(String),
+        fieldIndex: expect.any(Number),
+        targetContract: expect.any(String),
+      });
+    });
+  });
+
+  describe('getIncentiveScalar', () => {
+    test('should return a valid scalar for function-based criteria', async () => {
+      const recipient = accounts[1].account;
+
+      const { hash } = await erc721.transferFromRaw(
+        accounts[0].account,
+        recipient,
+        1n,
+      );
+      const scalar = await erc20Incentive.getIncentiveScalar({ hash });
+
+      expect(scalar).toBe(1n);
+    });
+
+    test('should return a valid scalar for event-based criteria', async () => {
+      erc20Incentive = fixtures.core.ERC20VariableCriteriaIncentive({
+        asset: budgets.erc20.assertValidAddress(),
+        reward: 1n,
+        limit: 1n,
+        criteria: basicErc721MintScalarCriteria(erc721),
+      });
+
+      boost = await freshBoost(fixtures, {
+        budget: budgets.budget,
+        incentives: [erc20Incentive],
+      });
+      const recipient = accounts[1].account;
+      const { hash } = await erc721.transferFromRaw(
+        accounts[0].account,
+        recipient,
+        1n,
+      );
+      const scalar = await erc20Incentive.getIncentiveScalar({ hash });
+
+      expect(scalar).toBe(1n);
+    });
+
+    test('should throw NoMatchingLogsError for event criteria with no matching logs', async () => {
+      const recipient = accounts[1].account;
+
+      const { hash } = await erc20.mintRaw(recipient, parseEther('100'));
+
+      try {
+        await erc20Incentive.getIncentiveScalar({ hash });
+      } catch (e) {
+        expect((e as Error).name).toBe('DecodedArgsError');
+      }
+    });
+
+    test('should throw DecodedArgsError for invalid function-based data', async () => {
+      const recipient = accounts[1].account;
+      const { hash } = await erc20.mintRaw(recipient, parseEther('100'));
+
+      try {
+        await erc20Incentive.getIncentiveScalar({ hash });
+      } catch (e) {
+        expect((e as Error).name).toBe('DecodedArgsError');
+      }
+    });
+  });
+});