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

package/src/Deployable/DeployableTargetWithRBAC.ts

@@ -0,0 +1,323 @@
+import {
+  rbacAbi,
+  readRbacHasAllRoles,
+  readRbacHasAnyRole,
+  readRbacIsAuthorized,
+  readRbacRolesOf,
+  simulateRbacGrantRoles,
+  simulateRbacRevokeRoles,
+  simulateRbacSetAuthorized,
+  writeRbacGrantRoles,
+  writeRbacRevokeRoles,
+  writeRbacSetAuthorized,
+} from '@boostxyz/evm';
+import type { Abi, Address, ContractEventName } from 'viem';
+import { DeployableTarget } from '../Deployable/DeployableTarget';
+import type { GenericLog, ReadParams, WriteParams } from '../utils';
+export { rbacAbi };
+
+/**
+ *  Enum representing available roles for use with the `RBAC` authorization scheme.
+ * `MANAGER` has lowest level of write permissions, for specific implementations, see Budgets and ALlowLists
+ * `ADMIN` can additionally manage authorized users on the contract.
+ *
+ * @export
+ * @type {{ readonly MANAGER: 1n; readonly ADMIN_ROLE: 2n; }}
+ * @enum {bigint}
+ */
+export enum Roles {
+  //@ts-expect-error ts doesn't like bigint enum values
+  MANAGER = 1n,
+  //@ts-expect-error ts doesn't like bigint enum values
+  ADMIN = 2n,
+}
+
+/**
+ * A generic `viem.Log` event with support for `Rbac` event types.
+ *
+ * @export
+ * @typedef {RBACLog}
+ * @template {ContractEventName<typeof rbacAbi>} [event=ContractEventName<
+ *     typeof rbacAbi
+ *   >]
+ */
+export type RBACLog<
+  event extends ContractEventName<typeof rbacAbi> = ContractEventName<
+    typeof rbacAbi
+  >,
+> = GenericLog<typeof rbacAbi, event>;
+
+/**
+ * A minimal RBAC implementation that offers MANAGER and ADMIN roles, and
+ * Budgets and allowlists support this auth scheme
+ *
+ * @export
+ * @class DeployableTargetWithRBAC
+ * @typedef {DeployableTargetWithRBAC}
+ * @extends {DeployableTarget<RbacPayload>}
+ */
+export class DeployableTargetWithRBAC<
+  Payload,
+  ABI extends Abi,
+> extends DeployableTarget<Payload, ABI> {
+  /**
+   * Set the authorized status of the given accounts
+   * The mechanism for managing authorization is left to the implementing contract
+   *
+   * @public
+   * @async
+   * @param {Address[]} addresses - The accounts to authorize or deauthorize
+   * @param {boolean[]} allowed - The authorization status for the given accounts
+   * @param {?WriteParams} [params]
+   * @returns {Promise<void>}
+   */
+  public async setAuthorized(
+    addresses: Address[],
+    allowed: boolean[],
+    params?: WriteParams<typeof rbacAbi, 'setAuthorized'>,
+  ) {
+    return await this.awaitResult(
+      this.setAuthorizedRaw(addresses, allowed, params),
+    );
+  }
+
+  /**
+   * Set the authorized status of the given accounts
+   * The mechanism for managing authorization is left to the implementing contract
+   *
+   * @public
+   * @async
+   * @param {Address[]} addresses - The accounts to authorize or deauthorize
+   * @param {boolean[]} allowed - The authorization status for the given accounts
+   * @param {?WriteParams} [params]
+   * @returns {Promise<void>}
+   */
+  public async setAuthorizedRaw(
+    addresses: Address[],
+    allowed: boolean[],
+    params?: WriteParams<typeof rbacAbi, 'setAuthorized'>,
+  ) {
+    const { request, result } = await simulateRbacSetAuthorized(this._config, {
+      address: this.assertValidAddress(),
+      args: [addresses, allowed],
+      ...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 writeRbacSetAuthorized(this._config, request);
+    return { hash, result };
+  }
+
+  /**
+   * Grant many accounts permissions on the rbac.
+   *
+   * @example
+   * ```ts
+   * await rbac.grantRoles(['0xfoo', '0xbar], [RbacRoles.MANAGER, RbacRoles.ADMIN])
+   * ```
+   * @public
+   * @async
+   * @param {Address[]} addresses
+   * @param {RbacRoles[]} roles
+   * @param {?WriteParams} [params]
+   * @returns {Promise<void>}
+   */
+  public async grantRoles(
+    addresses: Address[],
+    roles: Roles[],
+    params?: WriteParams<typeof rbacAbi, 'grantRoles'>,
+  ) {
+    return await this.awaitResult(this.grantRolesRaw(addresses, roles, params));
+  }
+
+  /**
+   * Grant many accounts permissions on the rbac.
+   *
+   * @example
+   * ```ts
+   * await rbac.grantRoles(['0xfoo', '0xbar], [Roles.MANAGER, Roles.ADMIN])
+   *
+   * @public
+   * @async
+   * @param {Address[]} addresses
+   * @param {RbacRoles[]} roles
+   * @param {?WriteParams} [params]
+   * @returns {Promise<{ hash: `0x${string}`; result: void; }>}
+   */
+  public async grantRolesRaw(
+    addresses: Address[],
+    roles: Roles[],
+    params?: WriteParams<typeof rbacAbi, 'grantRoles'>,
+  ) {
+    const { request, result } = await simulateRbacGrantRoles(this._config, {
+      address: this.assertValidAddress(),
+      args: [addresses, roles],
+      ...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 writeRbacGrantRoles(
+      this._config,
+      // biome-ignore lint/suspicious/noExplicitAny: negligible low level lack of type intersection
+      request as any,
+    );
+    return { hash, result };
+  }
+
+  /**
+   * Revoke many accounts' permissions on the rbac.
+   *
+   * @example
+   * ```ts
+   * await rbac.revokeRoles(['0xfoo', '0xbar], [RbacRoles.MANAGER, RbacRoles.ADMIN])
+   *
+   * @public
+   * @async
+   * @param {Address[]} addresses
+   * @param {RbacRoles[]} roles
+   * @param {?WriteParams} [params]
+   * @returns {Promise<void>}
+   */
+  public async revokeRoles(
+    addresses: Address[],
+    roles: Roles[],
+    params?: WriteParams<typeof rbacAbi, 'revokeRoles'>,
+  ) {
+    return await this.awaitResult(
+      this.revokeRolesRaw(addresses, roles, params),
+    );
+  }
+
+  /**
+   * Revoke many accounts' permissions on the rbac.
+   *
+   * @example
+   * ```ts
+   * await rbac.revokeRoles(['0xfoo', '0xbar], [RbacRoles.MANAGER, RbacRoles.ADMIN])
+   * @public
+   * @async
+   * @param {Address[]} addresses
+   * @param {RbacRoles[]} roles
+   * @param {?WriteParams} [params]
+   * @returns {Promise<{ hash: `0x${string}`; result: void; }>}
+   */
+  public async revokeRolesRaw(
+    addresses: Address[],
+    roles: Roles[],
+    params?: WriteParams<typeof rbacAbi, 'revokeRoles'>,
+  ) {
+    const { request, result } = await simulateRbacRevokeRoles(this._config, {
+      address: this.assertValidAddress(),
+      args: [addresses, roles],
+      ...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 writeRbacRevokeRoles(
+      this._config,
+      // biome-ignore lint/suspicious/noExplicitAny: negligible low level lack of type intersection
+      request as any,
+    );
+    return { hash, result };
+  }
+
+  /**
+   * Return an array of the roles assigned to the given account.
+   * @example
+   * ```ts
+   * (await rbac.rolesOf(0xfoo)).includes(RbacRoles.ADMIN)
+   * @public
+   * @param {Address} account
+   * @param {?ReadParams} [params]
+   * @returns {Promise<Array<RbacRoles>>}
+   */
+  public async rolesOf(
+    account: Address,
+    params?: ReadParams<typeof rbacAbi, 'rolesOf'>,
+  ) {
+    const roles = await readRbacRolesOf(this._config, {
+      address: this.assertValidAddress(),
+      args: [account],
+      ...this.optionallyAttachAccount(),
+      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
+      ...(params as any),
+    });
+    return ([Roles.MANAGER, Roles.ADMIN] as unknown as Array<bigint>).filter(
+      (role) => (roles & role) === role,
+    ) as unknown as Roles[];
+  }
+
+  /**
+   * Returns whether given account has any of the provided roles bitmap.
+   *
+   * @example
+   * ```ts
+   * await rbac.hasAnyRole(0xfoo, RbacRoles.ADMIN | RbacRoles.MANAGER)
+   * @public
+   * @param {Address} account
+   * @param {RbacRoles} roles
+   * @param {?ReadParams} [params]
+   * @returns {Promise<boolean>}
+   */
+  public hasAnyRole(
+    account: Address,
+    roles: Roles,
+    params?: ReadParams<typeof rbacAbi, 'hasAnyRole'>,
+  ) {
+    return readRbacHasAnyRole(this._config, {
+      address: this.assertValidAddress(),
+      args: [account, roles],
+      ...this.optionallyAttachAccount(),
+      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
+      ...(params as any),
+    });
+  }
+
+  /**
+   * Returns whether given account has all of the provided roles bitmap.
+   *
+   * @example
+   * ```ts
+   * await rbac.hasAllRoles(0xfoo, RbacRoles.ADMIN & RbacRoles.MANAGER)
+   *
+   * @public
+   * @param {Address} account
+   * @param {RbacRoles} roles
+   * @param {?ReadParams} [params]
+   * @returns {Promise<boolean>}
+   */
+  public hasAllRoles(
+    account: Address,
+    roles: Roles,
+    params?: ReadParams<typeof rbacAbi, 'hasAllRoles'>,
+  ) {
+    return readRbacHasAllRoles(this._config, {
+      address: this.assertValidAddress(),
+      args: [account, roles],
+      ...this.optionallyAttachAccount(),
+      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
+      ...(params as any),
+    });
+  }
+
+  /**
+   * Check if the given account is authorized to use the rbac
+   *
+   * @public
+   * @param {Address} account
+   * @param {?ReadParams} [params]
+   * @returns {Promise<boolean>} - True if the account is authorized
+   */
+  public isAuthorized(
+    account: Address,
+    params?: ReadParams<typeof rbacAbi, 'isAuthorized'>,
+  ) {
+    return readRbacIsAuthorized(this._config, {
+      address: this.assertValidAddress(),
+      args: [account],
+      ...this.optionallyAttachAccount(),
+      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
+      ...(params as any),
+    });
+  }
+}

package/src/Incentives/AllowListIncentive.test.ts

@@ -1,24 +1,23 @@
 import { loadFixture } from '@nomicfoundation/hardhat-network-helpers';
 import { isAddress, pad, parseEther, zeroAddress } 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,
   freshBoost,
-} from '../../test/helpers';
+} from '@boostxyz/test/helpers';
 import { LIST_MANAGER_ROLE } from '../AllowLists/SimpleAllowList';
-import { prepareSignerValidatorClaimDataPayload } from '../utils';
 import { PointsIncentive } from './PointsIncentive';
 
 let fixtures: Fixtures;
 
 function freshAllowList(fixtures: Fixtures) {
   return function freshAllowList() {
-    return fixtures.registry.clone(
+    return fixtures.registry.initialize(
       crypto.randomUUID(),
-      new fixtures.bases.SimpleAllowList(defaultOptions, {
+      fixtures.core.SimpleAllowList({
         owner: defaultOptions.account.address,
         allowed: [],
       }),
@@ -28,7 +27,7 @@ function freshAllowList(fixtures: Fixtures) {
 
 describe('AllowListIncentive', () => {
   beforeAll(async () => {
-    fixtures = await loadFixture(deployFixtures);
+    fixtures = await loadFixture(deployFixtures(defaultOptions));
   });
 
   test('can successfully be deployed', async () => {
@@ -68,11 +67,10 @@ describe('AllowListIncentive', () => {
     console.log(claimant);
 
     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,
@@ -114,11 +112,10 @@ describe('AllowListIncentive', () => {
     const incentiveData = pad('0xdef456232173821931823712381232131391321934');
     console.log(claimant);
 
-    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/AllowListIncentive.ts

@@ -11,26 +11,51 @@ 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,
+  zeroHash,
+} 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 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.
@@ -69,10 +94,11 @@ export class AllowListIncentive extends DeployableTarget<
    *
    * @public
    * @static
-   * @type {Address}
+   * @type {Record<number, Address>}
    */
-  public static override base: Address = import.meta.env
-    .VITE_ALLOWLIST_INCENTIVE_BASE;
+  public static override bases: Record<number, Address> = {
+    ...(AllowListIncentiveBases as Record<number, Address>),
+  };
   /**
    * @inheritdoc
    *
@@ -87,13 +113,13 @@ export class AllowListIncentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof allowListIncentiveAbi, 'owner'>} [params]
-   * @returns {unknown}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<Address>}
    */
   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
@@ -106,13 +132,13 @@ export class AllowListIncentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof allowListIncentiveAbi, 'claims'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<bigint>}
    */
   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
@@ -125,13 +151,13 @@ export class AllowListIncentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof allowListIncentiveAbi, 'reward'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<bigint>}
    */
   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
@@ -145,14 +171,14 @@ export class AllowListIncentive extends DeployableTarget<
    * @public
    * @async
    * @param {Address} address
-   * @param {?ReadParams<typeof allowListIncentiveAbi, 'claimed'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<boolean>}
    */
   public async claimed(
     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
@@ -165,7 +191,7 @@ export class AllowListIncentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof allowListIncentiveAbi, 'allowList'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<SimpleAllowList>}
    */
   public async allowList(
@@ -187,13 +213,13 @@ export class AllowListIncentive extends DeployableTarget<
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof allowListIncentiveAbi, 'limit'>} [params]
-   * @returns {unknown}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<bigint>}
    */
   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),
@@ -206,14 +232,14 @@ export class AllowListIncentive extends DeployableTarget<
    * @public
    * @async
    * @param {Pick<ClaimPayload, 'target'>} payload
-   * @param {?WriteParams<typeof allowListIncentiveAbi, 'claim'>} [params]
+   * @param {?WriteParams} [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));
   }
 
   /**
@@ -222,10 +248,10 @@ export class AllowListIncentive extends DeployableTarget<
    * @public
    * @async
    * @param {Pick<ClaimPayload, 'target'>} payload
-   * @param {?WriteParams<typeof allowListIncentiveAbi, 'claim'>} [params]
-   * @returns {Promise<true>} - return true if successful, otherwise revert
+   * @param {?WriteParams} [params]
+   * @returns {Promise<{ hash: `0x${string}`; result: boolean; }>} - return true if successful, otherwise revert
    */
-  public async claimRaw(
+  protected async claimRaw(
     payload: Pick<ClaimPayload, 'target'>,
     params?: WriteParams<typeof allowListIncentiveAbi, 'claim'>,
   ) {
@@ -249,14 +275,14 @@ export class AllowListIncentive extends DeployableTarget<
    * @public
    * @async
    * @param {Pick<ClaimPayload, 'target'>} payload
-   * @param {?ReadParams<typeof allowListIncentiveAbi, 'isClaimable'>} [params]
+   * @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 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
@@ -287,4 +313,36 @@ export class AllowListIncentive extends DeployableTarget<
       ...this.optionallyAttachAccount(options.account),
     };
   }
+
+  /**
+   * Builds the claim data for the AllowListIncentive.
+   *
+   * @public
+   * @returns {Hash} A `zeroHash`, as AllowListIncentive doesn't require specific claim data.
+   * @description This function returns `zeroHash` because AllowListIncentive doesn't use any specific claim data.
+   */
+  public buildClaimData() {
+    return zeroHash;
+  }
 }
+
+/**
+ * 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],
+  );
+};