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

package/src/Validators/Validator.ts

@@ -0,0 +1,55 @@
+import { aValidatorAbi } from '@boostxyz/evm';
+import { ASignerValidator } from '@boostxyz/evm/deploys/componentInterfaces.json';
+import { readContract } from '@wagmi/core';
+import type { Address, Hex } from 'viem';
+import type { DeployableOptions } from '../Deployable/Deployable';
+import { InvalidComponentInterfaceError } from '../errors';
+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 const ValidatorByComponentInterface = {
+  [ASignerValidator as Hex]: 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 {Promise<Validator>}
+ * @throws {@link InvalidComponentInterfaceError}
+ */
+export async function validatorFromAddress(
+  options: DeployableOptions,
+  address: Address,
+) {
+  const interfaceId = (await readContract(options.config, {
+    abi: aValidatorAbi,
+    functionName: 'getComponentInterface',
+    address,
+  })) as keyof typeof ValidatorByComponentInterface;
+  const Ctor = ValidatorByComponentInterface[interfaceId];
+  if (!Ctor) {
+    throw new InvalidComponentInterfaceError(
+      Object.keys(ValidatorByComponentInterface) as Hex[],
+      interfaceId as Hex,
+    );
+  }
+  return new Ctor(options, address);
+}

package/src/claiming.ts

@@ -0,0 +1,56 @@
+import { type Address, type Hex, encodeAbiParameters, zeroHash } from 'viem';
+
+/**
+ * Enum representing incentive disbursement strategies.
+ *
+ * @export
+ * @enum {number}
+ */
+export enum StrategyType {
+  POOL = 0,
+  MINT = 1,
+  RAFFLE = 2,
+}
+
+/**
+ * The object representation of an `Incentive.ClaimPayload`
+ *
+ * @export
+ * @interface ClaimPayload
+ * @typedef {ClaimPayload}
+ */
+export interface ClaimPayload {
+  /**
+   * The address of the recipient
+   *
+   * @type {Address}
+   */
+  target: Address;
+  /**
+   * The implementation-specific data for the claim, if needed
+   *
+   * @type {?Hex}
+   */
+  data?: Hex;
+}
+
+/**
+ * Given a valid {@link ClaimPayload}, encode the payload for use with Incentive operations.
+ *
+ * @param {ClaimPayload} param0
+ * @param {Address} param0.target - The address of the recipient
+ * @param {Hex} [param0.data=zeroHash] - The implementation-specific data for the claim, if needed
+ * @returns {Hex}
+ */
+export const prepareClaimPayload = ({
+  target,
+  data = zeroHash,
+}: ClaimPayload) => {
+  return encodeAbiParameters(
+    [
+      { type: 'address', name: 'target' },
+      { type: 'bytes', name: 'data' },
+    ],
+    [target, data],
+  );
+};