@boostxyz/sdk 0.0.0-alpha.7 → 0.0.0-alpha.9

package/src/Incentives/ERC20Incentive.ts

@@ -18,7 +18,12 @@ 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,
+} from 'viem';
 import type {
   DeployableOptions,
   GenericDeployableParams,
@@ -26,18 +31,51 @@ 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;
+}
 
 /**
  * A generic `viem.Log` event with support for `ERC20Incentive` event types.
@@ -94,7 +132,7 @@ export class ERC20Incentive extends DeployableTarget<
    * @returns {unknown}
    */
   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
@@ -113,7 +151,7 @@ export class ERC20Incentive extends DeployableTarget<
   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
@@ -130,7 +168,7 @@ export class ERC20Incentive extends DeployableTarget<
    * @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
@@ -151,7 +189,7 @@ export class ERC20Incentive extends DeployableTarget<
     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
@@ -168,7 +206,7 @@ export class ERC20Incentive extends DeployableTarget<
    * @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),
@@ -183,7 +221,7 @@ export class ERC20Incentive extends DeployableTarget<
    * @param {?ReadParams<typeof erc20IncentiveAbi, 'strategy'>} [params]
    * @returns {Promise<StrategyType>}
    */
-  public async strategy(
+  public strategy(
     params?: ReadParams<typeof erc20IncentiveAbi, 'strategy'>,
   ): Promise<StrategyType> {
     return readErc20IncentiveStrategy(this._config, {
@@ -202,7 +240,7 @@ export class ERC20Incentive extends DeployableTarget<
    * @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),
@@ -218,7 +256,7 @@ export class ERC20Incentive extends DeployableTarget<
    * @returns {unknown}
    */
   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),
@@ -238,7 +276,7 @@ export class ERC20Incentive extends DeployableTarget<
     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
@@ -255,11 +293,11 @@ export class ERC20Incentive extends DeployableTarget<
    * @param {?WriteParams<typeof erc20IncentiveAbi, 'claim'>} [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));
   }
 
   /**
@@ -271,7 +309,7 @@ export class ERC20Incentive extends DeployableTarget<
    * @param {?WriteParams<typeof erc20IncentiveAbi, 'claim'>} [params]
    * @returns {Promise<boolean>} - Returns true if successfully claimed
    */
