@boostxyz/sdk 0.0.0-alpha.2

package/dist/Validators/Validator.d.ts

@@ -0,0 +1,31 @@
+import type { Address } from 'viem';
+import type { DeployableOptions } from '../Deployable/Deployable';
+import { SignerValidator } from './SignerValidator';
+export { SignerValidator };
+/**
+ * A union type representing all valid protocol Validator implementations
+ *
+ * @export
+ * @typedef {Validator}
+ */
+export type Validator = SignerValidator;
+/**
+ * A map of Validator component interfaces to their constructors.
+ *
+ * @type {{ "0xd8725ea2": typeof SignerValidator; }}
+ */
+export declare const ValidatorByComponentInterface: {
+    "0xb8ce7b22": typeof SignerValidator;
+};
+/**
+ * A function that will read a contract's component interface using `getComponentInterface` and return the correct instantiated instance.
+ *
+ * @export
+ * @async
+ * @param {DeployableOptions} options
+ * @param {Address} address
+ * @returns {unknown}
+ * @throws {@link InvalidComponentInterfaceError}
+ */
+export declare function validatorFromAddress(options: DeployableOptions, address: Address): Promise<SignerValidator>;
+//# sourceMappingURL=Validator.d.ts.map

package/dist/Validators/Validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Validator.d.ts","sourceRoot":"","sources":["../../src/Validators/Validator.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAO,MAAM,MAAM,CAAC;AACzC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAElE,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,EAAE,eAAe,EAAE,CAAC;AAE3B;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,eAAe,CAAC;AAExC;;;;GAIG;AACH,eAAO,MAAM,6BAA6B;;CAEzC,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,iBAAiB,EAC1B,OAAO,EAAE,OAAO,4BAejB"}

package/dist/Validators/Validator.js

@@ -0,0 +1,25 @@
+import { r as a } from "../generated-x_abr3Yv.js";
+import { readContract as i } from "@wagmi/core";
+import { InvalidComponentInterfaceError as c } from "../errors.js";
+import { SignerValidator as m } from "./SignerValidator.js";
+const e = {
+  "0xb8ce7b22": m
+};
+async function C(r, o) {
+  const t = await i(r.config, {
+    abi: a,
+    functionName: "getComponentInterface",
+    address: o
+  }), n = e[t];
+  if (!n)
+    throw new c(
+      Object.keys(e),
+      t
+    );
+  return new n(r, o);
+}
+export {
+  m as SignerValidator,
+  e as ValidatorByComponentInterface,
+  C as validatorFromAddress
+};

package/dist/errors.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("viem");class s extends Error{constructor(){super('No "BoostCreated" log was emitted from which to extract boostId')}}class a extends Error{constructor(){super("Attempted to call contract method without providing an address")}}class n extends Error{constructor(e){super("Attempted to deploy a contract that already has an address configured"),this.address=e}}class d extends Error{constructor(){super("Implementing class did not properly override the `buildParameters` method")}}class i extends Error{constructor(){super("Expected an an owner to be provided in configuration or an account to exist on Wagmi config.")}}class c extends Error{constructor(){super("Expected a valid Wagmi configuration to be available either on Deployable, or as argument to deploy.")}}class l extends Error{constructor(){super("Expected a valid payload to be available either on Deployable or as argument to deploy.")}}class p extends Error{constructor(e){super("Expected a contract address to exist on receipt.",{cause:e}),this.receipt=e}}class u extends Error{constructor(e,o){super("Address provided does not match any expected protocol interface",{cause:{expected:e,received:o}}),this.expected=[],this.received=t.zeroHash,this.expected=e,this.received=o}}class E extends Error{constructor(e){super("Did not provide a valid FungibleTransferPayload or ERC1155 transfer payload.",{cause:e}),this.received=e}}class y extends Error{constructor(e){super(`Budget needs to explicitly authorize ${e}. You can retrieve this value from BoostCore.address`)}}class m extends Error{constructor(e){super(`Incentive not cloneable: ${e.constructor.name}`)}}exports.BoostCoreNoIdentifierEmitted=s;exports.BudgetMustAuthorizeBoostCore=y;exports.ContractAddressRequiredError=a;exports.DeployableAlreadyDeployedError=n;exports.DeployableBuildParametersUnspecifiedError=d;exports.DeployableMissingPayloadError=l;exports.DeployableUnknownOwnerProvidedError=i;exports.DeployableWagmiConfigurationRequiredError=c;exports.IncentiveNotCloneableError=m;exports.InvalidComponentInterfaceError=u;exports.NoContractAddressUponReceiptError=p;exports.UnknownTransferPayloadSupplied=E;

package/dist/errors.d.ts

