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

package/src/Incentives/AllowListIncentive.ts

@@ -11,26 +11,49 @@ import {
   writeAllowListIncentiveClaim,
 } from '@boostxyz/evm';
 import { bytecode } from '@boostxyz/evm/artifacts/contracts/incentives/AllowListIncentive.sol/AllowListIncentive.json';
-import type { Address, ContractEventName, Hex } from 'viem';
+import {
+  type Address,
+  type ContractEventName,
+  type Hex,
+  encodeAbiParameters,
+} from 'viem';
 import { SimpleAllowList } from '../AllowLists/AllowList';
 import type {
   DeployableOptions,
   GenericDeployableParams,
 } from '../Deployable/Deployable';
 import { DeployableTarget } from '../Deployable/DeployableTarget';
+import { type ClaimPayload, prepareClaimPayload } from '../claiming';
 import {
-  type AllowListIncentivePayload,
-  type ClaimPayload,
   type GenericLog,
   type ReadParams,
   RegistryType,
   type WriteParams,
-  prepareAllowListIncentivePayload,
-  prepareClaimPayload,
 } from '../utils';
 
 export { allowListIncentiveAbi };
-export type { AllowListIncentivePayload };
+
+/**
+ * The object representation of a `AllowListIncentive.InitPayload`
+ *
+ * @export
+ * @interface AllowListIncentivePayload
+ * @typedef {AllowListIncentivePayload}
+ */
+export interface AllowListIncentivePayload {
+  /**
+   * The address to the allowlist to add claimers to.
+   *
+   * @type {Address}
+   */
+  allowList: Address;
+  /**
+   *  The maximum number of claims that can be made (one per address)
+   *
+   * @type {bigint}
+   */
+  limit: bigint;
+}
 
 /**
  * A generic `viem.Log` event with support for `AllowListIncentive` event types.
@@ -93,7 +116,7 @@ export class AllowListIncentive extends DeployableTarget<
   public async owner(
     params?: ReadParams<typeof allowListIncentiveAbi, 'owner'>,
   ) {
-    return readAllowListIncentiveOwner(this._config, {
+    return await readAllowListIncentiveOwner(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
@@ -112,7 +135,7 @@ export class AllowListIncentive extends DeployableTarget<
   public async claims(
     params?: ReadParams<typeof allowListIncentiveAbi, 'claims'>,
   ) {
-    return readAllowListIncentiveClaims(this._config, {
+    return await readAllowListIncentiveClaims(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
@@ -131,7 +154,7 @@ export class AllowListIncentive extends DeployableTarget<
   public async reward(
     params?: ReadParams<typeof allowListIncentiveAbi, 'reward'>,
   ) {
-    return readAllowListIncentiveReward(this._config, {
+    return await readAllowListIncentiveReward(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
@@ -152,7 +175,7 @@ export class AllowListIncentive extends DeployableTarget<
     address: Address,
     params?: ReadParams<typeof allowListIncentiveAbi, 'claimed'>,
   ) {
-    return readAllowListIncentiveClaimed(this._config, {
+    return await readAllowListIncentiveClaimed(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
@@ -193,7 +216,7 @@ export class AllowListIncentive extends DeployableTarget<
   public async limit(
     params?: ReadParams<typeof allowListIncentiveAbi, 'limit'>,
   ) {
-    return readAllowListIncentiveLimit(this._config, {
+    return await readAllowListIncentiveLimit(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),
@@ -209,11 +232,11 @@ export class AllowListIncentive extends DeployableTarget<
    * @param {?WriteParams<typeof allowListIncentiveAbi, 'claim'>} [params]
    * @returns {Promise<true>} - return true if successful, otherwise revert
    */
