@boostxyz/sdk 0.0.0-alpha.11 → 0.0.0-alpha.13

package/src/BoostRegistry.ts

@@ -15,30 +15,41 @@ import {
   type Hex,
   isAddress,
 } from 'viem';
+import { BoostRegistry as BoostRegistryBases } from '../dist/deployments.json';
 import {
   Deployable,
   type DeployableOptions,
   type GenericDeployableParams,
 } from './Deployable/Deployable';
 import type { DeployableTarget } from './Deployable/DeployableTarget';
-import type {
-  GenericLog,
-  HashAndSimulatedResult,
-  ReadParams,
-  RegistryType,
-  WriteParams,
+import {
+  type GenericLog,
+  type HashAndSimulatedResult,
+  type ReadParams,
+  type RegistryType,
+  type WriteParams,
+  assertValidAddressByChainId,
 } from './utils';
 
-export { boostRegistryAbi };
-
 /**
- * The fixed address for the Boost Registry.
- * By default, `new BoostRegistry` will use this address if not otherwise provided.
+ * The address of the deployed `BoostRegistry` instance. In prerelease mode, this will be its sepolia address
  *
  * @type {Address}
  */
-export const BOOST_REGISTRY_ADDRESS: Address = import.meta.env
-  .VITE_BOOST_REGISTRY_ADDRESS;
+export const BOOST_REGISTRY_ADDRESS = (
+  BoostRegistryBases as Record<string, Address>
+)[__DEFAULT_CHAIN_ID__];
+
+/**
+ * The fixed addresses for the deployed Boost Registry.
+ * By default, `new BoostRegistry` will use the address deployed to the currently connected chain, or `BOOST_REGISTRY_ADDRESS` if not provided.
+ *
+ * @type {Record<number, Address>}
+ */
+export const BOOST_REGISTRY_ADDRESSES: Record<number, Address> = {
+  ...(BoostRegistryBases as Record<number, Address>),
+  31337: import.meta.env.VITE_BOOST_REGISTRY_ADDRESS,
+};
 
 /**
  * A record of `BoostRegistry` event names to `AbiEvent` objects for use with `getLogs`
@@ -151,6 +162,26 @@ export class BoostRegistry extends Deployable<
   never[],
   typeof boostRegistryAbi
 > {
+  /**
+   * A static property representing a map of stringified chain ID's to the address of the deployed implementation on chain
+   *
+   * @static
+   * @readonly
+   * @type {Record<string, Address>}
+   */
+  static readonly addresses: Record<number, Address> = BOOST_REGISTRY_ADDRESSES;
+
+  /**
+   * A getter that will return Boost registry's static addresses by numerical chain ID
+   *
+   * @public
+   * @readonly
+   * @type {Record<number, Address>}
+   */
+  public get addresses(): Record<number, Address> {
+    return (this.constructor as typeof BoostRegistry).addresses;
+  }
+
   /**
    * Creates an instance of BoostRegistry.
    *
@@ -167,7 +198,11 @@ export class BoostRegistry extends Deployable<
     } else if (isBoostRegistryDeployable(options)) {
       super({ account, config }, []);
     } else {
-      super({ account, config }, BOOST_REGISTRY_ADDRESS);
+      const { address } = assertValidAddressByChainId(
+        config,
+        BOOST_REGISTRY_ADDRESSES,
+      );
+      super({ account, config }, address);
     }
   }
 
@@ -216,7 +251,11 @@ export class BoostRegistry extends Deployable<
     const { request, result } = await simulateBoostRegistryRegister(
       this._config,
       {
-        address: this.assertValidAddress(),
+        ...assertValidAddressByChainId(
+          this._config,
+          this.addresses,
+          params?.chain?.id || params?.chainId,
+        ),
         args: [registryType, name, implementation],
         ...this.optionallyAttachAccount(),
         // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
@@ -310,11 +349,20 @@ export class BoostRegistry extends Deployable<
       config: this._config,
       account: this._account,
     });
+    const { address: baseAddress } = assertValidAddressByChainId(
+      this._config,
+      target.bases,
+      params?.chain?.id || params?.chainId,
+    );
     const { request, result } = await simulateBoostRegistryDeployClone(
       this._config,
       {
-        address: this.assertValidAddress(),
-        args: [target.registryType, target.base, displayName, payload.args[0]],
+        ...assertValidAddressByChainId(
+          this._config,
+          this.addresses,
+          params?.chain?.id || params?.chainId,
+        ),
+        args: [target.registryType, baseAddress, 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),
@@ -339,7 +387,11 @@ export class BoostRegistry extends Deployable<
     params?: ReadParams<typeof boostRegistryAbi, 'getBaseImplementation'>,
   ) {
     return await readBoostRegistryGetBaseImplementation(this._config, {
-      address: this.assertValidAddress(),
+      ...assertValidAddressByChainId(
+        this._config,
+        this.addresses,
+        params?.chainId,
+      ),
       args: [identifier],
       ...this.optionallyAttachAccount(),
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
@@ -361,7 +413,11 @@ export class BoostRegistry extends Deployable<
     params?: ReadParams<typeof boostRegistryAbi, 'getClone'>,
   ) {
     return await readBoostRegistryGetBaseImplementation(this._config, {
-      address: this.assertValidAddress(),
+      ...assertValidAddressByChainId(
+        this._config,
+        this.addresses,
+        params?.chainId,
+      ),
       args: [identifier],
       ...this.optionallyAttachAccount(),
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
@@ -383,7 +439,11 @@ export class BoostRegistry extends Deployable<
     params?: ReadParams<typeof boostRegistryAbi, 'getClones'>,
   ) {
     return await readBoostRegistryGetClones(this._config, {
-      address: this.assertValidAddress(),
+      ...assertValidAddressByChainId(
+        this._config,
+        this.addresses,
+        params?.chainId,
+      ),
       args: [deployer],
       ...this.optionallyAttachAccount(),
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
@@ -411,7 +471,11 @@ export class BoostRegistry extends Deployable<
     params?: ReadParams<typeof boostRegistryAbi, 'getCloneIdentifier'>,
   ) {
     return await readBoostRegistryGetCloneIdentifier(this._config, {
-      address: this.assertValidAddress(),
+      ...assertValidAddressByChainId(
+        this._config,
+        this.addresses,
+        params?.chainId,
+      ),
       args: [registryType, base, deployer, displayName],
       ...this.optionallyAttachAccount(),
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
@@ -435,7 +499,11 @@ export class BoostRegistry extends Deployable<
     params?: ReadParams<typeof boostRegistryAbi, 'getIdentifier'>,
   ) {
     return await readBoostRegistryGetCloneIdentifier(this._config, {
-      address: this.assertValidAddress(),
+      ...assertValidAddressByChainId(
+        this._config,
+        this.addresses,
+        params?.chainId,
+      ),
       args: [registryType, displayName],
       ...this.optionallyAttachAccount(),
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally

package/src/Budgets/ManagedBudget.ts

@@ -33,6 +33,7 @@ import {
   parseAbiParameters,
   zeroAddress,
 } from 'viem';
+import { ManagedBudget as ManagedBudgetBases } from '../../dist/deployments.json';
 import type {
   DeployableOptions,
   GenericDeployableParams,
@@ -54,7 +55,6 @@ import {
   RegistryType,
   type WriteParams,
 } from '../utils';
-
 export { managedBudgetAbi };
 export type { ERC1155TransferPayload, FungibleTransferPayload };
 
@@ -189,10 +189,12 @@ export class ManagedBudget extends DeployableTarget<
    *
    * @public
    * @static
-   * @type {Address}
+   * @type {Record<number, Address>}
    */
-  public static override base: Address = import.meta.env
-    .VITE_MANAGED_BUDGET_BASE;
+  public static override bases: Record<number, Address> = {
+    ...(ManagedBudgetBases as Record<number, Address>),
+    31337: import.meta.env.VITE_MANAGED_BUDGET_BASE,
+  };
   /**
    * @inheritdoc
    *

package/src/Budgets/SimpleBudget.ts

@@ -151,10 +151,11 @@ export class SimpleBudget extends DeployableTarget<
    *
    * @public
    * @static
-   * @type {Address}
+   * @type {Record<number, Address>}
    */
-  public static override base: Address = import.meta.env
-    .VITE_SIMPLE_BUDGET_BASE;
+  public static override bases: Record<number, Address> = {
+    31337: import.meta.env.VITE_SIMPLE_BUDGET_BASE,
+  };
   /**
    * @inheritdoc
    *

package/src/Budgets/VestingBudget.ts

@@ -127,10 +127,11 @@ export class VestingBudget extends DeployableTarget<
    *
    * @public
    * @static
-   * @type {Address}
+   * @type {Record<number, Address>}
    */
-  public static override base: Address = import.meta.env
-    .VITE_VESTING_BUDGET_BASE;
+  public static override bases: Record<number, Address> = {
+    31337: import.meta.env.VITE_VESTING_BUDGET_BASE,
+  };
   /**
    * @inheritdoc
    *

package/src/Deployable/DeployableTarget.ts

@@ -1,6 +1,6 @@
 import {
   type aCloneableAbi,
-  readACloneableGetComponentInterface as readACloneableGetComponentInterface,
+  readACloneableGetComponentInterface,
   readACloneableSupportsInterface,
 } from '@boostxyz/evm';
 import { deployContract } from '@wagmi/core';
@@ -11,6 +11,7 @@ import {
   type Hex,
   type WaitForTransactionReceiptParameters,
   isAddress,
+  isAddressEqual,
   zeroAddress,
 } from 'viem';
 import {
@@ -38,13 +39,13 @@ export class DeployableTarget<
   ContractAbi extends Abi,
 > extends Deployable<Payload, ContractAbi> {
   /**
-   * A static property representing the address of the base implementation on chain, used when cloning base contracts.
+   * A static property representing a map of stringified chain ID's to the address of the base implementation on chain, used when cloning base contracts.
    *
    * @static
    * @readonly
-   * @type {Address}
+   * @type {Record<string, Address>}
    */
-  static readonly base: Address = zeroAddress;
+  static readonly bases: Record<number, Address> = {};
   /**
    * The target's registry type.
    *
@@ -61,7 +62,14 @@ export class DeployableTarget<
    */
   protected _isBase = true;
   get isBase() {
-    if (!!this.address && this.address !== this.base) return false;
+    if (
+      !!this.address &&
+      Object.values(this.bases).some((base) =>
+        // biome-ignore lint/style/noNonNullAssertion: won't evaluate this if address checked and defined above
+        isAddressEqual(this.address!, base),
+      )
+    )
+      return true;
     return this._isBase;
   }
 
@@ -83,22 +91,25 @@ export class DeployableTarget<
     if (
       typeof payload === 'string' &&
       isAddress(payload) &&
-      payload !== this.base &&
-      payload !== zeroAddress
+      payload !== zeroAddress &&
+      !Object.values(this.bases).some((base) => {
+        if (!payload || !base) return false;
+        return isAddressEqual(payload, base);
+      })
     )
       isBase = false;
     if (isBase !== undefined) this._isBase = isBase;
   }
 
   /**
-   * A getter that will return the base implementation's static address
+   * A getter that will return the base implementation's static addresses by numerical chain ID
    *
    * @public
    * @readonly
-   * @type {Address}
+   * @type {Record<number, Address>}
    */
