@boostxyz/sdk 8.0.0-canary.2 → 8.0.0-canary.4

package/src/Incentives/ERC20Incentive.test.ts

@@ -5,7 +5,7 @@ import {
   type Fixtures,
   defaultOptions,
   deployFixtures,
-  freshBoost,
+  freshBoostWithV1Validator,
   fundBudget,
 } from "@boostxyz/test/helpers";
 import { loadFixture } from "@nomicfoundation/hardhat-network-helpers";
@@ -56,7 +56,7 @@ describe("ERC20Incentive", () => {
       limit: 1n,
       manager: budgets.budget.assertValidAddress(),
     });
-    const boost = await freshBoost(fixtures, {
+    const boost = await freshBoostWithV1Validator(fixtures, {
       budget: budgets.budget,
       incentives: [erc20Incentive],
     });
@@ -98,7 +98,7 @@ describe("ERC20Incentive", () => {
       limit: 1n,
       manager: budgets.budget.assertValidAddress(),
     });
-    const boost = await freshBoost(fixtures, {
+    const boost = await freshBoostWithV1Validator(fixtures, {
       budget: budgets.budget,
       incentives: [erc20Incentive],
     });
@@ -140,7 +140,7 @@ describe("ERC20Incentive", () => {
       limit: 1n,
       manager: budgets.budget.assertValidAddress(),
     });
-    const boost = await freshBoost(fixtures, {
+    const boost = await freshBoostWithV1Validator(fixtures, {
       budget: budgets.budget,
       incentives: [erc20Incentive],
     });
@@ -191,7 +191,7 @@ describe("ERC20Incentive", () => {
       limit: 10n,
       manager: budgets.budget.assertValidAddress(),
     });
-    const boost = await freshBoost(fixtures, {
+    const boost = await freshBoostWithV1Validator(fixtures, {
       budget: budgets.budget,
       incentives: [erc20Incentive],
     });
@@ -217,7 +217,7 @@ describe("ERC20Incentive", () => {
       limit: 1n,
       manager: budgets.budget.assertValidAddress(),
     });
-    const boost = await freshBoost(fixtures, {
+    const boost = await freshBoostWithV1Validator(fixtures, {
       budget: budgets.budget,
       incentives: [erc20Incentive],
     });

package/src/Incentives/ERC20PeggedVariableCriteriaIncentiveV2.test.ts

@@ -8,7 +8,7 @@ import {
   type Fixtures,
   defaultOptions,
   deployFixtures,
-  freshBoost,
+  freshBoostWithV1Validator,
   fundBudget,
   fundErc20,
   fundErc721,
@@ -98,7 +98,7 @@ describe("ERC20PeggedVariableCriteriaIncentive", () => {
       peg: erc20.assertValidAddress(),
     });
 
-    boost = await freshBoost(fixtures, {
+    boost = await freshBoostWithV1Validator(fixtures, {
       budget: budgets.budget,
       incentives: [erc20PeggedVariableCriteriaIncentive],
     });
@@ -203,7 +203,7 @@ describe("ERC20PeggedVariableCriteriaIncentive", () => {
     });
 
     test("should return a valid scalar for event-based criteria", async () => {
-      boost = await freshBoost(fixtures, {
+      boost = await freshBoostWithV1Validator(fixtures, {
         budget: budgets.budget,
         incentives: [erc20PeggedVariableCriteriaIncentive],
       });
@@ -244,7 +244,7 @@ describe("ERC20PeggedVariableCriteriaIncentive", () => {
         valueType: ValueType.WAD,
       });
 
-      boost = await freshBoost(fixtures, {
+      boost = await freshBoostWithV1Validator(fixtures, {
         budget: budgets.budget,
         incentives: [erc20PeggedVariableCriteriaIncentive],
       });
@@ -302,7 +302,7 @@ describe("ERC20PeggedVariableCriteriaIncentive", () => {
 
   test("can clawback via a budget", async () => {
     // rebase this
-    const boost = await freshBoost(fixtures, {
+    const boost = await freshBoostWithV1Validator(fixtures, {
       budget: budgets.budget,
       incentives: [erc20PeggedVariableCriteriaIncentive],
     });

package/src/Incentives/ERC20PeggedVariableCriteriaIncentiveV2.ts

@@ -877,7 +877,7 @@ export function prepareERC20PeggedVariableCriteriaIncentiveV2Payload({
             components: [
               { type: 'uint8', name: 'criteriaType' },
               { type: 'bytes32', name: 'signature' },
-              { type: 'uint8', name: 'fieldIndex' },
+              { type: 'uint32', name: 'fieldIndex' },
               { type: 'address', name: 'targetContract' },
               { type: 'uint8', name: 'valueType' },
             ],

package/src/Incentives/ERC20VariableCriteriaIncentiveV2.test.ts

@@ -8,7 +8,7 @@ import {
   type Fixtures,
   defaultOptions,
   deployFixtures,
-  freshBoost,
+  freshBoostWithV1Validator,
   fundBudget,
   fundErc20,
   fundErc721,
@@ -112,7 +112,7 @@ describe("ERC20VariableCriteriaIncentiveV2", () => {
       criteria: basicErc721TransferScalarCriteria(erc721),
     });
 
-    boost = await freshBoost(fixtures, {
+    boost = await freshBoostWithV1Validator(fixtures, {
       budget: budgets.budget,
       incentives: [erc20Incentive],
     });
@@ -160,7 +160,7 @@ describe("ERC20VariableCriteriaIncentiveV2", () => {
         criteria: basicErc721MintScalarCriteria(erc721),
       });
 
-      boost = await freshBoost(fixtures, {
+      boost = await freshBoostWithV1Validator(fixtures, {
         budget: budgets.budget,
         incentives: [erc20Incentive],
       });
@@ -200,7 +200,7 @@ describe("ERC20VariableCriteriaIncentiveV2", () => {
         valueType: ValueType.WAD,
       });
 
-      boost = await freshBoost(fixtures, {
+      boost = await freshBoostWithV1Validator(fixtures, {
         budget: budgets.budget,
         incentives: [erc20Incentive],
       });
@@ -257,7 +257,7 @@ describe("ERC20VariableCriteriaIncentiveV2", () => {
   });
 
   test("can clawback via a budget", async () => {
-    const boost = await freshBoost(fixtures, {
+    const boost = await freshBoostWithV1Validator(fixtures, {
       budget: budgets.budget,
       incentives: [erc20Incentive],
     });

package/src/Incentives/ERC20VariableCriteriaIncentiveV2.ts

@@ -457,7 +457,7 @@ export function prepareERC20VariableCriteriaIncentiveV2Payload({
             components: [
               { type: 'uint8', name: 'criteriaType' },
               { type: 'bytes32', name: 'signature' },
-              { type: 'uint8', name: 'fieldIndex' },
+              { type: 'uint32', name: 'fieldIndex' },
               { type: 'address', name: 'targetContract' },
               { type: 'uint8', name: 'valueType' },
             ],

package/src/Incentives/ERC20VariableIncentive.test.ts

@@ -5,7 +5,7 @@ import {
   type Fixtures,
   defaultOptions,
   deployFixtures,
-  freshBoost,
+  freshBoostWithV1Validator,
   fundBudget,
 } from "@boostxyz/test/helpers";
 import { loadFixture } from "@nomicfoundation/hardhat-network-helpers";
@@ -19,7 +19,6 @@ import { beforeAll, beforeEach, describe, expect, test } from "vitest";
 import { decodeClaimData } from "../Validators/Validator";
 import { ERC20VariableIncentive } from "./ERC20VariableIncentive";
 
-
 let fixtures: Fixtures, budgets: BudgetFixtures;
 
 describe("ERC20VariableIncentive", () => {
@@ -57,7 +56,7 @@ describe("ERC20VariableIncentive", () => {
         manager: zeroAddress,
       },
     );
-    const boost = await freshBoost(fixtures, {
+    const boost = await freshBoostWithV1Validator(fixtures, {
       budget: budgets.budget,
       incentives: [erc20VariableIncentive],
     });
@@ -99,7 +98,7 @@ describe("ERC20VariableIncentive", () => {
         manager: zeroAddress,
       },
     );
-    const boost = await freshBoost(fixtures, {
+    const boost = await freshBoostWithV1Validator(fixtures, {
       budget: budgets.budget,
       incentives: [erc20VariableIncentive],
     });
@@ -139,7 +138,7 @@ describe("ERC20VariableIncentive", () => {
         manager: zeroAddress,
       },
     );
-    const boost = await freshBoost(fixtures, {
+    const boost = await freshBoostWithV1Validator(fixtures, {
       budget: budgets.budget,
       incentives: [erc20VariableIncentive],
     });
@@ -186,7 +185,7 @@ describe("ERC20VariableIncentive", () => {
         manager: zeroAddress,
       },
     );
-    const boost = await freshBoost(fixtures, {
+    const boost = await freshBoostWithV1Validator(fixtures, {
       budget: budgets.budget,
       incentives: [erc20VariableIncentive],
     });
@@ -223,7 +222,7 @@ describe("ERC20VariableIncentive", () => {
         manager: zeroAddress,
       },
     );
-    const boost = await freshBoost(fixtures, {
+    const boost = await freshBoostWithV1Validator(fixtures, {
       budget: budgets.budget,
       incentives: [erc20VariableIncentive],
     });
@@ -248,7 +247,7 @@ describe("ERC20VariableIncentive", () => {
       limit: 1n,
       manager: budgets.budget.assertValidAddress(),
     });
-    const boost = await freshBoost(fixtures, {
+    const boost = await freshBoostWithV1Validator(fixtures, {
       budget: budgets.budget,
       incentives: [erc20VariableIncentive],
     });

package/src/Incentives/PointsIncentive.test.ts

@@ -5,7 +5,7 @@ import {
   type Fixtures,
   defaultOptions,
   deployFixtures,
-  freshBoost,
+  freshBoostWithV1Validator,
   freshPoints,
 } from "@boostxyz/test/helpers";
 import { loadFixture } from "@nomicfoundation/hardhat-network-helpers";
@@ -48,7 +48,7 @@ describe("PointsIncentive", () => {
       reward: 1n,
       limit: 10n,
     });
-    const boost = await freshBoost(fixtures, {
+    const boost = await freshBoostWithV1Validator(fixtures, {
       incentives: [pointsIncentive],
     });
 
@@ -93,7 +93,7 @@ describe("PointsIncentive", () => {
       reward: 1n,
       limit: 1n,
     });
-    const boost = await freshBoost(fixtures, {
+    const boost = await freshBoostWithV1Validator(fixtures, {
       incentives: [pointsIncentive],
     });
 
@@ -139,7 +139,7 @@ describe("PointsIncentive", () => {
       reward,
       limit: 10n,
     });
-    const boost = await freshBoost(fixtures, {
+    const boost = await freshBoostWithV1Validator(fixtures, {
       incentives: [pointsIncentive],
     });
 
@@ -188,7 +188,7 @@ describe("PointsIncentive", () => {
       reward: 1n,
       limit: 1n,
     });
-    const boost = await freshBoost(fixtures, {
+    const boost = await freshBoostWithV1Validator(fixtures, {
       incentives: [pointsIncentive],
     });
 

package/src/Validators/LimitedSignerValidator.test.ts

@@ -1,5 +1,5 @@
 import { loadFixture } from '@nomicfoundation/hardhat-network-helpers';
-import { isAddress, pad, ContractFunctionRevertedError } from 'viem';
+import { isAddress, pad } from 'viem';
 import { beforeAll, describe, expect, test } from 'vitest';
 import { accounts } from '@boostxyz/test/accounts';
 import {

package/src/Validators/LimitedSignerValidator.ts

@@ -17,7 +17,6 @@ import {
   type PrivateKeyAccount,
   encodeAbiParameters,
 } from 'viem';
-import { signTypedData } from 'viem/accounts';
 import { LimitedSignerValidator as SignerValidatorBases } from '../../dist/deployments.json';
 import type {
   DeployableOptions,
@@ -292,9 +291,9 @@ export type LimitedSignerValidatorLog<
  *  A simple implementation of a Validator that verifies a given signature and checks the recovered address against a set of authorized signers
  *
  * @export
- * @class SignerValidator
- * @typedef {SignerValidator}
- * @extends {DeployableTarget<SignerValidatorPayload>}
+ * @class LimitedSignerValidator
+ * @typedef {LimitedSignerValidator}
+ * @extends {DeployableTarget<LimitedSignerValidatorPayload>}
  */
 export class LimitedSignerValidator extends DeployableTarget<
   LimitedSignerValidatorPayload,
@@ -379,11 +378,11 @@ export class LimitedSignerValidator extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {SignerValidatorValidatePayload} payload
+   * @param {LimitedSignerValidatorValidatePayload} payload
    * @param {?WriteParams} [params]
    * @returns {Promise<boolean>} - True if the action has been validated based on the data payload
    */
-  protected async validate(
+  public async validate(
     payload: LimitedSignerValidatorValidatePayload,
     params?: WriteParams,
   ) {
@@ -395,11 +394,11 @@ export class LimitedSignerValidator extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {SignerValidatorValidatePayload} payload
+   * @param {LimitedSignerValidatorValidatePayload} payload
    * @param {?WriteParams} [params]
    * @returns {Promise<boolean>} - True if the action has been validated based on the data payload
    */
-  protected async validateRaw(
+  public async validateRaw(
     payload: LimitedSignerValidatorValidatePayload,
     params?: WriteParams,
   ) {
@@ -518,7 +517,7 @@ export class LimitedSignerValidator extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {SignerValidatorClaimDataParams} params
+   * @param {LimitedSignerValidatorClaimDataParams} params
    * @returns {Promise<Hex>}
    */
   public async encodeClaimData(
@@ -534,7 +533,7 @@ export class LimitedSignerValidator extends DeployableTarget<
    * @inheritdoc
    *
    * @public
-   * @param {?SignerValidatorPayload} [_payload]
+   * @param {?LimitedSignerValidatorPayload} [_payload]
    * @param {?DeployableOptions} [_options]
    * @returns {GenericDeployableParams}
    */

package/src/Validators/LimitedSignerValidatorV2.test.ts

@@ -0,0 +1,231 @@
+import { loadFixture } from '@nomicfoundation/hardhat-network-helpers';
+import { isAddress, pad, ContractFunctionRevertedError } from 'viem';
+import { beforeAll, describe, expect, test } from 'vitest';
+import { accounts } from '@boostxyz/test/accounts';
+import {
+  type Fixtures,
+  defaultOptions,
+  deployFixtures,
+} from '@boostxyz/test/helpers';
+import { testAccount } from '@boostxyz/test/viem';
+import { LimitedSignerValidatorV2 } from './LimitedSignerValidatorV2';
+
+let fixtures: Fixtures;
+
+function freshValidator(fixtures: Fixtures) {
+  return function freshValidator() {
+    // biome-ignore lint/style/noNonNullAssertion: this will never be undefined
+    const account = accounts.at(1)!.account;
+    return fixtures.registry.initialize(
+      crypto.randomUUID(),
+      fixtures.core.LimitedSignerValidatorV2({
+        signers: [defaultOptions.account.address, account],
+        validatorCaller: testAccount.address,
+        maxClaimCount: 1,
+      }),
+    );
+  };
+}
+
+describe('LimitedSignerValidatorV2', () => {
+  beforeAll(async () => {
+    fixtures = await loadFixture(deployFixtures(defaultOptions));
+  });
+
+  test('can successfully be deployed', async () => {
+    expect.assertions(1);
+    const action = new LimitedSignerValidatorV2(defaultOptions, {
+      signers: [testAccount.address],
+      validatorCaller: testAccount.address,
+      maxClaimCount: 0,
+    });
+    await action.deploy();
+    expect(isAddress(action.assertValidAddress())).toBe(true);
+  });
+
+  test('initializes successfully', async () => {
+    expect.assertions(3);
+    const validator = await loadFixture(freshValidator(fixtures));
+    expect(await validator.signers(defaultOptions.account.address)).toBe(true);
+    // biome-ignore lint/style/noNonNullAssertion: this will never be undefined
+    expect(await validator.signers(accounts.at(1)!.account)).toBe(true);
+    // biome-ignore lint/style/noNonNullAssertion: this will never be undefined
+    expect(await validator.signers(accounts.at(2)!.account)).toBe(false);
+  });
+
+  test('can validate hashes', async () => {
+    const validator = await loadFixture(freshValidator(fixtures));
+
+    // Define the input data
+    const boostId = 5n;
+    const incentiveQuantity = 1;
+    const incentiveId = 0n;
+    const claimant = '0x24582544C98a86eE59687c4D5B55D78f4FffA666';
+    const referrer = '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045';
+    const incentiveData = pad('0xdef456232173821931823712381232131391321934');
+
+    // biome-ignore lint/style/noNonNullAssertion: this will never be undefined
+    const trustedSigner = accounts.at(0)!;
+    // biome-ignore lint/style/noNonNullAssertion: this will never be undefined
+    const untrustedSigner = accounts.at(2)!;
+
+    const claimDataPayload = await validator.encodeClaimData({
+      signer: trustedSigner,
+      incentiveData,
+      chainId: defaultOptions.config.chains[0].id,
+      incentiveQuantity,
+      claimant,
+      boostId: boostId,
+      referrer,
+    });
+
+    const badClaimDataPayload = await validator.encodeClaimData({
+      signer: untrustedSigner,
+      incentiveData,
+      chainId: defaultOptions.config.chains[0].id,
+      incentiveQuantity,
+      claimant,
+      boostId: boostId,
+      referrer,
+    });
+
+    // Validation using trusted signer
+    expect(
+      await validator.validate({
+        boostId: boostId,
+        incentiveId: incentiveId,
+        claimData: claimDataPayload,
+        claimant: claimant,
+      }),
+    ).toBe(true);
+
+    // Validation using untrusted signer should throw an error
+    try {
+      await validator.validate({
+        boostId: boostId,
+        incentiveId: incentiveId,
+        claimData: badClaimDataPayload,
+        claimant: claimant,
+      });
+    } catch (e) {
+      expect(e).toBeInstanceOf(Error);
+    }
+    expect.assertions(2);
+  });
+
+  test('will not accept more than `maxClaims` valid claims', async () =>{
+    // in this case maxClaims is 1, configured above as a state variable
+    const validator = await loadFixture(freshValidator(fixtures));
+
+    // Define the input data
+    const boostId = 5n;
+    const incentiveQuantity = 1;
+    const incentiveId = 0n;
+    const claimant = '0x24582544C98a86eE59687c4D5B55D78f4FffA666';
+    const referrer = '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045';
+    const incentiveData = pad('0xdef456232173821931823712381232131391321934');
+
+    // biome-ignore lint/style/noNonNullAssertion: this will never be undefined
+    const trustedSigner = accounts[0];
+
+    const claimDataPayload = await validator.encodeClaimData({
+      signer: trustedSigner,
+      incentiveData,
+      chainId: defaultOptions.config.chains[0].id,
+      incentiveQuantity,
+      claimant,
+      boostId: boostId,
+      referrer,
+    });
+
+    // Validation using trusted signer
+    expect(
+      await validator.validate({
+        boostId: boostId,
+        incentiveId: incentiveId,
+        claimData: claimDataPayload,
+        claimant: claimant,
+      }),
+    ).toBe(true);
+
+    const newClaimDataPayload = await validator.encodeClaimData({
+      signer: trustedSigner,
+      incentiveData: pad('0xdef45623217382193182371238123213139132193456'),
+      chainId: defaultOptions.config.chains[0].id,
+      incentiveQuantity,
+      claimant,
+      boostId: boostId,
+      referrer,
+    });
+
+    try {
+    await validator.validate({
+        boostId: boostId,
+        incentiveId: incentiveId,
+        claimData: newClaimDataPayload,
+        claimant: claimant,
+      })
+    } catch(e) {
+      if (e instanceof Object)
+        expect((e).toString()).toContain('MaximumClaimed')
+    }
+    expect.assertions(2);
+  })
+
+  test('will not revalidate the same hash', async () => {
+    const validator = await loadFixture(freshValidator(fixtures));
+
+    // Define the input data
+    const boostId = 5n;
+    const incentiveQuantity = 1;
+    const incentiveId = 0n;
+    const claimant = '0x24582544C98a86eE59687c4D5B55D78f4FffA666';
+    const referrer = '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045';
+    const incentiveData = pad('0xdef456232173821931823712381232131391321934');
+
+    // biome-ignore lint/style/noNonNullAssertion: this will never be undefined
+    const trustedSigner = accounts.at(0)!;
+
+    const claimDataPayload = await validator.encodeClaimData({
+      signer: trustedSigner,
+      incentiveData,
+      chainId: defaultOptions.config.chains[0].id,
+      incentiveQuantity,
+      claimant,
+      boostId: boostId,
+      referrer,
+    });
+
+    expect(
+      await validator.validate({
+        boostId,
+        incentiveId,
+        claimant,
+        claimData: claimDataPayload,
+      }),
+    ).toBe(true);
+
+    // Attempt to validate the same hash again (should throw an error)
+    try {
+      await validator.validate({
+        boostId,
+        incentiveId,
+        claimData: claimDataPayload,
+        claimant,
+      });
+    } catch (e) {
+      expect(e).toBeInstanceOf(Error);
+    }
+    expect.assertions(2);
+  });
+
+  test('can set authorized', async () => {
+    const validator = await loadFixture(freshValidator(fixtures));
+    // biome-ignore lint/style/noNonNullAssertion: this will never be undefined
+    const newSigner = accounts.at(2)!.account;
+    expect(await validator.signers(newSigner)).toBe(false);
+    await validator.setAuthorized([newSigner], [true]);
+    expect(await validator.signers(newSigner)).toBe(true);
+    expect.assertions(2);
+  });
+});