@boostxyz/sdk 0.0.0-alpha.10

package/dist/errors.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.cjs","sources":["../src/errors.ts"],"sourcesContent":["import {\n  type Hex,\n  type Log,\n  type WaitForTransactionReceiptReturnType,\n  zeroHash,\n} from 'viem';\nimport type { Criteria } from './Actions/EventAction';\nimport type { BoostRegistry } from './BoostRegistry';\nimport type { Incentive } from './Incentives/Incentive';\n\n/**\n * This error is thrown during Boost creation if no `BoostCreated` event was emitted.\n *\n * @export\n * @class BoostCoreNoIdentifierEmitted\n * @typedef {BoostCoreNoIdentifierEmitted}\n * @extends {Error}\n * @example\n * ```ts\n * try {\n *   await boostCore.createBoost(...)\n * } catch(e) {\n *   if(e instanceof BoostCoreNoIdentifierEmitted) {}\n * }\n * ```\n */\nexport class BoostCoreNoIdentifierEmitted extends Error {\n  /**\n   * Creates an instance of BoostCoreNoIdentifierEmitted.\n   *\n   * @constructor\n   */\n  constructor() {\n    super(`No \"BoostCreated\" log was emitted from which to extract boostId`);\n  }\n}\n\n/**\n * This error is thrown when `assertValidAddress` is called, usually because a contract call expects the class to have a valid address attached.\n *\n * @export\n * @class ContractAddressRequiredError\n * @typedef {ContractAddressRequiredError}\n * @extends {Error}\n * @example\n * ```ts\n * try {\n *   target.assertValidAddress()\n * } catch(e) {\n *   if(e instanceof ContractAddressRequiredError) {}\n * }\n */\nexport class ContractAddressRequiredError extends Error {\n  /**\n   * Creates an instance of ContractAddressRequiredError.\n   *\n   * @constructor\n   */\n  constructor() {\n    super('Attempted to call contract method without providing an address');\n  }\n}\n\n/**\n * This error is thrown when attempting to deploy a contract that has already been deployed, or has an address attached.\n *\n * @export\n * @class DeployableAlreadyDeployedError\n * @typedef {DeployableAlreadyDeployedError}\n * @extends {Error}\n */\nexport class DeployableAlreadyDeployedError extends Error {\n  /**\n   * The address already attached to the target.\n   *\n   * @type {string}\n   */\n  address: string;\n  /**\n   * Creates an instance of DeployableAlreadyDeployedError.\n   *\n   * @constructor\n   * @param {string} address\n   */\n  constructor(address: string) {\n    super(\n      `Attempted to deploy a contract that already has an address configured`,\n    );\n    this.address = address;\n  }\n}\n\n/**\n * You should never see this error if we did our jobs and every target overrides the `buildParameters` method.\n *\n * @export\n * @class DeployableBuildParametersUnspecifiedError\n * @typedef {DeployableBuildParametersUnspecifiedError}\n * @extends {Error}\n */\nexport class DeployableBuildParametersUnspecifiedError extends Error {\n  /**\n   * Creates an instance of DeployableBuildParametersUnspecifiedError.\n   *\n   * @constructor\n   */\n  constructor() {\n    super(\n      'Implementing class did not properly override the `buildParameters` method',\n    );\n  }\n}\n\n/**\n * This error is thrown when attempting to deploy an `ownable` contract and the owner cannot be ascertained from the initialization payload or configured account.\n *\n * @export\n * @class DeployableUnknownOwnerProvidedError\n * @typedef {DeployableUnknownOwnerProvidedError}\n * @extends {Error}\n */\nexport class DeployableUnknownOwnerProvidedError extends Error {\n  /**\n   * Creates an instance of DeployableUnknownOwnerProvidedError.\n   *\n   * @constructor\n   */\n  constructor() {\n    super(\n      'Expected an an owner to be provided in configuration or an account to exist on Wagmi config.',\n    );\n  }\n}\n\n/**\n * This error is thrown when deploying a contract with no valid Wagmi configuration on the instance.\n *\n * @export\n * @class DeployableWagmiConfigurationRequiredError\n * @typedef {DeployableWagmiConfigurationRequiredError}\n * @extends {Error}\n */\nexport class DeployableWagmiConfigurationRequiredError extends Error {\n  /**\n   * Creates an instance of DeployableWagmiConfigurationRequiredError.\n   *\n   * @constructor\n   */\n  constructor() {\n    super(\n      'Expected a valid Wagmi configuration to be available either on Deployable, or as argument to deploy.',\n    );\n  }\n}\n\n/**\n * This error is thrown when deploying a contract with no valid initialization payload.\n *\n * @export\n * @class DeployableMissingPayloadError\n * @typedef {DeployableMissingPayloadError}\n * @extends {Error}\n */\nexport class DeployableMissingPayloadError extends Error {\n  /**\n   * Creates an instance of DeployableMissingPayloadError.\n   *\n   * @constructor\n   */\n  constructor() {\n    super(\n      'Expected a valid payload to be available either on Deployable or as argument to deploy.',\n    );\n  }\n}\n\n/**\n * This error is thrown when we receive a transaction receipt for a contract deployment without a contract address on it.\n *\n * @export\n * @class NoContractAddressUponReceiptError\n * @typedef {NoContractAddressUponReceiptError}\n * @extends {Error}\n */\nexport class NoContractAddressUponReceiptError extends Error {\n  /**\n   * The raw receipt we receive from [waitForTransactionReceipt](https://v1.viem.sh/docs/actions/public/waitForTransactionReceipt.html#waitfortransactionreceipt)\n   *\n   * @public\n   * @readonly\n   * @type {WaitForTransactionReceiptReturnType}\n   */\n  public readonly receipt: WaitForTransactionReceiptReturnType;\n  /**\n   * Creates an instance of NoContractAddressUponReceiptError.\n   *\n   * @constructor\n   * @param {WaitForTransactionReceiptReturnType} receipt\n   */\n  constructor(receipt: WaitForTransactionReceiptReturnType) {\n    super(`Expected a contract address to exist on receipt.`, {\n      cause: receipt,\n    });\n    this.receipt = receipt;\n  }\n}\n\n/**\n * This error is thrown when a target address was provided that doesn't match any supported interface for the given registry type.\n * For example, if you try to do `incentiveFromAddress()` with the address of a deployed `SimpleBudget`\n *\n * @export\n * @class InvalidComponentInterfaceError\n * @typedef {InvalidComponentInterfaceError}\n * @extends {Error}\n */\nexport class InvalidComponentInterfaceError extends Error {\n  /**\n   * Expected interface hashes.\n   *\n   * @public\n   * @readonly\n   * @type {Hex[]}\n   */\n  public readonly expected: Hex[] = [];\n  /**\n   * The actual interface hash.\n   *\n   * @public\n   * @readonly\n   * @type {Hex}\n   */\n  public readonly received: Hex = zeroHash;\n\n  /**\n   * Creates an instance of InvalidComponentInterfaceError.\n   *\n   * @constructor\n   * @param {Hex[]} expected\n   * @param {Hex} received\n   */\n  constructor(expected: Hex[], received: Hex) {\n    super(`Address provided does not match any expected protocol interface`, {\n      cause: { expected, received },\n    });\n    this.expected = expected;\n    this.received = received;\n  }\n}\n\n/**\n * This error is thrown when attempting a Budget transfer and arguments aren't of the type `FungibleTransferPayload` or `ERC1155TransferPayload`\n *\n * @see {@link FungibleTransferPayload}\n * @see {@link ERC1155TransferPayload}\n * @export\n * @class UnknownTransferPayloadSupplied\n * @typedef {UnknownTransferPayloadSupplied}\n * @extends {Error}\n */\nexport class UnknownTransferPayloadSupplied extends Error {\n  /**\n   * The given payload that does not conform to the correct payload shape.\n   *\n   * @type {unknown}\n   */\n  received: unknown;\n  /**\n   * Creates an instance of UnknownTransferPayloadSupplied.\n   *\n   * @constructor\n   * @param {unknown} received\n   */\n  constructor(received: unknown) {\n    super(\n      `Did not provide a valid FungibleTransferPayload or ERC1155 transfer payload.`,\n      { cause: received },\n    );\n    this.received = received;\n  }\n}\n\n/**\n * This error is thrown during Boost creation when the budget doesn't authorize the Boost Core address.\n *\n * @export\n * @class BudgetMustAuthorizeBoostCore\n * @typedef {BudgetMustAuthorizeBoostCore}\n * @extends {Error}\n */\nexport class BudgetMustAuthorizeBoostCore extends Error {\n  /**\n   * Creates an instance of BudgetMustAuthorizeBoostCore.\n   *\n   * @constructor\n   * @param {string} boostCoreAddress\n   */\n  constructor(boostCoreAddress: string) {\n    super(\n      `Budget needs to explicitly authorize ${boostCoreAddress}. You can retrieve this value from BoostCore.address`,\n    );\n  }\n}\n\n/**\n * Because this contract is a base implementation, it should not be initialized through the constructor. Instead, it should be cloned and initialized using the {@link BoostRegistry}\n *\n * @export\n * @class MustInitializeBudgetError\n * @typedef {MustInitializeBudgetError}\n * @extends {Error}\n */\nexport class MustInitializeBudgetError extends Error {\n  /**\n   * Creates an instance of MustInitializeBudgetError.\n   */\n  constructor() {\n    super(`Budgets must be preinitialized before being used with a new Boost`);\n  }\n}\n\n/**\n * The error is thrown when trying to reuse an existing deployed Incentive that isn't a base implementation.\n * The protocol doesn't allow this.\n *\n * @export\n * @class IncentiveNotCloneableError\n * @typedef {IncentiveNotCloneableError}\n * @extends {Error}\n */\nexport class IncentiveNotCloneableError extends Error {\n  /**\n   * Creates an instance of IncentiveNotCloneableError.\n   *\n   * @constructor\n   * @param {Incentive} incentive\n   */\n  constructor(incentive: Incentive) {\n    super(`Incentive not cloneable: ${incentive.constructor.name}`);\n  }\n}\n\n/**\n * Thrown when encoding an EventAction payload and no action steps are provided\n *\n * @export\n * @class NoEventActionStepsProvidedError\n * @typedef {NoEventActionStepsProvidedError}\n * @extends {Error}\n */\nexport class NoEventActionStepsProvidedError extends Error {\n  /**\n   * Creates an instance of NoEventActionStepsProvidedError.\n   *\n   * @constructor\n   */\n  constructor() {\n    super('Must supply at least one action step');\n  }\n}\n\n/**\n * Thrown when encoding an EventAction payload and > 4 steps are provided\n *\n * @export\n * @class TooManyEventActionStepsProvidedError\n * @typedef {TooManyEventActionStepsProvidedError}\n * @extends {Error}\n */\nexport class TooManyEventActionStepsProvidedError extends Error {\n  /**\n   * Creates an instance of TooManyEventActionStepsProvidedError.\n   *\n   * @constructor\n   */\n  constructor() {\n    super(\n      'Cannot supply more than 4 action steps with current protocol version',\n    );\n  }\n}\n\n/**\n * Event action validation context to help debug other validation errors\n *\n * @interface EventActionValidationMeta\n * @typedef {EventActionValidationMeta}\n */\ninterface EventActionValidationMeta {\n  /**\n   * The viem log being validated against\n   *\n   * @type {Log}\n   */\n  log: Log;\n  /**\n   * The value pulled off the log being validated against\n   *\n   * @type {*}\n   * biome-ignore lint/suspicious/noExplicitAny: this can be a few different types based on what the log emits\n   */\n  fieldValue: any;\n  /**\n   * The criteria being used to compare during validation\n   *\n   * @type {Criteria}\n   */\n  criteria: Criteria;\n}\n\n/**\n * The base error thrown during event action validation extended by more specific validation errors.\n * Instantiated with relevent context data for more in depth debugging.\n *\n * @export\n * @class EventActionValidationError\n * @typedef {EventActionValidationError}\n * @extends {Error}\n */\nexport class EventActionValidationError extends Error {\n  /**\n   * The viem log being validated against\n   *\n   * @type {Log}\n   */\n  log: Log;\n  /**\n   * The value pulled off the log being validated against\n   *\n   * @type {*}\n   * biome-ignore lint/suspicious/noExplicitAny: this can be a few different types based on what the log emits\n   */\n  fieldValue: any;\n  /**\n   * The criteria being used to compare during validation\n   *\n   * @type {Criteria}\n   */\n  criteria: Criteria;\n  /**\n   * Creates an instance of EventActionValidationError.\n   *\n   * @constructor\n   * @param {string} message\n   * @param {EventActionValidationMeta} param0\n   * @param {*} param0.fieldValue\n   * @param {Criteria} param0.criteria\n   * @param {Log} param0.log\n   */\n  constructor(\n    message: string,\n    { fieldValue, criteria, log }: EventActionValidationMeta,\n  ) {\n    super(message);\n    this.fieldValue = fieldValue;\n    this.criteria = criteria;\n    this.log = log;\n  }\n}\n\n/**\n * Thrown when field value on log is undefined\n *\n * @export\n * @class FieldValueUndefinedError\n * @typedef {FieldValueUndefinedError}\n * @extends {EventActionValidationError}\n */\nexport class FieldValueUndefinedError extends EventActionValidationError {\n  /**\n   * Creates an instance of FieldValueUndefinedError.\n   *\n   * @constructor\n   * @param {EventActionValidationMeta} metadata\n   */\n  constructor(metadata: EventActionValidationMeta) {\n    super('Field value is undefined', metadata);\n  }\n}\n\n/**\n * Thrown when a filter type is using a numerical operator but field type is not numerical\n *\n * @export\n * @class InvalidNumericalCriteriaError\n * @typedef {InvalidNumericalCriteriaError}\n * @extends {EventActionValidationError}\n */\nexport class InvalidNumericalCriteriaError extends EventActionValidationError {\n  /**\n   * Creates an instance of InvalidNumericalCriteria.\n   *\n   * @constructor\n   * @param {EventActionValidationMeta} metadata\n   */\n  constructor(metadata: EventActionValidationMeta) {\n    super(\n      'Numerical comparisons cannot be used with non-numerical criteria',\n      metadata,\n    );\n  }\n}\n\n/**\n * Thrown when an the log's field value is being compared a field type that isn't bytes or string during event action validation\n *\n * @export\n * @class FieldValueNotComparableError\n * @typedef {FieldValueNotComparableError}\n * @extends {EventActionValidationError}\n */\nexport class FieldValueNotComparableError extends EventActionValidationError {\n  /**\n   * Creates an instance of FieldValueNotComparableError.\n   *\n   * @constructor\n   * @param {EventActionValidationMeta} metadata\n   */\n  constructor(metadata: EventActionValidationMeta) {\n    super('Filter can only be used with bytes or string field type', metadata);\n  }\n}\n\n/**\n * Thrown when an invalid filter type enum was provided event action validation.\n *\n * @export\n * @class UnrecognizedFilterTypeError\n * @typedef {UnrecognizedFilterTypeError}\n * @extends {EventActionValidationError}\n */\nexport class UnrecognizedFilterTypeError extends EventActionValidationError {\n  /**\n   * Creates an instance of UnrecognizedFilterTypeError.\n   *\n   * @constructor\n   * @param {EventActionValidationMeta} metadata\n   */\n  constructor(metadata: EventActionValidationMeta) {\n    super('Invalid FilterType provided', metadata);\n  }\n}\n"],"names":["BoostCoreNoIdentifierEmitted","ContractAddressRequiredError","DeployableAlreadyDeployedError","address","DeployableBuildParametersUnspecifiedError","DeployableUnknownOwnerProvidedError","DeployableWagmiConfigurationRequiredError","DeployableMissingPayloadError","NoContractAddressUponReceiptError","receipt","InvalidComponentInterfaceError","expected","received","zeroHash","UnknownTransferPayloadSupplied","BudgetMustAuthorizeBoostCore","boostCoreAddress","MustInitializeBudgetError","IncentiveNotCloneableError","incentive","NoEventActionStepsProvidedError","TooManyEventActionStepsProvidedError","EventActionValidationError","message","fieldValue","criteria","log","FieldValueUndefinedError","metadata","InvalidNumericalCriteriaError","FieldValueNotComparableError","UnrecognizedFilterTypeError"],"mappings":"wGA0BO,MAAMA,UAAqC,KAAM,CAMtD,aAAc,CACZ,MAAM,iEAAiE,CACzE,CACF,CAiBO,MAAMC,UAAqC,KAAM,CAMtD,aAAc,CACZ,MAAM,gEAAgE,CACxE,CACF,CAUO,MAAMC,UAAuC,KAAM,CAaxD,YAAYC,EAAiB,CAC3B,MACE,uEAAA,EAEF,KAAK,QAAUA,CACjB,CACF,CAUO,MAAMC,UAAkD,KAAM,CAMnE,aAAc,CACZ,MACE,2EAAA,CAEJ,CACF,CAUO,MAAMC,UAA4C,KAAM,CAM7D,aAAc,CACZ,MACE,8FAAA,CAEJ,CACF,CAUO,MAAMC,UAAkD,KAAM,CAMnE,aAAc,CACZ,MACE,sGAAA,CAEJ,CACF,CAUO,MAAMC,UAAsC,KAAM,CAMvD,aAAc,CACZ,MACE,yFAAA,CAEJ,CACF,CAUO,MAAMC,UAA0C,KAAM,CAe3D,YAAYC,EAA8C,CACxD,MAAM,mDAAoD,CACxD,MAAOA,CAAA,CACR,EACD,KAAK,QAAUA,CACjB,CACF,CAWO,MAAMC,UAAuC,KAAM,CAyBxD,YAAYC,EAAiBC,EAAe,CAC1C,MAAM,kEAAmE,CACvE,MAAO,CAAE,SAAAD,EAAU,SAAAC,CAAS,CAAA,CAC7B,EApBH,KAAgB,SAAkB,GAQlC,KAAgB,SAAgBC,WAa9B,KAAK,SAAWF,EAChB,KAAK,SAAWC,CAClB,CACF,CAYO,MAAME,UAAuC,KAAM,CAaxD,YAAYF,EAAmB,CAC7B,MACE,+EACA,CAAE,MAAOA,CAAS,CAAA,EAEpB,KAAK,SAAWA,CAClB,CACF,CAUO,MAAMG,UAAqC,KAAM,CAOtD,YAAYC,EAA0B,CACpC,MACE,wCAAwCA,CAAgB,sDAAA,CAE5D,CACF,CAUO,MAAMC,UAAkC,KAAM,CAInD,aAAc,CACZ,MAAM,mEAAmE,CAC3E,CACF,CAWO,MAAMC,UAAmC,KAAM,CAOpD,YAAYC,EAAsB,CAChC,MAAM,4BAA4BA,EAAU,YAAY,IAAI,EAAE,CAChE,CACF,CAUO,MAAMC,UAAwC,KAAM,CAMzD,aAAc,CACZ,MAAM,sCAAsC,CAC9C,CACF,CAUO,MAAMC,UAA6C,KAAM,CAM9D,aAAc,CACZ,MACE,sEAAA,CAEJ,CACF,CAuCO,MAAMC,UAAmC,KAAM,CA8BpD,YACEC,EACA,CAAE,WAAAC,EAAY,SAAAC,EAAU,IAAAC,GACxB,CACA,MAAMH,CAAO,EACb,KAAK,WAAaC,EAClB,KAAK,SAAWC,EAChB,KAAK,IAAMC,CACb,CACF,CAUO,MAAMC,UAAiCL,CAA2B,CAOvE,YAAYM,EAAqC,CAC/C,MAAM,2BAA4BA,CAAQ,CAC5C,CACF,CAUO,MAAMC,UAAsCP,CAA2B,CAO5E,YAAYM,EAAqC,CAC/C,MACE,mEACAA,CAAA,CAEJ,CACF,CAUO,MAAME,UAAqCR,CAA2B,CAO3E,YAAYM,EAAqC,CAC/C,MAAM,0DAA2DA,CAAQ,CAC3E,CACF,CAUO,MAAMG,UAAoCT,CAA2B,CAO1E,YAAYM,EAAqC,CAC/C,MAAM,8BAA+BA,CAAQ,CAC/C,CACF"}