-  public async claim(
+  protected async claim(
     payload: Pick<ClaimPayload, 'target'>,
     params?: WriteParams<typeof allowListIncentiveAbi, 'claim'>,
   ) {
-    return this.awaitResult(this.claimRaw(payload, params));
+    return await this.awaitResult(this.claimRaw(payload, params));
   }
 
   /**
@@ -225,7 +248,7 @@ export class AllowListIncentive extends DeployableTarget<
    * @param {?WriteParams<typeof allowListIncentiveAbi, 'claim'>} [params]
    * @returns {Promise<true>} - return true if successful, otherwise revert
    */
-  public async claimRaw(
+  protected async claimRaw(
     payload: Pick<ClaimPayload, 'target'>,
     params?: WriteParams<typeof allowListIncentiveAbi, 'claim'>,
   ) {
@@ -256,7 +279,7 @@ export class AllowListIncentive extends DeployableTarget<
     payload: Pick<ClaimPayload, 'target'>,
     params?: ReadParams<typeof allowListIncentiveAbi, 'isClaimable'>,
   ) {
-    return readAllowListIncentiveIsClaimable(this._config, {
+    return await readAllowListIncentiveIsClaimable(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
@@ -288,3 +311,24 @@ export class AllowListIncentive extends DeployableTarget<
     };
   }
 }
+
+/**
+ * Given a {@link AllowListIncentivePayload}, properly encode a `AllowListIncentive.InitPayload` for use with {@link AllowListIncentive} initialization.
+ *
+ * @param {AllowListIncentivePayload} param0
+ * @param {Address} param0.allowList - The address to the allowlist to add claimers to.
+ * @param {bigint} param0.limit -  The maximum number of claims that can be made (one per address)
+ * @returns {Hex}
+ */
+export const prepareAllowListIncentivePayload = ({
+  allowList,
+  limit,
+}: AllowListIncentivePayload) => {
+  return encodeAbiParameters(
+    [
+      { type: 'address', name: 'allowList' },
+      { type: 'uint256', name: 'limit' },
+    ],
+    [allowList, limit],
+  );
+};

package/src/Incentives/CGDAIncentive.test.ts

@@ -1,7 +1,6 @@
 import { readMockErc20BalanceOf } from '@boostxyz/evm';
 import { loadFixture } from '@nomicfoundation/hardhat-network-helpers';
-import { signMessage } from '@wagmi/core';
-import { encodePacked, isAddress, keccak256, pad, parseEther } from 'viem';
+import { isAddress, pad, parseEther } from 'viem';
 import { beforeAll, beforeEach, describe, expect, test } from 'vitest';
 import { accounts } from '../../test/accounts';
 import {
@@ -12,7 +11,6 @@ import {
   freshBoost,
   fundBudget,
 } from '../../test/helpers';
-import { prepareSignerValidatorClaimDataPayload } from '../utils';
 import { CGDAIncentive } from './CGDAIncentive';
 
 let fixtures: Fixtures, budgets: BudgetFixtures;
@@ -59,11 +57,10 @@ describe('CGDAIncentive', () => {
     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,
@@ -104,11 +101,10 @@ describe('CGDAIncentive', () => {
     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,

package/src/Incentives/CGDAIncentive.ts

@@ -15,26 +15,100 @@ import {
   writeCgdaIncentiveClawback,
 } from '@boostxyz/evm';
 import { bytecode } from '@boostxyz/evm/artifacts/contracts/incentives/CGDAIncentive.sol/CGDAIncentive.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 CGDAIncentivePayload,
-  type CGDAParameters,
-  type ClaimPayload,
   type GenericLog,
   type ReadParams,
   RegistryType,
   type WriteParams,
-  prepareCGDAIncentivePayload,
-  prepareClaimPayload,
 } from '../utils';
 
 export { cgdaIncentiveAbi };
-export type { CGDAIncentivePayload };
+
+/**
+ * The object representation of a `CGDAIncentive.InitPayload`
+ *
+ * @export
+ * @interface CGDAIncentivePayload
+ * @typedef {CGDAIncentivePayload}
+ */
+export interface CGDAIncentivePayload {
+  /**
+   * The address of the ERC20-like token
+   *
+   * @type {Address}
+   */
+  asset: Address;
+  /**
+   * The initial reward amount
+   *
+   * @type {bigint}
+   */
+  initialReward: bigint;
+  /**
+   * The amount to subtract from the current reward after each claim
+   *
+   * @type {bigint}
+   */
+  rewardDecay: bigint;
+  /**
+   * The amount by which the reward increases for each hour without a claim (continuous linear increase)
+   *
+   * @type {bigint}
+   */
+  rewardBoost: bigint;
+  /**
+   * The total budget for the incentive
+   *
+   * @type {bigint}
+   */
+  totalBudget: bigint;
+}
+
+/**
+ *  The configuration parameters for the CGDAIncentive
+ *
+ * @export
+ * @interface CGDAParameters
+ * @typedef {CGDAParameters}
+ */
+export interface CGDAParameters {
+  /**
+   * The amount to subtract from the current reward after each claim
+   *
+   * @type {bigint}
+   */
+  rewardDecay: bigint;
+  /**
+   * The amount by which the reward increases for each hour without a claim (continuous linear increase)
+   *
+   * @type {bigint}
+   */
+  rewardBoost: bigint;
+  /**
+   * The timestamp of the last claim
+   *
+   * @type {bigint}
+   */
+  lastClaimTime: bigint;
+  /**
+   * The current reward amount
+   *
+   * @type {bigint}
+   */
+  currentReward: bigint;
+}
 
 /**
  * A generic `viem.Log` event with support for `CGDAIncentive` event types.
@@ -92,7 +166,7 @@ export class CGDAIncentive extends DeployableTarget<
    * @returns {unknown}
    */
   public async owner(params?: ReadParams<typeof cgdaIncentiveAbi, 'owner'>) {
-    return readCgdaIncentiveOwner(this._config, {
+    return await readCgdaIncentiveOwner(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
@@ -109,7 +183,7 @@ export class CGDAIncentive extends DeployableTarget<
    * @returns {Promise<bigint>}
    */
   public async claims(params?: ReadParams<typeof cgdaIncentiveAbi, 'claims'>) {
-    return readCgdaIncentiveClaims(this._config, {
+    return await readCgdaIncentiveClaims(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,7 +200,7 @@ export class CGDAIncentive extends DeployableTarget<
    * @returns {Promise<bigint>}
    */
   public async reward(params?: ReadParams<typeof cgdaIncentiveAbi, 'reward'>) {
-    return readCgdaIncentiveReward(this._config, {
+    return await readCgdaIncentiveReward(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
@@ -147,7 +221,7 @@ export class CGDAIncentive extends DeployableTarget<
     address: Address,
     params?: ReadParams<typeof cgdaIncentiveAbi, 'claimed'>,
   ) {
-    return readCgdaIncentiveClaimed(this._config, {
+    return await readCgdaIncentiveClaimed(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
@@ -164,7 +238,7 @@ export class CGDAIncentive extends DeployableTarget<
    * @returns {unknown}
    */
   public async asset(params?: ReadParams<typeof cgdaIncentiveAbi, 'asset'>) {
-    return readCgdaIncentiveAsset(this._config, {
+    return await readCgdaIncentiveAsset(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 +281,7 @@ export class CGDAIncentive extends DeployableTarget<
   public async totalBudget(
     params?: ReadParams<typeof cgdaIncentiveAbi, 'totalBudget'>,
   ) {
-    return readCgdaIncentiveTotalBudget(this._config, {
+    return await readCgdaIncentiveTotalBudget(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),
@@ -223,11 +297,11 @@ export class CGDAIncentive extends DeployableTarget<
    * @param {?WriteParams<typeof cgdaIncentiveAbi, 'claim'>} [params]
    * @returns {Promise<boolean>} - Returns true if successfully claimed
    */
-  public async claim(
+  protected async claim(
     payload: ClaimPayload,
     params?: WriteParams<typeof cgdaIncentiveAbi, 'claim'>,
   ) {
-    return this.awaitResult(this.claimRaw(payload, params));
+    return await this.awaitResult(this.claimRaw(payload, params));
   }
 
   /**
@@ -239,7 +313,7 @@ export class CGDAIncentive extends DeployableTarget<
    * @param {?WriteParams<typeof cgdaIncentiveAbi, 'claim'>} [params]
    * @returns {Promise<boolean>} - Returns true if successfully claimed
    */
-  public async claimRaw(
+  protected async claimRaw(
     payload: ClaimPayload,
     params?: WriteParams<typeof cgdaIncentiveAbi, 'claim'>,
   ) {
@@ -267,7 +341,7 @@ export class CGDAIncentive extends DeployableTarget<
     payload: ClaimPayload,
     params?: WriteParams<typeof cgdaIncentiveAbi, 'clawback'>,
   ) {
-    return this.awaitResult(this.clawbackRaw(payload, params));
+    return await this.awaitResult(this.clawbackRaw(payload, params));
   }
 
   /**
@@ -310,7 +384,7 @@ export class CGDAIncentive extends DeployableTarget<
     payload: ClaimPayload,
     params?: ReadParams<typeof cgdaIncentiveAbi, 'isClaimable'>,
   ) {
-    return readCgdaIncentiveIsClaimable(this._config, {
+    return await readCgdaIncentiveIsClaimable(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
@@ -331,7 +405,7 @@ export class CGDAIncentive extends DeployableTarget<
   public async currentReward(
     params?: ReadParams<typeof cgdaIncentiveAbi, 'currentReward'>,
   ) {
-    return readCgdaIncentiveCurrentReward(this._config, {
+    return await readCgdaIncentiveCurrentReward(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),
@@ -362,3 +436,33 @@ export class CGDAIncentive extends DeployableTarget<
     };
   }
 }
+
+/**
+ * Given a {@link CGDAIncentivePayload}, properly encode a `CGDAIncentive.InitPayload` for use with {@link CGDAIncentive} initialization.
+ *
+ * @param {CGDAIncentivePayload} param0
+ * @param {Address} param0.asset - The address of the ERC20-like token
+ * @param {bigint} param0.initialReward - The initial reward amount
+ * @param {bigint} param0.rewardDecay - The amount to subtract from the current reward after each claim
+ * @param {bigint} param0.rewardBoost - The amount by which the reward increases for each hour without a claim (continuous linear increase)
+ * @param {bigint} param0.totalBudget - The total budget for the incentive
+ * @returns {Hex}
+ */
+export function prepareCGDAIncentivePayload({
+  asset,
+  initialReward,
+  rewardDecay,
+  rewardBoost,
+  totalBudget,
+}: CGDAIncentivePayload) {
+  return encodeAbiParameters(
+    [
+      { type: 'address', name: 'asset' },
+      { type: 'uint256', name: 'initialReward' },
+      { type: 'uint256', name: 'rewardDecay' },
+      { type: 'uint256', name: 'rewardBoost' },
+      { type: 'uint256', name: 'totalBudget' },
+    ],
+    [asset, initialReward, rewardDecay, rewardBoost, totalBudget],
+  );
+}

package/src/Incentives/ERC1155Incentive.test.ts

@@ -1,15 +1,6 @@
 import { readMockErc1155BalanceOf } from '@boostxyz/evm';
 import { loadFixture } from '@nomicfoundation/hardhat-network-helpers';
-import { signMessage } from '@wagmi/core';
-import {
-  encodePacked,
-  isAddress,
-  keccak256,
-  pad,
-  parseEther,
-  zeroAddress,
-  zeroHash,
-} from 'viem';
+import { isAddress, pad, parseEther, zeroAddress, zeroHash } from 'viem';
 import { beforeAll, beforeEach, describe, expect, test } from 'vitest';
 import { accounts } from '../../test/accounts';
 import {
@@ -20,7 +11,6 @@ import {
   freshBoost,
   fundBudget,
 } from '../../test/helpers';
-import { prepareSignerValidatorClaimDataPayload } from '../utils';
 import { ERC1155Incentive, ERC1155StrategyType } from './ERC1155Incentive';
 
 const BOOST_CORE_CLAIM_FEE = parseEther('0.000075');
@@ -71,11 +61,10 @@ describe.skip('ERC1155Incentive', () => {
     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,