-  public async claimRaw(
+  protected async claimRaw(
     payload: ClaimPayload,
     params?: WriteParams<typeof erc20IncentiveAbi, 'claim'>,
   ) {
@@ -302,7 +340,7 @@ export class ERC20Incentive extends DeployableTarget<
     payload: ClaimPayload,
     params?: WriteParams<typeof erc20IncentiveAbi, 'clawback'>,
   ) {
-    return this.awaitResult(this.clawbackRaw(payload, params));
+    return await this.awaitResult(this.clawbackRaw(payload, params));
   }
 
   /**
@@ -345,7 +383,7 @@ export class ERC20Incentive extends DeployableTarget<
     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
@@ -364,7 +402,7 @@ export class ERC20Incentive extends DeployableTarget<
   public async drawRaffle(
     params?: WriteParams<typeof erc20IncentiveAbi, 'drawRaffle'>,
   ) {
-    return this.awaitResult(this.drawRaffleRaw(params));
+    return await this.awaitResult(this.drawRaffleRaw(params));
   }
 
   /**
@@ -415,3 +453,30 @@ export class ERC20Incentive extends DeployableTarget<
     };
   }
 }
+
+/**
+ * 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 {*}
+ */
+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/ERC20VariableIncentive.test.ts

@@ -1,19 +1,6 @@
-import {
-  readMockErc20BalanceOf,
-  readMockErc20TotalSupply,
-} from '@boostxyz/evm';
+import { readMockErc20BalanceOf } from '@boostxyz/evm';
 import { loadFixture } from '@nomicfoundation/hardhat-network-helpers';
-import { signMessage } from '@wagmi/core';
-import {
-  encodeAbiParameters,
-  encodePacked,
-  isAddress,
-  keccak256,
-  pad,
-  parseEther,
-  zeroAddress,
-} from 'viem';
-import { toHex } from 'viem';
+import { encodeAbiParameters, isAddress, parseEther, zeroAddress } from 'viem';
 import { beforeAll, beforeEach, describe, expect, test } from 'vitest';
 import { accounts } from '../../test/accounts';
 import {
@@ -24,11 +11,6 @@ import {
   freshBoost,
   fundBudget,
 } from '../../test/helpers';
-import {
-  StrategyType,
-  prepareClaimPayload,
-  prepareSignerValidatorClaimDataPayload,
-} from '../utils';
 import { ERC20VariableIncentive } from './ERC20VariableIncentive';
 
 const BOOST_CORE_CLAIM_FEE = parseEther('0.000075');
@@ -74,14 +56,13 @@ describe('ERC20VariableIncentive', () => {
 
     const claimant = trustedSigner.account;
     const incentiveQuantity = 1;
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+    const claimDataPayload = await boost.validator.encodeClaimData({
       signer: trustedSigner,
       incentiveData: encodeAbiParameters(
         [{ name: '', type: 'uint256' }],
         [parseEther('1')],
       ),
       chainId: defaultOptions.config.chains[0].id,
-      validator: boost.validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
       boostId: boost.id,
@@ -121,14 +102,13 @@ describe('ERC20VariableIncentive', () => {
 
     const claimant = trustedSigner.account;
     const incentiveQuantity = 1;
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+    const claimDataPayload = await boost.validator.encodeClaimData({
       signer: trustedSigner,
       incentiveData: encodeAbiParameters(
         [{ name: '', type: 'uint256' }],
         [parseEther('1')],
       ),
       chainId: defaultOptions.config.chains[0].id,
-      validator: boost.validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
       boostId: boost.id,

package/src/Incentives/ERC20VariableIncentive.ts

@@ -15,25 +15,53 @@ import {
   writeErc20VariableIncentiveClawback,
 } from '@boostxyz/evm';
 import { bytecode } from '@boostxyz/evm/artifacts/contracts/incentives/ERC20VariableIncentive.sol/ERC20VariableIncentive.json';
-import type { Address, ContractEventName, Hex } from 'viem';
+import {
+  type Address,
+  type ContractEventName,
+  type Hex,
+  encodeAbiParameters,
+} from 'viem';
 import type {
   DeployableOptions,
   GenericDeployableParams,
 } from '../Deployable/Deployable';
 import { DeployableTarget } from '../Deployable/DeployableTarget';
+import { type ClaimPayload, prepareClaimPayload } from '../claiming';
 import {
-  type ClaimPayload,
-  type ERC20VariableIncentivePayload,
   type GenericLog,
   type ReadParams,
   RegistryType,
   type WriteParams,
-  prepareClaimPayload,
-  prepareERC20VariableIncentivePayload,
 } from '../utils';
 
 export { erc20VariableIncentiveAbi };
-export type { ERC20VariableIncentivePayload };
+/**
+ * The object representation of a `ERC20VariableIncentivePayload.InitPayload`
+ *
+ * @export
+ * @interface ERC20VariableIncentivePayload
+ * @typedef {ERC20VariableIncentivePayload}
+ */
+export interface ERC20VariableIncentivePayload {
+  /**
+   * The address of the incentivized asset.
+   *
+   * @type {Address}
+   */
+  asset: Address;
+  /**
+   * The amount of the asset to distribute.
+   *
+   * @type {bigint}
+   */
+  reward: bigint;
+  /**
+   * How many times can this incentive be claimed.
+   *
+   * @type {bigint}
+   */
+  limit: bigint;
+}
 
 /**
  * A generic `viem.Log` event with support for `ERC20VariableIncentive` event types.
@@ -92,7 +120,7 @@ export class ERC20VariableIncentive extends DeployableTarget<
   public async owner(
     params?: ReadParams<typeof erc20VariableIncentiveAbi, 'owner'>,
   ) {
-    return readErc20VariableIncentiveOwner(this._config, {
+    return await readErc20VariableIncentiveOwner(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
@@ -111,7 +139,7 @@ export class ERC20VariableIncentive extends DeployableTarget<
   public async totalClaimed(
     params?: ReadParams<typeof erc20VariableIncentiveAbi, 'totalClaimed'>,
   ) {
-    return readErc20VariableIncentiveTotalClaimed(this._config, {
+    return await readErc20VariableIncentiveTotalClaimed(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
@@ -130,7 +158,7 @@ export class ERC20VariableIncentive extends DeployableTarget<
   public async currentReward(
     params?: ReadParams<typeof erc20VariableIncentiveAbi, 'currentReward'>,
   ) {
-    return readErc20VariableIncentiveCurrentReward(this._config, {
+    return await readErc20VariableIncentiveCurrentReward(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
@@ -149,7 +177,7 @@ export class ERC20VariableIncentive extends DeployableTarget<
   public async claims(
     params?: ReadParams<typeof erc20VariableIncentiveAbi, 'claims'>,
   ) {
-    return readErc20VariableIncentiveClaims(this._config, {
+    return await readErc20VariableIncentiveClaims(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
@@ -170,7 +198,7 @@ export class ERC20VariableIncentive extends DeployableTarget<
     address: Address,
     params?: ReadParams<typeof erc20VariableIncentiveAbi, 'claimed'>,
   ) {
-    return readErc20VariableIncentiveClaimed(this._config, {
+    return await readErc20VariableIncentiveClaimed(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
@@ -189,7 +217,7 @@ export class ERC20VariableIncentive extends DeployableTarget<
   public async asset(
     params?: ReadParams<typeof erc20VariableIncentiveAbi, 'asset'>,
   ) {
-    return readErc20VariableIncentiveAsset(this._config, {
+    return await readErc20VariableIncentiveAsset(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),
@@ -207,7 +235,7 @@ export class ERC20VariableIncentive extends DeployableTarget<
   public async reward(
     params?: ReadParams<typeof erc20VariableIncentiveAbi, 'reward'>,
   ) {
-    return readErc20VariableIncentiveReward(this._config, {
+    return await readErc20VariableIncentiveReward(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),
@@ -225,7 +253,7 @@ export class ERC20VariableIncentive extends DeployableTarget<
   public async limit(
     params?: ReadParams<typeof erc20VariableIncentiveAbi, 'limit'>,
   ) {
-    return readErc20VariableIncentiveLimit(this._config, {
+    return await readErc20VariableIncentiveLimit(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),
@@ -241,11 +269,11 @@ export class ERC20VariableIncentive extends DeployableTarget<
    * @param {?WriteParams<typeof erc20VariableIncentiveAbi, 'claim'>} [params]
    * @returns {Promise<boolean>} - Returns true if successfully claimed
    */
-  public async claim(
+  protected async claim(
     payload: ClaimPayload,
     params?: WriteParams<typeof erc20VariableIncentiveAbi, 'claim'>,
   ) {
-    return this.awaitResult(this.claimRaw(payload, params));
+    return await this.awaitResult(this.claimRaw(payload, params));
   }
 
   /**
@@ -257,7 +285,7 @@ export class ERC20VariableIncentive extends DeployableTarget<
    * @param {?WriteParams<typeof erc20VariableIncentiveAbi, 'claim'>} [params]
    * @returns {Promise<boolean>} - Returns true if successfully claimed
    */
-  public async claimRaw(
+  protected async claimRaw(
     payload: ClaimPayload,
     params?: WriteParams<typeof erc20VariableIncentiveAbi, 'claim'>,
   ) {
@@ -288,7 +316,7 @@ export class ERC20VariableIncentive extends DeployableTarget<
     payload: ClaimPayload,
     params?: WriteParams<typeof erc20VariableIncentiveAbi, 'clawback'>,
   ) {
-    return this.awaitResult(this.clawbackRaw(payload, params));
+    return await this.awaitResult(this.clawbackRaw(payload, params));
   }
 
   /**
@@ -334,7 +362,7 @@ export class ERC20VariableIncentive extends DeployableTarget<
     payload: ClaimPayload,
     params?: ReadParams<typeof erc20VariableIncentiveAbi, 'isClaimable'>,
   ) {
-    return readErc20VariableIncentiveIsClaimable(this._config, {
+    return await readErc20VariableIncentiveIsClaimable(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
@@ -366,3 +394,27 @@ export class ERC20VariableIncentive extends DeployableTarget<
     };
   }
 }
+
+/**
+ * Given a {@link ERC20VariableIncentivePayload}, properly encode a ` ERC20VariableIncentive.InitPayload` for use with {@link ERC20VariableIncentive} initialization.
+ *
+ * @param {ERC20VariableIncentivePayload} param0
+ * @param {Address} param0.asset - The address of the incentivized asset.
+ * @param {bigint} param0.reward - The amount of the asset to distribute.
+ * @param {bigint} param0.limit - How many times can this incentive be claimed.
+ * @returns {*}
+ */
+export function prepareERC20VariableIncentivePayload({
+  asset,
+  reward,
+  limit,
+}: ERC20VariableIncentivePayload) {
+  return encodeAbiParameters(
+    [
+      { type: 'address', name: 'asset' },
+      { type: 'uint256', name: 'reward' },
+      { type: 'uint256', name: 'limit' },
+    ],
+    [asset, reward, limit],
+  );
+}

package/src/Incentives/Incentive.test.ts

@@ -1,7 +1,7 @@
 import { zeroAddress } from 'viem';
 import { describe, expect, test } from 'vitest';
 import { defaultOptions } from '../../test/helpers';
-import { StrategyType } from '../utils';
+import { StrategyType } from '../claiming';
 import {
   AllowListIncentive,
   CGDAIncentive,

package/src/Incentives/PointsIncentive.test.ts

@@ -1,6 +1,5 @@
 import { readPointsBalanceOf, writePointsGrantRoles } from '@boostxyz/evm';
 import { loadFixture } from '@nomicfoundation/hardhat-network-helpers';
-import { signMessage } from '@wagmi/core';
 import { isAddress, pad, parseEther, zeroAddress } from 'viem';
 import { beforeAll, beforeEach, describe, expect, test } from 'vitest';
 import type { MockPoints } from '../../test/MockPoints';
@@ -12,7 +11,7 @@ import {
   freshBoost,
   freshPoints,
 } from '../../test/helpers';
-import { bytes4, prepareSignerValidatorClaimDataPayload } from '../utils';
+import { bytes4 } from '../utils';
 import { PointsIncentive } from './PointsIncentive';
 
 let fixtures: Fixtures, points: MockPoints;
@@ -55,11 +54,10 @@ describe('PointsIncentive', () => {
     const claimant = trustedSigner.account;
     const incentiveData = pad('0xdef456232173821931823712381232131391321934');
     const incentiveQuantity = 1;
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+    const claimDataPayload = await boost.validator.encodeClaimData({
       signer: trustedSigner,
       incentiveData,
       chainId: defaultOptions.config.chains[0].id,
-      validator: boost.validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
       boostId: boost.id,
@@ -105,11 +103,10 @@ describe('PointsIncentive', () => {
     const claimant = trustedSigner.account;
     const incentiveData = pad('0xdef456232173821931823712381232131391321934');
     const incentiveQuantity = 1;
-    const claimDataPayload = await prepareSignerValidatorClaimDataPayload({
+    const claimDataPayload = await boost.validator.encodeClaimData({
       signer: trustedSigner,
       incentiveData,
       chainId: defaultOptions.config.chains[0].id,
-      validator: boost.validator.assertValidAddress(),
       incentiveQuantity,
       claimant,
       boostId: boost.id,