@boostxyz/sdk 0.0.0-alpha.9 → 1.1.0-alpha.23

package/src/AllowLists/AllowList.test.ts

@@ -4,7 +4,7 @@ import {
   type Fixtures,
   defaultOptions,
   deployFixtures,
-} from '../../test/helpers';
+} from '@boostxyz/test/helpers';
 import {
   SimpleAllowList,
   SimpleDenyList,
@@ -14,14 +14,14 @@ import {
 let fixtures: Fixtures;
 
 beforeAll(async () => {
-  fixtures = await loadFixture(deployFixtures);
+  fixtures = await loadFixture(deployFixtures(defaultOptions));
 });
 
 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: [defaultOptions.account.address],
       }),
@@ -31,9 +31,9 @@ function freshAllowList(fixtures: Fixtures) {
 
 function freshDenyList(fixtures: Fixtures) {
   return function freshDenyList() {
-    return fixtures.registry.clone(
+    return fixtures.registry.initialize(
       crypto.randomUUID(),
-      new fixtures.bases.SimpleDenyList(defaultOptions, {
+      fixtures.core.SimpleDenyList({
         owner: defaultOptions.account.address,
         denied: [defaultOptions.account.address],
       }),
@@ -52,7 +52,7 @@ describe('AllowList', () => {
     ).toBeInstanceOf(SimpleAllowList);
   });
 
-  test('can automatically instantiate SimpleAllowList given an address', async () => {
+  test('can automatically instantiate SimpleDenyList given an address', async () => {
     const _allowList = await loadFixture(freshDenyList(fixtures));
     expect(
       await allowListFromAddress(

package/src/AllowLists/AllowList.ts

@@ -7,10 +7,11 @@ import { readContract } from '@wagmi/core';
 import type { Address, Hex } from 'viem';
 import type { DeployableOptions } from '../Deployable/Deployable';
 import { InvalidComponentInterfaceError } from '../errors';
+import { OpenAllowList } from './OpenAllowList';
 import { SimpleAllowList } from './SimpleAllowList';
 import { SimpleDenyList } from './SimpleDenyList';
 
-export { SimpleAllowList, SimpleDenyList };
+export { OpenAllowList, SimpleAllowList, SimpleDenyList };
 
 /**
  * A union type representing all valid protocol AllowList implementations
@@ -18,7 +19,7 @@ export { SimpleAllowList, SimpleDenyList };
  * @export
  * @typedef {AllowList}
  */
-export type AllowList = SimpleAllowList | SimpleDenyList;
+export type AllowList = OpenAllowList | SimpleAllowList | SimpleDenyList;
 
 /**
  * A map of AllowList component interfaces to their constructors.
@@ -32,6 +33,7 @@ export const AllowListByComponentInterface = {
 
 /**
  * A function that will read a contract's component interface using `getComponentInterface` and return the correct instantiated instance.
+ * This function will never return an instance of {@link OpenAllowList} because it has the same component interface as {@link SimpleDenyList}
  *
  * @export
  * @async
@@ -56,5 +58,5 @@ export async function allowListFromAddress(
       interfaceId as Hex,
     );
   }
-  return new Ctor(options, address);
+  return new Ctor(options, address) as SimpleDenyList | SimpleAllowList;
 }

package/src/AllowLists/OpenAllowList.test.ts

@@ -0,0 +1,40 @@
+import { loadFixture } from '@nomicfoundation/hardhat-network-helpers';
+import { isAddress, zeroAddress } from 'viem';
+import { beforeAll, describe, expect, test } from 'vitest';
+import { accounts } from '@boostxyz/test/accounts';
+import {
+  type Fixtures,
+  defaultOptions,
+  deployFixtures,
+} from '@boostxyz/test/helpers';
+import { OpenAllowList } from './OpenAllowList';
+
+let fixtures: Fixtures;
+
+beforeAll(async () => {
+  fixtures = await loadFixture(deployFixtures(defaultOptions));
+});
+
+function freshOpenAllowList(fixtures: Fixtures) {
+  return function freshOpenAllowList() {
+    return fixtures.registry.initialize(
+      crypto.randomUUID(),
+      new fixtures.bases.OpenAllowList(defaultOptions),
+    );
+  };
+}
+
+describe('OpenAllowList', () => {
+  test('can successfully be deployed', async () => {
+    const denyList = new OpenAllowList(defaultOptions);
+    await denyList.deploy();
+    expect(isAddress(denyList.assertValidAddress())).toBe(true);
+  });
+
+  test('allows anyone', async () => {
+    const denyList = await loadFixture(freshOpenAllowList(fixtures));
+    expect(await denyList.isAllowed(defaultOptions.account.address)).toBe(true);
+    expect(await denyList.isAllowed(zeroAddress)).toBe(true);
+    expect(await denyList.isAllowed(accounts.at(1)!.account)).toBe(true);
+  });
+});

package/src/AllowLists/OpenAllowList.ts

@@ -0,0 +1,45 @@
+import { simpleDenyListAbi } from '@boostxyz/evm';
+import { bytecode } from '@boostxyz/evm/artifacts/contracts/allowlists/SimpleDenyList.sol/SimpleDenyList.json';
+import { type Hex, zeroAddress } from 'viem';
+import type {
+  DeployableOptions,
+  GenericDeployableParams,
+} from '../Deployable/Deployable';
+import {
+  SimpleDenyList,
+  type SimpleDenyListPayload,
+  prepareSimpleDenyListPayload,
+} from './SimpleDenyList';
+
+export const openAllowListAbi = simpleDenyListAbi;
+
+/**
+ * A simple AllowList, extending {@link DenyList}, that is ownerless and allows anyone to claim.
+ *
+ * @export
+ * @class OpenAllowList
+ * @typedef {OpenAllowList}
+ * @extends {DeployableTarget<OpenAllowListPayload>}
+ */
+export class OpenAllowList extends SimpleDenyList<undefined> {
+  /**
+   * @inheritdoc
+   *
+   * @public
+   * @param {?SimpleDenyListPayload} [_payload]
+   * @param {?DeployableOptions} [_options]
+   * @returns {GenericDeployableParams}
+   */
+  public override buildParameters(
+    _payload?: SimpleDenyListPayload,
+    _options?: DeployableOptions,
+  ): GenericDeployableParams {
+    const [_, options] = this.validateDeploymentConfig({}, _options);
+    return {
+      abi: openAllowListAbi,
+      bytecode: bytecode as Hex,
+      args: [prepareSimpleDenyListPayload({ owner: zeroAddress, denied: [] })],
+      ...this.optionallyAttachAccount(options.account),
+    };
+  }
+}

package/src/AllowLists/SimpleAllowList.test.ts

@@ -5,20 +5,20 @@ import {
   type Fixtures,
   defaultOptions,
   deployFixtures,
-} from '../../test/helpers';
+} from '@boostxyz/test/helpers';
 import { SimpleAllowList } from './SimpleAllowList';
 
 let fixtures: Fixtures;
 
 beforeAll(async () => {
-  fixtures = await loadFixture(deployFixtures);
+  fixtures = await loadFixture(deployFixtures(defaultOptions));
 });
 
 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: [defaultOptions.account.address],
       }),

package/src/AllowLists/SimpleAllowList.ts

@@ -1,9 +1,8 @@
 import {
   readSimpleAllowListIsAllowed,
+  readSimpleAllowListOwner,
   simpleAllowListAbi,
-  simulateSimpleAllowListGrantRoles,
   simulateSimpleAllowListSetAllowed,
-  writeSimpleAllowListGrantRoles,
   writeSimpleAllowListSetAllowed,
 } from '@boostxyz/evm';
 import { bytecode } from '@boostxyz/evm/artifacts/contracts/allowlists/SimpleAllowList.sol/SimpleAllowList.json';
@@ -16,11 +15,15 @@ import {
   zeroAddress,
   zeroHash,
 } from 'viem';
+import { SimpleAllowList as SimpleAllowListBases } from '../../dist/deployments.json';
 import type {
   DeployableOptions,
   GenericDeployableParams,
 } from '../Deployable/Deployable';
-import { DeployableTarget } from '../Deployable/DeployableTarget';
+import {
+  DeployableTargetWithRBAC,
+  Roles,
+} from '../Deployable/DeployableTargetWithRBAC';
 import { DeployableUnknownOwnerProvidedError } from '../errors';
 import {
   type GenericLog,
@@ -71,18 +74,19 @@ export type SimpleAllowListLog<
 /**
  * A constant representing the list manager's role
  *
- * @type {2n}
+ * @deprecated use {@link Roles} instead
+ * @type {1n}
  */
-export const LIST_MANAGER_ROLE = 2n;
+export const LIST_MANAGER_ROLE = Roles.MANAGER;
 /**
  * A simple implementation of an AllowList that checks if a user is authorized based on a list of allowed addresses
  *
  * @export
  * @class SimpleAllowList
  * @typedef {SimpleAllowList}
- * @extends {DeployableTarget<SimpleAllowListPayload>}
+ * @extends {DeployableTargetWithRBAC<SimpleAllowListPayload>}
  */
-export class SimpleAllowList extends DeployableTarget<
+export class SimpleAllowList extends DeployableTargetWithRBAC<
   SimpleAllowListPayload,
   typeof simpleAllowListAbi
 > {
@@ -92,10 +96,12 @@ export class SimpleAllowList extends DeployableTarget<
    *
    * @public
    * @static
-   * @type {Address}
+   * @type {Record<number, Address>}
    */
-  public static override base: Address = import.meta.env
-    .VITE_SIMPLE_ALLOWLIST_BASE;
+  public static override bases: Record<number, Address> = {
+    31337: import.meta.env.VITE_SIMPLE_ALLOWLIST_BASE,
+    ...(SimpleAllowListBases as Record<number, Address>),
+  };
   /**
    * @inheritdoc
    *
@@ -105,13 +111,33 @@ export class SimpleAllowList extends DeployableTarget<
    */
   public static override registryType: RegistryType = RegistryType.ALLOW_LIST;
 
+  /**
+   * Retrieves the owner
+   *
+   * @public
+   * @async
+   * @param {?ReadParams} [params]
+   * @returns {Promise<Address>} - The address of the owner
+   */
+  public async owner(
+    params?: ReadParams<typeof simpleAllowListAbi, 'owner'>,
+  ): Promise<Address> {
+    return await readSimpleAllowListOwner(this._config, {
+      ...this.optionallyAttachAccount(),
+      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
+      ...(params as any),
+      address: this.assertValidAddress(),
+      args: [],
+    });
+  }
+
   /**
    * Check if a user is authorized.
    *
    * @public
    * @async
    * @param {Address} address - The address of the user
-   * @param {?ReadParams<typeof simpleAllowListAbi, 'setAllowed'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<boolean>} - True if the user is authorized
    */
   public async isAllowed(
@@ -135,7 +161,7 @@ export class SimpleAllowList extends DeployableTarget<
    * @async
    * @param {Address[]} addresses - The list of users to update
    * @param {boolean[]} allowed - The allowed status of each user
-   * @param {?ReadParams<typeof simpleAllowListAbi, 'setAllowed'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<void>}
    */
   public async setAllowed(
@@ -156,8 +182,8 @@ export class SimpleAllowList extends DeployableTarget<
    * @async
    * @param {Address[]} addresses - The list of users to update
    * @param {boolean[]} allowed - The allowed status of each user
-   * @param {?ReadParams<typeof simpleAllowListAbi, 'setAllowed'>} [params]
-   * @returns {Promise<void>}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<{ hash: `0x${string}`; result: void; }>}
    */
   public async setAllowedRaw(
     addresses: Address[],
@@ -178,53 +204,6 @@ export class SimpleAllowList extends DeployableTarget<
     return { hash, result };
   }
 
-  /**
-   * Allows the owner to grant `user` `roles`.
-   *
-   * @public
-   * @async
-   * @param {Address} address
-   * @param {bigint} role
-   * @param {?ReadParams<typeof simpleAllowListAbi, 'grantRoles'>} [params]
-   * @returns {Promise<void>}
-   */
-  public async grantRoles(
-    address: Address,
-    role: bigint,
-    params?: WriteParams<typeof simpleAllowListAbi, 'grantRoles'>,
-  ) {
-    return await this.awaitResult(this.grantRolesRaw(address, role, params));
-  }
-
-  /**
-   * Allows the owner to grant `user` `roles`.
-   *
-   * @public
-   * @async
-   * @param {Address} address
-   * @param {bigint} role
-   * @param {?ReadParams<typeof simpleAllowListAbi, 'grantRoles'>} [params]
-   * @returns {Promise<void>}
-   */
-  public async grantRolesRaw(
-    address: Address,
-    role: bigint,
-    params?: ReadParams<typeof simpleAllowListAbi, 'grantRoles'>,
-  ) {
-    const { request, result } = await simulateSimpleAllowListGrantRoles(
-      this._config,
-      {
-        address: this.assertValidAddress(),
-        args: [address, role],
-        ...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 writeSimpleAllowListGrantRoles(this._config, request);
-    return { hash, result };
-  }
-
   /**
    * @inheritdoc
    *

package/src/AllowLists/SimpleDenyList.test.ts

@@ -5,20 +5,20 @@ import {
   type Fixtures,
   defaultOptions,
   deployFixtures,
-} from '../../test/helpers';
+} from '@boostxyz/test/helpers';
 import { SimpleDenyList } from './SimpleDenyList';
 
 let fixtures: Fixtures;
 
 beforeAll(async () => {
-  fixtures = await loadFixture(deployFixtures);
+  fixtures = await loadFixture(deployFixtures(defaultOptions));
 });
 
 function freshDenyList(fixtures: Fixtures) {
   return function freshDenyList() {
-    return fixtures.registry.clone(
+    return fixtures.registry.initialize(
       crypto.randomUUID(),
-      new fixtures.bases.SimpleDenyList(defaultOptions, {
+      fixtures.core.SimpleDenyList({
         owner: defaultOptions.account.address,
         denied: [defaultOptions.account.address],
       }),

package/src/AllowLists/SimpleDenyList.ts

@@ -1,4 +1,5 @@
 import {
+  readSimpleAllowListOwner,
   readSimpleDenyListIsAllowed,
   simpleDenyListAbi,
   simulateSimpleDenyListSetDenied,
@@ -14,11 +15,12 @@ import {
   zeroAddress,
   zeroHash,
 } from 'viem';
+import { SimpleDenyList as SimpleDenyListBases } from '../../dist/deployments.json';
 import type {
   DeployableOptions,
   GenericDeployableParams,
 } from '../Deployable/Deployable';
-import { DeployableTarget } from '../Deployable/DeployableTarget';
+import { DeployableTargetWithRBAC } from '../Deployable/DeployableTargetWithRBAC';
 import { DeployableUnknownOwnerProvidedError } from '../errors';
 import {
   type GenericLog,
@@ -72,10 +74,12 @@ export type SimpleDenyListLog<
  * @export
  * @class SimpleDenyList
  * @typedef {SimpleDenyList}
- * @extends {DeployableTarget<SimpleDenyListPayload>}
+ * @extends {DeployableTargetWithRBAC<SimpleDenyListPayload>}
  */
-export class SimpleDenyList extends DeployableTarget<
-  SimpleDenyListPayload,
+export class SimpleDenyList<
+  Payload = SimpleDenyListPayload,
+> extends DeployableTargetWithRBAC<
+  Payload | undefined,
   typeof simpleDenyListAbi
 > {
   public override readonly abi = simpleDenyListAbi;
@@ -84,10 +88,12 @@ export class SimpleDenyList extends DeployableTarget<
    *
    * @public
    * @static
-   * @type {Address}
+   * @type {Record<number, Address>}
    */
-  public static override base: Address = import.meta.env
-    .VITE_SIMPLE_DENYLIST_BASE;
+  public static override bases: Record<number, Address> = {
+    31337: import.meta.env.VITE_SIMPLE_DENYLIST_BASE,
+    ...(SimpleDenyListBases as Record<number, Address>),
+  };
   /**
    * @inheritdoc
    *
@@ -97,13 +103,33 @@ export class SimpleDenyList extends DeployableTarget<
    */
   public static override registryType: RegistryType = RegistryType.ALLOW_LIST;
 
+  /**
+   * Retrieves the owner
+   *
+   * @public
+   * @async
+   * @param {?ReadParams} [params]
+   * @returns {Promise<Address>} - The address of the owner
+   */
+  public async owner(
+    params?: ReadParams<typeof simpleDenyListAbi, 'owner'>,
+  ): Promise<Address> {
+    return await readSimpleAllowListOwner(this._config, {
+      ...this.optionallyAttachAccount(),
+      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
+      ...(params as any),
+      address: this.assertValidAddress(),
+      args: [],
+    });
+  }
+
   /**
    * Check if a user is authorized (i.e. not denied)
    *
    * @public
    * @async
    * @param {Address} address - The address of the user
-   * @param {?ReadParams<typeof simpleDenyListAbi, 'isAllowed'>} [params]
+   * @param {?ReadParams} [params]
    * @returns {Promise<boolean>} - True if the user is authorized
    */
   public async isAllowed(
@@ -126,8 +152,8 @@ export class SimpleDenyList extends DeployableTarget<
    * @async
    * @param {Address[]} addresses - The list of users to update
    * @param {boolean[]} allowed - The denied status of each user
-   * @param {?WriteParams<typeof simpleDenyListAbi, 'setDenied'>} [params]
-   * @returns {unknown}
+   * @param {?WriteParams} [params]
+   * @returns {Promise<void>}
    */
   public async setDenied(
     addresses: Address[],
@@ -146,8 +172,8 @@ export class SimpleDenyList extends DeployableTarget<
    * @async
    * @param {Address[]} addresses - The list of users to update
    * @param {boolean[]} allowed - The denied status of each user
-   * @param {?WriteParams<typeof simpleDenyListAbi, 'setDenied'>} [params]
-   * @returns {unknown}
+   * @param {?WriteParams} [params]
+   * @returns {Promise<{ hash: `0x${string}`; result: void; }>}
    */
   public async setDeniedRaw(
     addresses: Address[],
@@ -177,13 +203,11 @@ export class SimpleDenyList extends DeployableTarget<
    * @returns {GenericDeployableParams}
    */
   public override buildParameters(
-    _payload?: SimpleDenyListPayload,
+    _payload?: Payload,
     _options?: DeployableOptions,
   ): GenericDeployableParams {
-    const [payload, options] = this.validateDeploymentConfig(
-      _payload,
-      _options,
-    );
+    const [p, options] = this.validateDeploymentConfig(_payload, _options);
+    const payload = p as SimpleDenyListPayload;
     if (!payload.owner || payload.owner === zeroAddress) {
       const owner = options.account
         ? options.account.address

package/src/Auth/PassthroughAuth.test.ts

@@ -1,6 +1,6 @@
 import { zeroAddress } from 'viem';
 import { describe, expect, test } from 'vitest';
-import { defaultOptions } from '../../test/helpers';
+import { defaultOptions } from '@boostxyz/test/helpers';
 import { PassthroughAuth } from './PassthroughAuth';
 
 describe('PassthroughAuth', () => {

package/src/Boost.ts

@@ -12,12 +12,30 @@ import type { Budget } from './Budgets/Budget';
 import type { Incentive } from './Incentives/Incentive';
 import type { Validator } from './Validators/Validator';
 
+/**
+ * Interface representing a `BoostLib.Boost` on-chain struct
+ *
+ * @export
+ * @interface RawBoost
+ * @typedef {RawBoost}
+ */
+export interface RawBoost {
+  action: Address;
+  validator: Address;
+  allowList: Address;
+  budget: Address;
+  incentives: readonly Address[];
+  protocolFee: bigint;
+  maxParticipants: bigint;
+  owner: Address;
+}
+
 /**
  * Configuration used to instantiate a `Boost` instance.
  *
  * @export
- * @interface BoostPayload
- * @typedef {BoostPayload}
+ * @interface BoostConfig
+ * @typedef {BoostConfig}
  */
 export interface BoostConfig {
   /**
@@ -55,11 +73,6 @@ export interface BoostConfig {
    * @type {?bigint}
    */
   protocolFee?: bigint;
-  /**
-   *
-   * @type {?bigint}
-   */
-  referralFee?: bigint;
   /**
    *
    * @type {?bigint}
@@ -122,12 +135,6 @@ export class Boost {
    * @type {bigint}
    */
   readonly protocolFee: bigint;
-  /**
-   *
-   * @readonly
-   * @type {bigint}
-   */
-  readonly referralFee: bigint;
   /**
    *
    * @readonly
@@ -155,7 +162,6 @@ export class Boost {
     this.allowList = config.allowList;
     this.incentives = config.incentives;
     this.protocolFee = config.protocolFee || 0n;
-    this.referralFee = config.referralFee || 0n;
     this.maxParticipants = config.maxParticipants || 0n;
     this.owner = config.owner || zeroAddress;
   }
@@ -218,12 +224,6 @@ export interface BoostPayload {
    * @type {?bigint}
    */
   protocolFee?: bigint;
-  /**
-   * The base referral fee (in bps)
-   *
-   * @type {?bigint}
-   */
-  referralFee?: bigint;
   /**
    * Optional maximum amount of participants in the Boost.
    *
@@ -249,7 +249,6 @@ export interface BoostPayload {
  * @param {Target} param0.allowList - Target for existing allowList, or base with initialization payload.
  * @param {Target[]} param0.incentives - Targets for new incentives, with initialization payloads.
  * @param {bigint} [param0.protocolFee=0n] - The base protocol fee (in bps)
- * @param {bigint} [param0.referralFee=0n] - The base referral fee (in bps)
  * @param {bigint} [param0.maxParticipants=0n] - Optional maximum amount of participants in the Boost.
  * @param {Address} param0.owner - The owner of the Boost.
  * @returns {Hex}
@@ -261,7 +260,6 @@ export function prepareBoostPayload({
   allowList,
   incentives,
   protocolFee = 0n,
-  referralFee = 0n,
   maxParticipants = 0n,
   owner,
 }: BoostPayload): Hex {
@@ -269,7 +267,7 @@ export function prepareBoostPayload({
     encodeAbiParameters(
       parseAbiParameters([
         'BoostPayload payload',
-        'struct BoostPayload { address budget; Target action; Target validator; Target allowList; Target[] incentives; uint64 protocolFee; uint64 referralFee; uint256 maxParticipants; address owner; }',
+        'struct BoostPayload { address budget; Target action; Target validator; Target allowList; Target[] incentives; uint64 protocolFee; uint256 maxParticipants; address owner; }',
         'struct Target { bool isBase; address instance; bytes parameters; }',
       ]),
       [
@@ -280,7 +278,6 @@ export function prepareBoostPayload({
           allowList,
           incentives,
           protocolFee,
-          referralFee,
           maxParticipants,
           owner,
         },