@boostxyz/sdk 0.0.0-alpha.2 → 0.0.0-alpha.20

package/dist/Deployable/Contract.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Contract.d.ts","sourceRoot":"","sources":["../../src/Deployable/Contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAsB,MAAM,aAAa,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,EACL,KAAK,GAAG,EACR,KAAK,OAAO,EACZ,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,mCAAmC,EACxC,KAAK,iCAAiC,EAEvC,MAAM,MAAM,CAAC;AAGd,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,sBAAsB,EAC3B,KAAK,WAAW,EAEjB,MAAM,UAAU,CAAC;AAElB;;;;;;;;GAQG;AACH,qBAAa,QAAQ,CAAC,WAAW,SAAS,GAAG;IAE3C,SAAgB,GAAG,EAAE,WAAW,CAAC;IACjC;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAC1B;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IAExC;;;;;;OAMG;gBACS,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,SAAS;IAKxD;;;;;;OAMG;IACH,IAAW,OAAO,8BAEjB;IAED;;;;;;OAMG;IACI,EAAE,CAAC,OAAO,EAAE,OAAO;IAK1B;;;;;;OAMG;IACI,UAAU,CAAC,MAAM,EAAE,MAAM;IAKhC;;;;;;OAMG;IACI,kBAAkB;IAMzB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,OAAO,CAClB,KAAK,SAAS,iBAAiB,CAAC,WAAW,CAAC,EAC5C,KAAK,CAAC,QAAQ,SAAS,eAAe,CACpC,WAAW,EACX,KAAK,CACN,GAAG,eAAe,CAAC,WAAW,EAAE,KAAK,CAAC,EAEvC,MAAM,CAAC,EAAE,IAAI,CACX,aAAa,CAAC,WAAW,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,EACvD,OAAO,GAAG,QAAQ,CACnB,GAAG;QACF,SAAS,CAAC,EAAE,KAAK,CAAC;QAClB,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC;KACtB,GACA,OAAO,CAAC,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;IA4BnD;;;;;;;;;;;;;OAaG;IACU,SAAS,CAAC,KAAK,SAAS,iBAAiB,CAAC,WAAW,CAAC,EACjE,EAAE,EAAE,CACF,GAAG,EAAE,iCAAiC,CAAC,WAAW,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,KACrE,OAAO,EACZ,MAAM,CAAC,EAAE,WAAW,CAAC,WAAW,EAAE,KAAK,CAAC,GAAG;QACzC,SAAS,CAAC,EAAE,KAAK,CAAC;KACnB;IAqBH;;;;;;;;OAQG;cACa,WAAW,CAAC,MAAM,GAAG,OAAO,EAC1C,WAAW,EAAE,OAAO,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC,EACpD,UAAU,CAAC,EAAE,IAAI,CAAC,mCAAmC,EAAE,MAAM,CAAC;CAIjE"}
+{"version":3,"file":"Contract.d.ts","sourceRoot":"","sources":["../../src/Deployable/Contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAsB,MAAM,aAAa,CAAC;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,EACL,KAAK,GAAG,EACR,KAAK,OAAO,EACZ,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,mCAAmC,EACxC,KAAK,iCAAiC,EAEvC,MAAM,MAAM,CAAC;AAGd,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,sBAAsB,EAC3B,KAAK,WAAW,EAEjB,MAAM,UAAU,CAAC;AAElB;;;;;;;;GAQG;AACH,qBAAa,QAAQ,CAAC,WAAW,SAAS,GAAG;IAE3C,SAAgB,GAAG,EAAE,WAAW,CAAC;IACjC;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAC1B;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IAExC;;;;;;OAMG;gBACS,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,SAAS;IAKxD;;;;;;OAMG;IACH,IAAW,OAAO,8BAEjB;IAED;;;;;;OAMG;IACI,EAAE,CAAC,OAAO,EAAE,OAAO;IAK1B;;;;;;OAMG;IACI,UAAU,CAAC,MAAM,EAAE,MAAM;IAKhC;;;;;;OAMG;IACI,kBAAkB;IAMzB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,OAAO,CAClB,KAAK,SAAS,iBAAiB,CAAC,WAAW,CAAC,EAC5C,KAAK,CAAC,QAAQ,SAAS,eAAe,CACpC,WAAW,EACX,KAAK,CACN,GAAG,eAAe,CAAC,WAAW,EAAE,KAAK,CAAC,EAEvC,MAAM,CAAC,EAAE,IAAI,CACX,aAAa,CAAC,WAAW,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,EACvD,OAAO,GAAG,QAAQ,CACnB,GAAG;QACF,SAAS,CAAC,EAAE,KAAK,CAAC;QAClB,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC;KACtB,GACA,OAAO,CAAC,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;IA4BnD;;;;;;;;;;;;OAYG;IACI,SAAS,CAAC,KAAK,SAAS,iBAAiB,CAAC,WAAW,CAAC,EAC3D,EAAE,EAAE,CACF,GAAG,EAAE,iCAAiC,CAAC,WAAW,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,KACrE,OAAO,EACZ,MAAM,CAAC,EAAE,WAAW,CAAC,WAAW,EAAE,KAAK,CAAC,GAAG;QACzC,SAAS,CAAC,EAAE,KAAK,CAAC;KACnB;IAqBH;;;;;;;;OAQG;cACa,WAAW,CAAC,MAAM,GAAG,OAAO,EAC1C,WAAW,EAAE,OAAO,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC,EACpD,UAAU,CAAC,EAAE,IAAI,CAAC,mCAAmC,EAAE,MAAM,CAAC;CAIjE"}

package/dist/Deployable/Contract.js

@@ -19,7 +19,7 @@ class v {
    *
    * @public
    * @readonly
-   * @type {*}
+   * @type {Address | undefined}
    */
   get address() {
     return this._address;
@@ -53,8 +53,7 @@ class v {
    */
   assertValidAddress() {
     const t = this.address;
-    if (!t)
-      throw new r();
+    if (!t) throw new r();
     return t;
   }
   /**
@@ -108,7 +107,6 @@ class v {
    * A typed wrapper for `wagmi.watchContractEvent`
    *
    * @public
-   * @async
    * @template {ContractEvent} event
    * @param {(
    *       log: WatchContractEventOnLogsParameter<ContractAbi, event, true>[number],
@@ -116,9 +114,9 @@ class v {
    * @param {?WatchParams<ContractAbi, event> & {
    *       eventName?: event;
    *     }} [params]
-   * @returns {unknown, params?: any) => unknown}
+   * @returns {() => void}
    */
-  async subscribe(t, e) {
+  subscribe(t, e) {
     return o(this._config, {
       // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally
       ...e,
@@ -138,12 +136,13 @@ class v {
    * @template [Result=unknown]
    * @param {Promise<HashAndSimulatedResult<Result>>} hashPromise
    * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams]
-   * @returns {unknown}
+   * @returns {Promise<Result>}
    */
   async awaitResult(t, e) {
-    return h(this._config, t, e);
+    return await h(this._config, t, e);
   }
 }
 export {
   v as Contract
 };
+//# sourceMappingURL=Contract.js.map

package/dist/Deployable/Contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Contract.js","sources":["../../src/Deployable/Contract.ts"],"sourcesContent":["import { type Config, watchContractEvent } from '@wagmi/core';\nimport type { ExtractAbiEvent } from 'abitype';\nimport {\n  type Abi,\n  type Address,\n  type ContractEventName,\n  type GetLogsReturnType,\n  type WaitForTransactionReceiptParameters,\n  type WatchContractEventOnLogsParameter,\n  getAbiItem,\n} from 'viem';\nimport { getLogs } from 'viem/actions';\nimport { ContractAddressRequiredError } from '../errors';\nimport {\n  type GetLogsParams,\n  type HashAndSimulatedResult,\n  type WatchParams,\n  awaitResult,\n} from '../utils';\n\n/**\n * A basic Contract class to encapsulate configuration and a potential address\n *\n * @export\n * @class Contract\n * @typedef {Contract}\n * @template {Abi} [ContractAbi=[]]\n * @template {ContractEventName<ContractAbi>} [ContractEvent=any]\n */\nexport class Contract<ContractAbi extends Abi> {\n  //@ts-expect-error this should always be set by implementing contract\n  public readonly abi: ContractAbi;\n  /**\n   * @see [Wagmi Configuration](https://wagmi.sh/core/api/createConfig)\n   * @protected\n   * @type {WagmiConfig}\n   */\n  protected _config: Config;\n  /**\n   * The internally managed address for this contract\n   *\n   * @protected\n   * @type {(Address | undefined)}\n   */\n  protected _address: Address | undefined;\n\n  /**\n   * Creates an instance of Contract.\n   *\n   * @constructor\n   * @param {Config} config\n   * @param {(Address | undefined)} address\n   */\n  constructor(config: Config, address: Address | undefined) {\n    this._config = config;\n    this._address = address;\n  }\n\n  /**\n   * A getter returning this contract's deployed address, if it exists.\n   *\n   * @public\n   * @readonly\n   * @type {Address | undefined}\n   */\n  public get address() {\n    return this._address;\n  }\n\n  /**\n   * Will set this contract's address and return the instance for chaining. Does not verify that provided address is valid.\n   *\n   * @public\n   * @param {Address} address\n   * @returns {this}\n   */\n  public at(address: Address) {\n    this._address = address;\n    return this;\n  }\n\n  /**\n   * Will set this contract's internal [Wagmi Configuration](https://en.wikipedia.org/wiki/Factorial) and return the instance for chaining.\n   *\n   * @public\n   * @param {Config} config\n   * @returns {this}\n   */\n  public withConfig(config: Config) {\n    this._config = config;\n    return this;\n  }\n\n  /**\n   * Utility function to validate the existence of an address on this Contract.\n   *\n   * @public\n   * @returns {Address}\n   * @throws {@link ContractAddressRequiredError} if no address exists on this Contract instance\n   */\n  public assertValidAddress() {\n    const address = this.address;\n    if (!address) throw new ContractAddressRequiredError();\n    return address;\n  }\n\n  /**\n   * A typed wrapper for (viem.getLogs)[https://viem.sh/docs/actions/public/getLogs#getlogs].\n   * Accepts `eventName` and `eventNames` as optional parameters to narrow the returned log types.\n   * @example\n   * ```ts\n   * const logs = contract.getLogs({ eventName: 'EventName' })\n   * const logs = contract.getLogs({ eventNames: ['EventName'] })\n   *\n   * @public\n   * @async\n   * @template {ContractEvent} event\n   * @template {ExtractAbiEvent<\n   *       ContractAbi,\n   *       event\n   *     >} [abiEvent=ExtractAbiEvent<ContractAbi, event>]\n   * @param {?Omit<\n   *       GetLogsParams<ContractAbi, event, abiEvent, abiEvent[]>,\n   *       'event' | 'events'\n   *     > & {\n   *       eventName?: event;\n   *       eventNames?: event[];\n   *     }} [params]\n   * @returns {Promise<GetLogsReturnType<abiEvent, abiEvent[]>>}\n   */\n  public async getLogs<\n    event extends ContractEventName<ContractAbi>,\n    const abiEvent extends ExtractAbiEvent<\n      ContractAbi,\n      event\n    > = ExtractAbiEvent<ContractAbi, event>,\n  >(\n    params?: Omit<\n      GetLogsParams<ContractAbi, event, abiEvent, abiEvent[]>,\n      'event' | 'events'\n    > & {\n      eventName?: event;\n      eventNames?: event[];\n    },\n  ): Promise<GetLogsReturnType<abiEvent, abiEvent[]>> {\n    return getLogs(this._config.getClient({ chainId: params?.chainId }), {\n      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wag\n      ...(params as any),\n      ...(params?.eventName\n        ? {\n            event: getAbiItem({\n              abi: this.abi,\n              name: params.eventName,\n              // biome-ignore lint/suspicious/noExplicitAny: awkward abi intersection issue\n            } as any),\n          }\n        : {}),\n      ...(params?.eventNames\n        ? {\n            events: params.eventNames.map((name) =>\n              getAbiItem({\n                abi: this.abi,\n                name,\n                // biome-ignore lint/suspicious/noExplicitAny: awkward abi intersection issue\n              } as any),\n            ),\n          }\n        : {}),\n      address: this.assertValidAddress(),\n    });\n  }\n\n  /**\n   * A typed wrapper for `wagmi.watchContractEvent`\n   *\n   * @public\n   * @template {ContractEvent} event\n   * @param {(\n   *       log: WatchContractEventOnLogsParameter<ContractAbi, event, true>[number],\n   *     ) => unknown} cb\n   * @param {?WatchParams<ContractAbi, event> & {\n   *       eventName?: event;\n   *     }} [params]\n   * @returns {() => void}\n   */\n  public subscribe<event extends ContractEventName<ContractAbi>>(\n    cb: (\n      log: WatchContractEventOnLogsParameter<ContractAbi, event, true>[number],\n    ) => unknown,\n    params?: WatchParams<ContractAbi, event> & {\n      eventName?: event;\n    },\n  ) {\n    return watchContractEvent<\n      typeof this._config,\n      (typeof this._config)['chains'][number]['id'],\n      ContractAbi,\n      event\n    >(this._config, {\n      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally\n      ...(params as any),\n      eventName: params?.eventName,\n      abi: this.abi,\n      address: this.assertValidAddress(),\n      onLogs: (logs) => {\n        for (let l of logs) {\n          cb(l);\n        }\n      },\n    });\n  }\n\n  /**\n   * @see {@link awaitResult}\n   * @protected\n   * @async\n   * @template [Result=unknown]\n   * @param {Promise<HashAndSimulatedResult<Result>>} hashPromise\n   * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams]\n   * @returns {Promise<Result>}\n   */\n  protected async awaitResult<Result = unknown>(\n    hashPromise: Promise<HashAndSimulatedResult<Result>>,\n    waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>,\n  ) {\n    return await awaitResult(this._config, hashPromise, waitParams);\n  }\n}\n"],"names":["Contract","config","address","ContractAddressRequiredError","params","getLogs","getAbiItem","name","cb","watchContractEvent","logs","l","hashPromise","waitParams","awaitResult"],"mappings":";;;;;AA6BO,MAAMA,EAAkC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwB7C,YAAYC,GAAgBC,GAA8B;AACxD,SAAK,UAAUD,GACf,KAAK,WAAWC;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,IAAW,UAAU;AACnB,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,GAAGA,GAAkB;AAC1B,gBAAK,WAAWA,GACT;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,WAAWD,GAAgB;AAChC,gBAAK,UAAUA,GACR;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,qBAAqB;AAC1B,UAAMC,IAAU,KAAK;AACrB,QAAI,CAACA,EAAe,OAAA,IAAIC;AACjB,WAAAD;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA0BA,MAAa,QAOXE,GAOkD;AAC3C,WAAAC,EAAQ,KAAK,QAAQ,UAAU,EAAE,SAASD,KAAA,gBAAAA,EAAQ,QAAQ,CAAC,GAAG;AAAA;AAAA,MAEnE,GAAIA;AAAA,MACJ,GAAIA,KAAA,QAAAA,EAAQ,YACR;AAAA,QACE,OAAOE,EAAW;AAAA,UAChB,KAAK,KAAK;AAAA,UACV,MAAMF,EAAO;AAAA;AAAA,QAAA,CAEP;AAAA,MAAA,IAEV,CAAC;AAAA,MACL,GAAIA,KAAA,QAAAA,EAAQ,aACR;AAAA,QACE,QAAQA,EAAO,WAAW;AAAA,UAAI,CAACG,MAC7BD,EAAW;AAAA,YACT,KAAK,KAAK;AAAA,YACV,MAAAC;AAAA;AAAA,UAAA,CAEM;AAAA,QACV;AAAA,MAAA,IAEF,CAAC;AAAA,MACL,SAAS,KAAK,mBAAmB;AAAA,IAAA,CAClC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeO,UACLC,GAGAJ,GAGA;AACO,WAAAK,EAKL,KAAK,SAAS;AAAA;AAAA,MAEd,GAAIL;AAAA,MACJ,WAAWA,KAAA,gBAAAA,EAAQ;AAAA,MACnB,KAAK,KAAK;AAAA,MACV,SAAS,KAAK,mBAAmB;AAAA,MACjC,QAAQ,CAACM,MAAS;AAChB,iBAASC,KAAKD;AACZ,UAAAF,EAAGG,CAAC;AAAA,MAER;AAAA,IAAA,CACD;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAgB,YACdC,GACAC,GACA;AACA,WAAO,MAAMC,EAAY,KAAK,SAASF,GAAaC,CAAU;AAAA,EAChE;AACF;"}

package/dist/Deployable/Deployable.cjs

@@ -1 +1,2 @@
 "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("@wagmi/core"),a=require("../errors.cjs"),n=require("../utils.cjs"),c=require("./Contract.cjs");class l extends c.Contract{constructor({account:t,config:e},o){typeof o=="string"?super(e,o):(super(e,void 0),this._payload=o),t&&(this._account=t)}get payload(){return this._payload}withPayload(t){return this._payload=t,this}async deploy(t,e,o){const r=(e==null?void 0:e.config)||this._config,i=await n.getDeployedContractAddress(r,this.deployRaw(t,e),o);return this._address=i,this}async deployRaw(t,e){if(this.address)throw new a.DeployableAlreadyDeployedError(this.address);const[o,r]=this.validateDeploymentConfig(t,e);return await s.deployContract(r.config,{...this.buildParameters(o),...this.optionallyAttachAccount(r.account)})}optionallyAttachAccount(t){return t?{account:t}:this._account?{account:this._account}:{}}buildParameters(t,e){throw new a.DeployableBuildParametersUnspecifiedError}validateDeploymentConfig(t,e){const o=e||{config:this._config,account:this._account};if(!o)throw new a.DeployableWagmiConfigurationRequiredError;return[t||this._payload,o]}}exports.Deployable=l;
+//# sourceMappingURL=Deployable.cjs.map

package/dist/Deployable/Deployable.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"Deployable.cjs","sources":["../../src/Deployable/Deployable.ts"],"sourcesContent":["import { type Config, deployContract } from '@wagmi/core';\nimport type {\n  Abi,\n  Account,\n  Address,\n  ContractEventName,\n  Hash,\n  Hex,\n  WaitForTransactionReceiptParameters,\n} from 'viem';\nimport {\n  DeployableAlreadyDeployedError,\n  DeployableBuildParametersUnspecifiedError,\n  DeployableMissingPayloadError,\n  DeployableWagmiConfigurationRequiredError,\n} from '../errors';\nimport { getDeployedContractAddress } from '../utils';\nimport { Contract } from './Contract';\n\n/**\n * A base class representing a deployable contract, contains base implementations for deployment and initialization payload construction.\n *\n * @export\n * @typedef {GenericDeployableParams}\n */\nexport type GenericDeployableParams = Omit<\n  Parameters<typeof deployContract>[1],\n  'args' | 'account'\n> & {\n  args: [Hex, ...Array<Hex>];\n  account?: Account;\n};\n\n/**\n * A generic type that encapsulates either an initialization payload for a contract, or a valid address for a previously deployed contract.\n *\n * @export\n * @typedef {DeployablePayloadOrAddress}\n * @template [Payload=unknown]\n */\nexport type DeployablePayloadOrAddress<Payload = unknown> = Payload | Address;\n\n/**\n * Instantion options for the base deployable.\n *\n * @export\n * @interface DeployableOptions\n * @typedef {DeployableOptions}\n */\nexport interface DeployableOptions {\n  /**\n   * [Wagmi Configuration](https://wagmi.sh/core/api/createConfig)\n   *\n   * @see {@link Config}\n   * @type {Config}\n   */\n  config: Config;\n  /**\n   * [Viem Local Account](https://viem.sh/docs/accounts/local), required if in a Node environment\n   *\n   * @see {@link Account}\n   * @type {?Account}\n   */\n  account?: Account;\n}\n\n/**\n * A generic deployable contract that encapsulates common operations related to contract deployment\n *\n * @export\n * @class Deployable\n * @typedef {Deployable}\n * @template [Payload=unknown]\n * @template {Abi} [ContractAbi=[]]\n * @template {ContractEventName<ContractAbi>} [ContractEvent=ContractEventName<ContractAbi>]\n * @extends {Contract<ContractAbi, ContractEvent>}\n */\nexport class Deployable<\n  Payload,\n  ContractAbi extends Abi,\n> extends Contract<ContractAbi> {\n  /**\n   * The deployable payload used either for contract construction or initialization\n   *\n   * @protected\n   * @type {(Payload | undefined)}\n   */\n  protected _payload: Payload | undefined;\n  /**\n   * If it exists, [Viem Local Account](https://viem.sh/docs/accounts/local), if in a Node environment\n   *\n   * @protected\n   * @type {?Account}\n   */\n  protected _account?: Account;\n\n  /**\n   * Creates an instance of Deployable.\n   *\n   * @constructor\n   * @param {DeployableOptions} param0\n   * @param {?Account} [param0.account]\n   * @param {Config} param0.config\n   * @param {DeployablePayloadOrAddress<Payload>} payload\n   */\n  constructor(\n    { account, config }: DeployableOptions,\n    payload?: DeployablePayloadOrAddress<Payload>,\n  ) {\n    if (typeof payload === 'string') {\n      super(config, payload as Address);\n    } else {\n      super(config, undefined);\n      this._payload = payload as Payload;\n    }\n    if (account) this._account = account;\n  }\n\n  /**\n   * Returns the attached deployable payload, if it exists\n   *\n   * @readonly\n   * @type {Payload}\n   */\n  get payload() {\n    return this._payload;\n  }\n\n  /**\n   * Attaches a new payload for use with this deployable's initialization\n   *\n   * @public\n   * @param {Payload} payload\n   * @returns {this}\n   */\n  public withPayload(payload: Payload) {\n    this._payload = payload;\n    return this;\n  }\n\n  /**\n   * High level deployment function to deploy and await the contract address.\n   * This is mainly a convenience method to easily deploy a contract, but will not initialize a `Cloneable`,\n   * which makes it useless for Boost components.\n   * Obviously you can ignore the TS warnings and use this, but you shouldn't in most all cases.\n   *\n   * @public\n   * @async\n   * @param {?Payload} [_payload]\n   * @param {?DeployableOptions} [_options]\n   * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams] - See [viem.WaitForTransactionReceipt](https://v1.viem.sh/docs/actions/public/waitForTransactionReceipt.html#waitfortransactionreceipt)\n   * @returns {Promise<this>}\n   */\n  protected async deploy(\n    _payload?: Payload,\n    _options?: DeployableOptions,\n    waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>,\n  ) {\n    const config = _options?.config || this._config;\n    const address = await getDeployedContractAddress(\n      config,\n      this.deployRaw(_payload, _options),\n      waitParams,\n    );\n    this._address = address;\n    return this;\n  }\n\n  /**\n   * The lower level contract deployment function that does not await for the transaction receipt.\n   * This is mainly a convenience method to easily deploy a contract, but will not initialize a `Cloneable`,\n   * which makes it useless for Boost components.\n   * Obviously you can ignore the TS warnings and use this, but you shouldn't in most all cases.\n   *\n   * @public\n   * @async\n   * @param {?Payload} [_payload]\n   * @param {?DeployableOptions} [_options]\n   * @returns {Promise<Hash>}\n   * @throws {@link DeployableAlreadyDeployedError}\n   * @throws {@link DeployableWagmiConfigurationRequiredError}\n   * @throws {@link DeployableMissingPayloadError}\n   */\n  protected async deployRaw(\n    _payload?: Payload,\n    _options?: DeployableOptions,\n  ): Promise<Hash> {\n    if (this.address) throw new DeployableAlreadyDeployedError(this.address);\n    const [payload, options] = this.validateDeploymentConfig(\n      _payload,\n      _options,\n    );\n    return await deployContract(options.config, {\n      ...this.buildParameters(payload),\n      ...this.optionallyAttachAccount(options.account),\n    });\n  }\n\n  /**\n   * Internal function to attach the connected account to write methods to avoid manually passing in an account each call.\n   *\n   * @protected\n   * @param {?Account} [account]\n   * @returns {({ account: Account; } | { account?: undefined; })}\n   */\n  protected optionallyAttachAccount(account?: Account) {\n    if (account) return { account };\n    return this._account ? { account: this._account } : {};\n  }\n\n  /**\n   * Base parameter constructor, should return a partial `viem.deployContract` parameters shape including abi, bytecode, and arguments, if any.\n   * Expected to be overridden by protocol contracts.\n   *\n   * @public\n   * @param {?Payload} [_payload]\n   * @param {?DeployableOptions} [_options]\n   * @returns {GenericDeployableParams}\n   */\n  public buildParameters(\n    _payload?: Payload,\n    _options?: DeployableOptions,\n  ): GenericDeployableParams {\n    throw new DeployableBuildParametersUnspecifiedError();\n  }\n\n  /**\n   * Internal method used to ensure that a Wagmi configuration and payload are always present when deploying.\n   *\n   * @protected\n   * @template [P=Payload]\n   * @param {?P} [_payload]\n   * @param {?DeployableOptions} [_options]\n   * @returns {[P, DeployableOptions]}\n   * @throws {@link DeployableWagmiConfigurationRequiredError}\n   * @throws {@link DeployableMissingPayloadError}\n   */\n  protected validateDeploymentConfig<P = Payload>(\n    _payload?: P,\n    _options?: DeployableOptions,\n  ) {\n    const options = _options || {\n      config: this._config,\n      account: this._account,\n    };\n    if (!options) throw new DeployableWagmiConfigurationRequiredError();\n    const payload = _payload || this._payload;\n    return [payload, options] as [P, DeployableOptions];\n  }\n}\n"],"names":["Deployable","Contract","account","config","payload","_payload","_options","waitParams","address","getDeployedContractAddress","DeployableAlreadyDeployedError","options","deployContract","DeployableBuildParametersUnspecifiedError","DeployableWagmiConfigurationRequiredError"],"mappings":"gMA6EO,MAAMA,UAGHC,EAAAA,QAAsB,CAyB9B,YACE,CAAE,QAAAC,EAAS,OAAAC,CAAA,EACXC,EACA,CACI,OAAOA,GAAY,SACrB,MAAMD,EAAQC,CAAkB,GAEhC,MAAMD,EAAQ,MAAS,EACvB,KAAK,SAAWC,GAEdF,SAAc,SAAWA,EAC/B,CAQA,IAAI,SAAU,CACZ,OAAO,KAAK,QACd,CASO,YAAYE,EAAkB,CACnC,YAAK,SAAWA,EACT,IACT,CAeA,MAAgB,OACdC,EACAC,EACAC,EACA,CACM,MAAAJ,GAASG,GAAA,YAAAA,EAAU,SAAU,KAAK,QAClCE,EAAU,MAAMC,EAAA,2BACpBN,EACA,KAAK,UAAUE,EAAUC,CAAQ,EACjCC,CAAA,EAEF,YAAK,SAAWC,EACT,IACT,CAiBA,MAAgB,UACdH,EACAC,EACe,CACf,GAAI,KAAK,QAAS,MAAM,IAAII,EAAAA,+BAA+B,KAAK,OAAO,EACvE,KAAM,CAACN,EAASO,CAAO,EAAI,KAAK,yBAC9BN,EACAC,CAAA,EAEK,OAAA,MAAMM,EAAAA,eAAeD,EAAQ,OAAQ,CAC1C,GAAG,KAAK,gBAAgBP,CAAO,EAC/B,GAAG,KAAK,wBAAwBO,EAAQ,OAAO,CAAA,CAChD,CACH,CASU,wBAAwBT,EAAmB,CAC/C,OAAAA,EAAgB,CAAE,QAAAA,GACf,KAAK,SAAW,CAAE,QAAS,KAAK,UAAa,EACtD,CAWO,gBACLG,EACAC,EACyB,CACzB,MAAM,IAAIO,EAA0C,yCACtD,CAaU,yBACRR,EACAC,EACA,CACA,MAAMK,EAAUL,GAAY,CAC1B,OAAQ,KAAK,QACb,QAAS,KAAK,QAAA,EAEhB,GAAI,CAACK,EAAe,MAAA,IAAIG,EAAAA,0CAEjB,MAAA,CADST,GAAY,KAAK,SAChBM,CAAO,CAC1B,CACF"}

package/dist/Deployable/Deployable.d.ts

@@ -95,17 +95,23 @@ export declare class Deployable<Payload, ContractAbi extends Abi> extends Contra
     withPayload(payload: Payload): this;
     /**
      * 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
      * @param {?Payload} [_payload]
      * @param {?DeployableOptions} [_options]
      * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams] - See [viem.WaitForTransactionReceipt](https://v1.viem.sh/docs/actions/public/waitForTransactionReceipt.html#waitfortransactionreceipt)
-     * @returns {unknown}
+     * @returns {Promise<this>}
      */
-    deploy(_payload?: Payload, _options?: DeployableOptions, waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>): Promise<this>;
+    protected deploy(_payload?: Payload, _options?: DeployableOptions, waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>): Promise<this>;
     /**
      * 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
@@ -116,7 +122,7 @@ export declare class Deployable<Payload, ContractAbi extends Abi> extends Contra
      * @throws {@link DeployableWagmiConfigurationRequiredError}
      * @throws {@link DeployableMissingPayloadError}
      */
-    deployRaw(_payload?: Payload, _options?: DeployableOptions): Promise<Hash>;
+    protected deployRaw(_payload?: Payload, _options?: DeployableOptions): Promise<Hash>;
     /**
      * Internal function to attach the connected account to write methods to avoid manually passing in an account each call.
      *

package/dist/Deployable/Deployable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Deployable.d.ts","sourceRoot":"","sources":["../../src/Deployable/Deployable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,KAAK,EACV,GAAG,EACH,OAAO,EACP,OAAO,EAEP,IAAI,EACJ,GAAG,EACH,mCAAmC,EACpC,MAAM,MAAM,CAAC;AAQd,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG,IAAI,CACxC,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC,EACpC,MAAM,GAAG,SAAS,CACnB,GAAG;IACF,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,0BAA0B,CAAC,OAAO,GAAG,OAAO,IAAI,OAAO,GAAG,OAAO,CAAC;AAE9E;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;;;;GAUG;AACH,qBAAa,UAAU,CACrB,OAAO,EACP,WAAW,SAAS,GAAG,CACvB,SAAQ,QAAQ,CAAC,WAAW,CAAC;IAC7B;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;;;;OAQG;gBAED,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,iBAAiB,EACtC,OAAO,CAAC,EAAE,0BAA0B,CAAC,OAAO,CAAC;IAW/C;;;;;OAKG;IACH,IAAI,OAAO,wBAEV;IAED;;;;;;OAMG;IACI,WAAW,CAAC,OAAO,EAAE,OAAO;IAKnC;;;;;;;;;OASG;IACU,MAAM,CACjB,QAAQ,CAAC,EAAE,OAAO,EAClB,QAAQ,CAAC,EAAE,iBAAiB,EAC5B,UAAU,CAAC,EAAE,IAAI,CAAC,mCAAmC,EAAE,MAAM,CAAC;IAYhE;;;;;;;;;;;OAWG;IACU,SAAS,CACpB,QAAQ,CAAC,EAAE,OAAO,EAClB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,OAAO,CAAC,IAAI,CAAC;IAYhB;;;;;;OAMG;IACH,SAAS,CAAC,uBAAuB,CAAC,OAAO,CAAC,EAAE,OAAO;;;;;IAKnD;;;;;;;;OAQG;IACI,eAAe,CACpB,QAAQ,CAAC,EAAE,OAAO,EAClB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,uBAAuB;IAI1B;;;;;;;;;;OAUG;IACH,SAAS,CAAC,wBAAwB,CAAC,CAAC,GAAG,OAAO,EAC5C,QAAQ,CAAC,EAAE,CAAC,EACZ,QAAQ,CAAC,EAAE,iBAAiB;CAU/B"}
+{"version":3,"file":"Deployable.d.ts","sourceRoot":"","sources":["../../src/Deployable/Deployable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,KAAK,EACV,GAAG,EACH,OAAO,EACP,OAAO,EAEP,IAAI,EACJ,GAAG,EACH,mCAAmC,EACpC,MAAM,MAAM,CAAC;AAQd,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG,IAAI,CACxC,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC,EACpC,MAAM,GAAG,SAAS,CACnB,GAAG;IACF,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,0BAA0B,CAAC,OAAO,GAAG,OAAO,IAAI,OAAO,GAAG,OAAO,CAAC;AAE9E;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;;;;GAUG;AACH,qBAAa,UAAU,CACrB,OAAO,EACP,WAAW,SAAS,GAAG,CACvB,SAAQ,QAAQ,CAAC,WAAW,CAAC;IAC7B;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IACxC;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;;;;OAQG;gBAED,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,iBAAiB,EACtC,OAAO,CAAC,EAAE,0BAA0B,CAAC,OAAO,CAAC;IAW/C;;;;;OAKG;IACH,IAAI,OAAO,wBAEV;IAED;;;;;;OAMG;IACI,WAAW,CAAC,OAAO,EAAE,OAAO;IAKnC;;;;;;;;;;;;OAYG;cACa,MAAM,CACpB,QAAQ,CAAC,EAAE,OAAO,EAClB,QAAQ,CAAC,EAAE,iBAAiB,EAC5B,UAAU,CAAC,EAAE,IAAI,CAAC,mCAAmC,EAAE,MAAM,CAAC;IAYhE;;;;;;;;;;;;;;OAcG;cACa,SAAS,CACvB,QAAQ,CAAC,EAAE,OAAO,EAClB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,OAAO,CAAC,IAAI,CAAC;IAYhB;;;;;;OAMG;IACH,SAAS,CAAC,uBAAuB,CAAC,OAAO,CAAC,EAAE,OAAO;;;;;IAKnD;;;;;;;;OAQG;IACI,eAAe,CACpB,QAAQ,CAAC,EAAE,OAAO,EAClB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,uBAAuB;IAI1B;;;;;;;;;;OAUG;IACH,SAAS,CAAC,wBAAwB,CAAC,CAAC,GAAG,OAAO,EAC5C,QAAQ,CAAC,EAAE,CAAC,EACZ,QAAQ,CAAC,EAAE,iBAAiB,GAQC,CAAC,CAAC,EAAE,iBAAiB,CAAC;CAEtD"}

package/dist/Deployable/Deployable.js

@@ -36,13 +36,16 @@ class m extends d {
   }
   /**
    * 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
    * @param {?Payload} [_payload]
    * @param {?DeployableOptions} [_options]
    * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams] - See [viem.WaitForTransactionReceipt](https://v1.viem.sh/docs/actions/public/waitForTransactionReceipt.html#waitfortransactionreceipt)
-   * @returns {unknown}
+   * @returns {Promise<this>}
    */
   async deploy(t, o, a) {
     const e = (o == null ? void 0 : o.config) || this._config, r = await c(
@@ -54,6 +57,9 @@ class m extends d {
   }
   /**
    * 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
@@ -65,8 +71,7 @@ class m extends d {
    * @throws {@link DeployableMissingPayloadError}
    */
   async deployRaw(t, o) {
-    if (this.address)
-      throw new s(this.address);
+    if (this.address) throw new s(this.address);
     const [a, e] = this.validateDeploymentConfig(
       t,
       o
@@ -114,11 +119,11 @@ class m extends d {
       config: this._config,
       account: this._account
     };
-    if (!a)
-      throw new l();
+    if (!a) throw new l();
     return [t || this._payload, a];
   }
 }
 export {
   m as Deployable
 };
+//# sourceMappingURL=Deployable.js.map

package/dist/Deployable/Deployable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Deployable.js","sources":["../../src/Deployable/Deployable.ts"],"sourcesContent":["import { type Config, deployContract } from '@wagmi/core';\nimport type {\n  Abi,\n  Account,\n  Address,\n  ContractEventName,\n  Hash,\n  Hex,\n  WaitForTransactionReceiptParameters,\n} from 'viem';\nimport {\n  DeployableAlreadyDeployedError,\n  DeployableBuildParametersUnspecifiedError,\n  DeployableMissingPayloadError,\n  DeployableWagmiConfigurationRequiredError,\n} from '../errors';\nimport { getDeployedContractAddress } from '../utils';\nimport { Contract } from './Contract';\n\n/**\n * A base class representing a deployable contract, contains base implementations for deployment and initialization payload construction.\n *\n * @export\n * @typedef {GenericDeployableParams}\n */\nexport type GenericDeployableParams = Omit<\n  Parameters<typeof deployContract>[1],\n  'args' | 'account'\n> & {\n  args: [Hex, ...Array<Hex>];\n  account?: Account;\n};\n\n/**\n * A generic type that encapsulates either an initialization payload for a contract, or a valid address for a previously deployed contract.\n *\n * @export\n * @typedef {DeployablePayloadOrAddress}\n * @template [Payload=unknown]\n */\nexport type DeployablePayloadOrAddress<Payload = unknown> = Payload | Address;\n\n/**\n * Instantion options for the base deployable.\n *\n * @export\n * @interface DeployableOptions\n * @typedef {DeployableOptions}\n */\nexport interface DeployableOptions {\n  /**\n   * [Wagmi Configuration](https://wagmi.sh/core/api/createConfig)\n   *\n   * @see {@link Config}\n   * @type {Config}\n   */\n  config: Config;\n  /**\n   * [Viem Local Account](https://viem.sh/docs/accounts/local), required if in a Node environment\n   *\n   * @see {@link Account}\n   * @type {?Account}\n   */\n  account?: Account;\n}\n\n/**\n * A generic deployable contract that encapsulates common operations related to contract deployment\n *\n * @export\n * @class Deployable\n * @typedef {Deployable}\n * @template [Payload=unknown]\n * @template {Abi} [ContractAbi=[]]\n * @template {ContractEventName<ContractAbi>} [ContractEvent=ContractEventName<ContractAbi>]\n * @extends {Contract<ContractAbi, ContractEvent>}\n */\nexport class Deployable<\n  Payload,\n  ContractAbi extends Abi,\n> extends Contract<ContractAbi> {\n  /**\n   * The deployable payload used either for contract construction or initialization\n   *\n   * @protected\n   * @type {(Payload | undefined)}\n   */\n  protected _payload: Payload | undefined;\n  /**\n   * If it exists, [Viem Local Account](https://viem.sh/docs/accounts/local), if in a Node environment\n   *\n   * @protected\n   * @type {?Account}\n   */\n  protected _account?: Account;\n\n  /**\n   * Creates an instance of Deployable.\n   *\n   * @constructor\n   * @param {DeployableOptions} param0\n   * @param {?Account} [param0.account]\n   * @param {Config} param0.config\n   * @param {DeployablePayloadOrAddress<Payload>} payload\n   */\n  constructor(\n    { account, config }: DeployableOptions,\n    payload?: DeployablePayloadOrAddress<Payload>,\n  ) {\n    if (typeof payload === 'string') {\n      super(config, payload as Address);\n    } else {\n      super(config, undefined);\n      this._payload = payload as Payload;\n    }\n    if (account) this._account = account;\n  }\n\n  /**\n   * Returns the attached deployable payload, if it exists\n   *\n   * @readonly\n   * @type {Payload}\n   */\n  get payload() {\n    return this._payload;\n  }\n\n  /**\n   * Attaches a new payload for use with this deployable's initialization\n   *\n   * @public\n   * @param {Payload} payload\n   * @returns {this}\n   */\n  public withPayload(payload: Payload) {\n    this._payload = payload;\n    return this;\n  }\n\n  /**\n   * High level deployment function to deploy and await the contract address.\n   * This is mainly a convenience method to easily deploy a contract, but will not initialize a `Cloneable`,\n   * which makes it useless for Boost components.\n   * Obviously you can ignore the TS warnings and use this, but you shouldn't in most all cases.\n   *\n   * @public\n   * @async\n   * @param {?Payload} [_payload]\n   * @param {?DeployableOptions} [_options]\n   * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams] - See [viem.WaitForTransactionReceipt](https://v1.viem.sh/docs/actions/public/waitForTransactionReceipt.html#waitfortransactionreceipt)\n   * @returns {Promise<this>}\n   */\n  protected async deploy(\n    _payload?: Payload,\n    _options?: DeployableOptions,\n    waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>,\n  ) {\n    const config = _options?.config || this._config;\n    const address = await getDeployedContractAddress(\n      config,\n      this.deployRaw(_payload, _options),\n      waitParams,\n    );\n    this._address = address;\n    return this;\n  }\n\n  /**\n   * The lower level contract deployment function that does not await for the transaction receipt.\n   * This is mainly a convenience method to easily deploy a contract, but will not initialize a `Cloneable`,\n   * which makes it useless for Boost components.\n   * Obviously you can ignore the TS warnings and use this, but you shouldn't in most all cases.\n   *\n   * @public\n   * @async\n   * @param {?Payload} [_payload]\n   * @param {?DeployableOptions} [_options]\n   * @returns {Promise<Hash>}\n   * @throws {@link DeployableAlreadyDeployedError}\n   * @throws {@link DeployableWagmiConfigurationRequiredError}\n   * @throws {@link DeployableMissingPayloadError}\n   */\n  protected async deployRaw(\n    _payload?: Payload,\n    _options?: DeployableOptions,\n  ): Promise<Hash> {\n    if (this.address) throw new DeployableAlreadyDeployedError(this.address);\n    const [payload, options] = this.validateDeploymentConfig(\n      _payload,\n      _options,\n    );\n    return await deployContract(options.config, {\n      ...this.buildParameters(payload),\n      ...this.optionallyAttachAccount(options.account),\n    });\n  }\n\n  /**\n   * Internal function to attach the connected account to write methods to avoid manually passing in an account each call.\n   *\n   * @protected\n   * @param {?Account} [account]\n   * @returns {({ account: Account; } | { account?: undefined; })}\n   */\n  protected optionallyAttachAccount(account?: Account) {\n    if (account) return { account };\n    return this._account ? { account: this._account } : {};\n  }\n\n  /**\n   * Base parameter constructor, should return a partial `viem.deployContract` parameters shape including abi, bytecode, and arguments, if any.\n   * Expected to be overridden by protocol contracts.\n   *\n   * @public\n   * @param {?Payload} [_payload]\n   * @param {?DeployableOptions} [_options]\n   * @returns {GenericDeployableParams}\n   */\n  public buildParameters(\n    _payload?: Payload,\n    _options?: DeployableOptions,\n  ): GenericDeployableParams {\n    throw new DeployableBuildParametersUnspecifiedError();\n  }\n\n  /**\n   * Internal method used to ensure that a Wagmi configuration and payload are always present when deploying.\n   *\n   * @protected\n   * @template [P=Payload]\n   * @param {?P} [_payload]\n   * @param {?DeployableOptions} [_options]\n   * @returns {[P, DeployableOptions]}\n   * @throws {@link DeployableWagmiConfigurationRequiredError}\n   * @throws {@link DeployableMissingPayloadError}\n   */\n  protected validateDeploymentConfig<P = Payload>(\n    _payload?: P,\n    _options?: DeployableOptions,\n  ) {\n    const options = _options || {\n      config: this._config,\n      account: this._account,\n    };\n    if (!options) throw new DeployableWagmiConfigurationRequiredError();\n    const payload = _payload || this._payload;\n    return [payload, options] as [P, DeployableOptions];\n  }\n}\n"],"names":["Deployable","Contract","account","config","payload","_payload","_options","waitParams","address","getDeployedContractAddress","DeployableAlreadyDeployedError","options","deployContract","DeployableBuildParametersUnspecifiedError","DeployableWagmiConfigurationRequiredError"],"mappings":";;;;AA6EO,MAAMA,UAGHC,EAAsB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAyB9B,YACE,EAAE,SAAAC,GAAS,QAAAC,EAAA,GACXC,GACA;AACI,IAAA,OAAOA,KAAY,WACrB,MAAMD,GAAQC,CAAkB,KAEhC,MAAMD,GAAQ,MAAS,GACvB,KAAK,WAAWC,IAEdF,WAAc,WAAWA;AAAA,EAC/B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAI,UAAU;AACZ,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,YAAYE,GAAkB;AACnC,gBAAK,WAAWA,GACT;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,MAAgB,OACdC,GACAC,GACAC,GACA;AACM,UAAAJ,KAASG,KAAA,gBAAAA,EAAU,WAAU,KAAK,SAClCE,IAAU,MAAMC;AAAA,MACpBN;AAAA,MACA,KAAK,UAAUE,GAAUC,CAAQ;AAAA,MACjCC;AAAA,IAAA;AAEF,gBAAK,WAAWC,GACT;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,MAAgB,UACdH,GACAC,GACe;AACf,QAAI,KAAK,QAAS,OAAM,IAAII,EAA+B,KAAK,OAAO;AACvE,UAAM,CAACN,GAASO,CAAO,IAAI,KAAK;AAAA,MAC9BN;AAAA,MACAC;AAAA,IAAA;AAEK,WAAA,MAAMM,EAAeD,EAAQ,QAAQ;AAAA,MAC1C,GAAG,KAAK,gBAAgBP,CAAO;AAAA,MAC/B,GAAG,KAAK,wBAAwBO,EAAQ,OAAO;AAAA,IAAA,CAChD;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASU,wBAAwBT,GAAmB;AAC/C,WAAAA,IAAgB,EAAE,SAAAA,MACf,KAAK,WAAW,EAAE,SAAS,KAAK,aAAa;EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWO,gBACLG,GACAC,GACyB;AACzB,UAAM,IAAIO,EAA0C;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaU,yBACRR,GACAC,GACA;AACA,UAAMK,IAAUL,KAAY;AAAA,MAC1B,QAAQ,KAAK;AAAA,MACb,SAAS,KAAK;AAAA,IAAA;AAEhB,QAAI,CAACK,EAAe,OAAA,IAAIG;AAEjB,WAAA,CADST,KAAY,KAAK,UAChBM,CAAO;AAAA,EAC1B;AACF;"}

package/dist/Deployable/DeployableTarget.cjs

@@ -1 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("../generated-BaaleHW-.cjs"),d=require("@wagmi/core"),l=require("viem"),n=require("../errors.cjs"),y=require("../utils.cjs"),u=require("./Deployable.cjs"),s=class s extends u.Deployable{constructor(t,e,r){super(t,e),this.isBase=!0,r!==void 0&&(this.isBase=r)}get base(){return this.constructor.base}get registryType(){return this.constructor.registryType}async deploy(t,e,r){return await super.deploy(t,e,r),this.assertValidAddress(),this}async deployRaw(t,e){if(this.address)throw new n.DeployableAlreadyDeployedError(this.address);const r=t||this._payload,o=(e==null?void 0:e.config)||this._config,{args:h,...c}=this.buildParameters(r);return await d.deployContract(o,{...c,...this.optionallyAttachAccount(e==null?void 0:e.account),args:[]})}async supportsInterface(t,e){return i.Xn(this._config,{address:this.assertValidAddress(),...this.optionallyAttachAccount(),...e,args:[t]})}async getComponentInterface(t){return i.Kn(this._config,{address:this.assertValidAddress(),...this.optionallyAttachAccount(),...t,args:[]})}validateDeploymentConfig(t,e){const r=t||this._payload;if(!r)throw new n.DeployableMissingPayloadError;return super.validateDeploymentConfig(r,e)}};s.base=l.zeroAddress,s.registryType=y.RegistryType.ACTION;let a=s;exports.DeployableTarget=a;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const c=require("../generated-B0tk-c9b.cjs"),u=require("@wagmi/core"),i=require("viem"),d=require("../errors.cjs"),l=require("../utils.cjs"),h=require("./Deployable.cjs"),a=class a extends h.Deployable{constructor(s,e,t){super(s,e),this._isBase=!0,typeof e=="string"&&i.isAddress(e)&&e!==i.zeroAddress&&!Object.values(this.bases).some(r=>!e||!r?!1:i.isAddressEqual(e,r))&&(t=!1),t!==void 0&&(this._isBase=t)}get isBase(){return this.address&&Object.values(this.bases).some(s=>i.isAddressEqual(this.address,s))?!0:this._isBase}get bases(){return this.constructor.bases}get registryType(){return this.constructor.registryType}async deploy(s,e,t){return await super.deploy(s,e,t),this.assertValidAddress(),this}async deployRaw(s,e){if(this.address)throw new d.DeployableAlreadyDeployedError(this.address);const t=s||this._payload,r=(e==null?void 0:e.config)||this._config,{args:y,...o}=this.buildParameters(t);return await u.deployContract(r,{...o,...this.optionallyAttachAccount(e==null?void 0:e.account),args:[]})}async supportsInterface(s,e){return await c.ti(this._config,{address:this.assertValidAddress(),...this.optionallyAttachAccount(),...e,args:[s]})}async getComponentInterface(s){return await c.ei(this._config,{address:this.assertValidAddress(),...this.optionallyAttachAccount(),...s,args:[]})}validateDeploymentConfig(s,e){const t=s||this._payload;if(!t)throw new d.DeployableMissingPayloadError;return super.validateDeploymentConfig(t,e)}};a.bases={},a.registryType=l.RegistryType.ACTION;let n=a;exports.DeployableTarget=n;
+//# sourceMappingURL=DeployableTarget.cjs.map

package/dist/Deployable/DeployableTarget.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeployableTarget.cjs","sources":["../../src/Deployable/DeployableTarget.ts"],"sourcesContent":["import {\n  type aCloneableAbi,\n  readACloneableGetComponentInterface,\n  readACloneableSupportsInterface,\n} from '@boostxyz/evm';\nimport { deployContract } from '@wagmi/core';\nimport {\n  type Abi,\n  type Address,\n  type Hash,\n  type Hex,\n  type WaitForTransactionReceiptParameters,\n  isAddress,\n  isAddressEqual,\n  zeroAddress,\n} from 'viem';\nimport {\n  DeployableAlreadyDeployedError,\n  DeployableMissingPayloadError,\n} from '../errors';\nimport { type ReadParams, RegistryType } from '../utils';\nimport {\n  Deployable,\n  type DeployableOptions,\n  type DeployablePayloadOrAddress,\n} from './Deployable';\n\n/**\n * A base class representing a generic base Boost Protocol target contract, extended by Actions, AllowLists, Budgets, Incentives, and Validators.\n *\n * @export\n * @class DeployableTarget\n * @typedef {DeployableTarget}\n * @template [Payload=unknown]\n * @extends {Deployable<Payload>}\n */\nexport class DeployableTarget<\n  Payload,\n  ContractAbi extends Abi,\n> extends Deployable<Payload, ContractAbi> {\n  /**\n   * 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.\n   *\n   * @static\n   * @readonly\n   * @type {Record<string, Address>}\n   */\n  static readonly bases: Record<number, Address> = {};\n  /**\n   * The target's registry type.\n   *\n   * @static\n   * @readonly\n   * @type {RegistryType}\n   */\n  static readonly registryType: RegistryType = RegistryType.ACTION;\n  /**\n   * A property asserting that the protocol should eiher clone and initialize a new target from the base implementation, or re-use an existing contract without initializing.\n   *\n   * @readonly\n   * @type {boolean}\n   */\n  readonly _isBase: boolean = true;\n  public get isBase() {\n    if (\n      !!this.address &&\n      Object.values(this.bases).some((base) =>\n        // biome-ignore lint/style/noNonNullAssertion: won't evaluate this if address checked and defined above\n        isAddressEqual(this.address!, base),\n      )\n    )\n      return true;\n    return this._isBase;\n  }\n\n  /**\n   * Creates an instance of DeployableTarget.\n   *\n   * @constructor\n   * @param {DeployableOptions} options\n   * @param {DeployablePayloadOrAddress<Payload>} payload - Either a given implementation's initialization payload, or an address to an existing on chain target.\n   * @param {?boolean} [isBase] - A property asserting that the protocol should eiher clone and initialize a new target from the base implementation, or re-use an existing contract without initializing.\n   */\n  constructor(\n    options: DeployableOptions,\n    payload?: DeployablePayloadOrAddress<Payload>,\n    isBase?: boolean,\n  ) {\n    super(options, payload);\n    // if supplying a custom address, safe enough to assume it is not a base address which makes reusing contracts like budgets easier\n    if (\n      typeof payload === 'string' &&\n      isAddress(payload) &&\n      payload !== zeroAddress &&\n      !Object.values(this.bases).some((base) => {\n        if (!payload || !base) return false;\n        return isAddressEqual(payload, base);\n      })\n    )\n      isBase = false;\n    if (isBase !== undefined) this._isBase = isBase;\n  }\n\n  /**\n   * A getter that will return the base implementation's static addresses by numerical chain ID\n   *\n   * @public\n   * @readonly\n   * @type {Record<number, Address>}\n   */\n  public get bases(): Record<number, Address> {\n    return (this.constructor as typeof DeployableTarget).bases;\n  }\n\n  /**\n   * A getter that returns the registry type of the base implementation\n   *\n   * @public\n   * @readonly\n   * @type {RegistryType}\n   */\n  public get registryType(): RegistryType {\n    return (this.constructor as typeof DeployableTarget).registryType;\n  }\n\n  /**\n   * @inheritdoc\n   *\n   * @public\n   * @async\n   * @param {?Payload} [payload]\n   * @param {?DeployableOptions} [options]\n   * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams]\n   * @returns {Promise<this>}\n   */\n  protected override async deploy(\n    payload?: Payload,\n    options?: DeployableOptions,\n    waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>,\n  ) {\n    await super.deploy(payload, options, waitParams);\n    this.assertValidAddress();\n    return this;\n  }\n\n  /**\n   * @inheritdoc\n   *\n   * @public\n   * @async\n   * @param {?Payload} [_payload]\n   * @param {?DeployableOptions} [_options]\n   * @returns {Promise<Hash>}\n   */\n  protected override async deployRaw(\n    _payload?: Payload,\n    _options?: DeployableOptions,\n  ): Promise<Hash> {\n    if (this.address) throw new DeployableAlreadyDeployedError(this.address);\n    const payload = _payload || this._payload;\n    const config = _options?.config || this._config;\n    const { args, ...deployment } = this.buildParameters(payload);\n    return await deployContract(config, {\n      ...deployment,\n      ...this.optionallyAttachAccount(_options?.account),\n      // Deployable targets don't construct with arguments, they initialize with encoded payloads\n      args: [],\n    });\n  }\n\n  /**\n   * Check if the contract supports the given interface\n   *\n   * @public\n   * @async\n   * @param {Hex} interfaceId - The interface identifier\n   * @param {?ReadParams} [params]\n   * @returns {Promise<boolean>} - True if the contract supports the interface\n   */\n  public async supportsInterface(\n    interfaceId: Hex,\n    params?: ReadParams<typeof aCloneableAbi, 'supportsInterface'>,\n  ) {\n    return await readACloneableSupportsInterface(this._config, {\n      address: this.assertValidAddress(),\n      ...this.optionallyAttachAccount(),\n      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally\n      ...(params as any),\n      args: [interfaceId],\n    });\n  }\n\n  /**\n   *  Return a cloneable's unique identifier for downstream consumers to differentiate various targets\n   *  All implementations must override this function\n   *\n   * @public\n   * @async\n   * @param {?ReadParams} [params]\n   * @returns {Promise<Hex>}\n   */\n  public async getComponentInterface(\n    params?: ReadParams<typeof aCloneableAbi, 'getComponentInterface'>,\n  ) {\n    return await readACloneableGetComponentInterface(this._config, {\n      address: this.assertValidAddress(),\n      ...this.optionallyAttachAccount(),\n      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally\n      ...(params as any),\n      args: [],\n    });\n  }\n\n  /**\n   * @inheritdoc\n   *\n   * @protected\n   * @template [P=Payload]\n   * @param {?P} [_payload]\n   * @param {?DeployableOptions} [_options]\n   * @returns {[P, DeployableOptions]}\n   */\n  protected override validateDeploymentConfig<P = Payload>(\n    _payload?: P,\n    _options?: DeployableOptions,\n  ) {\n    const payload = _payload || this._payload;\n    if (!payload) throw new DeployableMissingPayloadError();\n    return super.validateDeploymentConfig(payload, _options) as [\n      P,\n      DeployableOptions,\n    ];\n  }\n}\n"],"names":["_DeployableTarget","Deployable","options","payload","isBase","isAddress","zeroAddress","base","isAddressEqual","waitParams","_payload","_options","DeployableAlreadyDeployedError","config","args","deployment","deployContract","interfaceId","params","readACloneableSupportsInterface","readACloneableGetComponentInterface","DeployableMissingPayloadError","RegistryType","DeployableTarget"],"mappings":"2PAoCaA,EAAN,MAAMA,UAGHC,EAAAA,UAAiC,CA4CzC,YACEC,EACAC,EACAC,EACA,CACA,MAAMF,EAASC,CAAO,EA1BxB,KAAS,QAAmB,GA6BxB,OAAOA,GAAY,UACnBE,EAAU,UAAAF,CAAO,GACjBA,IAAYG,EAAAA,aACZ,CAAC,OAAO,OAAO,KAAK,KAAK,EAAE,KAAMC,GAC3B,CAACJ,GAAW,CAACI,EAAa,GACvBC,EAAA,eAAeL,EAASI,CAAI,CACpC,IAEQH,EAAA,IACPA,IAAW,SAAW,KAAK,QAAUA,EAC3C,CAtCA,IAAW,QAAS,CAEhB,OAAE,KAAK,SACP,OAAO,OAAO,KAAK,KAAK,EAAE,KAAMG,GAE9BC,iBAAe,KAAK,QAAUD,CAAI,CACpC,EAEO,GACF,KAAK,OACd,CAqCA,IAAW,OAAiC,CAC1C,OAAQ,KAAK,YAAwC,KACvD,CASA,IAAW,cAA6B,CACtC,OAAQ,KAAK,YAAwC,YACvD,CAYA,MAAyB,OACvBJ,EACAD,EACAO,EACA,CACA,aAAM,MAAM,OAAON,EAASD,EAASO,CAAU,EAC/C,KAAK,mBAAmB,EACjB,IACT,CAWA,MAAyB,UACvBC,EACAC,EACe,CACf,GAAI,KAAK,QAAS,MAAM,IAAIC,EAAAA,+BAA+B,KAAK,OAAO,EACjE,MAAAT,EAAUO,GAAY,KAAK,SAC3BG,GAASF,GAAA,YAAAA,EAAU,SAAU,KAAK,QAClC,CAAE,KAAAG,EAAM,GAAGC,GAAe,KAAK,gBAAgBZ,CAAO,EACrD,OAAA,MAAMa,iBAAeH,EAAQ,CAClC,GAAGE,EACH,GAAG,KAAK,wBAAwBJ,GAAA,YAAAA,EAAU,OAAO,EAEjD,KAAM,CAAC,CAAA,CACR,CACH,CAWA,MAAa,kBACXM,EACAC,EACA,CACO,OAAA,MAAMC,EAAAA,GAAgC,KAAK,QAAS,CACzD,QAAS,KAAK,mBAAmB,EACjC,GAAG,KAAK,wBAAwB,EAEhC,GAAID,EACJ,KAAM,CAACD,CAAW,CAAA,CACnB,CACH,CAWA,MAAa,sBACXC,EACA,CACO,OAAA,MAAME,EAAAA,GAAoC,KAAK,QAAS,CAC7D,QAAS,KAAK,mBAAmB,EACjC,GAAG,KAAK,wBAAwB,EAEhC,GAAIF,EACJ,KAAM,CAAC,CAAA,CACR,CACH,CAWmB,yBACjBR,EACAC,EACA,CACM,MAAAR,EAAUO,GAAY,KAAK,SACjC,GAAI,CAACP,EAAe,MAAA,IAAIkB,EAAAA,8BACjB,OAAA,MAAM,yBAAyBlB,EAASQ,CAAQ,CAIzD,CACF,EA1LEX,EAAgB,MAAiC,GAQjDA,EAAgB,aAA6BsB,EAAa,aAAA,OAnBrD,IAAMC,EAANvB"}

package/dist/Deployable/DeployableTarget.d.ts

@@ -13,13 +13,13 @@ import { Deployable, type DeployableOptions, type DeployablePayloadOrAddress } f
  */
 export declare class DeployableTarget<Payload, 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;
+    static readonly bases: Record<number, Address>;
     /**
      * The target's registry type.
      *
@@ -34,7 +34,8 @@ export declare class DeployableTarget<Payload, ContractAbi extends Abi> extends
      * @readonly
      * @type {boolean}
      */
-    readonly isBase: boolean;
+    readonly _isBase: boolean;
+    get isBase(): boolean;
     /**
      * Creates an instance of DeployableTarget.
      *
@@ -43,15 +44,15 @@ export declare class DeployableTarget<Payload, ContractAbi extends Abi> extends
      * @param {DeployablePayloadOrAddress<Payload>} payload - Either a given implementation's initialization payload, or an address to an existing on chain target.
      * @param {?boolean} [isBase] - A property asserting that the protocol should eiher clone and initialize a new target from the base implementation, or re-use an existing contract without initializing.
      */
-    constructor(options: DeployableOptions, payload: DeployablePayloadOrAddress<Payload>, isBase?: boolean);
+    constructor(options: DeployableOptions, payload?: DeployablePayloadOrAddress<Payload>, isBase?: boolean);
     /**
-     * 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>}
      */
-    get base(): Address;
+    get bases(): Record<number, Address>;
     /**
      * A getter that returns the registry type of the base implementation
      *
@@ -68,9 +69,9 @@ export declare class DeployableTarget<Payload, ContractAbi extends Abi> extends
      * @param {?Payload} [payload]
      * @param {?DeployableOptions} [options]
      * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams]
-     * @returns {unknown}
+     * @returns {Promise<this>}
      */
-    deploy(payload?: Payload, options?: DeployableOptions, waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>): Promise<this>;
+    protected deploy(payload?: Payload, options?: DeployableOptions, waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>): Promise<this>;
     /**
      * @inheritdoc
      *
@@ -80,15 +81,15 @@ export declare class DeployableTarget<Payload, ContractAbi extends Abi> extends
      * @param {?DeployableOptions} [_options]
      * @returns {Promise<Hash>}
      */
-    deployRaw(_payload?: Payload, _options?: DeployableOptions): Promise<Hash>;
+    protected deployRaw(_payload?: Payload, _options?: DeployableOptions): Promise<Hash>;
     /**
      * Check if the contract supports the given interface
      *
      * @public
      * @async
      * @param {Hex} interfaceId - The interface identifier
-     * @param {?ReadParams<typeof contractActionAbi, 'supportsInterface'>} [params]
-     * @returns {unknown} - True if the contract supports the interface
+     * @param {?ReadParams} [params]
+     * @returns {Promise<boolean>} - True if the contract supports the interface
      */
     supportsInterface(interfaceId: Hex, params?: ReadParams<typeof aCloneableAbi, 'supportsInterface'>): Promise<boolean>;
     /**
@@ -97,8 +98,8 @@ export declare class DeployableTarget<Payload, ContractAbi extends Abi> extends
      *
      * @public
      * @async
-     * @param {?ReadParams<typeof contractActionAbi, 'getComponentInterface'>} [params]
-     * @returns {unknown}
+     * @param {?ReadParams} [params]
+     * @returns {Promise<Hex>}
      */
     getComponentInterface(params?: ReadParams<typeof aCloneableAbi, 'getComponentInterface'>): Promise<`0x${string}`>;
     /**

package/dist/Deployable/DeployableTarget.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DeployableTarget.d.ts","sourceRoot":"","sources":["../../src/Deployable/DeployableTarget.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,aAAa,EAGnB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,KAAK,GAAG,EACR,KAAK,OAAO,EACZ,KAAK,IAAI,EACT,KAAK,GAAG,EACR,KAAK,mCAAmC,EAEzC,MAAM,MAAM,CAAC;AAKd,OAAO,EAAE,KAAK,UAAU,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACzD,OAAO,EACL,UAAU,EACV,KAAK,iBAAiB,EACtB,KAAK,0BAA0B,EAChC,MAAM,cAAc,CAAC;AAEtB;;;;;;;;GAQG;AACH,qBAAa,gBAAgB,CAC3B,OAAO,EACP,WAAW,SAAS,GAAG,CACvB,SAAQ,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC;IACxC;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAe;IAC5C;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAuB;IACjE;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAQ;IAEhC;;;;;;;OAOG;gBAED,OAAO,EAAE,iBAAiB,EAC1B,OAAO,EAAE,0BAA0B,CAAC,OAAO,CAAC,EAC5C,MAAM,CAAC,EAAE,OAAO;IAMlB;;;;;;OAMG;IACH,IAAW,IAAI,IAAI,OAAO,CAEzB;IAED;;;;;;OAMG;IACH,IAAW,YAAY,IAAI,YAAY,CAEtC;IAED;;;;;;;;;OASG;IACmB,MAAM,CAC1B,OAAO,CAAC,EAAE,OAAO,EACjB,OAAO,CAAC,EAAE,iBAAiB,EAC3B,UAAU,CAAC,EAAE,IAAI,CAAC,mCAAmC,EAAE,MAAM,CAAC;IAOhE;;;;;;;;OAQG;IACmB,SAAS,CAC7B,QAAQ,CAAC,EAAE,OAAO,EAClB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,OAAO,CAAC,IAAI,CAAC;IAahB;;;;;;;;OAQG;IACU,iBAAiB,CAC5B,WAAW,EAAE,GAAG,EAChB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,aAAa,EAAE,mBAAmB,CAAC;IAWhE;;;;;;;;OAQG;IACU,qBAAqB,CAChC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,aAAa,EAAE,uBAAuB,CAAC;IAWpE;;;;;;;;OAQG;cACgB,wBAAwB,CAAC,CAAC,GAAG,OAAO,EACrD,QAAQ,CAAC,EAAE,CAAC,EACZ,QAAQ,CAAC,EAAE,iBAAiB;CAS/B"}
+{"version":3,"file":"DeployableTarget.d.ts","sourceRoot":"","sources":["../../src/Deployable/DeployableTarget.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,aAAa,EAGnB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,KAAK,GAAG,EACR,KAAK,OAAO,EACZ,KAAK,IAAI,EACT,KAAK,GAAG,EACR,KAAK,mCAAmC,EAIzC,MAAM,MAAM,CAAC;AAKd,OAAO,EAAE,KAAK,UAAU,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACzD,OAAO,EACL,UAAU,EACV,KAAK,iBAAiB,EACtB,KAAK,0BAA0B,EAChC,MAAM,cAAc,CAAC;AAEtB;;;;;;;;GAQG;AACH,qBAAa,gBAAgB,CAC3B,OAAO,EACP,WAAW,SAAS,GAAG,CACvB,SAAQ,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC;IACxC;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAM;IACpD;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAuB;IACjE;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAQ;IACjC,IAAW,MAAM,YAUhB;IAED;;;;;;;OAOG;gBAED,OAAO,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,0BAA0B,CAAC,OAAO,CAAC,EAC7C,MAAM,CAAC,EAAE,OAAO;IAiBlB;;;;;;OAMG;IACH,IAAW,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAE1C;IAED;;;;;;OAMG;IACH,IAAW,YAAY,IAAI,YAAY,CAEtC;IAED;;;;;;;;;OASG;cACsB,MAAM,CAC7B,OAAO,CAAC,EAAE,OAAO,EACjB,OAAO,CAAC,EAAE,iBAAiB,EAC3B,UAAU,CAAC,EAAE,IAAI,CAAC,mCAAmC,EAAE,MAAM,CAAC;IAOhE;;;;;;;;OAQG;cACsB,SAAS,CAChC,QAAQ,CAAC,EAAE,OAAO,EAClB,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,OAAO,CAAC,IAAI,CAAC;IAahB;;;;;;;;OAQG;IACU,iBAAiB,CAC5B,WAAW,EAAE,GAAG,EAChB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,aAAa,EAAE,mBAAmB,CAAC;IAWhE;;;;;;;;OAQG;IACU,qBAAqB,CAChC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,aAAa,EAAE,uBAAuB,CAAC;IAWpE;;;;;;;;OAQG;cACgB,wBAAwB,CAAC,CAAC,GAAG,OAAO,EACrD,QAAQ,CAAC,EAAE,CAAC,EACZ,QAAQ,CAAC,EAAE,iBAAiB,GAIgC,CAC1D,CAAC,EACD,iBAAiB,CAClB;CAEJ"}

package/dist/Deployable/DeployableTarget.js

@@ -1,10 +1,10 @@
-import { a as n, K as c } from "../generated-x_abr3Yv.js";
-import { deployContract as d } from "@wagmi/core";
-import { zeroAddress as y } from "viem";
-import { DeployableAlreadyDeployedError as l, DeployableMissingPayloadError as h } from "../errors.js";
-import { RegistryType as p } from "../utils.js";
-import { Deployable as u } from "./Deployable.js";
-const e = class e extends u {
+import { q as d, r as c } from "../generated-B7VaSah4.js";
+import { deployContract as h } from "@wagmi/core";
+import { isAddress as u, zeroAddress as l, isAddressEqual as a } from "viem";
+import { DeployableAlreadyDeployedError as y, DeployableMissingPayloadError as f } from "../errors.js";
+import { RegistryType as m } from "../utils.js";
+import { Deployable as p } from "./Deployable.js";
+const i = class i extends p {
   /**
    * Creates an instance of DeployableTarget.
    *
@@ -13,18 +13,26 @@ const e = class e extends u {
    * @param {DeployablePayloadOrAddress<Payload>} payload - Either a given implementation's initialization payload, or an address to an existing on chain target.
    * @param {?boolean} [isBase] - A property asserting that the protocol should eiher clone and initialize a new target from the base implementation, or re-use an existing contract without initializing.
    */
-  constructor(s, t, r) {
-    super(s, t), this.isBase = !0, r !== void 0 && (this.isBase = r);
+  constructor(t, s, r) {
+    super(t, s), this._isBase = !0, typeof s == "string" && u(s) && s !== l && !Object.values(this.bases).some((e) => !s || !e ? !1 : a(s, e)) && (r = !1), r !== void 0 && (this._isBase = r);
+  }
+  get isBase() {
+    return this.address && Object.values(this.bases).some(
+      (t) => (
+        // biome-ignore lint/style/noNonNullAssertion: won't evaluate this if address checked and defined above
+        a(this.address, t)
+      )
+    ) ? !0 : this._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>}
    */
-  get base() {
-    return this.constructor.base;
+  get bases() {
+    return this.constructor.bases;
   }
   /**
    * A getter that returns the registry type of the base implementation
@@ -44,10 +52,10 @@ const e = class e extends u {
    * @param {?Payload} [payload]
    * @param {?DeployableOptions} [options]
    * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams]
-   * @returns {unknown}
+   * @returns {Promise<this>}
    */
-  async deploy(s, t, r) {
-    return await super.deploy(s, t, r), this.assertValidAddress(), this;
+  async deploy(t, s, r) {
+    return await super.deploy(t, s, r), this.assertValidAddress(), this;
   }
   /**
    * @inheritdoc
@@ -58,13 +66,12 @@ const e = class e extends u {
    * @param {?DeployableOptions} [_options]
    * @returns {Promise<Hash>}
    */
-  async deployRaw(s, t) {
-    if (this.address)
-      throw new l(this.address);
-    const r = s || this._payload, i = (t == null ? void 0 : t.config) || this._config, { args: f, ...o } = this.buildParameters(r);
-    return await d(i, {
-      ...o,
-      ...this.optionallyAttachAccount(t == null ? void 0 : t.account),
+  async deployRaw(t, s) {
+    if (this.address) throw new y(this.address);
+    const r = t || this._payload, e = (s == null ? void 0 : s.config) || this._config, { args: g, ...n } = this.buildParameters(r);
+    return await h(e, {
+      ...n,
+      ...this.optionallyAttachAccount(s == null ? void 0 : s.account),
       // Deployable targets don't construct with arguments, they initialize with encoded payloads
       args: []
     });
@@ -75,16 +82,16 @@ const e = class e extends u {
    * @public
    * @async
    * @param {Hex} interfaceId - The interface identifier
-   * @param {?ReadParams<typeof contractActionAbi, 'supportsInterface'>} [params]
-   * @returns {unknown} - True if the contract supports the interface
+   * @param {?ReadParams} [params]
+   * @returns {Promise<boolean>} - True if the contract supports the interface
    */
-  async supportsInterface(s, t) {
-    return n(this._config, {
+  async supportsInterface(t, s) {
+    return await d(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
-      ...t,
-      args: [s]
+      ...s,
+      args: [t]
     });
   }
   /**
@@ -93,15 +100,15 @@ const e = class e extends u {
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof contractActionAbi, 'getComponentInterface'>} [params]
-   * @returns {unknown}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<Hex>}
    */
-  async getComponentInterface(s) {
-    return c(this._config, {
+  async getComponentInterface(t) {
+    return await c(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
-      ...s,
+      ...t,
       args: []
     });
   }
@@ -114,15 +121,15 @@ const e = class e extends u {
    * @param {?DeployableOptions} [_options]
    * @returns {[P, DeployableOptions]}
    */
-  validateDeploymentConfig(s, t) {
-    const r = s || this._payload;
-    if (!r)
-      throw new h();
-    return super.validateDeploymentConfig(r, t);
+  validateDeploymentConfig(t, s) {
+    const r = t || this._payload;
+    if (!r) throw new f();
+    return super.validateDeploymentConfig(r, s);
   }
 };
-e.base = y, e.registryType = p.ACTION;
-let a = e;
+i.bases = {}, i.registryType = m.ACTION;
+let o = i;
 export {
-  a as DeployableTarget
+  o as DeployableTarget
 };
+//# sourceMappingURL=DeployableTarget.js.map

package/dist/Deployable/DeployableTarget.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeployableTarget.js","sources":["../../src/Deployable/DeployableTarget.ts"],"sourcesContent":["import {\n  type aCloneableAbi,\n  readACloneableGetComponentInterface,\n  readACloneableSupportsInterface,\n} from '@boostxyz/evm';\nimport { deployContract } from '@wagmi/core';\nimport {\n  type Abi,\n  type Address,\n  type Hash,\n  type Hex,\n  type WaitForTransactionReceiptParameters,\n  isAddress,\n  isAddressEqual,\n  zeroAddress,\n} from 'viem';\nimport {\n  DeployableAlreadyDeployedError,\n  DeployableMissingPayloadError,\n} from '../errors';\nimport { type ReadParams, RegistryType } from '../utils';\nimport {\n  Deployable,\n  type DeployableOptions,\n  type DeployablePayloadOrAddress,\n} from './Deployable';\n\n/**\n * A base class representing a generic base Boost Protocol target contract, extended by Actions, AllowLists, Budgets, Incentives, and Validators.\n *\n * @export\n * @class DeployableTarget\n * @typedef {DeployableTarget}\n * @template [Payload=unknown]\n * @extends {Deployable<Payload>}\n */\nexport class DeployableTarget<\n  Payload,\n  ContractAbi extends Abi,\n> extends Deployable<Payload, ContractAbi> {\n  /**\n   * 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.\n   *\n   * @static\n   * @readonly\n   * @type {Record<string, Address>}\n   */\n  static readonly bases: Record<number, Address> = {};\n  /**\n   * The target's registry type.\n   *\n   * @static\n   * @readonly\n   * @type {RegistryType}\n   */\n  static readonly registryType: RegistryType = RegistryType.ACTION;\n  /**\n   * A property asserting that the protocol should eiher clone and initialize a new target from the base implementation, or re-use an existing contract without initializing.\n   *\n   * @readonly\n   * @type {boolean}\n   */\n  readonly _isBase: boolean = true;\n  public get isBase() {\n    if (\n      !!this.address &&\n      Object.values(this.bases).some((base) =>\n        // biome-ignore lint/style/noNonNullAssertion: won't evaluate this if address checked and defined above\n        isAddressEqual(this.address!, base),\n      )\n    )\n      return true;\n    return this._isBase;\n  }\n\n  /**\n   * Creates an instance of DeployableTarget.\n   *\n   * @constructor\n   * @param {DeployableOptions} options\n   * @param {DeployablePayloadOrAddress<Payload>} payload - Either a given implementation's initialization payload, or an address to an existing on chain target.\n   * @param {?boolean} [isBase] - A property asserting that the protocol should eiher clone and initialize a new target from the base implementation, or re-use an existing contract without initializing.\n   */\n  constructor(\n    options: DeployableOptions,\n    payload?: DeployablePayloadOrAddress<Payload>,\n    isBase?: boolean,\n  ) {\n    super(options, payload);\n    // if supplying a custom address, safe enough to assume it is not a base address which makes reusing contracts like budgets easier\n    if (\n      typeof payload === 'string' &&\n      isAddress(payload) &&\n      payload !== zeroAddress &&\n      !Object.values(this.bases).some((base) => {\n        if (!payload || !base) return false;\n        return isAddressEqual(payload, base);\n      })\n    )\n      isBase = false;\n    if (isBase !== undefined) this._isBase = isBase;\n  }\n\n  /**\n   * A getter that will return the base implementation's static addresses by numerical chain ID\n   *\n   * @public\n   * @readonly\n   * @type {Record<number, Address>}\n   */\n  public get bases(): Record<number, Address> {\n    return (this.constructor as typeof DeployableTarget).bases;\n  }\n\n  /**\n   * A getter that returns the registry type of the base implementation\n   *\n   * @public\n   * @readonly\n   * @type {RegistryType}\n   */\n  public get registryType(): RegistryType {\n    return (this.constructor as typeof DeployableTarget).registryType;\n  }\n\n  /**\n   * @inheritdoc\n   *\n   * @public\n   * @async\n   * @param {?Payload} [payload]\n   * @param {?DeployableOptions} [options]\n   * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams]\n   * @returns {Promise<this>}\n   */\n  protected override async deploy(\n    payload?: Payload,\n    options?: DeployableOptions,\n    waitParams?: Omit<WaitForTransactionReceiptParameters, 'hash'>,\n  ) {\n    await super.deploy(payload, options, waitParams);\n    this.assertValidAddress();\n    return this;\n  }\n\n  /**\n   * @inheritdoc\n   *\n   * @public\n   * @async\n   * @param {?Payload} [_payload]\n   * @param {?DeployableOptions} [_options]\n   * @returns {Promise<Hash>}\n   */\n  protected override async deployRaw(\n    _payload?: Payload,\n    _options?: DeployableOptions,\n  ): Promise<Hash> {\n    if (this.address) throw new DeployableAlreadyDeployedError(this.address);\n    const payload = _payload || this._payload;\n    const config = _options?.config || this._config;\n    const { args, ...deployment } = this.buildParameters(payload);\n    return await deployContract(config, {\n      ...deployment,\n      ...this.optionallyAttachAccount(_options?.account),\n      // Deployable targets don't construct with arguments, they initialize with encoded payloads\n      args: [],\n    });\n  }\n\n  /**\n   * Check if the contract supports the given interface\n   *\n   * @public\n   * @async\n   * @param {Hex} interfaceId - The interface identifier\n   * @param {?ReadParams} [params]\n   * @returns {Promise<boolean>} - True if the contract supports the interface\n   */\n  public async supportsInterface(\n    interfaceId: Hex,\n    params?: ReadParams<typeof aCloneableAbi, 'supportsInterface'>,\n  ) {\n    return await readACloneableSupportsInterface(this._config, {\n      address: this.assertValidAddress(),\n      ...this.optionallyAttachAccount(),\n      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally\n      ...(params as any),\n      args: [interfaceId],\n    });\n  }\n\n  /**\n   *  Return a cloneable's unique identifier for downstream consumers to differentiate various targets\n   *  All implementations must override this function\n   *\n   * @public\n   * @async\n   * @param {?ReadParams} [params]\n   * @returns {Promise<Hex>}\n   */\n  public async getComponentInterface(\n    params?: ReadParams<typeof aCloneableAbi, 'getComponentInterface'>,\n  ) {\n    return await readACloneableGetComponentInterface(this._config, {\n      address: this.assertValidAddress(),\n      ...this.optionallyAttachAccount(),\n      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally\n      ...(params as any),\n      args: [],\n    });\n  }\n\n  /**\n   * @inheritdoc\n   *\n   * @protected\n   * @template [P=Payload]\n   * @param {?P} [_payload]\n   * @param {?DeployableOptions} [_options]\n   * @returns {[P, DeployableOptions]}\n   */\n  protected override validateDeploymentConfig<P = Payload>(\n    _payload?: P,\n    _options?: DeployableOptions,\n  ) {\n    const payload = _payload || this._payload;\n    if (!payload) throw new DeployableMissingPayloadError();\n    return super.validateDeploymentConfig(payload, _options) as [\n      P,\n      DeployableOptions,\n    ];\n  }\n}\n"],"names":["_DeployableTarget","Deployable","options","payload","isBase","isAddress","zeroAddress","base","isAddressEqual","waitParams","_payload","_options","DeployableAlreadyDeployedError","config","args","deployment","deployContract","interfaceId","params","readACloneableSupportsInterface","readACloneableGetComponentInterface","DeployableMissingPayloadError","RegistryType","DeployableTarget"],"mappings":";;;;;;AAoCO,MAAMA,IAAN,MAAMA,UAGHC,EAAiC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA4CzC,YACEC,GACAC,GACAC,GACA;AACA,UAAMF,GAASC,CAAO,GA1BxB,KAAS,UAAmB,IA6BxB,OAAOA,KAAY,YACnBE,EAAUF,CAAO,KACjBA,MAAYG,KACZ,CAAC,OAAO,OAAO,KAAK,KAAK,EAAE,KAAK,CAACC,MAC3B,CAACJ,KAAW,CAACI,IAAa,KACvBC,EAAeL,GAASI,CAAI,CACpC,MAEQH,IAAA,KACPA,MAAW,WAAW,KAAK,UAAUA;AAAA,EAC3C;AAAA,EAtCA,IAAW,SAAS;AAEhB,WAAE,KAAK,WACP,OAAO,OAAO,KAAK,KAAK,EAAE;AAAA,MAAK,CAACG;AAAA;AAAA,QAE9BC,EAAe,KAAK,SAAUD,CAAI;AAAA;AAAA,IACpC,IAEO,KACF,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqCA,IAAW,QAAiC;AAC1C,WAAQ,KAAK,YAAwC;AAAA,EACvD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,IAAW,eAA6B;AACtC,WAAQ,KAAK,YAAwC;AAAA,EACvD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,MAAyB,OACvBJ,GACAD,GACAO,GACA;AACA,iBAAM,MAAM,OAAON,GAASD,GAASO,CAAU,GAC/C,KAAK,mBAAmB,GACjB;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAyB,UACvBC,GACAC,GACe;AACf,QAAI,KAAK,QAAS,OAAM,IAAIC,EAA+B,KAAK,OAAO;AACjE,UAAAT,IAAUO,KAAY,KAAK,UAC3BG,KAASF,KAAA,gBAAAA,EAAU,WAAU,KAAK,SAClC,EAAE,MAAAG,GAAM,GAAGC,MAAe,KAAK,gBAAgBZ,CAAO;AACrD,WAAA,MAAMa,EAAeH,GAAQ;AAAA,MAClC,GAAGE;AAAA,MACH,GAAG,KAAK,wBAAwBJ,KAAA,gBAAAA,EAAU,OAAO;AAAA;AAAA,MAEjD,MAAM,CAAC;AAAA,IAAA,CACR;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAa,kBACXM,GACAC,GACA;AACO,WAAA,MAAMC,EAAgC,KAAK,SAAS;AAAA,MACzD,SAAS,KAAK,mBAAmB;AAAA,MACjC,GAAG,KAAK,wBAAwB;AAAA;AAAA,MAEhC,GAAID;AAAA,MACJ,MAAM,CAACD,CAAW;AAAA,IAAA,CACnB;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAa,sBACXC,GACA;AACO,WAAA,MAAME,EAAoC,KAAK,SAAS;AAAA,MAC7D,SAAS,KAAK,mBAAmB;AAAA,MACjC,GAAG,KAAK,wBAAwB;AAAA;AAAA,MAEhC,GAAIF;AAAA,MACJ,MAAM,CAAC;AAAA,IAAA,CACR;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWmB,yBACjBR,GACAC,GACA;AACM,UAAAR,IAAUO,KAAY,KAAK;AACjC,QAAI,CAACP,EAAe,OAAA,IAAIkB;AACjB,WAAA,MAAM,yBAAyBlB,GAASQ,CAAQ;AAAA,EAIzD;AACF;AA1LEX,EAAgB,QAAiC,IAQjDA,EAAgB,eAA6BsB,EAAa;AAnBrD,IAAMC,IAANvB;"}

package/dist/Deployable/DeployableTargetWithRBAC.cjs

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../generated-B0tk-c9b.cjs"),c=require("./DeployableTarget.cjs");var n=(i=>(i[i.MANAGER=1n]="MANAGER",i[i.ADMIN=2n]="ADMIN",i))(n||{});class l extends c.DeployableTarget{async setAuthorized(t,s,a){return await this.awaitResult(this.setAuthorizedRaw(t,s,a))}async setAuthorizedRaw(t,s,a){const{request:r,result:o}=await e.Mg(this._config,{address:this.assertValidAddress(),args:[t,s],...this.optionallyAttachAccount(),...a});return{hash:await e.fg(this._config,r),result:o}}async grantRoles(t,s,a){return await this.awaitResult(this.grantRolesRaw(t,s,a))}async grantRolesRaw(t,s,a){const{request:r,result:o}=await e.Ig(this._config,{address:this.assertValidAddress(),args:[t,s],...this.optionallyAttachAccount(),...a});return{hash:await e.yg(this._config,r),result:o}}async revokeRoles(t,s,a){return await this.awaitResult(this.revokeRolesRaw(t,s,a))}async revokeRolesRaw(t,s,a){const{request:r,result:o}=await e.Og(this._config,{address:this.assertValidAddress(),args:[t,s],...this.optionallyAttachAccount(),...a});return{hash:await e.bg(this._config,r),result:o}}async rolesOf(t,s){const a=await e.og(this._config,{address:this.assertValidAddress(),args:[t],...this.optionallyAttachAccount(),...s});return[n.MANAGER,n.ADMIN].filter(r=>(a&r)===r)}hasAnyRole(t,s,a){return e.ag(this._config,{address:this.assertValidAddress(),args:[t,s],...this.optionallyAttachAccount(),...a})}hasAllRoles(t,s,a){return e.ng(this._config,{address:this.assertValidAddress(),args:[t,s],...this.optionallyAttachAccount(),...a})}isAuthorized(t,s){return e.ig(this._config,{address:this.assertValidAddress(),args:[t],...this.optionallyAttachAccount(),...s})}}exports.rbacAbi=e.z;exports.DeployableTargetWithRBAC=l;exports.Roles=n;
+//# sourceMappingURL=DeployableTargetWithRBAC.cjs.map

package/dist/Deployable/DeployableTargetWithRBAC.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeployableTargetWithRBAC.cjs","sources":["../../src/Deployable/DeployableTargetWithRBAC.ts"],"sourcesContent":["import {\n  rbacAbi,\n  readRbacHasAllRoles,\n  readRbacHasAnyRole,\n  readRbacIsAuthorized,\n  readRbacRolesOf,\n  simulateRbacGrantRoles,\n  simulateRbacRevokeRoles,\n  simulateRbacSetAuthorized,\n  writeRbacGrantRoles,\n  writeRbacRevokeRoles,\n  writeRbacSetAuthorized,\n} from '@boostxyz/evm';\nimport type { Abi, Address, ContractEventName } from 'viem';\nimport { DeployableTarget } from '../Deployable/DeployableTarget';\nimport type { GenericLog, ReadParams, WriteParams } from '../utils';\nexport { rbacAbi };\n\n/**\n *  Enum representing available roles for use with the `RBAC` authorization scheme.\n * `MANAGER` has lowest level of write permissions, for specific implementations, see Budgets and ALlowLists\n * `ADMIN` can additionally manage authorized users on the contract.\n *\n * @export\n * @type {{ readonly MANAGER: 1n; readonly ADMIN_ROLE: 2n; }}\n * @enum {bigint}\n */\nexport enum Roles {\n  //@ts-expect-error ts doesn't like bigint enum values\n  MANAGER = 1n,\n  //@ts-expect-error ts doesn't like bigint enum values\n  ADMIN = 2n,\n}\n\n/**\n * A generic `viem.Log` event with support for `Rbac` event types.\n *\n * @export\n * @typedef {RBACLog}\n * @template {ContractEventName<typeof rbacAbi>} [event=ContractEventName<\n *     typeof rbacAbi\n *   >]\n */\nexport type RBACLog<\n  event extends ContractEventName<typeof rbacAbi> = ContractEventName<\n    typeof rbacAbi\n  >,\n> = GenericLog<typeof rbacAbi, event>;\n\n/**\n * A minimal RBAC implementation that offers MANAGER and ADMIN roles, and\n * Budgets and allowlists support this auth scheme\n *\n * @export\n * @class DeployableTargetWithRBAC\n * @typedef {DeployableTargetWithRBAC}\n * @extends {DeployableTarget<RbacPayload>}\n */\nexport class DeployableTargetWithRBAC<\n  Payload,\n  ABI extends Abi,\n> extends DeployableTarget<Payload, ABI> {\n  /**\n   * Set the authorized status of the given accounts\n   * The mechanism for managing authorization is left to the implementing contract\n   *\n   * @public\n   * @async\n   * @param {Address[]} addresses - The accounts to authorize or deauthorize\n   * @param {boolean[]} allowed - The authorization status for the given accounts\n   * @param {?WriteParams} [params]\n   * @returns {Promise<void>}\n   */\n  public async setAuthorized(\n    addresses: Address[],\n    allowed: boolean[],\n    params?: WriteParams<typeof rbacAbi, 'setAuthorized'>,\n  ) {\n    return await this.awaitResult(\n      this.setAuthorizedRaw(addresses, allowed, params),\n    );\n  }\n\n  /**\n   * Set the authorized status of the given accounts\n   * The mechanism for managing authorization is left to the implementing contract\n   *\n   * @public\n   * @async\n   * @param {Address[]} addresses - The accounts to authorize or deauthorize\n   * @param {boolean[]} allowed - The authorization status for the given accounts\n   * @param {?WriteParams} [params]\n   * @returns {Promise<void>}\n   */\n  public async setAuthorizedRaw(\n    addresses: Address[],\n    allowed: boolean[],\n    params?: WriteParams<typeof rbacAbi, 'setAuthorized'>,\n  ) {\n    const { request, result } = await simulateRbacSetAuthorized(this._config, {\n      address: this.assertValidAddress(),\n      args: [addresses, allowed],\n      ...this.optionallyAttachAccount(),\n      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally\n      ...(params as any),\n    });\n    const hash = await writeRbacSetAuthorized(this._config, request);\n    return { hash, result };\n  }\n\n  /**\n   * Grant many accounts permissions on the rbac.\n   *\n   * @example\n   * ```ts\n   * await rbac.grantRoles(['0xfoo', '0xbar], [RbacRoles.MANAGER, RbacRoles.ADMIN])\n   * ```\n   * @public\n   * @async\n   * @param {Address[]} addresses\n   * @param {RbacRoles[]} roles\n   * @param {?WriteParams} [params]\n   * @returns {Promise<void>}\n   */\n  public async grantRoles(\n    addresses: Address[],\n    roles: Roles[],\n    params?: WriteParams<typeof rbacAbi, 'grantRoles'>,\n  ) {\n    return await this.awaitResult(this.grantRolesRaw(addresses, roles, params));\n  }\n\n  /**\n   * Grant many accounts permissions on the rbac.\n   *\n   * @example\n   * ```ts\n   * await rbac.grantRoles(['0xfoo', '0xbar], [Roles.MANAGER, Roles.ADMIN])\n   *\n   * @public\n   * @async\n   * @param {Address[]} addresses\n   * @param {RbacRoles[]} roles\n   * @param {?WriteParams} [params]\n   * @returns {Promise<{ hash: `0x${string}`; result: void; }>}\n   */\n  public async grantRolesRaw(\n    addresses: Address[],\n    roles: Roles[],\n    params?: WriteParams<typeof rbacAbi, 'grantRoles'>,\n  ) {\n    const { request, result } = await simulateRbacGrantRoles(this._config, {\n      address: this.assertValidAddress(),\n      args: [addresses, roles],\n      ...this.optionallyAttachAccount(),\n      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally\n      ...(params as any),\n    });\n    const hash = await writeRbacGrantRoles(\n      this._config,\n      // biome-ignore lint/suspicious/noExplicitAny: negligible low level lack of type intersection\n      request as any,\n    );\n    return { hash, result };\n  }\n\n  /**\n   * Revoke many accounts' permissions on the rbac.\n   *\n   * @example\n   * ```ts\n   * await rbac.revokeRoles(['0xfoo', '0xbar], [RbacRoles.MANAGER, RbacRoles.ADMIN])\n   *\n   * @public\n   * @async\n   * @param {Address[]} addresses\n   * @param {RbacRoles[]} roles\n   * @param {?WriteParams} [params]\n   * @returns {Promise<void>}\n   */\n  public async revokeRoles(\n    addresses: Address[],\n    roles: Roles[],\n    params?: WriteParams<typeof rbacAbi, 'revokeRoles'>,\n  ) {\n    return await this.awaitResult(\n      this.revokeRolesRaw(addresses, roles, params),\n    );\n  }\n\n  /**\n   * Revoke many accounts' permissions on the rbac.\n   *\n   * @example\n   * ```ts\n   * await rbac.revokeRoles(['0xfoo', '0xbar], [RbacRoles.MANAGER, RbacRoles.ADMIN])\n   * @public\n   * @async\n   * @param {Address[]} addresses\n   * @param {RbacRoles[]} roles\n   * @param {?WriteParams} [params]\n   * @returns {Promise<{ hash: `0x${string}`; result: void; }>}\n   */\n  public async revokeRolesRaw(\n    addresses: Address[],\n    roles: Roles[],\n    params?: WriteParams<typeof rbacAbi, 'revokeRoles'>,\n  ) {\n    const { request, result } = await simulateRbacRevokeRoles(this._config, {\n      address: this.assertValidAddress(),\n      args: [addresses, roles],\n      ...this.optionallyAttachAccount(),\n      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally\n      ...(params as any),\n    });\n    const hash = await writeRbacRevokeRoles(\n      this._config,\n      // biome-ignore lint/suspicious/noExplicitAny: negligible low level lack of type intersection\n      request as any,\n    );\n    return { hash, result };\n  }\n\n  /**\n   * Return an array of the roles assigned to the given account.\n   * @example\n   * ```ts\n   * (await rbac.rolesOf(0xfoo)).includes(RbacRoles.ADMIN)\n   * @public\n   * @param {Address} account\n   * @param {?ReadParams} [params]\n   * @returns {Promise<Array<RbacRoles>>}\n   */\n  public async rolesOf(\n    account: Address,\n    params?: ReadParams<typeof rbacAbi, 'rolesOf'>,\n  ) {\n    const roles = await readRbacRolesOf(this._config, {\n      address: this.assertValidAddress(),\n      args: [account],\n      ...this.optionallyAttachAccount(),\n      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally\n      ...(params as any),\n    });\n    return ([Roles.MANAGER, Roles.ADMIN] as unknown as Array<bigint>).filter(\n      (role) => (roles & role) === role,\n    ) as unknown as Roles[];\n  }\n\n  /**\n   * Returns whether given account has any of the provided roles bitmap.\n   *\n   * @example\n   * ```ts\n   * await rbac.hasAnyRole(0xfoo, RbacRoles.ADMIN | RbacRoles.MANAGER)\n   * @public\n   * @param {Address} account\n   * @param {RbacRoles} roles\n   * @param {?ReadParams} [params]\n   * @returns {Promise<boolean>}\n   */\n  public hasAnyRole(\n    account: Address,\n    roles: Roles,\n    params?: ReadParams<typeof rbacAbi, 'hasAnyRole'>,\n  ) {\n    return readRbacHasAnyRole(this._config, {\n      address: this.assertValidAddress(),\n      args: [account, roles],\n      ...this.optionallyAttachAccount(),\n      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally\n      ...(params as any),\n    });\n  }\n\n  /**\n   * Returns whether given account has all of the provided roles bitmap.\n   *\n   * @example\n   * ```ts\n   * await rbac.hasAllRoles(0xfoo, RbacRoles.ADMIN & RbacRoles.MANAGER)\n   *\n   * @public\n   * @param {Address} account\n   * @param {RbacRoles} roles\n   * @param {?ReadParams} [params]\n   * @returns {Promise<boolean>}\n   */\n  public hasAllRoles(\n    account: Address,\n    roles: Roles,\n    params?: ReadParams<typeof rbacAbi, 'hasAllRoles'>,\n  ) {\n    return readRbacHasAllRoles(this._config, {\n      address: this.assertValidAddress(),\n      args: [account, roles],\n      ...this.optionallyAttachAccount(),\n      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally\n      ...(params as any),\n    });\n  }\n\n  /**\n   * Check if the given account is authorized to use the rbac\n   *\n   * @public\n   * @param {Address} account\n   * @param {?ReadParams} [params]\n   * @returns {Promise<boolean>} - True if the account is authorized\n   */\n  public isAuthorized(\n    account: Address,\n    params?: ReadParams<typeof rbacAbi, 'isAuthorized'>,\n  ) {\n    return readRbacIsAuthorized(this._config, {\n      address: this.assertValidAddress(),\n      args: [account],\n      ...this.optionallyAttachAccount(),\n      // biome-ignore lint/suspicious/noExplicitAny: Accept any shape of valid wagmi/viem parameters, wagmi does the same thing internally\n      ...(params as any),\n    });\n  }\n}\n"],"names":["Roles","DeployableTargetWithRBAC","DeployableTarget","addresses","allowed","params","request","result","simulateRbacSetAuthorized","writeRbacSetAuthorized","roles","simulateRbacGrantRoles","writeRbacGrantRoles","simulateRbacRevokeRoles","writeRbacRevokeRoles","account","readRbacRolesOf","role","readRbacHasAnyRole","readRbacHasAllRoles","readRbacIsAuthorized"],"mappings":"iKA2BY,IAAAA,GAAAA,IAEVA,EAAAA,EAAA,QAAU,EAAV,EAAA,UAEAA,EAAAA,EAAA,MAAQ,EAAR,EAAA,QAJUA,IAAAA,GAAA,CAAA,CAAA,EA+BL,MAAMC,UAGHC,EAAAA,gBAA+B,CAYvC,MAAa,cACXC,EACAC,EACAC,EACA,CACA,OAAO,MAAM,KAAK,YAChB,KAAK,iBAAiBF,EAAWC,EAASC,CAAM,CAAA,CAEpD,CAaA,MAAa,iBACXF,EACAC,EACAC,EACA,CACA,KAAM,CAAE,QAAAC,EAAS,OAAAC,CAAA,EAAW,MAAMC,EAAA,GAA0B,KAAK,QAAS,CACxE,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACL,EAAWC,CAAO,EACzB,GAAG,KAAK,wBAAwB,EAEhC,GAAIC,CAAA,CACL,EAEM,MAAA,CAAE,KADI,MAAMI,EAAuB,GAAA,KAAK,QAASH,CAAO,EAChD,OAAAC,EACjB,CAgBA,MAAa,WACXJ,EACAO,EACAL,EACA,CACO,OAAA,MAAM,KAAK,YAAY,KAAK,cAAcF,EAAWO,EAAOL,CAAM,CAAC,CAC5E,CAgBA,MAAa,cACXF,EACAO,EACAL,EACA,CACA,KAAM,CAAE,QAAAC,EAAS,OAAAC,CAAA,EAAW,MAAMI,EAAA,GAAuB,KAAK,QAAS,CACrE,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACR,EAAWO,CAAK,EACvB,GAAG,KAAK,wBAAwB,EAEhC,GAAIL,CAAA,CACL,EAMM,MAAA,CAAE,KALI,MAAMO,EAAA,GACjB,KAAK,QAELN,CAAA,EAEa,OAAAC,EACjB,CAgBA,MAAa,YACXJ,EACAO,EACAL,EACA,CACA,OAAO,MAAM,KAAK,YAChB,KAAK,eAAeF,EAAWO,EAAOL,CAAM,CAAA,CAEhD,CAeA,MAAa,eACXF,EACAO,EACAL,EACA,CACA,KAAM,CAAE,QAAAC,EAAS,OAAAC,CAAA,EAAW,MAAMM,EAAA,GAAwB,KAAK,QAAS,CACtE,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACV,EAAWO,CAAK,EACvB,GAAG,KAAK,wBAAwB,EAEhC,GAAIL,CAAA,CACL,EAMM,MAAA,CAAE,KALI,MAAMS,EAAA,GACjB,KAAK,QAELR,CAAA,EAEa,OAAAC,EACjB,CAYA,MAAa,QACXQ,EACAV,EACA,CACA,MAAMK,EAAQ,MAAMM,KAAgB,KAAK,QAAS,CAChD,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACD,CAAO,EACd,GAAG,KAAK,wBAAwB,EAEhC,GAAIV,CAAA,CACL,EACD,MAAQ,CAACL,EAAM,QAASA,EAAM,KAAK,EAA+B,OAC/DiB,IAAUP,EAAQO,KAAUA,CAAA,CAEjC,CAcO,WACLF,EACAL,EACAL,EACA,CACO,OAAAa,EAAA,GAAmB,KAAK,QAAS,CACtC,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACH,EAASL,CAAK,EACrB,GAAG,KAAK,wBAAwB,EAEhC,GAAIL,CAAA,CACL,CACH,CAeO,YACLU,EACAL,EACAL,EACA,CACO,OAAAc,EAAA,GAAoB,KAAK,QAAS,CACvC,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACJ,EAASL,CAAK,EACrB,GAAG,KAAK,wBAAwB,EAEhC,GAAIL,CAAA,CACL,CACH,CAUO,aACLU,EACAV,EACA,CACO,OAAAe,EAAA,GAAqB,KAAK,QAAS,CACxC,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACL,CAAO,EACd,GAAG,KAAK,wBAAwB,EAEhC,GAAIV,CAAA,CACL,CACH,CACF"}