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

package/dist/Deployable/DeployableTarget.js

@@ -1,10 +1,10 @@
-import { b as d, K as c } from "../generated-57_Kffpz.js";
+import { z as d, C as c } from "../generated-CsNyWPKA.js";
 import { deployContract as h } from "@wagmi/core";
-import { isAddress as y, zeroAddress as i } from "viem";
-import { DeployableAlreadyDeployedError as l, DeployableMissingPayloadError as f } from "../errors.js";
-import { RegistryType as u } from "../utils.js";
+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 e = class e extends p {
+const i = class i extends p {
   /**
    * Creates an instance of DeployableTarget.
    *
@@ -14,20 +14,25 @@ const e = class e extends p {
    * @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(t, s, r) {
-    super(t, s), this._isBase = !0, typeof s == "string" && y(s) && s !== this.base && s !== i && (r = !1), r !== void 0 && (this._isBase = 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 && this.address !== this.base ? !1 : this._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
@@ -47,7 +52,7 @@ const e = class e extends p {
    * @param {?Payload} [payload]
    * @param {?DeployableOptions} [options]
    * @param {?Omit<WaitForTransactionReceiptParameters, 'hash'>} [waitParams]
-   * @returns {unknown}
+   * @returns {Promise<this>}
    */
   async deploy(t, s, r) {
     return await super.deploy(t, s, r), this.assertValidAddress(), this;
@@ -62,10 +67,9 @@ const e = class e extends p {
    * @returns {Promise<Hash>}
    */
   async deployRaw(t, s) {
-    if (this.address)
-      throw new l(this.address);
-    const r = t || this._payload, o = (s == null ? void 0 : s.config) || this._config, { args: g, ...n } = this.buildParameters(r);
-    return await h(o, {
+    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
@@ -78,8 +82,8 @@ const e = class e extends p {
    * @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(t, s) {
     return await d(this._config, {
@@ -96,8 +100,8 @@ const e = class e extends p {
    *
    * @public
    * @async
-   * @param {?ReadParams<typeof contractActionAbi, 'getComponentInterface'>} [params]
-   * @returns {unknown}
+   * @param {?ReadParams} [params]
+   * @returns {Promise<Hex>}
    */
   async getComponentInterface(t) {
     return await c(this._config, {
@@ -119,14 +123,13 @@ const e = class e extends p {
    */
   validateDeploymentConfig(t, s) {
     const r = t || this._payload;
-    if (!r)
-      throw new f();
+    if (!r) throw new f();
     return super.validateDeploymentConfig(r, s);
   }
 };
-e.base = i, e.registryType = u.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

@@ -1 +1 @@
-{"version":3,"file":"DeployableTarget.js","sources":["../../src/Deployable/DeployableTarget.ts"],"sourcesContent":["import {\n  type aCloneableAbi,\n  readACloneableGetComponentInterface as 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  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 the address of the base implementation on chain, used when cloning base contracts.\n   *\n   * @static\n   * @readonly\n   * @type {Address}\n   */\n  static readonly base: Address = zeroAddress;\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  protected _isBase = true;\n  get isBase() {\n    if (!!this.address && this.address !== this.base) return false;\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 !== this.base &&\n      payload !== zeroAddress\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 address\n   *\n   * @public\n   * @readonly\n   * @type {Address}\n   */\n  public get base(): Address {\n    return (this.constructor as typeof DeployableTarget).base;\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 {unknown}\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<typeof contractActionAbi, 'supportsInterface'>} [params]\n   * @returns {unknown} - 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<typeof contractActionAbi, 'getComponentInterface'>} [params]\n   * @returns {unknown}\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","waitParams","_payload","_options","DeployableAlreadyDeployedError","config","args","deployment","deployContract","interfaceId","params","readACloneableSupportsInterface","readACloneableGetComponentInterface","DeployableMissingPayloadError","RegistryType","DeployableTarget"],"mappings":";;;;;;AAmCO,MAAMA,IAAN,MAAMA,UAGHC,EAAiC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqCzC,YACEC,GACAC,GACAC,GACA;AACA,UAAMF,GAASC,CAAO,GAnBxB,KAAU,UAAU,IAsBhB,OAAOA,KAAY,YACnBE,EAAUF,CAAO,KACjBA,MAAY,KAAK,QACjBA,MAAYG,MAEHF,IAAA,KACPA,MAAW,WAAW,KAAK,UAAUA;AAAA,EAC3C;AAAA,EA5BA,IAAI,SAAS;AACX,WAAM,KAAK,WAAW,KAAK,YAAY,KAAK,OAAa,KAClD,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkCA,IAAW,OAAgB;AACzB,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,OACvBD,GACAD,GACAK,GACA;AACA,iBAAM,MAAM,OAAOJ,GAASD,GAASK,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;AAAe,YAAA,IAAIC,EAA+B,KAAK,OAAO;AACjE,UAAAP,IAAUK,KAAY,KAAK,UAC3BG,KAASF,KAAA,gBAAAA,EAAU,WAAU,KAAK,SAClC,EAAE,MAAAG,GAAM,GAAGC,MAAe,KAAK,gBAAgBV,CAAO;AACrD,WAAA,MAAMW,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,UAAAN,IAAUK,KAAY,KAAK;AACjC,QAAI,CAACL;AAAS,YAAM,IAAIgB,EAA8B;AAC/C,WAAA,MAAM,yBAAyBhB,GAASM,CAAQ;AAAA,EAIzD;AACF;AAhLET,EAAgB,OAAgBM,GAQhCN,EAAgB,eAA6BoB,EAAa;AAnBrD,IAAMC,IAANrB;"}
+{"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-DHerxf1y.cjs"),c=require("./DeployableTarget.cjs");var h=(n=>(n[n.MANAGER=1n]="MANAGER",n[n.ADMIN=2n]="ADMIN",n))(h||{});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:i,result:r}=await e.O6(this._config,{address:this.assertValidAddress(),args:[t,s],...this.optionallyAttachAccount(),...a});return{hash:await e.b6(this._config,i),result:r}}async grantRoles(t,s,a){return await this.awaitResult(this.grantRolesRaw(t,s,a))}async grantRolesRaw(t,s,a){const{request:i,result:r}=await e.I6(this._config,{address:this.assertValidAddress(),args:[t,s],...this.optionallyAttachAccount(),...a});return{hash:await e.u6(this._config,i),result:r}}async revokeRoles(t,s,a){return await this.awaitResult(this.revokeRolesRaw(t,s,a))}async revokeRolesRaw(t,s,a){const{request:i,result:r}=await e.R6(this._config,{address:this.assertValidAddress(),args:[t,s],...this.optionallyAttachAccount(),...a});return{hash:await e.m6(this._config,i),result:r}}async grantManyRoles(t,s,a){return await this.awaitResult(this.grantManyRolesRaw(t,s,a))}async grantManyRolesRaw(t,s,a){const{request:i,result:r}=await e.A6(this._config,{address:this.assertValidAddress(),args:[t,s],...this.optionallyAttachAccount(),...a});return{hash:await e.p6(this._config,i),result:r}}async revokeManyRoles(t,s,a){return await this.awaitResult(this.revokeManyRolesRaw(t,s,a))}async revokeManyRolesRaw(t,s,a){const{request:i,result:r}=await e.M6(this._config,{address:this.assertValidAddress(),args:[t,s],...this.optionallyAttachAccount(),...a});return{hash:await e.c6(this._config,i),result:r}}async rolesOf(t,s){const a=await e.i6(this._config,{address:this.assertValidAddress(),args:[t],...this.optionallyAttachAccount(),...s});return[h.MANAGER,h.ADMIN].filter(i=>(a&i)===i)}hasAnyRole(t,s,a){return e.e6(this._config,{address:this.assertValidAddress(),args:[t,s],...this.optionallyAttachAccount(),...a})}hasAllRoles(t,s,a){return e.YR(this._config,{address:this.assertValidAddress(),args:[t,s],...this.optionallyAttachAccount(),...a})}isAuthorized(t,s){return e.t6(this._config,{address:this.assertValidAddress(),args:[t],...this.optionallyAttachAccount(),...s})}}exports.rbacAbi=e.R;exports.DeployableTargetWithRBAC=l;exports.Roles=h;
+//# 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  simulateRbacGrantManyRoles,\n  simulateRbacGrantRoles,\n  simulateRbacRevokeManyRoles,\n  simulateRbacRevokeRoles,\n  simulateRbacSetAuthorized,\n  writeRbacGrantManyRoles,\n  writeRbacGrantRoles,\n  writeRbacRevokeManyRoles,\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 permissions for a user on the rbac.\n   *\n   * @example\n   * ```ts\n   * await rbac.grantRoles('0xfoo', Roles.MANAGER)\n   * ```\n   * @public\n   * @async\n   * @param {Address} address\n   * @param {Roles} role\n   * @param {?WriteParams<typeof rbacAbi, 'grantRoles'>} [params]\n   * @returns {Promise<void>}\n   */\n  public async grantRoles(\n    address: Address,\n    role: Roles,\n    params?: WriteParams<typeof rbacAbi, 'grantRoles'>,\n  ) {\n    return await this.awaitResult(this.grantRolesRaw(address, role, params));\n  }\n\n  /**\n   * Grant permissions for a user on the rbac.\n   *\n   * @example\n   * ```ts\n   * await rbac.grantRoles('0xfoo', Roles.MANAGER)\n   * ```\n   * @public\n   * @async\n   * @param {Address} address\n   * @param {Roles} role\n   * @param {?WriteParams} [params]\n   * @returns {Promise<{ hash: `0x${string}`; result: void; }>}\n   */\n  public async grantRolesRaw(\n    address: Address,\n    role: Roles,\n    params?: WriteParams<typeof rbacAbi, 'grantRoles'>,\n  ) {\n    const { request, result } = await simulateRbacGrantRoles(this._config, {\n      address: this.assertValidAddress(),\n      args: [address, role],\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 permissions for a user on the rbac.\n   *\n   * @example\n   * ```ts\n   * await rbac.revokeRoles('0xfoo', Roles.MANAGER)\n   * ```\n   * @public\n   * @async\n   * @param {Address} address\n   * @param {Roles} role\n   * @param {?WriteParams} [params]\n   * @returns {Promise<void>}\n   */\n  public async revokeRoles(\n    address: Address,\n    role: Roles,\n    params?: WriteParams<typeof rbacAbi, 'revokeRoles'>,\n  ) {\n    return await this.awaitResult(this.revokeRolesRaw(address, role, params));\n  }\n\n  /**\n   * Revoke permissions for a user on the rbac.\n   *\n   * @example\n   * ```ts\n   * await rbac.revokeRoles('0xfoo', Roles.MANAGER)\n   * ```\n   * @public\n   * @async\n   * @param {Address} address\n   * @param {Roles} role\n   * @param {?WriteParams} [params]\n   * @returns {Promise<{ hash: `0x${string}`; result: void; }>}\n   */\n  public async revokeRolesRaw(\n    address: Address,\n    role: Roles,\n    params?: WriteParams<typeof rbacAbi, 'revokeRoles'>,\n  ) {\n    const { request, result } = await simulateRbacRevokeRoles(this._config, {\n      address: this.assertValidAddress(),\n      args: [address, role],\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   * Grant many accounts permissions on the rbac.\n   *\n   * @example\n   * ```ts\n   * await rbac.grantManyRoles(['0xfoo', '0xbar], [Roles.MANAGER, Roles.ADMIN])\n   * ```\n   * @public\n   * @async\n   * @param {Address[]} addresses\n   * @param {Roles[]} roles\n   * @param {?WriteParams} [params]\n   * @returns {Promise<void>}\n   */\n  public async grantManyRoles(\n    addresses: Address[],\n    roles: Roles[],\n    params?: WriteParams<typeof rbacAbi, 'grantManyRoles'>,\n  ) {\n    return await this.awaitResult(\n      this.grantManyRolesRaw(addresses, roles, params),\n    );\n  }\n\n  /**\n   * Grant many accounts permissions on the rbac.\n   *\n   * @example\n   * ```ts\n   * await rbac.grantManyRoles(['0xfoo', '0xbar], [Roles.MANAGER, Roles.ADMIN])\n   * ```\n   * @public\n   * @async\n   * @param {Address[]} addresses\n   * @param {Roles[]} roles\n   * @param {?WriteParams} [params]\n   * @returns {Promise<{ hash: `0x${string}`; result: void; }>}\n   */\n  public async grantManyRolesRaw(\n    addresses: Address[],\n    roles: Roles[],\n    params?: WriteParams<typeof rbacAbi, 'grantManyRoles'>,\n  ) {\n    const { request, result } = await simulateRbacGrantManyRoles(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 writeRbacGrantManyRoles(\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.revokeManyRoles(['0xfoo', '0xbar], [Roles.MANAGER, Roles.ADMIN])\n   * ```\n   * @public\n   * @async\n   * @param {Address[]} addresses\n   * @param {Roles[]} roles\n   * @param {?WriteParams} [params]\n   * @returns {Promise<void>}\n   */\n  public async revokeManyRoles(\n    addresses: Address[],\n    roles: Roles[],\n    params?: WriteParams<typeof rbacAbi, 'revokeManyRoles'>,\n  ) {\n    return await this.awaitResult(\n      this.revokeManyRolesRaw(addresses, roles, params),\n    );\n  }\n\n  /**\n   * Revoke many accounts' permissions on the rbac.\n   *\n   * @example\n   * ```ts\n   * await rbac.revokeManyRoles(['0xfoo', '0xbar], [Roles.MANAGER, Roles.ADMIN])\n   * ```\n   * @public\n   * @async\n   * @param {Address[]} addresses\n   * @param {Roles[]} roles\n   * @param {?WriteParams} [params]\n   * @returns {Promise<{ hash: `0x${string}`; result: void; }>}\n   */\n  public async revokeManyRolesRaw(\n    addresses: Address[],\n    roles: Roles[],\n    params?: WriteParams<typeof rbacAbi, 'revokeManyRoles'>,\n  ) {\n    const { request, result } = await simulateRbacRevokeManyRoles(\n      this._config,\n      {\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    );\n    const hash = await writeRbacRevokeManyRoles(\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(Roles.ADMIN)\n   * ```\n   * @public\n   * @param {Address} account\n   * @param {?ReadParams} [params]\n   * @returns {Promise<Array<Roles>>}\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, Roles.ADMIN | Roles.MANAGER)\n   * ```\n   * @public\n   * @param {Address} account\n   * @param {Roles} 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, Roles.ADMIN | Roles.MANAGER)\n   * ```\n   * @public\n   * @param {Address} account\n   * @param {Roles} 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","address","role","simulateRbacGrantRoles","writeRbacGrantRoles","simulateRbacRevokeRoles","writeRbacRevokeRoles","roles","simulateRbacGrantManyRoles","writeRbacGrantManyRoles","simulateRbacRevokeManyRoles","writeRbacRevokeManyRoles","account","readRbacRolesOf","readRbacHasAnyRole","readRbacHasAllRoles","readRbacIsAuthorized"],"mappings":"iKA+BY,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,WACXG,EACAC,EACAN,EACA,CACO,OAAA,MAAM,KAAK,YAAY,KAAK,cAAcK,EAASC,EAAMN,CAAM,CAAC,CACzE,CAgBA,MAAa,cACXK,EACAC,EACAN,EACA,CACA,KAAM,CAAE,QAAAC,EAAS,OAAAC,CAAA,EAAW,MAAMK,EAAA,GAAuB,KAAK,QAAS,CACrE,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACF,EAASC,CAAI,EACpB,GAAG,KAAK,wBAAwB,EAEhC,GAAIN,CAAA,CACL,EAMM,MAAA,CAAE,KALI,MAAMQ,EAAA,GACjB,KAAK,QAELP,CAAA,EAEa,OAAAC,EACjB,CAgBA,MAAa,YACXG,EACAC,EACAN,EACA,CACO,OAAA,MAAM,KAAK,YAAY,KAAK,eAAeK,EAASC,EAAMN,CAAM,CAAC,CAC1E,CAgBA,MAAa,eACXK,EACAC,EACAN,EACA,CACA,KAAM,CAAE,QAAAC,EAAS,OAAAC,CAAA,EAAW,MAAMO,EAAA,GAAwB,KAAK,QAAS,CACtE,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACJ,EAASC,CAAI,EACpB,GAAG,KAAK,wBAAwB,EAEhC,GAAIN,CAAA,CACL,EAMM,MAAA,CAAE,KALI,MAAMU,EAAA,GACjB,KAAK,QAELT,CAAA,EAEa,OAAAC,EACjB,CAgBA,MAAa,eACXJ,EACAa,EACAX,EACA,CACA,OAAO,MAAM,KAAK,YAChB,KAAK,kBAAkBF,EAAWa,EAAOX,CAAM,CAAA,CAEnD,CAgBA,MAAa,kBACXF,EACAa,EACAX,EACA,CACA,KAAM,CAAE,QAAAC,EAAS,OAAAC,CAAA,EAAW,MAAMU,EAAA,GAA2B,KAAK,QAAS,CACzE,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACd,EAAWa,CAAK,EACvB,GAAG,KAAK,wBAAwB,EAEhC,GAAIX,CAAA,CACL,EAMM,MAAA,CAAE,KALI,MAAMa,EAAA,GACjB,KAAK,QAELZ,CAAA,EAEa,OAAAC,EACjB,CAgBA,MAAa,gBACXJ,EACAa,EACAX,EACA,CACA,OAAO,MAAM,KAAK,YAChB,KAAK,mBAAmBF,EAAWa,EAAOX,CAAM,CAAA,CAEpD,CAgBA,MAAa,mBACXF,EACAa,EACAX,EACA,CACA,KAAM,CAAE,QAAAC,EAAS,OAAAC,CAAO,EAAI,MAAMY,EAAA,GAChC,KAAK,QACL,CACE,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAAChB,EAAWa,CAAK,EACvB,GAAG,KAAK,wBAAwB,EAEhC,GAAIX,CACN,CAAA,EAOK,MAAA,CAAE,KALI,MAAMe,EAAA,GACjB,KAAK,QAELd,CAAA,EAEa,OAAAC,EACjB,CAaA,MAAa,QACXc,EACAhB,EACA,CACA,MAAMW,EAAQ,MAAMM,KAAgB,KAAK,QAAS,CAChD,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACD,CAAO,EACd,GAAG,KAAK,wBAAwB,EAEhC,GAAIhB,CAAA,CACL,EACD,MAAQ,CAACL,EAAM,QAASA,EAAM,KAAK,EAA+B,OAC/DW,IAAUK,EAAQL,KAAUA,CAAA,CAEjC,CAeO,WACLU,EACAL,EACAX,EACA,CACO,OAAAkB,EAAA,GAAmB,KAAK,QAAS,CACtC,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACF,EAASL,CAAK,EACrB,GAAG,KAAK,wBAAwB,EAEhC,GAAIX,CAAA,CACL,CACH,CAeO,YACLgB,EACAL,EACAX,EACA,CACO,OAAAmB,EAAA,GAAoB,KAAK,QAAS,CACvC,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACH,EAASL,CAAK,EACrB,GAAG,KAAK,wBAAwB,EAEhC,GAAIX,CAAA,CACL,CACH,CAUO,aACLgB,EACAhB,EACA,CACO,OAAAoB,EAAA,GAAqB,KAAK,QAAS,CACxC,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACJ,CAAO,EACd,GAAG,KAAK,wBAAwB,EAEhC,GAAIhB,CAAA,CACL,CACH,CACF"}

package/dist/Deployable/DeployableTargetWithRBAC.d.ts

@@ -0,0 +1,248 @@
+import { rbacAbi } from '@boostxyz/evm';
+import type { Abi, Address, ContractEventName } from 'viem';
+import { DeployableTarget } from '../Deployable/DeployableTarget';
+import type { GenericLog, ReadParams, WriteParams } from '../utils';
+export { rbacAbi };
+/**
+ *  Enum representing available roles for use with the `RBAC` authorization scheme.
+ * `MANAGER` has lowest level of write permissions, for specific implementations, see Budgets and ALlowLists
+ * `ADMIN` can additionally manage authorized users on the contract.
+ *
+ * @export
+ * @type {{ readonly MANAGER: 1n; readonly ADMIN_ROLE: 2n; }}
+ * @enum {bigint}
+ */
+export declare enum Roles {
+    MANAGER,
+    ADMIN
+}
+/**
+ * A generic `viem.Log` event with support for `Rbac` event types.
+ *
+ * @export
+ * @typedef {RBACLog}
+ * @template {ContractEventName<typeof rbacAbi>} [event=ContractEventName<
+ *     typeof rbacAbi
+ *   >]
+ */
+export type RBACLog<event extends ContractEventName<typeof rbacAbi> = ContractEventName<typeof rbacAbi>> = GenericLog<typeof rbacAbi, event>;
+/**
+ * A minimal RBAC implementation that offers MANAGER and ADMIN roles, and
+ * Budgets and allowlists support this auth scheme
+ *
+ * @export
+ * @class DeployableTargetWithRBAC
+ * @typedef {DeployableTargetWithRBAC}
+ * @extends {DeployableTarget<RbacPayload>}
+ */
+export declare class DeployableTargetWithRBAC<Payload, ABI extends Abi> extends DeployableTarget<Payload, ABI> {
+    /**
+     * Set the authorized status of the given accounts
+     * The mechanism for managing authorization is left to the implementing contract
+     *
+     * @public
+     * @async
+     * @param {Address[]} addresses - The accounts to authorize or deauthorize
+     * @param {boolean[]} allowed - The authorization status for the given accounts
+     * @param {?WriteParams} [params]
+     * @returns {Promise<void>}
+     */
+    setAuthorized(addresses: Address[], allowed: boolean[], params?: WriteParams<typeof rbacAbi, 'setAuthorized'>): Promise<void>;
+    /**
+     * Set the authorized status of the given accounts
+     * The mechanism for managing authorization is left to the implementing contract
+     *
+     * @public
+     * @async
+     * @param {Address[]} addresses - The accounts to authorize or deauthorize
+     * @param {boolean[]} allowed - The authorization status for the given accounts
+     * @param {?WriteParams} [params]
+     * @returns {Promise<void>}
+     */
+    setAuthorizedRaw(addresses: Address[], allowed: boolean[], params?: WriteParams<typeof rbacAbi, 'setAuthorized'>): Promise<{
+        hash: `0x${string}`;
+        result: void;
+    }>;
+    /**
+     * Grant permissions for a user on the rbac.
+     *
+     * @example
+     * ```ts
+     * await rbac.grantRoles('0xfoo', Roles.MANAGER)
+     * ```
+     * @public
+     * @async
+     * @param {Address} address
+     * @param {Roles} role
+     * @param {?WriteParams<typeof rbacAbi, 'grantRoles'>} [params]
+     * @returns {Promise<void>}
+     */
+    grantRoles(address: Address, role: Roles, params?: WriteParams<typeof rbacAbi, 'grantRoles'>): Promise<void>;
+    /**
+     * Grant permissions for a user on the rbac.
+     *
+     * @example
+     * ```ts
+     * await rbac.grantRoles('0xfoo', Roles.MANAGER)
+     * ```
+     * @public
+     * @async
+     * @param {Address} address
+     * @param {Roles} role
+     * @param {?WriteParams} [params]
+     * @returns {Promise<{ hash: `0x${string}`; result: void; }>}
+     */
+    grantRolesRaw(address: Address, role: Roles, params?: WriteParams<typeof rbacAbi, 'grantRoles'>): Promise<{
+        hash: `0x${string}`;
+        result: void;
+    }>;
+    /**
+     * Revoke permissions for a user on the rbac.
+     *
+     * @example
+     * ```ts
+     * await rbac.revokeRoles('0xfoo', Roles.MANAGER)
+     * ```
+     * @public
+     * @async
+     * @param {Address} address
+     * @param {Roles} role
+     * @param {?WriteParams} [params]
+     * @returns {Promise<void>}
+     */
+    revokeRoles(address: Address, role: Roles, params?: WriteParams<typeof rbacAbi, 'revokeRoles'>): Promise<void>;
+    /**
+     * Revoke permissions for a user on the rbac.
+     *
+     * @example
+     * ```ts
+     * await rbac.revokeRoles('0xfoo', Roles.MANAGER)
+     * ```
+     * @public
+     * @async
+     * @param {Address} address
+     * @param {Roles} role
+     * @param {?WriteParams} [params]
+     * @returns {Promise<{ hash: `0x${string}`; result: void; }>}
+     */
+    revokeRolesRaw(address: Address, role: Roles, params?: WriteParams<typeof rbacAbi, 'revokeRoles'>): Promise<{
+        hash: `0x${string}`;
+        result: void;
+    }>;
+    /**
+     * Grant many accounts permissions on the rbac.
+     *
+     * @example
+     * ```ts
+     * await rbac.grantManyRoles(['0xfoo', '0xbar], [Roles.MANAGER, Roles.ADMIN])
+     * ```
+     * @public
+     * @async
+     * @param {Address[]} addresses
+     * @param {Roles[]} roles
+     * @param {?WriteParams} [params]
+     * @returns {Promise<void>}
+     */
+    grantManyRoles(addresses: Address[], roles: Roles[], params?: WriteParams<typeof rbacAbi, 'grantManyRoles'>): Promise<void>;
+    /**
+     * Grant many accounts permissions on the rbac.
+     *
+     * @example
+     * ```ts
+     * await rbac.grantManyRoles(['0xfoo', '0xbar], [Roles.MANAGER, Roles.ADMIN])
+     * ```
+     * @public
+     * @async
+     * @param {Address[]} addresses
+     * @param {Roles[]} roles
+     * @param {?WriteParams} [params]
+     * @returns {Promise<{ hash: `0x${string}`; result: void; }>}
+     */
+    grantManyRolesRaw(addresses: Address[], roles: Roles[], params?: WriteParams<typeof rbacAbi, 'grantManyRoles'>): Promise<{
+        hash: `0x${string}`;
+        result: void;
+    }>;
+    /**
+     * Revoke many accounts' permissions on the rbac.
+     *
+     * @example
+     * ```ts
+     * await rbac.revokeManyRoles(['0xfoo', '0xbar], [Roles.MANAGER, Roles.ADMIN])
+     * ```
+     * @public
+     * @async
+     * @param {Address[]} addresses
+     * @param {Roles[]} roles
+     * @param {?WriteParams} [params]
+     * @returns {Promise<void>}
+     */
+    revokeManyRoles(addresses: Address[], roles: Roles[], params?: WriteParams<typeof rbacAbi, 'revokeManyRoles'>): Promise<void>;
+    /**
+     * Revoke many accounts' permissions on the rbac.
+     *
+     * @example
+     * ```ts
+     * await rbac.revokeManyRoles(['0xfoo', '0xbar], [Roles.MANAGER, Roles.ADMIN])
+     * ```
+     * @public
+     * @async
+     * @param {Address[]} addresses
+     * @param {Roles[]} roles
+     * @param {?WriteParams} [params]
+     * @returns {Promise<{ hash: `0x${string}`; result: void; }>}
+     */
+    revokeManyRolesRaw(addresses: Address[], roles: Roles[], params?: WriteParams<typeof rbacAbi, 'revokeManyRoles'>): Promise<{
+        hash: `0x${string}`;
+        result: void;
+    }>;
+    /**
+     * Return an array of the roles assigned to the given account.
+     * @example
+     * ```ts
+     * (await rbac.rolesOf(0xfoo)).includes(Roles.ADMIN)
+     * ```
+     * @public
+     * @param {Address} account
+     * @param {?ReadParams} [params]
+     * @returns {Promise<Array<Roles>>}
+     */
+    rolesOf(account: Address, params?: ReadParams<typeof rbacAbi, 'rolesOf'>): Promise<Roles[]>;
+    /**
+     * Returns whether given account has any of the provided roles bitmap.
+     *
+     * @example
+     * ```ts
+     * await rbac.hasAnyRole(0xfoo, Roles.ADMIN | Roles.MANAGER)
+     * ```
+     * @public
+     * @param {Address} account
+     * @param {Roles} roles
+     * @param {?ReadParams} [params]
+     * @returns {Promise<boolean>}
+     */
+    hasAnyRole(account: Address, roles: Roles, params?: ReadParams<typeof rbacAbi, 'hasAnyRole'>): Promise<boolean>;
+    /**
+     * Returns whether given account has all of the provided roles bitmap.
+     *
+     * @example
+     * ```ts
+     * await rbac.hasAllRoles(0xfoo, Roles.ADMIN | Roles.MANAGER)
+     * ```
+     * @public
+     * @param {Address} account
+     * @param {Roles} roles
+     * @param {?ReadParams} [params]
+     * @returns {Promise<boolean>}
+     */
+    hasAllRoles(account: Address, roles: Roles, params?: ReadParams<typeof rbacAbi, 'hasAllRoles'>): Promise<boolean>;
+    /**
+     * Check if the given account is authorized to use the rbac
+     *
+     * @public
+     * @param {Address} account
+     * @param {?ReadParams} [params]
+     * @returns {Promise<boolean>} - True if the account is authorized
+     */
+    isAuthorized(account: Address, params?: ReadParams<typeof rbacAbi, 'isAuthorized'>): Promise<boolean>;
+}
+//# sourceMappingURL=DeployableTargetWithRBAC.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DeployableTargetWithRBAC.d.ts","sourceRoot":"","sources":["../../src/Deployable/DeployableTargetWithRBAC.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAeR,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,CAAC;AAEnB;;;;;;;;GAQG;AACH,oBAAY,KAAK;IAEf,OAAY;IAEZ,KAAU;CACX;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,OAAO,CACjB,KAAK,SAAS,iBAAiB,CAAC,OAAO,OAAO,CAAC,GAAG,iBAAiB,CACjE,OAAO,OAAO,CACf,IACC,UAAU,CAAC,OAAO,OAAO,EAAE,KAAK,CAAC,CAAC;AAEtC;;;;;;;;GAQG;AACH,qBAAa,wBAAwB,CACnC,OAAO,EACP,GAAG,SAAS,GAAG,CACf,SAAQ,gBAAgB,CAAC,OAAO,EAAE,GAAG,CAAC;IACtC;;;;;;;;;;OAUG;IACU,aAAa,CACxB,SAAS,EAAE,OAAO,EAAE,EACpB,OAAO,EAAE,OAAO,EAAE,EAClB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,OAAO,EAAE,eAAe,CAAC;IAOvD;;;;;;;;;;OAUG;IACU,gBAAgB,CAC3B,SAAS,EAAE,OAAO,EAAE,EACpB,OAAO,EAAE,OAAO,EAAE,EAClB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,OAAO,EAAE,eAAe,CAAC;;;;IAavD;;;;;;;;;;;;;OAaG;IACU,UAAU,CACrB,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,KAAK,EACX,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,OAAO,EAAE,YAAY,CAAC;IAKpD;;;;;;;;;;;;;OAaG;IACU,aAAa,CACxB,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,KAAK,EACX,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,OAAO,EAAE,YAAY,CAAC;;;;IAiBpD;;;;;;;;;;;;;OAaG;IACU,WAAW,CACtB,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,KAAK,EACX,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,OAAO,EAAE,aAAa,CAAC;IAKrD;;;;;;;;;;;;;OAaG;IACU,cAAc,CACzB,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,KAAK,EACX,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,OAAO,EAAE,aAAa,CAAC;;;;IAiBrD;;;;;;;;;;;;;OAaG;IACU,cAAc,CACzB,SAAS,EAAE,OAAO,EAAE,EACpB,KAAK,EAAE,KAAK,EAAE,EACd,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,OAAO,EAAE,gBAAgB,CAAC;IAOxD;;;;;;;;;;;;;OAaG;IACU,iBAAiB,CAC5B,SAAS,EAAE,OAAO,EAAE,EACpB,KAAK,EAAE,KAAK,EAAE,EACd,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,OAAO,EAAE,gBAAgB,CAAC;;;;IAiBxD;;;;;;;;;;;;;OAaG;IACU,eAAe,CAC1B,SAAS,EAAE,OAAO,EAAE,EACpB,KAAK,EAAE,KAAK,EAAE,EACd,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,OAAO,EAAE,iBAAiB,CAAC;IAOzD;;;;;;;;;;;;;OAaG;IACU,kBAAkB,CAC7B,SAAS,EAAE,OAAO,EAAE,EACpB,KAAK,EAAE,KAAK,EAAE,EACd,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,OAAO,EAAE,iBAAiB,CAAC;;;;IAoBzD;;;;;;;;;;OAUG;IACU,OAAO,CAClB,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,OAAO,EAAE,SAAS,CAAC;IAchD;;;;;;;;;;;;OAYG;IACI,UAAU,CACf,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,KAAK,EACZ,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,OAAO,EAAE,YAAY,CAAC;IAWnD;;;;;;;;;;;;OAYG;IACI,WAAW,CAChB,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,KAAK,EACZ,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,OAAO,EAAE,aAAa,CAAC;IAWpD;;;;;;;OAOG;IACI,YAAY,CACjB,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,OAAO,EAAE,cAAc,CAAC;CAUtD"}