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

package/src/Incentives/PointsIncentive.ts

@@ -12,25 +12,62 @@ import {
   writePointsIncentiveClaim,
 } from '@boostxyz/evm';
 import { bytecode } from '@boostxyz/evm/artifacts/contracts/incentives/PointsIncentive.sol/PointsIncentive.json';
-import type { Address, ContractEventName, Hex } from 'viem';
+import {
+  type Address,
+  type ContractEventName,
+  type Hex,
+  encodeAbiParameters,
+  zeroHash,
+} from 'viem';
+import { PointsIncentive as PointsIncentiveBases } from '../../dist/deployments.json';
 import type {
   DeployableOptions,
   GenericDeployableParams,
 } from '../Deployable/Deployable';
 import { DeployableTarget } from '../Deployable/DeployableTarget';
+import { type ClaimPayload, prepareClaimPayload } from '../claiming';
 import {
-  type ClaimPayload,
   type GenericLog,
-  type PointsIncentivePayload,
   type ReadParams,
   RegistryType,
   type WriteParams,
-  prepareClaimPayload,
-  preparePointsIncentivePayload,
 } from '../utils';
 
 export { pointsIncentiveAbi };
-export type { PointsIncentivePayload };
+
+/**
+ * The object representation of a `PointsIncentive.InitPayload`
+ *
+ * @export
+ * @interface PointsIncentivePayload
+ * @typedef {PointsIncentivePayload}
+ */
+export interface PointsIncentivePayload {
+  /**
+   * The address of the points contract
+   *
+   * @type {Address}
+   */
+  venue: Address;
+  /**
+   * The selector for the issuance function on the points contract
+   *
+   * @type {Hex}
+   */
+  selector: Hex;
+  /**
+   * The reward amount issued for each claim
+   *
+   * @type {bigint}
+   */
+  reward: bigint;
+  /**
+   *  The maximum number of claims that can be made (one per address)
+   *
+   * @type {bigint}
+   */
+  limit: bigint;
+}
 
 /**
  * A generic `viem.Log` event with support for `PointsIncentive` event types.
@@ -70,10 +107,11 @@ export class PointsIncentive extends DeployableTarget<
    *
    * @public
    * @static
-   * @type {Address}
+   * @type {Record<number, Address>}
    */
