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

package/src/BoostRegistry.ts

@@ -21,15 +21,15 @@ import {
   type GenericDeployableParams,
 } from './Deployable/Deployable';
 import type { DeployableTarget } from './Deployable/DeployableTarget';
-import {
-  type GenericLog,
-  type HashAndSimulatedResult,
-  type ReadParams,
+import type {
+  GenericLog,
+  HashAndSimulatedResult,
+  ReadParams,
   RegistryType,
-  type WriteParams,
+  WriteParams,
 } from './utils';
 
-export { RegistryType, boostRegistryAbi };
+export { boostRegistryAbi };
 
 /**
  * The fixed address for the Boost Registry.
@@ -192,7 +192,7 @@ export class BoostRegistry extends Deployable<
     implementation: Address,
     params?: WriteParams<typeof boostRegistryAbi, 'register'>,
   ) {
-    return this.awaitResult(
+    return await this.awaitResult(
       this.registerRaw(registryType, name, implementation, params),
     );
   }
@@ -240,7 +240,7 @@ export class BoostRegistry extends Deployable<
    * @returns {Target} - The provided instance, but with a new address attached.
    * biome-ignore lint/suspicious/noExplicitAny: any deployable target will suffice
    */
-  public async initialize<Target extends DeployableTarget<any, any>>(
+  public initialize<Target extends DeployableTarget<any, any>>(
     displayName: string,
     target: Target,
     params?: WriteParams<typeof boostRegistryAbi, 'deployClone'>,
@@ -286,7 +286,9 @@ export class BoostRegistry extends Deployable<
     target: Target,
     params?: WriteParams<typeof boostRegistryAbi, 'deployClone'>,
   ): Promise<Address> {
-    return this.awaitResult(this.deployCloneRaw(displayName, target, params));
+    return await this.awaitResult(
+      this.deployCloneRaw(displayName, target, params),
+    );
   }
 
   /**
@@ -312,12 +314,7 @@ export class BoostRegistry extends Deployable<
       this._config,
       {
         address: this.assertValidAddress(),
-        args: [
-          target.registryType,
-          target.base,
-          displayName,
-          payload.args.at(0)!,
-        ],
+        args: [target.registryType, target.base, displayName, payload.args[0]],
         ...this.optionallyAttachAccount(),
         // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
         ...(params as any),
@@ -341,7 +338,7 @@ export class BoostRegistry extends Deployable<
     identifier: Hex,
     params?: ReadParams<typeof boostRegistryAbi, 'getBaseImplementation'>,
   ) {
-    return readBoostRegistryGetBaseImplementation(this._config, {
+    return await readBoostRegistryGetBaseImplementation(this._config, {
       address: this.assertValidAddress(),
       args: [identifier],
       ...this.optionallyAttachAccount(),
@@ -351,7 +348,7 @@ export class BoostRegistry extends Deployable<
   }
 
   /**
-   * Get the address of a deployed clone by its identifier (index in incentives array)
+   * Get the address of a deployed clone by its identifier
    *
    * @public
    * @async
@@ -363,7 +360,7 @@ export class BoostRegistry extends Deployable<
     identifier: Hex,
     params?: ReadParams<typeof boostRegistryAbi, 'getClone'>,
   ) {
-    return readBoostRegistryGetBaseImplementation(this._config, {
+    return await readBoostRegistryGetBaseImplementation(this._config, {
       address: this.assertValidAddress(),
       args: [identifier],
       ...this.optionallyAttachAccount(),
@@ -379,13 +376,13 @@ export class BoostRegistry extends Deployable<
    * @async
    * @param {Address} deployer - The address of the deployer
    * @param {?ReadParams<typeof boostRegistryAbi, 'getClones'>} [params]
-   * @returns {Promise<Address[]>} - The list of deployed clones for the given deployer
+   * @returns {Promise<Hex[]>} - The list of deployed clones for the given deployer
    */
   public async getClones(
     deployer: Address,
     params?: ReadParams<typeof boostRegistryAbi, 'getClones'>,
   ) {
-    return readBoostRegistryGetClones(this._config, {
+    return await readBoostRegistryGetClones(this._config, {
       address: this.assertValidAddress(),
       args: [deployer],
       ...this.optionallyAttachAccount(),
@@ -413,7 +410,7 @@ export class BoostRegistry extends Deployable<
     displayName: string,
     params?: ReadParams<typeof boostRegistryAbi, 'getCloneIdentifier'>,
   ) {
-    return readBoostRegistryGetCloneIdentifier(this._config, {
+    return await readBoostRegistryGetCloneIdentifier(this._config, {
       address: this.assertValidAddress(),
       args: [registryType, base, deployer, displayName],
       ...this.optionallyAttachAccount(),
@@ -437,7 +434,7 @@ export class BoostRegistry extends Deployable<
     displayName: string,
     params?: ReadParams<typeof boostRegistryAbi, 'getIdentifier'>,
   ) {
-    return readBoostRegistryGetCloneIdentifier(this._config, {
+    return await readBoostRegistryGetCloneIdentifier(this._config, {
       address: this.assertValidAddress(),
       args: [registryType, displayName],
       ...this.optionallyAttachAccount(),

package/src/Budgets/ManagedBudget.ts

@@ -29,6 +29,8 @@ import {
   type Address,
   type ContractEventName,
   type Hex,
+  encodeAbiParameters,
+  parseAbiParameters,
   zeroAddress,
 } from 'viem';
 import type {
@@ -43,22 +45,46 @@ import {
 import {
   type ERC1155TransferPayload,
   type FungibleTransferPayload,
+  prepareERC1155Transfer,
+  prepareFungibleTransfer,
+} from '../transfers';
+import {
   type GenericLog,
-  type ManagedBudgetPayload,
   type ReadParams,
   RegistryType,
   type WriteParams,
-  prepareERC1155Transfer,
-  prepareFungibleTransfer,
-  prepareManagedBudgetPayload,
 } from '../utils';
 
 export { managedBudgetAbi };
-export type {
-  ERC1155TransferPayload,
-  FungibleTransferPayload,
-  ManagedBudgetPayload,
-};
+export type { ERC1155TransferPayload, FungibleTransferPayload };
+
+/**
+ * The object representation of a `ManagedBudgetPayload.InitPayload`
+ *
+ * @export
+ * @interface ManagedBudgetPayload
+ * @typedef {ManagedBudgetPayload}
+ */
+export interface ManagedBudgetPayload {
+  /**
+   * The budget's owner
+   *
+   * @type {Address}
+   */
+  owner: Address;
+  /**
+   * List of accounts authorized to use the budget. This list should include a Boost core address to interact with the protocol.
+   *
+   * @type {Address[]}
+   */
+  authorized: Address[];
+  /**
+   * List of roles to assign to the corresponding account by index.
+   *
+   * @type {bigint[]}
+   */
+  roles: bigint[];
+}
 
 /**
  * Enum representing available roles for use in the `ManagedBudget`.
@@ -185,7 +211,7 @@ export class ManagedBudget extends DeployableTarget<
     transfer: FungibleTransferPayload | ERC1155TransferPayload,
     params?: WriteParams<typeof managedBudgetAbi, 'allocate'>,
   ) {
-    return this.awaitResult(this.allocateRaw(transfer, params));
+    return await this.awaitResult(this.allocateRaw(transfer, params));
   }
 
   /**
@@ -233,7 +259,7 @@ export class ManagedBudget extends DeployableTarget<
     transfer: FungibleTransferPayload | ERC1155TransferPayload,
     params?: WriteParams<typeof managedBudgetAbi, 'clawback'>,
   ) {
-    return this.awaitResult(this.clawbackRaw(transfer, params));
+    return await this.awaitResult(this.clawbackRaw(transfer, params));
   }
 
   /**
@@ -280,7 +306,7 @@ export class ManagedBudget extends DeployableTarget<
     transfer: FungibleTransferPayload | ERC1155TransferPayload,
     params?: WriteParams<typeof managedBudgetAbi, 'disburse'>,
   ) {
-    return this.awaitResult(this.disburseRaw(transfer, params));
+    return await this.awaitResult(this.disburseRaw(transfer, params));
   }
 
   /**
@@ -324,7 +350,7 @@ export class ManagedBudget extends DeployableTarget<
     transfers: Array<FungibleTransferPayload | ERC1155TransferPayload>,
     params?: WriteParams<typeof managedBudgetAbi, 'disburseBatch'>,
   ) {
-    return this.awaitResult(this.disburseBatchRaw(transfers, params));
+    return await this.awaitResult(this.disburseBatchRaw(transfers, params));
   }
 
   /**
@@ -370,7 +396,9 @@ export class ManagedBudget extends DeployableTarget<
     allowed: boolean[],
     params?: WriteParams<typeof managedBudgetAbi, 'setAuthorized'>,
   ) {
-    return this.awaitResult(this.setAuthorizedRaw(addresses, allowed, params));
+    return await this.awaitResult(
+      this.setAuthorizedRaw(addresses, allowed, params),
+    );
   }
 
   /**
@@ -422,7 +450,7 @@ export class ManagedBudget extends DeployableTarget<
     roles: bigint[],
     params?: WriteParams<typeof managedBudgetAbi, 'grantRoles'>,
   ) {
-    return this.awaitResult(this.grantRolesRaw(addresses, roles, params));
+    return await this.awaitResult(this.grantRolesRaw(addresses, roles, params));
   }
 
   /**
@@ -481,7 +509,9 @@ export class ManagedBudget extends DeployableTarget<
     roles: bigint[],
     params?: WriteParams<typeof managedBudgetAbi, 'revokeRoles'>,
   ) {
-    return this.awaitResult(this.revokeRolesRaw(addresses, roles, params));
+    return await this.awaitResult(
+      this.revokeRolesRaw(addresses, roles, params),
+    );
   }
 
   /**
@@ -741,3 +771,26 @@ export class ManagedBudget extends DeployableTarget<
     };
   }
 }
+
+/**
+ * Given a {@link ManagedBudgetPayload}, properly encode a `ManagedBudget.InitPayload` for use with {@link ManagedBudget} initialization.
+ *
+ * @param {ManagedBudgetPayload} param0
+ * @param {Address} param0.owner - The budget's owner
+ * @param {{}} param0.authorized - List of accounts authorized to use the budget. This list should include a Boost core address to interact with the protocol.
+ * @param {{}} param0.roles - List of roles to assign to the corresponding account by index.
+ * @returns {*}
+ */
+export const prepareManagedBudgetPayload = ({
+  owner,
+  authorized,
+  roles,
+}: ManagedBudgetPayload) => {
+  return encodeAbiParameters(
+    parseAbiParameters([
+      'ManagedBudgetPayload payload',
+      'struct ManagedBudgetPayload { address owner; address[] authorized; uint256[] roles; }',
+    ]),
+    [{ owner, authorized, roles }],
+  );
+};

package/src/Budgets/SimpleBudget.ts

@@ -22,6 +22,8 @@ import {
   type Address,
   type ContractEventName,
   type Hex,
+  encodeAbiParameters,
+  parseAbiParameters,
   zeroAddress,
 } from 'viem';
 import type {
@@ -36,22 +38,40 @@ import {
 import {
   type ERC1155TransferPayload,
   type FungibleTransferPayload,
+  prepareERC1155Transfer,
+  prepareFungibleTransfer,
+} from '../transfers';
+import {
   type GenericLog,
   type ReadParams,
   RegistryType,
-  type SimpleBudgetPayload,
   type WriteParams,
-  prepareERC1155Transfer,
-  prepareFungibleTransfer,
-  prepareSimpleBudgetPayload,
 } from '../utils';
 
 export { simpleBudgetAbi };
-export type {
-  ERC1155TransferPayload,
-  FungibleTransferPayload,
-  SimpleBudgetPayload,
-};
+export type { ERC1155TransferPayload, FungibleTransferPayload };
+
+/**
+ * The object representation of a `SimpleBudgetPayload.InitPayload`
+ *
+ * @export
+ * @interface SimpleBudgetPayload
+ * @typedef {SimpleBudgetPayload}
+ */
+export interface SimpleBudgetPayload {
+  /**
+   * The budget's owner
+   *
+   * @type {Address}
+   */
+  owner: Address;
+  /**
+   * List of accounts authorized to use the budget. This list should include a Boost core address to interact with the protocol.
+   *
+   * @type {Address[]}
+   */
+  authorized: Address[];
+}
 
 /**
  * A generic `viem.Log` event with support for `SimpleBudget` event types.
@@ -159,7 +179,7 @@ export class SimpleBudget extends DeployableTarget<
     transfer: FungibleTransferPayload | ERC1155TransferPayload,
     params?: WriteParams<typeof simpleBudgetAbi, 'allocate'>,
   ) {
-    return this.awaitResult(this.allocateRaw(transfer, params));
+    return await this.awaitResult(this.allocateRaw(transfer, params));
   }
 
   /**
@@ -207,7 +227,7 @@ export class SimpleBudget extends DeployableTarget<
     transfer: FungibleTransferPayload | ERC1155TransferPayload,
     params?: WriteParams<typeof simpleBudgetAbi, 'clawback'>,
   ) {
-    return this.awaitResult(this.clawbackRaw(transfer, params));
+    return await this.awaitResult(this.clawbackRaw(transfer, params));
   }
 
   /**
@@ -254,7 +274,7 @@ export class SimpleBudget extends DeployableTarget<
     transfer: FungibleTransferPayload | ERC1155TransferPayload,
     params?: WriteParams<typeof simpleBudgetAbi, 'disburse'>,
   ) {
-    return this.awaitResult(this.disburseRaw(transfer, params));
+    return await this.awaitResult(this.disburseRaw(transfer, params));
   }
 
   /**
@@ -298,7 +318,7 @@ export class SimpleBudget extends DeployableTarget<
     transfers: Array<FungibleTransferPayload | ERC1155TransferPayload>,
     params?: WriteParams<typeof simpleBudgetAbi, 'disburseBatch'>,
   ) {
-    return this.awaitResult(this.disburseBatchRaw(transfers, params));
+    return await this.awaitResult(this.disburseBatchRaw(transfers, params));
   }
 
   /**
@@ -344,7 +364,9 @@ export class SimpleBudget extends DeployableTarget<
     allowed: boolean[],
     params?: WriteParams<typeof simpleBudgetAbi, 'setAuthorized'>,
   ) {
-    return this.awaitResult(this.setAuthorizedRaw(addresses, allowed, params));
+    return await this.awaitResult(
+      this.setAuthorizedRaw(addresses, allowed, params),
+    );
   }
 
   /**
@@ -519,3 +541,24 @@ export class SimpleBudget extends DeployableTarget<
     };
   }
 }
+
+/**
+ * Given a {@link SimpleBudgetPayload}, properly encode a `SimpleBudget.InitPayload` for use with {@link SimpleBudget} initialization.
+ *
+ * @param {SimpleBudgetPayload} param0
+ * @param {Address} param0.owner - The budget's owner
+ * @param {{}} param0.authorized - List of accounts authorized to use the budget. This list should include a Boost core address to interact with the protocol.
+ * @returns {*}
+ */
+export const prepareSimpleBudgetPayload = ({
+  owner,
+  authorized,
+}: SimpleBudgetPayload) => {
+  return encodeAbiParameters(
+    parseAbiParameters([
+      'SimpleBudgetPayload payload',
+      'struct SimpleBudgetPayload { address owner; address[] authorized; }',
+    ]),
+    [{ owner, authorized }],
+  );
+};

package/src/Budgets/VestingBudget.ts

@@ -26,6 +26,8 @@ import {
   type Address,
   type ContractEventName,
   type Hex,
+  encodeAbiParameters,
+  parseAbiParameters,
   zeroAddress,
 } from 'viem';
 import type {
@@ -36,17 +38,56 @@ import { DeployableTarget } from '../Deployable/DeployableTarget';
 import { DeployableUnknownOwnerProvidedError } from '../errors';
 import {
   type FungibleTransferPayload,
+  prepareFungibleTransfer,
+} from '../transfers';
+import {
   type GenericLog,
   type ReadParams,
   RegistryType,
-  type VestingBudgetPayload,
   type WriteParams,
-  prepareFungibleTransfer,
-  prepareVestingBudgetPayload,
 } from '../utils';
 
 export { vestingBudgetAbi };
-export type { VestingBudgetPayload };
+export type { FungibleTransferPayload };
+/**
+ * The object representation of a `VestingBudget.InitPayload`
+ *
+ * @export
+ * @interface VestingBudgetPayload
+ * @typedef {VestingBudgetPayload}
+ */
+export interface VestingBudgetPayload {
+  /**
+   * The budget's owner.
+   *
+   * @type {Address}
+   */
+  owner: Address;
+  /**
+   * List of accounts authorized to use the budget. This list should include a Boost core address to interact with the protocol.
+   *
+   * @type {Address[]}
+   */
+  authorized: Address[];
+  /**
+   * The timestamp at which the vesting schedule begins
+   *
+   * @type {bigint}
+   */
+  start: bigint;
+  /**
+   * The duration of the vesting schedule (in seconds)
+   *
+   * @type {bigint}
+   */
+  duration: bigint;
+  /**
+   * The duration of the cliff period (in seconds)
+   *
+   * @type {bigint}
+   */
+  cliff: bigint;
+}
 
 /**
  * A generic `viem.Log` event with support for `VestingBudget` event types.
@@ -178,7 +219,7 @@ export class VestingBudget extends DeployableTarget<
     transfer: FungibleTransferPayload,
     params?: WriteParams<typeof vestingBudgetAbi, 'allocate'>,
   ) {
-    return this.awaitResult(this.allocateRaw(transfer, params));
+    return await this.awaitResult(this.allocateRaw(transfer, params));
   }
 
   /**
@@ -226,7 +267,7 @@ export class VestingBudget extends DeployableTarget<
     transfer: FungibleTransferPayload,
     params?: WriteParams<typeof vestingBudgetAbi, 'clawback'>,
   ) {
-    return this.awaitResult(this.clawbackRaw(transfer, params));
+    return await this.awaitResult(this.clawbackRaw(transfer, params));
   }
 
   /**
@@ -273,7 +314,7 @@ export class VestingBudget extends DeployableTarget<
     transfer: FungibleTransferPayload,
     params?: WriteParams<typeof vestingBudgetAbi, 'disburse'>,
   ) {
-    return this.awaitResult(this.disburseRaw(transfer, params));
+    return await this.awaitResult(this.disburseRaw(transfer, params));
   }
 
   /**
@@ -317,7 +358,7 @@ export class VestingBudget extends DeployableTarget<
     transfers: FungibleTransferPayload[],
     params?: WriteParams<typeof vestingBudgetAbi, 'disburseBatch'>,
   ) {
-    return this.awaitResult(this.disburseBatchRaw(transfers, params));
+    return await this.awaitResult(this.disburseBatchRaw(transfers, params));
   }
 
   /**
@@ -363,7 +404,9 @@ export class VestingBudget extends DeployableTarget<
     allowed: boolean[],
     params?: WriteParams<typeof vestingBudgetAbi, 'setAuthorized'>,
   ) {
-    return this.awaitResult(this.setAuthorizedRaw(addresses, allowed, params));
+    return await this.awaitResult(
+      this.setAuthorizedRaw(addresses, allowed, params),
+    );
   }
 
   /**
@@ -530,3 +573,30 @@ export class VestingBudget extends DeployableTarget<
     };
   }
 }
+
+/**
+ * Given a {@link VestingBudgetPayload}, properly encode a `VestingBudget.InitPayload` for use with {@link VestingBudget} initialization.
+ *
+ * @param {VestingBudgetPayload} param0
+ * @param {Address} param0.owner - The budget's owner.
+ * @param {{}} param0.authorized - List of accounts authorized to use the budget. This list should include a Boost core address to interact with the protocol.
+ * @param {bigint} param0.start - The timestamp at which the vesting schedule begins
+ * @param {bigint} param0.duration - The duration of the vesting schedule (in seconds)
+ * @param {bigint} param0.cliff - The duration of the cliff period (in seconds)
+ * @returns {Hex}
+ */
+export function prepareVestingBudgetPayload({
+  owner,
+  authorized,
+  start,
+  duration,
+  cliff,
+}: VestingBudgetPayload) {
+  return encodeAbiParameters(
+    parseAbiParameters([
+      'VestingBudgetPayload payload',
+      'struct VestingBudgetPayload { address owner; address[] authorized; uint64 start; uint64 duration; uint64 cliff; }',
+    ]),
+    [{ owner, authorized, start, duration, cliff }],
+  );
+}

package/src/Deployable/Contract.ts

@@ -224,6 +224,6 @@ export class Contract<ContractAbi extends Abi> {
     hashPromise: Promise<HashAndSimulatedResult<Result>>,
     waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>,
   ) {
-    return awaitResult(this._config, hashPromise, waitParams);
+    return await awaitResult(this._config, hashPromise, waitParams);
   }
 }

package/src/Deployable/DeployableTarget.ts

@@ -170,7 +170,7 @@ export class DeployableTarget<
     interfaceId: Hex,
     params?: ReadParams<typeof aCloneableAbi, 'supportsInterface'>,
   ) {
-    return readACloneableSupportsInterface(this._config, {
+    return await readACloneableSupportsInterface(this._config, {
       address: this.assertValidAddress(),
       ...this.optionallyAttachAccount(),
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
@@ -191,7 +191,7 @@ export class DeployableTarget<
   public async getComponentInterface(
     params?: ReadParams<typeof aCloneableAbi, 'getComponentInterface'>,
   ) {
-    return readACloneableGetComponentInterface(this._config, {
+    return await readACloneableGetComponentInterface(this._config, {
       address: this.assertValidAddress(),
       ...this.optionallyAttachAccount(),
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally

package/src/Incentives/AllowListIncentive.test.ts

@@ -9,7 +9,6 @@ import {
   freshBoost,
 } from '../../test/helpers';
 import { LIST_MANAGER_ROLE } from '../AllowLists/SimpleAllowList';
-import { prepareSignerValidatorClaimDataPayload } from '../utils';
 import { PointsIncentive } from './PointsIncentive';
 
 let fixtures: Fixtures;
@@ -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,