-  public get base(): Address {
-    return (this.constructor as typeof DeployableTarget).base;
+  public get bases(): Record<number, Address> {
+    return (this.constructor as typeof DeployableTarget).bases;
   }
 
   /**

package/src/Incentives/AllowListIncentive.ts

@@ -17,6 +17,7 @@ import {
   type Hex,
   encodeAbiParameters,
 } from 'viem';
+import { AllowListIncentive as AllowListIncentiveBases } from '../../dist/deployments.json';
 import { SimpleAllowList } from '../AllowLists/AllowList';
 import type {
   DeployableOptions,
@@ -92,10 +93,12 @@ 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>),
+    31337: import.meta.env.VITE_ALLOWLIST_INCENTIVE_BASE,
+  };
   /**
    * @inheritdoc
    *

package/src/Incentives/CGDAIncentive.ts

@@ -21,6 +21,7 @@ import {
   type Hex,
   encodeAbiParameters,
 } from 'viem';
+import { CGDAIncentive as CGDAIncentiveBases } from '../../dist/deployments.json';
 import type {
   DeployableOptions,
   GenericDeployableParams,
@@ -144,10 +145,12 @@ export class CGDAIncentive extends DeployableTarget<
    *
    * @public
    * @static
-   * @type {Address}
+   * @type {Record<number, Address>}
    */
-  public static override base: Address = import.meta.env
-    .VITE_CGDA_INCENTIVE_BASE;
+  public static override bases: Record<number, Address> = {
+    ...(CGDAIncentiveBases as Record<number, Address>),
+    31337: import.meta.env.VITE_CGDA_INCENTIVE_BASE,
+  };
   /**
    * @inheritdoc
    *

package/src/Incentives/ERC1155Incentive.ts

@@ -127,10 +127,11 @@ export class ERC1155Incentive extends DeployableTarget<
    *
    * @public
    * @static
-   * @type {Address}
+   * @type {Record<number, Address>}
    */
-  public static override base: Address = import.meta.env
-    .VITE_ERC1155_INCENTIVE_BASE;
+  public static override bases: Record<number, Address> = {
+    31337: import.meta.env.VITE_ERC1155_INCENTIVE_BASE,
+  };
   /**
    * @inheritdoc
    *

package/src/Incentives/ERC20Incentive.ts

@@ -24,6 +24,7 @@ import {
   type Hex,
   encodeAbiParameters,
 } from 'viem';
+import { ERC20Incentive as ERC20IncentiveBases } from '../../dist/deployments.json';
 import type {
   DeployableOptions,
   GenericDeployableParams,
@@ -110,10 +111,12 @@ export class ERC20Incentive extends DeployableTarget<
    *
    * @public
    * @static
-   * @type {Address}
+   * @type {Record<number, Address>}
    */
-  public static override base: Address = import.meta.env
-    .VITE_ERC20_INCENTIVE_BASE;
+  public static override bases: Record<number, Address> = {
+    ...(ERC20IncentiveBases as Record<number, Address>),
+    31337: import.meta.env.VITE_ERC20_INCENTIVE_BASE,
+  };
   /**
    * @inheritdoc
    *

package/src/Incentives/ERC20VariableIncentive.ts

@@ -21,6 +21,7 @@ import {
   type Hex,
   encodeAbiParameters,
 } from 'viem';
+import { ERC20VariableIncentive as ERC20VariableIncentiveBases } from '../../dist/deployments.json';
 import type {
   DeployableOptions,
   GenericDeployableParams,
@@ -96,10 +97,12 @@ export class ERC20VariableIncentive extends DeployableTarget<
    *
    * @public
    * @static
-   * @type {Address}
+   * @type {Record<number, Address>}
    */
-  public static override base: Address = import.meta.env
-    .VITE_ERC20_VARIABLE_INCENTIVE_BASE;
+  public static override bases: Record<number, Address> = {
+    ...(ERC20VariableIncentiveBases as Record<number, Address>),
+    31337: import.meta.env.VITE_ERC20_VARIABLE_INCENTIVE_BASE,
+  };
   /**
    * @inheritdoc
    *

package/src/Incentives/PointsIncentive.ts

@@ -18,6 +18,7 @@ import {
   type Hex,
   encodeAbiParameters,
 } from 'viem';
+import { PointsIncentive as PointsIncentiveBases } from '../../dist/deployments.json';
 import type {
   DeployableOptions,
   GenericDeployableParams,
@@ -105,10 +106,12 @@ export class PointsIncentive extends DeployableTarget<
    *
    * @public
    * @static
-   * @type {Address}
+   * @type {Record<number, Address>}
    */
-  public static override base: Address = import.meta.env
-    .VITE_POINTS_INCENTIVE_BASE;
+  public static override bases: Record<number, Address> = {
+    ...(PointsIncentiveBases as Record<number, Address>),
+    31337: import.meta.env.VITE_POINTS_INCENTIVE_BASE,
+  };
   /**
    * @inheritdoc
    *

package/src/Validators/SignerValidator.ts

@@ -18,6 +18,7 @@ import {
   encodeAbiParameters,
 } from 'viem';
 import { signTypedData } from 'viem/accounts';
+import { SignerValidator as SignerValidatorBases } from '../../dist/deployments.json';
 import type {
   DeployableOptions,
   GenericDeployableParams,
@@ -306,10 +307,12 @@ export class SignerValidator extends DeployableTarget<
    *
    * @public
    * @static
-   * @type {Address}
+   * @type {Record<number, Address>}
    */
-  public static override base: Address = import.meta.env
-    .VITE_SIGNER_VALIDATOR_BASE;
+  public static override bases: Record<number, Address> = {
+    ...(SignerValidatorBases as Record<number, Address>),
+    31337: import.meta.env.VITE_SIGNER_VALIDATOR_BASE,
+  };
   /**
    * @inheritdoc
    *