package/dist/errors.d.ts

@@ -0,0 +1,441 @@
+import { type Hex, type Log, type WaitForTransactionReceiptReturnType } from 'viem';
+import type { Criteria } from './Actions/EventAction';
+import type { Incentive } from './Incentives/Incentive';
+/**
+ * This error is thrown during Boost creation if no `BoostCreated` event was emitted.
+ *
+ * @export
+ * @class BoostCoreNoIdentifierEmitted
+ * @typedef {BoostCoreNoIdentifierEmitted}
+ * @extends {Error}
+ * @example
+ * ```ts
+ * try {
+ *   await boostCore.createBoost(...)
+ * } catch(e) {
+ *   if(e instanceof BoostCoreNoIdentifierEmitted) {}
+ * }
+ * ```
+ */
+export declare class BoostCoreNoIdentifierEmitted extends Error {
+    /**
+     * Creates an instance of BoostCoreNoIdentifierEmitted.
+     *
+     * @constructor
+     */
+    constructor();
+}
+/**
+ * This error is thrown when `assertValidAddress` is called, usually because a contract call expects the class to have a valid address attached.
+ *
+ * @export
+ * @class ContractAddressRequiredError
+ * @typedef {ContractAddressRequiredError}
+ * @extends {Error}
+ * @example
+ * ```ts
+ * try {
+ *   target.assertValidAddress()
+ * } catch(e) {
+ *   if(e instanceof ContractAddressRequiredError) {}
+ * }
+ */
+export declare class ContractAddressRequiredError extends Error {
+    /**
+     * Creates an instance of ContractAddressRequiredError.
+     *
+     * @constructor
+     */
+    constructor();
+}
+/**
+ * This error is thrown when attempting to deploy a contract that has already been deployed, or has an address attached.
+ *
+ * @export
+ * @class DeployableAlreadyDeployedError
+ * @typedef {DeployableAlreadyDeployedError}
+ * @extends {Error}
+ */
+export declare class DeployableAlreadyDeployedError extends Error {
+    /**
+     * The address already attached to the target.
+     *
+     * @type {string}
+     */
+    address: string;
+    /**
+     * Creates an instance of DeployableAlreadyDeployedError.
+     *
+     * @constructor
+     * @param {string} address
+     */
+    constructor(address: string);
+}
+/**
+ * You should never see this error if we did our jobs and every target overrides the `buildParameters` method.
+ *
+ * @export
+ * @class DeployableBuildParametersUnspecifiedError
+ * @typedef {DeployableBuildParametersUnspecifiedError}
+ * @extends {Error}
+ */
+export declare class DeployableBuildParametersUnspecifiedError extends Error {
+    /**
+     * Creates an instance of DeployableBuildParametersUnspecifiedError.
+     *
+     * @constructor
+     */
+    constructor();
+}
+/**
+ * This error is thrown when attempting to deploy an `ownable` contract and the owner cannot be ascertained from the initialization payload or configured account.
+ *
+ * @export
+ * @class DeployableUnknownOwnerProvidedError
+ * @typedef {DeployableUnknownOwnerProvidedError}
+ * @extends {Error}
+ */
+export declare class DeployableUnknownOwnerProvidedError extends Error {
+    /**
+     * Creates an instance of DeployableUnknownOwnerProvidedError.
+     *
+     * @constructor
+     */
+    constructor();
+}
+/**
+ * This error is thrown when deploying a contract with no valid Wagmi configuration on the instance.
+ *
+ * @export
+ * @class DeployableWagmiConfigurationRequiredError
+ * @typedef {DeployableWagmiConfigurationRequiredError}
+ * @extends {Error}
+ */
+export declare class DeployableWagmiConfigurationRequiredError extends Error {
+    /**
+     * Creates an instance of DeployableWagmiConfigurationRequiredError.
+     *
+     * @constructor
+     */
+    constructor();
+}
+/**
+ * This error is thrown when deploying a contract with no valid initialization payload.
+ *
+ * @export
+ * @class DeployableMissingPayloadError
+ * @typedef {DeployableMissingPayloadError}
+ * @extends {Error}
+ */
+export declare class DeployableMissingPayloadError extends Error {
+    /**
+     * Creates an instance of DeployableMissingPayloadError.
+     *
+     * @constructor
+     */
+    constructor();
+}
+/**
+ * This error is thrown when we receive a transaction receipt for a contract deployment without a contract address on it.
+ *
+ * @export
+ * @class NoContractAddressUponReceiptError
+ * @typedef {NoContractAddressUponReceiptError}
+ * @extends {Error}
+ */
+export declare class NoContractAddressUponReceiptError extends Error {
+    /**
+     * The raw receipt we receive from [waitForTransactionReceipt](https://v1.viem.sh/docs/actions/public/waitForTransactionReceipt.html#waitfortransactionreceipt)
+     *
+     * @public
+     * @readonly
+     * @type {WaitForTransactionReceiptReturnType}
+     */
+    readonly receipt: WaitForTransactionReceiptReturnType;
+    /**
+     * Creates an instance of NoContractAddressUponReceiptError.
+     *
+     * @constructor
+     * @param {WaitForTransactionReceiptReturnType} receipt
+     */
+    constructor(receipt: WaitForTransactionReceiptReturnType);
+}
+/**
+ * This error is thrown when a target address was provided that doesn't match any supported interface for the given registry type.
+ * For example, if you try to do `incentiveFromAddress()` with the address of a deployed `SimpleBudget`
+ *
+ * @export
+ * @class InvalidComponentInterfaceError
+ * @typedef {InvalidComponentInterfaceError}
+ * @extends {Error}
+ */
+export declare class InvalidComponentInterfaceError extends Error {
+    /**
+     * Expected interface hashes.
+     *
+     * @public
+     * @readonly
+     * @type {Hex[]}
+     */
+    readonly expected: Hex[];
+    /**
+     * The actual interface hash.
+     *
+     * @public
+     * @readonly
+     * @type {Hex}
+     */
+    readonly received: Hex;
+    /**
+     * Creates an instance of InvalidComponentInterfaceError.
+     *
+     * @constructor
+     * @param {Hex[]} expected
+     * @param {Hex} received
+     */
+    constructor(expected: Hex[], received: Hex);
+}
+/**
+ * This error is thrown when attempting a Budget transfer and arguments aren't of the type `FungibleTransferPayload` or `ERC1155TransferPayload`
+ *
+ * @see {@link FungibleTransferPayload}
+ * @see {@link ERC1155TransferPayload}
+ * @export
+ * @class UnknownTransferPayloadSupplied
+ * @typedef {UnknownTransferPayloadSupplied}
+ * @extends {Error}
+ */
+export declare class UnknownTransferPayloadSupplied extends Error {
+    /**
+     * The given payload that does not conform to the correct payload shape.
+     *
+     * @type {unknown}
+     */
+    received: unknown;
+    /**
+     * Creates an instance of UnknownTransferPayloadSupplied.
+     *
+     * @constructor
+     * @param {unknown} received
+     */
+    constructor(received: unknown);
+}
+/**
+ * This error is thrown during Boost creation when the budget doesn't authorize the Boost Core address.
+ *
+ * @export
+ * @class BudgetMustAuthorizeBoostCore
+ * @typedef {BudgetMustAuthorizeBoostCore}
+ * @extends {Error}
+ */
+export declare class BudgetMustAuthorizeBoostCore extends Error {
+    /**
+     * Creates an instance of BudgetMustAuthorizeBoostCore.
+     *
+     * @constructor
+     * @param {string} boostCoreAddress
+     */
+    constructor(boostCoreAddress: string);
+}
+/**
+ * Because this contract is a base implementation, it should not be initialized through the constructor. Instead, it should be cloned and initialized using the {@link BoostRegistry}
+ *
+ * @export
+ * @class MustInitializeBudgetError
+ * @typedef {MustInitializeBudgetError}
+ * @extends {Error}
+ */
+export declare class MustInitializeBudgetError extends Error {
+    /**
+     * Creates an instance of MustInitializeBudgetError.
+     */
+    constructor();
+}
+/**
+ * The error is thrown when trying to reuse an existing deployed Incentive that isn't a base implementation.
+ * The protocol doesn't allow this.
+ *
+ * @export
+ * @class IncentiveNotCloneableError
+ * @typedef {IncentiveNotCloneableError}
+ * @extends {Error}
+ */
+export declare class IncentiveNotCloneableError extends Error {
+    /**
+     * Creates an instance of IncentiveNotCloneableError.
+     *
+     * @constructor
+     * @param {Incentive} incentive
+     */
+    constructor(incentive: Incentive);
+}
+/**
+ * Thrown when encoding an EventAction payload and no action steps are provided
+ *
+ * @export
+ * @class NoEventActionStepsProvidedError
+ * @typedef {NoEventActionStepsProvidedError}
+ * @extends {Error}
+ */
+export declare class NoEventActionStepsProvidedError extends Error {
+    /**
+     * Creates an instance of NoEventActionStepsProvidedError.
+     *
+     * @constructor
+     */
+    constructor();
+}
+/**
+ * Thrown when encoding an EventAction payload and > 4 steps are provided
+ *
+ * @export
+ * @class TooManyEventActionStepsProvidedError
+ * @typedef {TooManyEventActionStepsProvidedError}
+ * @extends {Error}
+ */
+export declare class TooManyEventActionStepsProvidedError extends Error {
+    /**
+     * Creates an instance of TooManyEventActionStepsProvidedError.
+     *
+     * @constructor
+     */
+    constructor();
+}
+/**
+ * Event action validation context to help debug other validation errors
+ *
+ * @interface EventActionValidationMeta
+ * @typedef {EventActionValidationMeta}
+ */
+interface EventActionValidationMeta {
+    /**
+     * The viem log being validated against
+     *
+     * @type {Log}
+     */
+    log: Log;
+    /**
+     * The value pulled off the log being validated against
+     *
+     * @type {*}
+     * biome-ignore lint/suspicious/noExplicitAny: this can be a few different types based on what the log emits
+     */
+    fieldValue: any;
+    /**
+     * The criteria being used to compare during validation
+     *
+     * @type {Criteria}
+     */
+    criteria: Criteria;
+}
+/**
+ * The base error thrown during event action validation extended by more specific validation errors.
+ * Instantiated with relevent context data for more in depth debugging.
+ *
+ * @export
+ * @class EventActionValidationError
+ * @typedef {EventActionValidationError}
+ * @extends {Error}
+ */
+export declare class EventActionValidationError extends Error {
+    /**
+     * The viem log being validated against
+     *
+     * @type {Log}
+     */
+    log: Log;
+    /**
+     * The value pulled off the log being validated against
+     *
+     * @type {*}
+     * biome-ignore lint/suspicious/noExplicitAny: this can be a few different types based on what the log emits
+     */
+    fieldValue: any;
+    /**
+     * The criteria being used to compare during validation
+     *
+     * @type {Criteria}
+     */
+    criteria: Criteria;
+    /**
+     * Creates an instance of EventActionValidationError.
+     *
+     * @constructor
+     * @param {string} message
+     * @param {EventActionValidationMeta} param0
+     * @param {*} param0.fieldValue
+     * @param {Criteria} param0.criteria
+     * @param {Log} param0.log
+     */
+    constructor(message: string, { fieldValue, criteria, log }: EventActionValidationMeta);
+}
+/**
+ * Thrown when field value on log is undefined
+ *
+ * @export
+ * @class FieldValueUndefinedError
+ * @typedef {FieldValueUndefinedError}
+ * @extends {EventActionValidationError}
+ */
+export declare class FieldValueUndefinedError extends EventActionValidationError {
+    /**
+     * Creates an instance of FieldValueUndefinedError.
+     *
+     * @constructor
+     * @param {EventActionValidationMeta} metadata
+     */
+    constructor(metadata: EventActionValidationMeta);
+}
+/**
+ * Thrown when a filter type is using a numerical operator but field type is not numerical
+ *
+ * @export
+ * @class InvalidNumericalCriteriaError
+ * @typedef {InvalidNumericalCriteriaError}
+ * @extends {EventActionValidationError}
+ */
+export declare class InvalidNumericalCriteriaError extends EventActionValidationError {
+    /**
+     * Creates an instance of InvalidNumericalCriteria.
+     *
+     * @constructor
+     * @param {EventActionValidationMeta} metadata
+     */
+    constructor(metadata: EventActionValidationMeta);
+}
+/**
+ * Thrown when an the log's field value is being compared a field type that isn't bytes or string during event action validation
+ *
+ * @export
+ * @class FieldValueNotComparableError
+ * @typedef {FieldValueNotComparableError}
+ * @extends {EventActionValidationError}
+ */
+export declare class FieldValueNotComparableError extends EventActionValidationError {
+    /**
+     * Creates an instance of FieldValueNotComparableError.
+     *
+     * @constructor
+     * @param {EventActionValidationMeta} metadata
+     */
+    constructor(metadata: EventActionValidationMeta);
+}
+/**
+ * Thrown when an invalid filter type enum was provided event action validation.
+ *
+ * @export
+ * @class UnrecognizedFilterTypeError
+ * @typedef {UnrecognizedFilterTypeError}
+ * @extends {EventActionValidationError}
+ */
+export declare class UnrecognizedFilterTypeError extends EventActionValidationError {
+    /**
+     * Creates an instance of UnrecognizedFilterTypeError.
+     *
+     * @constructor
+     * @param {EventActionValidationMeta} metadata
+     */
+    constructor(metadata: EventActionValidationMeta);
+}
+export {};
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,GAAG,EACR,KAAK,GAAG,EACR,KAAK,mCAAmC,EAEzC,MAAM,MAAM,CAAC;AACd,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,4BAA6B,SAAQ,KAAK;IACrD;;;;OAIG;;CAIJ;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,4BAA6B,SAAQ,KAAK;IACrD;;;;OAIG;;CAIJ;AAED;;;;;;;GAOG;AACH,qBAAa,8BAA+B,SAAQ,KAAK;IACvD;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;gBACS,OAAO,EAAE,MAAM;CAM5B;AAED;;;;;;;GAOG;AACH,qBAAa,yCAA0C,SAAQ,KAAK;IAClE;;;;OAIG;;CAMJ;AAED;;;;;;;GAOG;AACH,qBAAa,mCAAoC,SAAQ,KAAK;IAC5D;;;;OAIG;;CAMJ;AAED;;;;;;;GAOG;AACH,qBAAa,yCAA0C,SAAQ,KAAK;IAClE;;;;OAIG;;CAMJ;AAED;;;;;;;GAOG;AACH,qBAAa,6BAA8B,SAAQ,KAAK;IACtD;;;;OAIG;;CAMJ;AAED;;;;;;;GAOG;AACH,qBAAa,iCAAkC,SAAQ,KAAK;IAC1D;;;;;;OAMG;IACH,SAAgB,OAAO,EAAE,mCAAmC,CAAC;IAC7D;;;;;OAKG;gBACS,OAAO,EAAE,mCAAmC;CAMzD;AAED;;;;;;;;GAQG;AACH,qBAAa,8BAA+B,SAAQ,KAAK;IACvD;;;;;;OAMG;IACH,SAAgB,QAAQ,EAAE,GAAG,EAAE,CAAM;IACrC;;;;;;OAMG;IACH,SAAgB,QAAQ,EAAE,GAAG,CAAY;IAEzC;;;;;;OAMG;gBACS,QAAQ,EAAE,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG;CAO3C;AAED;;;;;;;;;GASG;AACH,qBAAa,8BAA+B,SAAQ,KAAK;IACvD;;;;OAIG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;;OAKG;gBACS,QAAQ,EAAE,OAAO;CAO9B;AAED;;;;;;;GAOG;AACH,qBAAa,4BAA6B,SAAQ,KAAK;IACrD;;;;;OAKG;gBACS,gBAAgB,EAAE,MAAM;CAKrC;AAED;;;;;;;GAOG;AACH,qBAAa,yBAA0B,SAAQ,KAAK;IAClD;;OAEG;;CAIJ;AAED;;;;;;;;GAQG;AACH,qBAAa,0BAA2B,SAAQ,KAAK;IACnD;;;;;OAKG;gBACS,SAAS,EAAE,SAAS;CAGjC;AAED;;;;;;;GAOG;AACH,qBAAa,+BAAgC,SAAQ,KAAK;IACxD;;;;OAIG;;CAIJ;AAED;;;;;;;GAOG;AACH,qBAAa,oCAAqC,SAAQ,KAAK;IAC7D;;;;OAIG;;CAMJ;AAED;;;;;GAKG;AACH,UAAU,yBAAyB;IACjC;;;;OAIG;IACH,GAAG,EAAE,GAAG,CAAC;IACT;;;;;OAKG;IACH,UAAU,EAAE,GAAG,CAAC;IAChB;;;;OAIG;IACH,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,qBAAa,0BAA2B,SAAQ,KAAK;IACnD;;;;OAIG;IACH,GAAG,EAAE,GAAG,CAAC;IACT;;;;;OAKG;IACH,UAAU,EAAE,GAAG,CAAC;IAChB;;;;OAIG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB;;;;;;;;;OASG;gBAED,OAAO,EAAE,MAAM,EACf,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,EAAE,EAAE,yBAAyB;CAO3D;AAED;;;;;;;GAOG;AACH,qBAAa,wBAAyB,SAAQ,0BAA0B;IACtE;;;;;OAKG;gBACS,QAAQ,EAAE,yBAAyB;CAGhD;AAED;;;;;;;GAOG;AACH,qBAAa,6BAA8B,SAAQ,0BAA0B;IAC3E;;;;;OAKG;gBACS,QAAQ,EAAE,yBAAyB;CAMhD;AAED;;;;;;;GAOG;AACH,qBAAa,4BAA6B,SAAQ,0BAA0B;IAC1E;;;;;OAKG;gBACS,QAAQ,EAAE,yBAAyB;CAGhD;AAED;;;;;;;GAOG;AACH,qBAAa,2BAA4B,SAAQ,0BAA0B;IACzE;;;;;OAKG;gBACS,QAAQ,EAAE,yBAAyB;CAGhD"}