@@ -0,0 +1,257 @@
+import { type Hex, type WaitForTransactionReceiptReturnType } from 'viem';
+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);
+}
+/**
+ * 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);
+}
+//# 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,mCAAmC,EAEzC,MAAM,MAAM,CAAC;AACd,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;;;;;;;;GAQG;AACH,qBAAa,0BAA2B,SAAQ,KAAK;IACnD;;;;;OAKG;gBACS,SAAS,EAAE,SAAS;CAGjC"}

package/dist/errors.js

@@ -0,0 +1,161 @@
+import { zeroHash as t } from "viem";
+class a extends Error {
+  /**
+   * Creates an instance of BoostCoreNoIdentifierEmitted.
+   *
+   * @constructor
+   */
+  constructor() {
+    super('No "BoostCreated" log was emitted from which to extract boostId');
+  }
+}
+class n extends Error {
+  /**
+   * Creates an instance of ContractAddressRequiredError.
+   *
+   * @constructor
+   */
+  constructor() {
+    super("Attempted to call contract method without providing an address");
+  }
+}
+class d extends Error {
+  /**
+   * Creates an instance of DeployableAlreadyDeployedError.
+   *
+   * @constructor
+   * @param {string} address
+   */
+  constructor(e) {
+    super(
+      "Attempted to deploy a contract that already has an address configured"
+    ), this.address = e;
+  }
+}
+class c extends Error {
+  /**
+   * Creates an instance of DeployableBuildParametersUnspecifiedError.
+   *
+   * @constructor
+   */
+  constructor() {
+    super(
+      "Implementing class did not properly override the `buildParameters` method"
+    );
+  }
+}
+class i extends Error {
+  /**
+   * Creates an instance of DeployableUnknownOwnerProvidedError.
+   *
+   * @constructor
+   */
+  constructor() {
+    super(
+      "Expected an an owner to be provided in configuration or an account to exist on Wagmi config."
+    );
+  }
+}
+class l extends Error {
+  /**
+   * Creates an instance of DeployableWagmiConfigurationRequiredError.
+   *
+   * @constructor
+   */
+  constructor() {
+    super(
+      "Expected a valid Wagmi configuration to be available either on Deployable, or as argument to deploy."
+    );
+  }
+}
+class p extends Error {
+  /**
+   * Creates an instance of DeployableMissingPayloadError.
+   *
+   * @constructor
+   */
+  constructor() {
+    super(
+      "Expected a valid payload to be available either on Deployable or as argument to deploy."
+    );
+  }
+}
+class u extends Error {
+  /**
+   * Creates an instance of NoContractAddressUponReceiptError.
+   *
+   * @constructor
+   * @param {WaitForTransactionReceiptReturnType} receipt
+   */
+  constructor(e) {
+    super("Expected a contract address to exist on receipt.", {
+      cause: e
+    }), this.receipt = e;
+  }
+}
+class E extends Error {
+  /**
+   * Creates an instance of InvalidComponentInterfaceError.
+   *
+   * @constructor
+   * @param {Hex[]} expected
+   * @param {Hex} received
+   */
+  constructor(e, o) {
+    super("Address provided does not match any expected protocol interface", {
+      cause: { expected: e, received: o }
+    }), this.expected = [], this.received = t, this.expected = e, this.received = o;
+  }
+}
+class x extends Error {
+  /**
+   * Creates an instance of UnknownTransferPayloadSupplied.
+   *
+   * @constructor
+   * @param {unknown} received
+   */
+  constructor(e) {
+    super(
+      "Did not provide a valid FungibleTransferPayload or ERC1155 transfer payload.",
+      { cause: e }
+    ), this.received = e;
+  }
+}
+class h extends Error {
+  /**
+   * Creates an instance of BudgetMustAuthorizeBoostCore.
+   *
+   * @constructor
+   * @param {string} boostCoreAddress
+   */
+  constructor(e) {
+    super(
+      `Budget needs to explicitly authorize ${e}. You can retrieve this value from BoostCore.address`
+    );
+  }
+}
+class m extends Error {
+  /**
+   * Creates an instance of IncentiveNotCloneableError.
+   *
+   * @constructor
+   * @param {Incentive} incentive
+   */
+  constructor(e) {
+    super(`Incentive not cloneable: ${e.constructor.name}`);
+  }
+}
+export {
+  a as BoostCoreNoIdentifierEmitted,
+  h as BudgetMustAuthorizeBoostCore,
+  n as ContractAddressRequiredError,
+  d as DeployableAlreadyDeployedError,
+  c as DeployableBuildParametersUnspecifiedError,
+  p as DeployableMissingPayloadError,
+  i as DeployableUnknownOwnerProvidedError,
+  l as DeployableWagmiConfigurationRequiredError,
+  m as IncentiveNotCloneableError,
+  E as InvalidComponentInterfaceError,
+  u as NoContractAddressUponReceiptError,
+  x as UnknownTransferPayloadSupplied
+};