@boostxyz/sdk 0.0.0-alpha.2 → 0.0.0-alpha.21

package/src/Incentives/AllowListIncentive.ts

@@ -0,0 +1,336 @@
+import {
+  allowListIncentiveAbi,
+  readAllowListIncentiveAllowList,
+  readAllowListIncentiveClaimed,
+  readAllowListIncentiveClaims,
+  readAllowListIncentiveIsClaimable,
+  readAllowListIncentiveLimit,
+  readAllowListIncentiveOwner,
+  readAllowListIncentiveReward,
+  simulateAllowListIncentiveClaim,
+  writeAllowListIncentiveClaim,
+} from '@boostxyz/evm';
+import { bytecode } from '@boostxyz/evm/artifacts/contracts/incentives/AllowListIncentive.sol/AllowListIncentive.json';
+import {
+  type Address,
+  type ContractEventName,
+  type Hex,
+  encodeAbiParameters,
+} from 'viem';
+import { AllowListIncentive as AllowListIncentiveBases } from '../../dist/deployments.json';
+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 GenericLog,
+  type ReadParams,
+  RegistryType,
+  type WriteParams,
+} from '../utils';
+
+export { allowListIncentiveAbi };
+
+/**
+ * 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.
+ *
+ * @export
+ * @typedef {AllowListIncentiveLog}
+ * @template {ContractEventName<
+ *     typeof allowListIncentiveAbi
+ *   >} [event=ContractEventName<typeof allowListIncentiveAbi>]
+ */
+export type AllowListIncentiveLog<
+  event extends ContractEventName<
+    typeof allowListIncentiveAbi
+  > = ContractEventName<typeof allowListIncentiveAbi>,
+> = GenericLog<typeof allowListIncentiveAbi, event>;
+
+/**
+ * An incentive implementation that grants the claimer a slot on an {SimpleAllowList}
+ * In order for any claim to be successful:
+ * - The claimer must not already be on the allow list; and
+ * - The maximum number of claims must not have been reached; and
+ * - This contract must be authorized to modify the allow list
+ *
+ * @export
+ * @class AllowListIncentive
+ * @typedef {AllowListIncentive}
+ * @extends {DeployableTarget<AllowListIncentivePayload>}
+ */
+export class AllowListIncentive extends DeployableTarget<
+  AllowListIncentivePayload,
+  typeof allowListIncentiveAbi
+> {
+  public override readonly abi = allowListIncentiveAbi;
+  /**
+   * @inheritdoc
+   *
+   * @public
+   * @static
+   * @type {Record<number, Address>}
+   */
+  public static override bases: Record<number, Address> = {
+    ...(AllowListIncentiveBases as Record<number, Address>),
+  };
+  /**
+   * @inheritdoc
+   *
+   * @public
+   * @static
+   * @type {RegistryType}
+   */
+  public static override registryType: RegistryType = RegistryType.INCENTIVE;
+
+  /**
+   * The owner of the allowList
+   *
+   * @public
+   * @async
+   * @param {?ReadParams} [params]
+   * @returns {Promise<Address>}
+   */
+  public async owner(
+    params?: ReadParams<typeof allowListIncentiveAbi, 'owner'>,
+  ) {
+    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
+      ...(params as any),
+    });
+  }
+
+  /**
+   * The number of claims that have been made
+   *
+   * @public
+   * @async
+   * @param {?ReadParams} [params]
+   * @returns {Promise<bigint>}
+   */
+  public async claims(
+    params?: ReadParams<typeof allowListIncentiveAbi, 'claims'>,
+  ) {
+    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
+      ...(params as any),
+    });
+  }
+
+  /**
+   * The reward amount issued for each claim
+   *
+   * @public
+   * @async
+   * @param {?ReadParams} [params]
+   * @returns {Promise<bigint>}
+   */
+  public async reward(
+    params?: ReadParams<typeof allowListIncentiveAbi, 'reward'>,
+  ) {
+    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
+      ...(params as any),
+    });
+  }
+
+  /**
+   * Get the claim status for a user
+   *
+   * @public
+   * @async
+   * @param {Address} address
+   * @param {?ReadParams} [params]
+   * @returns {Promise<boolean>}
+   */
+  public async claimed(
+    address: Address,
+    params?: ReadParams<typeof allowListIncentiveAbi, 'claimed'>,
+  ) {
+    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
+      ...(params as any),
+    });
+  }
+
+  /**
+   * The {@link SimpleAllowList} contract
+   *
+   * @public
+   * @async
+   * @param {?ReadParams} [params]
+   * @returns {Promise<SimpleAllowList>}
+   */
+  public async allowList(
+    params?: ReadParams<typeof allowListIncentiveAbi, 'allowList'>,
+  ): Promise<SimpleAllowList> {
+    const address = await readAllowListIncentiveAllowList(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),
+    });
+    return new SimpleAllowList(
+      { config: this._config, account: this._account },
+      address,
+    );
+  }
+
+  /**
+   * The maximum number of claims that can be made (one per address)
+   *
+   * @public
+   * @async
+   * @param {?ReadParams} [params]
+   * @returns {Promise<bigint>}
+   */
+  public async limit(
+    params?: ReadParams<typeof allowListIncentiveAbi, 'limit'>,
+  ) {
+    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),
+    });
+  }
+
+  /**
+   * Claim a slot on the {@link SimpleAllowList}
+   *
+   * @public
+   * @async
+   * @param {Pick<ClaimPayload, 'target'>} payload
+   * @param {?WriteParams} [params]
+   * @returns {Promise<true>} - return true if successful, otherwise revert
+   */
+  protected async claim(
+    payload: Pick<ClaimPayload, 'target'>,
+    params?: WriteParams<typeof allowListIncentiveAbi, 'claim'>,
+  ) {
+    return await this.awaitResult(this.claimRaw(payload, params));
+  }
+
+  /**
+   * Claim a slot on the {@link SimpleAllowList}
+   *
+   * @public
+   * @async
+   * @param {Pick<ClaimPayload, 'target'>} payload
+   * @param {?WriteParams} [params]
+   * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - return true if successful, otherwise revert
+   */
+  protected async claimRaw(
+    payload: Pick<ClaimPayload, 'target'>,
+    params?: WriteParams<typeof allowListIncentiveAbi, 'claim'>,
+  ) {
+    const { request, result } = await simulateAllowListIncentiveClaim(
+      this._config,
+      {
+        address: this.assertValidAddress(),
+        args: [prepareClaimPayload(payload)],
+        ...this.optionallyAttachAccount(),
+        // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
+        ...(params as any),
+      },
+    );
+    const hash = await writeAllowListIncentiveClaim(this._config, request);
+    return { hash, result };
+  }
+
+  /**
+   * Check if an incentive is claimable
+   *
+   * @public
+   * @async
+   * @param {Pick<ClaimPayload, 'target'>} payload
+   * @param {?ReadParams} [params]
+   * @returns {Promise<boolean>} - True if the incentive is claimable based on the data payload
+   */
+  public async isClaimable(
+    payload: Pick<ClaimPayload, 'target'>,
+    params?: ReadParams<typeof allowListIncentiveAbi, 'isClaimable'>,
+  ) {
+    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
+      ...(params as any),
+    });
+  }
+
+  /**
+   * @inheritdoc
+   *
+   * @public
+   * @param {?AllowListIncentivePayload} [_payload]
+   * @param {?DeployableOptions} [_options]
+   * @returns {GenericDeployableParams}
+   */
+  public override buildParameters(
+    _payload?: AllowListIncentivePayload,
+    _options?: DeployableOptions,
+  ): GenericDeployableParams {
+    const [payload, options] = this.validateDeploymentConfig(
+      _payload,
+      _options,
+    );
+    return {
+      abi: allowListIncentiveAbi,
+      bytecode: bytecode as Hex,
+      args: [prepareAllowListIncentivePayload(payload)],
+      ...this.optionallyAttachAccount(options.account),
+    };
+  }
+}
+
+/**
+ * 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

@@ -0,0 +1,135 @@
+import { readMockErc20BalanceOf } from '@boostxyz/evm';
+import { loadFixture } from '@nomicfoundation/hardhat-network-helpers';
+import { isAddress, pad, parseEther, zeroAddress } from 'viem';
+import { beforeAll, beforeEach, describe, expect, test } from 'vitest';
+import { accounts } from '@boostxyz/test/accounts';
+import {
+  type BudgetFixtures,
+  type Fixtures,
+  defaultOptions,
+  deployFixtures,
+  freshBoost,
+  fundBudget,
+} from '@boostxyz/test/helpers';
+import { CGDAIncentive } from './CGDAIncentive';
+
+let fixtures: Fixtures, budgets: BudgetFixtures;
+
+describe('CGDAIncentive', () => {
+  beforeAll(async () => {
+    fixtures = await loadFixture(deployFixtures(defaultOptions));
+  });
+
+  beforeEach(async () => {
+    budgets = await loadFixture(fundBudget(defaultOptions, fixtures));
+  });
+
+  test('can successfully be deployed', async () => {
+    const action = new CGDAIncentive(defaultOptions, {
+      asset: budgets.erc20.assertValidAddress(),
+      initialReward: 1n,
+      totalBudget: 10n,
+      rewardBoost: 1n,
+      rewardDecay: 1n,
+      manager: budgets.budget.address || zeroAddress 
+    });
+    await action.deploy();
+    expect(isAddress(action.assertValidAddress())).toBe(true);
+  });
+
+  test('can claim', async () => {
+    // biome-ignore lint/style/noNonNullAssertion: we know this is defined
+    const referrer = accounts.at(1)!.account!;
+    // biome-ignore lint/style/noNonNullAssertion: we know this is defined
+    const trustedSigner = accounts.at(0)!;
+    const erc20Incentive = fixtures.core.CGDAIncentive({
+      asset: budgets.erc20.assertValidAddress(),
+      initialReward: 1n,
+      totalBudget: 10n,
+      rewardBoost: 1n,
+      rewardDecay: 1n,
+      manager: budgets.budget.assertValidAddress(),
+    });
+    const boost = await freshBoost(fixtures, {
+      budget: budgets.budget,
+      incentives: [erc20Incentive],
+    });
+
+    const claimant = trustedSigner.account;
+    const incentiveData = pad('0xdef456232173821931823712381232131391321934');
+
+    const incentiveQuantity = 1;
+    const claimDataPayload = await boost.validator.encodeClaimData({
+      signer: trustedSigner,
+      incentiveData,
+      chainId: defaultOptions.config.chains[0].id,
+      incentiveQuantity,
+      claimant,
+      boostId: boost.id,
+    });
+
+    await fixtures.core.claimIncentive(
+      boost.id,
+      0n,
+      referrer,
+      claimDataPayload,
+      { value: parseEther('0.000075') },
+    );
+    expect(
+      await readMockErc20BalanceOf(defaultOptions.config, {
+        address: budgets.erc20.assertValidAddress(),
+        args: [defaultOptions.account.address],
+      }),
+    ).toBe(1n);
+  });
+
+  test('cannot claim twice', async () => {
+    // biome-ignore lint/style/noNonNullAssertion: we know this is defined
+    const referrer = accounts.at(1)!.account!;
+    // biome-ignore lint/style/noNonNullAssertion: we know this is defined
+    const trustedSigner = accounts.at(0)!;
+    const erc20Incentive = fixtures.core.CGDAIncentive({
+      asset: budgets.erc20.assertValidAddress(),
+      initialReward: 1n,
+      totalBudget: 10n,
+      rewardBoost: 1n,
+      rewardDecay: 1n,
+      manager: budgets.budget.address || zeroAddress 
+    });
+    const boost = await freshBoost(fixtures, {
+      budget: budgets.budget,
+      incentives: [erc20Incentive],
+    });
+
+    const claimant = trustedSigner.account;
+    const incentiveData = pad('0xdef456232173821931823712381232131391321934');
+    const incentiveQuantity = 1;
+    const claimDataPayload = await boost.validator.encodeClaimData({
+      signer: trustedSigner,
+      incentiveData,
+      chainId: defaultOptions.config.chains[0].id,
+      incentiveQuantity,
+      claimant,
+      boostId: boost.id,
+    });
+
+    await fixtures.core.claimIncentive(
+      boost.id,
+      0n,
+      referrer,
+      claimDataPayload,
+      { value: parseEther('0.000075') },
+    );
+    try {
+      await fixtures.core.claimIncentive(
+        boost.id,
+        0n,
+        referrer,
+        claimDataPayload,
+        { value: parseEther('0.000075') },
+      );
+    } catch (e) {
+      expect(e).toBeInstanceOf(Error);
+    }
+  });
+});