chore(sdk): update prepareSignerValidatorClaimDataPayload to use inte…

…rface, proper documentation (#59)
boostxyz · Sep 3, 2024 · d35de0b · d35de0b
2 parents 752f937 + db754cf
commit d35de0b
Show file tree

Hide file tree

Showing 9 changed files with 159 additions and 112 deletions.
diff --git a/package.json b/package.json
@@ -47,8 +47,7 @@
     "typescript": "^5.3.3",
     "viem": "^2.20.1",
     "vite": "^5.2.13",
-    "vitest": "^1.6.0",
-    "ethereum-cryptography": "2.2.1"
+    "vitest": "^1.6.0"
   },
   "pnpm": {
     "overrides": {

diff --git a/packages/sdk/src/Incentives/AllowListIncentive.test.ts b/packages/sdk/src/Incentives/AllowListIncentive.test.ts
@@ -1,14 +1,5 @@
-import { writePointsGrantRoles } 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, describe, expect, test } from 'vitest';
 import { accounts } from '../../test/accounts';
 import {
@@ -18,11 +9,7 @@ import {
   freshBoost,
 } from '../../test/helpers';
 import { LIST_MANAGER_ROLE } from '../AllowLists/SimpleAllowList';
-import {
-  bytes4,
-  prepareSignerValidatorClaimDataPayload,
-  prepareSignerValidatorValidatePayload,
-} from '../utils';
+import { prepareSignerValidatorClaimDataPayload } from '../utils';
 import { PointsIncentive } from './PointsIncentive';
 
 let fixtures: Fixtures;
@@ -81,15 +68,15 @@ describe('AllowListIncentive', () => {
     console.log(claimant);
 
     const incentiveQuantity = 0;
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload(
-      trustedSigner,
+    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+      signer: trustedSigner,
       incentiveData,
-      defaultOptions.config.chains[0].id,
-      boost.validator.assertValidAddress(),
+      chainId: defaultOptions.config.chains[0].id,
+      validator: boost.validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
-      boost.id,
-    );
+      boostId: boost.id,
+    });
 
     await fixtures.core.claimIncentive(
       boost.id,
@@ -126,15 +113,15 @@ describe('AllowListIncentive', () => {
     const incentiveData = pad('0xdef456232173821931823712381232131391321934');
     console.log(claimant);
 
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload(
-      trustedSigner,
+    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+      signer: trustedSigner,
       incentiveData,
-      defaultOptions.config.chains[0].id,
-      boost.validator.assertValidAddress(),
+      chainId: defaultOptions.config.chains[0].id,
+      validator: boost.validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
-      boost.id,
-    );
+      boostId: boost.id,
+    });
 
     await fixtures.core.claimIncentive(
       boost.id,

diff --git a/packages/sdk/src/Incentives/CGDAIncentive.test.ts b/packages/sdk/src/Incentives/CGDAIncentive.test.ts
@@ -59,15 +59,15 @@ describe('CGDAIncentive', () => {
     const incentiveData = pad('0xdef456232173821931823712381232131391321934');
 
     const incentiveQuantity = 0;
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload(
-      trustedSigner,
+    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+      signer: trustedSigner,
       incentiveData,
-      defaultOptions.config.chains[0].id,
-      boost.validator.assertValidAddress(),
+      chainId: defaultOptions.config.chains[0].id,
+      validator: boost.validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
-      boost.id,
-    );
+      boostId: boost.id,
+    });
 
     await fixtures.core.claimIncentive(
       boost.id,
@@ -104,15 +104,15 @@ describe('CGDAIncentive', () => {
     const claimant = trustedSigner.account;
     const incentiveData = pad('0xdef456232173821931823712381232131391321934');
     const incentiveQuantity = 0;
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload(
-      trustedSigner,
+    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+      signer: trustedSigner,
       incentiveData,
-      defaultOptions.config.chains[0].id,
-      boost.validator.assertValidAddress(),
+      chainId: defaultOptions.config.chains[0].id,
+      validator: boost.validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
-      boost.id,
-    );
+      boostId: boost.id,
+    });
 
     await fixtures.core.claimIncentive(
       boost.id,

diff --git a/packages/sdk/src/Incentives/ERC1155Incentive.test.ts b/packages/sdk/src/Incentives/ERC1155Incentive.test.ts
@@ -71,15 +71,15 @@ describe('ERC1155Incentive', () => {
     const claimant = trustedSigner.account;
     const incentiveData = pad('0xdef456232173821931823712381232131391321934');
     const incentiveQuantity = 0;
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload(
-      trustedSigner,
+    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+      signer: trustedSigner,
       incentiveData,
-      defaultOptions.config.chains[0].id,
-      boost.validator.assertValidAddress(),
+      chainId: defaultOptions.config.chains[0].id,
+      validator: boost.validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
-      boost.id,
-    );
+      boostId: boost.id,
+    });
 
     await fixtures.core.claimIncentive(
       boost.id,

diff --git a/packages/sdk/src/Incentives/ERC20Incentive.test.ts b/packages/sdk/src/Incentives/ERC20Incentive.test.ts
@@ -65,15 +65,15 @@ describe('ERC20Incentive', () => {
     const claimant = trustedSigner.account;
     const incentiveData = pad('0xdef456232173821931823712381232131391321934');
     const incentiveQuantity = 0;
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload(
-      trustedSigner,
+    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+      signer: trustedSigner,
       incentiveData,
-      defaultOptions.config.chains[0].id,
-      boost.validator.assertValidAddress(),
+      chainId: defaultOptions.config.chains[0].id,
+      validator: boost.validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
-      boost.id,
-    );
+      boostId: boost.id,
+    });
 
     await fixtures.core.claimIncentive(
       boost.id,
@@ -109,15 +109,15 @@ describe('ERC20Incentive', () => {
     const claimant = trustedSigner.account;
     const incentiveData = pad('0xdef456232173821931823712381232131391321934');
     const incentiveQuantity = 0;
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload(
-      trustedSigner,
+    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+      signer: trustedSigner,
       incentiveData,
-      defaultOptions.config.chains[0].id,
-      boost.validator.assertValidAddress(),
+      chainId: defaultOptions.config.chains[0].id,
+      validator: boost.validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
-      boost.id,
-    );
+      boostId: boost.id,
+    });
 
     await fixtures.core.claimIncentive(
       boost.id,

diff --git a/packages/sdk/src/Incentives/PointsIncentive.test.ts b/packages/sdk/src/Incentives/PointsIncentive.test.ts
@@ -55,15 +55,15 @@ describe.skip('PointsIncentive', () => {
     const claimant = trustedSigner.account;
     const incentiveData = pad('0xdef456232173821931823712381232131391321934');
     const incentiveQuantity = 0;
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload(
-      trustedSigner,
+    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+      signer: trustedSigner,
       incentiveData,
-      defaultOptions.config.chains[0].id,
-      boost.validator.assertValidAddress(),
+      chainId: defaultOptions.config.chains[0].id,
+      validator: boost.validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
-      boost.id,
-    );
+      boostId: boost.id,
+    });
 
     await writePointsGrantRoles(defaultOptions.config, {
       address: points.assertValidAddress(),
@@ -105,15 +105,15 @@ describe.skip('PointsIncentive', () => {
     const claimant = trustedSigner.account;
     const incentiveData = pad('0xdef456232173821931823712381232131391321934');
     const incentiveQuantity = 0;
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload(
-      trustedSigner,
+    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+      signer: trustedSigner,
       incentiveData,
-      defaultOptions.config.chains[0].id,
-      boost.validator.assertValidAddress(),
+      chainId: defaultOptions.config.chains[0].id,
+      validator: boost.validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
-      boost.id,
-    );
+      boostId: boost.id,
+    });
 
     await writePointsGrantRoles(defaultOptions.config, {
       address: points.assertValidAddress(),

diff --git a/packages/sdk/src/Validators/SignerValidator.test.ts b/packages/sdk/src/Validators/SignerValidator.test.ts
@@ -63,25 +63,25 @@ describe('SignerValidator', () => {
     // biome-ignore lint/style/noNonNullAssertion: this will never be undefined
     const untrustedSigner = accounts.at(2)!;
 
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload(
-      trustedSigner,
+    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+      signer: trustedSigner,
       incentiveData,
-      defaultOptions.config.chains[0].id,
-      validator.assertValidAddress(),
+      chainId: defaultOptions.config.chains[0].id,
+      validator: validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
-      boostId,
-    );
+      boostId: boostId,
+    });
 
-    const badClaimDataPayload = await prepareSignerValidatorClaimDataPayload(
-      untrustedSigner,
+    const badClaimDataPayload = await prepareSignerValidatorClaimDataPayload({
+      signer: untrustedSigner,
       incentiveData,
-      defaultOptions.config.chains[0].id,
-      validator.assertValidAddress(),
+      chainId: defaultOptions.config.chains[0].id,
+      validator: validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
-      boostId,
-    );
+      boostId: boostId,
+    });
 
     // Validation using trusted signer
     expect(
@@ -118,15 +118,15 @@ describe('SignerValidator', () => {
     // biome-ignore lint/style/noNonNullAssertion: this will never be undefined
     const trustedSigner = accounts.at(0)!;
 
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload(
-      trustedSigner,
+    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+      signer: trustedSigner,
       incentiveData,
-      defaultOptions.config.chains[0].id,
-      validator.assertValidAddress(),
+      chainId: defaultOptions.config.chains[0].id,
+      validator: validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
-      boostId,
-    );
+      boostId: boostId,
+    });
 
     expect(
       await validator.validate({