@boostxyz/sdk 0.0.0-alpha.16 → 0.0.0-alpha.18

package/src/Incentives/ERC1155Incentive.ts

@@ -144,8 +144,8 @@ 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'>,
@@ -163,8 +163,8 @@ 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'>,
@@ -183,8 +183,8 @@ 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,
@@ -203,8 +203,8 @@ 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 await readErc1155IncentiveAsset(this._config, {
@@ -219,7 +219,7 @@ export class ERC1155Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof erc1155IncentiveAbi, 'strategy'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<StrategyType>}
    */
   public strategy(
@@ -237,7 +237,7 @@ 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'>) {
@@ -253,8 +253,8 @@ 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'>,
@@ -271,8 +271,8 @@ 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'>,
@@ -290,8 +290,8 @@ export class ERC1155Incentive extends DeployableTarget<
    * @public
    * @async
    * @param {ClaimPayload} payload
-   * @param {?WriteParams<typeof erc1155IncentiveAbi, 'claim'>} [params]
-   * @returns {unknown}
+   * @param {?WriteParams} [params]
+   * @returns {Promise<boolean>}
    */
   protected async claim(
     payload: ClaimPayload,
@@ -306,8 +306,8 @@ 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; }>}
    */
   protected async claimRaw(
     payload: ClaimPayload,
@@ -333,8 +333,8 @@ 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,
@@ -349,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,
@@ -376,8 +376,8 @@ 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,
@@ -397,8 +397,8 @@ 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,

package/src/Incentives/ERC20Incentive.ts

@@ -130,8 +130,8 @@ 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 await readErc20IncentiveOwner(this._config, {
@@ -147,7 +147,7 @@ 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(
@@ -166,7 +166,7 @@ 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'>) {
@@ -184,7 +184,7 @@ 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(
@@ -204,7 +204,7 @@ 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'>) {
@@ -220,7 +220,7 @@ export class ERC20Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof erc20IncentiveAbi, 'strategy'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<StrategyType>}
    */
   public strategy(
@@ -238,7 +238,7 @@ 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'>) {
@@ -254,8 +254,8 @@ 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 await readErc20IncentiveLimit(this._config, {
@@ -271,7 +271,7 @@ 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(
@@ -292,7 +292,7 @@ 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
    */
   protected async claim(
@@ -308,8 +308,8 @@ 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
    */
   protected async claimRaw(
     payload: ClaimPayload,
@@ -335,7 +335,7 @@ 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(
@@ -351,8 +351,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,
@@ -378,8 +378,8 @@ 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,
@@ -398,7 +398,7 @@ export class ERC20Incentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?WriteParams<typeof erc20IncentiveAbi, 'drawRaffle'>} [params]
+   * @param {?WriteParams} [params]
    * @returns {Promise<void>}
    */
   public async drawRaffle(
@@ -412,8 +412,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'>,
@@ -464,7 +464,7 @@ export class ERC20Incentive extends DeployableTarget<
  * @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 {*}
+ * @returns {Hex}
  */
 export function prepareERC20IncentivePayload({
   asset,

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');
+      }
+    });
+  });
+});