-  public static override base: Address = import.meta.env
-    .VITE_POINTS_INCENTIVE_BASE;
+  public static override bases: Record<number, Address> = {
+    ...(PointsIncentiveBases as Record<number, Address>),
+  };
   /**
    * @inheritdoc
    *
@@ -88,13 +126,13 @@ export class PointsIncentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof erc20IncentiveAbi, 'claims'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<bigint>}
    */
   public async claims(
     params?: ReadParams<typeof pointsIncentiveAbi, 'claims'>,
   ) {
-    return readPointsIncentiveClaims(this._config, {
+    return await readPointsIncentiveClaims(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 +145,13 @@ export class PointsIncentive 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 pointsIncentiveAbi, 'currentReward'>,
   ) {
-    return readPointsIncentiveCurrentReward(this._config, {
+    return await readPointsIncentiveCurrentReward(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,13 +164,13 @@ export class PointsIncentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof pointsIncentiveAbi, 'reward'>} [params]
-   * @returns {unknown}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<bigint>} The reward amount issued for each claim
    */
   public async reward(
     params?: ReadParams<typeof pointsIncentiveAbi, 'reward'>,
   ) {
-    return readPointsIncentiveReward(this._config, {
+    return await readPointsIncentiveReward(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
@@ -146,14 +184,14 @@ export class PointsIncentive extends DeployableTarget<
    * @public
    * @async
    * @param {Address} address
-   * @param {?ReadParams<typeof pointsIncentiveAbi, 'claimed'>} [params]
-   * @returns {unknown}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<boolean>}
    */
   public async claimed(
     address: Address,
     params?: ReadParams<typeof pointsIncentiveAbi, 'claimed'>,
   ) {
-    return readPointsIncentiveClaimed(this._config, {
+    return await readPointsIncentiveClaimed(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
@@ -166,11 +204,11 @@ export class PointsIncentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof pointsIncentiveAbi, 'venue'>} [params]
-   * @returns {unknown}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<Address>}
    */
   public async venue(params?: ReadParams<typeof pointsIncentiveAbi, 'venue'>) {
-    return readPointsIncentiveVenue(this._config, {
+    return await readPointsIncentiveVenue(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),
@@ -182,11 +220,11 @@ export class PointsIncentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof pointsIncentiveAbi, 'limit'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<bigint>}
    */
   public async limit(params?: ReadParams<typeof pointsIncentiveAbi, 'limit'>) {
-    return readPointsIncentiveLimit(this._config, {
+    return await readPointsIncentiveLimit(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),
@@ -198,13 +236,13 @@ export class PointsIncentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof pointsIncentiveAbi, 'selector'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<Hex>}
    */
   public async selector(
     params?: ReadParams<typeof pointsIncentiveAbi, 'selector'>,
   ) {
-    return readPointsIncentiveSelector(this._config, {
+    return await readPointsIncentiveSelector(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,14 +255,14 @@ export class PointsIncentive extends DeployableTarget<
    * @public
    * @async
    * @param {ClaimPayload} payload
-   * @param {?WriteParams<typeof pointsIncentiveAbi, 'claim'>} [params]
+   * @param {?WriteParams} [params]
    * @returns {Promise<boolean>} -  True if the incentive was successfully claimed
    */
-  public async claim(
+  protected async claim(
     payload: ClaimPayload,
     params?: WriteParams<typeof pointsIncentiveAbi, 'claim'>,
   ) {
-    return this.awaitResult(this.claimRaw(payload, params));
+    return await this.awaitResult(this.claimRaw(payload, params));
   }
 
   /**
@@ -233,10 +271,10 @@ export class PointsIncentive extends DeployableTarget<
    * @public
    * @async
    * @param {ClaimPayload} payload
-   * @param {?WriteParams<typeof pointsIncentiveAbi, 'claim'>} [params]
-   * @returns {Promise<boolean>} -  True if the incentive was successfully claimed
+   * @param {?WriteParams} [params]
+   * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} -  True if the incentive was successfully claimed
    */
-  public async claimRaw(
+  protected async claimRaw(
     payload: ClaimPayload,
     params?: WriteParams<typeof pointsIncentiveAbi, 'claim'>,
   ) {
@@ -262,14 +300,14 @@ export class PointsIncentive extends DeployableTarget<
    * @public
    * @async
    * @param {ClaimPayload} payload
-   * @param {?ReadParams<typeof pointsIncentiveAbi, 'isClaimable'>} [params]
+   * @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 pointsIncentiveAbi, 'isClaimable'>,
   ) {
-    return readPointsIncentiveIsClaimable(this._config, {
+    return await readPointsIncentiveIsClaimable(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
@@ -300,4 +338,42 @@ export class PointsIncentive extends DeployableTarget<
       ...this.optionallyAttachAccount(options.account),
     };
   }
+
+  /**
+   * Builds the claim data for the PointsIncentive.
+   *
+   * @public
+   * @returns {Hash} A `zeroHash`, as PointsIncentive doesn't require specific claim data.
+   * @description This function returns `zeroHash` because PointsIncentive doesn't use any specific claim data.
+   */
+  public buildClaimData() {
+    return zeroHash;
+  }
 }
+
+/**
+ * Given a {@link PointsIncentivePayload}, properly encode a `PointsIncentive.InitPayload` for use with {@link PointsIncentive} initialization.
+ *
+ * @param {PointsIncentivePayload} param0
+ * @param {Address} param0.venue - The address of the points contract
+ * @param {Hex} param0.selector - The selector for the issuance function on the points contract
+ * @param {bigint} param0.reward - The reward amount issued for each claim
+ * @param {bigint} param0.limit -  The maximum number of claims that can be made (one per address)
+ * @returns {*}
+ */
+export const preparePointsIncentivePayload = ({
+  venue,
+  selector,
+  reward,
+  limit,
+}: PointsIncentivePayload) => {
+  return encodeAbiParameters(
+    [
+      { type: 'address', name: 'venue' },
+      { type: 'bytes4', name: 'selector' },
+      { type: 'uint256', name: 'reward' },
+      { type: 'uint256', name: 'limit' },
+    ],
+    [venue, selector, reward, limit],
+  );
+};

package/src/Validators/SignerValidator.test.ts

@@ -1,14 +1,13 @@
 import { loadFixture } from '@nomicfoundation/hardhat-network-helpers';
 import { isAddress, pad } from 'viem';
 import { beforeAll, describe, expect, test } from 'vitest';
-import { accounts } from '../../test/accounts';
+import { accounts } from '@boostxyz/test/accounts';
 import {
   type Fixtures,
   defaultOptions,
   deployFixtures,
-} from '../../test/helpers';
-import { testAccount } from '../../test/viem';
-import { prepareSignerValidatorClaimDataPayload } from '../utils';
+} from '@boostxyz/test/helpers';
+import { testAccount } from '@boostxyz/test/viem';
 import { SignerValidator } from './SignerValidator';
 
 let fixtures: Fixtures;
@@ -17,9 +16,9 @@ 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.clone(
+    return fixtures.registry.initialize(
       crypto.randomUUID(),
-      new fixtures.bases.SignerValidator(defaultOptions, {
+      fixtures.core.SignerValidator({
         signers: [defaultOptions.account.address, account],
         validatorCaller: testAccount.address,
       }),
@@ -29,7 +28,7 @@ function freshValidator(fixtures: Fixtures) {
 
 describe('SignerValidator', () => {
   beforeAll(async () => {
-    fixtures = await loadFixture(deployFixtures);
+    fixtures = await loadFixture(deployFixtures(defaultOptions));
   });
 
   test('can successfully be deployed', async () => {
@@ -65,21 +64,19 @@ describe('SignerValidator', () => {
     // biome-ignore lint/style/noNonNullAssertion: this will never be undefined
     const untrustedSigner = accounts.at(2)!;
 
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+    const claimDataPayload = await validator.encodeClaimData({
       signer: trustedSigner,
       incentiveData,
       chainId: defaultOptions.config.chains[0].id,
-      validator: validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
       boostId: boostId,
     });
 
-    const badClaimDataPayload = await prepareSignerValidatorClaimDataPayload({
+    const badClaimDataPayload = await validator.encodeClaimData({
       signer: untrustedSigner,
       incentiveData,
       chainId: defaultOptions.config.chains[0].id,
-      validator: validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
       boostId: boostId,
@@ -120,11 +117,10 @@ describe('SignerValidator', () => {
     // biome-ignore lint/style/noNonNullAssertion: this will never be undefined
     const trustedSigner = accounts.at(0)!;
 
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+    const claimDataPayload = await validator.encodeClaimData({
       signer: trustedSigner,
       incentiveData,
       chainId: defaultOptions.config.chains[0].id,
-      validator: validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
       boostId: boostId,