chore(sdk): boostregistry.initialize, better target .isBase inference…

…, comments

.changeset/swift-rivers-deny.md

@@ -0,0 +1,5 @@
+---
+"@boostxyz/sdk": minor
+---
+
+add `BoostRegistry.initialize` as more obvious alternative name for `.clone`, make `.deploy` protected for Boost targets, await valid action steps, better `isBase` defaults, update comments

packages/sdk/src/Actions/EventAction.ts

@@ -46,8 +46,16 @@ import {
   isEventActionPayloadSimple,
   prepareEventActionPayload,
 } from '../utils';
+import type { SignatureType } from './../utils';
 
-export type { EventActionPayload };
+export type {
+  EventActionPayload,
+  ActionStep,
+  ActionClaimant,
+  SignatureType,
+  FilterType,
+  PrimitiveType,
+};
 
 /**
  * A generic event action

packages/sdk/src/AllowLists/SimpleAllowList.ts

@@ -26,6 +26,7 @@ import {
   type ReadParams,
   RegistryType,
   type SimpleAllowListPayload,
+  type WriteParams,
   prepareSimpleAllowListPayload,
 } from '../utils';
 
@@ -120,7 +121,7 @@ export class SimpleAllowList extends DeployableTarget<
   public async setAllowed(
     addresses: Address[],
     allowed: boolean[],
-    params?: ReadParams<typeof simpleAllowListAbi, 'setAllowed'>,
+    params?: WriteParams<typeof simpleAllowListAbi, 'setAllowed'>,
   ) {
     return this.awaitResult(this.setAllowedRaw(addresses, allowed, params));
   }
@@ -168,7 +169,7 @@ export class SimpleAllowList extends DeployableTarget<
   public async grantRoles(
     address: Address,
     role: bigint,
-    params?: ReadParams<typeof simpleAllowListAbi, 'grantRoles'>,
+    params?: WriteParams<typeof simpleAllowListAbi, 'grantRoles'>,
   ) {
     return this.awaitResult(this.grantRolesRaw(address, role, params));
   }

packages/sdk/src/BoostCore.ts

@@ -84,6 +84,7 @@ import {
   BoostCoreNoIdentifierEmitted,
   BudgetMustAuthorizeBoostCore,
   DeployableUnknownOwnerProvidedError,
+  IncentiveNotCloneableError,
   NoContractAddressUponReceiptError,
 } from './errors';
 import {
@@ -247,7 +248,8 @@ export class BoostCore extends Deployable<
     }
     //@ts-expect-error I can't set this property on the class because for some reason it takes super out of constructor scope?
     this.abi = boostCoreAbi;
-  } /**
+  }
+  /**
    * Create a new Boost.
    *
    * @public
@@ -404,6 +406,7 @@ export class BoostCore extends Deployable<
       const incentive = incentives.at(i)!;
       if (incentive.address) {
         const isBase = incentive.address === incentive.base || incentive.isBase;
+        if (!isBase) throw new IncentiveNotCloneableError(incentive);
         incentivesPayloads[i] = {
           isBase: isBase,
           instance: incentive.address,

packages/sdk/src/BoostRegistry.ts

@@ -227,6 +227,27 @@ export class BoostRegistry extends Deployable<
     return { hash, result };
   }
 
+  /**
+   * Initialize a new instance of a registered base implementation, returning the provided target with a new address set on it.
+   * This method is the same as `clone`, but serves to make its function more obvious as to why you'd need to use it.
+   *
+   * @public
+   * @async
+   * @template {DeployableTarget} Target
+   * @param {string} displayName - The display name for the clone
+   * @param {Target} target - An instance of a target contract to clone and initialize
+   * @param {?WriteParams<typeof boostRegistryAbi, 'deployClone'>} [params]
+   * @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>>(
+    displayName: string,
+    target: Target,
+    params?: WriteParams<typeof boostRegistryAbi, 'deployClone'>,
+  ): Promise<Target> {
+    return this.clone(displayName, target, params);
+  }
+
   /**
    * Deploy a new instance of a registered base implementation, returning the provided target with a new address set on it.
    *

packages/sdk/src/Deployable/Deployable.ts

@@ -140,6 +140,9 @@ export class Deployable<
 
   /**
    * High level deployment function to deploy and await the contract address.
+   * This is mainly a convenience method to easily deploy a contract, but will not initialize a `Cloneable`,
+   * which makes it useless for Boost components.
+   * Obviously you can ignore the TS warnings and use this, but you shouldn't in most all cases.
    *
    * @public
    * @async
@@ -148,7 +151,7 @@ export class Deployable<
    * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams] - See [viem.WaitForTransactionReceipt](https://v1.viem.sh/docs/actions/public/waitForTransactionReceipt.html#waitfortransactionreceipt)
    * @returns {unknown}
    */
-  public async deploy(
+  protected async deploy(
     _payload?: Payload,
     _options?: DeployableOptions,
     waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>,
@@ -165,6 +168,9 @@ export class Deployable<
 
   /**
    * The lower level contract deployment function that does not await for the transaction receipt.
+   * This is mainly a convenience method to easily deploy a contract, but will not initialize a `Cloneable`,
+   * which makes it useless for Boost components.
+   * Obviously you can ignore the TS warnings and use this, but you shouldn't in most all cases.
    *
    * @public
    * @async
@@ -175,7 +181,7 @@ export class Deployable<
    * @throws {@link DeployableWagmiConfigurationRequiredError}
    * @throws {@link DeployableMissingPayloadError}
    */
-  public async deployRaw(
+  protected async deployRaw(
     _payload?: Payload,
     _options?: DeployableOptions,
   ): Promise<Hash> {

packages/sdk/src/Deployable/DeployableTarget.ts

@@ -10,6 +10,7 @@ import {
   type Hash,
   type Hex,
   type WaitForTransactionReceiptParameters,
+  isAddress,
   zeroAddress,
 } from 'viem';
 import {
@@ -58,7 +59,11 @@ export class DeployableTarget<
    * @readonly
    * @type {boolean}
    */
-  readonly isBase: boolean = true;
+  protected _isBase = true;
+  get isBase() {
+    if (!!this.address && this.address !== this.base) return false;
+    return this._isBase;
+  }
 
   /**
    * Creates an instance of DeployableTarget.
@@ -74,7 +79,15 @@ export class DeployableTarget<
     isBase?: boolean,
   ) {
     super(options, payload);
-    if (isBase !== undefined) this.isBase = isBase;
+    // if supplying a custom address, safe enough to assume it is not a base address which makes reusing contracts like budgets easier
+    if (
+      typeof payload === 'string' &&
+      isAddress(payload) &&
+      payload !== this.base &&
+      payload !== zeroAddress
+    )
+      isBase = false;
+    if (isBase !== undefined) this._isBase = isBase;
   }
 
   /**
@@ -109,7 +122,7 @@ export class DeployableTarget<
    * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams]
    * @returns {unknown}
    */
-  public override async deploy(
+  protected override async deploy(
     payload?: Payload,
     options?: DeployableOptions,
     waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>,
@@ -128,7 +141,7 @@ export class DeployableTarget<
    * @param {?DeployableOptions} [_options]
    * @returns {Promise<Hash>}
    */
-  public override async deployRaw(
+  protected override async deployRaw(
     _payload?: Payload,
     _options?: DeployableOptions,
   ): Promise<Hash> {