@boostxyz/sdk 0.0.0-alpha.8 → 0.0.0-alpha.9

package/dist/Validators/SignerValidator.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"SignerValidator.cjs","sources":["../../src/Validators/SignerValidator.ts"],"sourcesContent":["import {\n  readSignerValidatorHashSignerData,\n  readSignerValidatorSigners,\n  signerValidatorAbi,\n  simulateSignerValidatorSetAuthorized,\n  simulateSignerValidatorSetValidatorCaller,\n  simulateSignerValidatorValidate,\n  writeSignerValidatorSetAuthorized,\n  writeSignerValidatorSetValidatorCaller,\n  writeSignerValidatorValidate,\n} from '@boostxyz/evm';\nimport { bytecode } from '@boostxyz/evm/artifacts/contracts/validators/SignerValidator.sol/SignerValidator.json';\nimport type { Address, ContractEventName, Hex } from 'viem';\nimport type {\n  DeployableOptions,\n  GenericDeployableParams,\n} from '../Deployable/Deployable';\nimport { DeployableTarget } from '../Deployable/DeployableTarget';\nimport {\n  type GenericLog,\n  type ReadParams,\n  RegistryType,\n  type SignerValidatorPayload,\n  type SignerValidatorSignaturePayload,\n  type SignerValidatorValidatePayload,\n  type WriteParams,\n  prepareSignerValidatorPayload,\n} from '../utils';\n\nexport { signerValidatorAbi };\nexport type { SignerValidatorPayload };\n\n/**\n * A generic `viem.Log` event with support for `BoostCore` event types.\n *\n * @export\n * @typedef {SignerValidatorLog}\n * @template {ContractEventName<\n *     typeof signerValidatorAbi\n *   >} [event=ContractEventName<typeof signerValidatorAbi>]\n */\nexport type SignerValidatorLog<\n  event extends ContractEventName<\n    typeof signerValidatorAbi\n  > = ContractEventName<typeof signerValidatorAbi>,\n> = GenericLog<typeof signerValidatorAbi, event>;\n\n/**\n *  A simple implementation of a Validator that verifies a given signature and checks the recovered address against a set of authorized signers\n *\n * @export\n * @class SignerValidator\n * @typedef {SignerValidator}\n * @extends {DeployableTarget<SignerValidatorPayload>}\n */\nexport class SignerValidator extends DeployableTarget<\n  SignerValidatorPayload,\n  typeof signerValidatorAbi\n> {\n  public override readonly abi = signerValidatorAbi;\n  /**\n   * @inheritdoc\n   *\n   * @public\n   * @static\n   * @type {Address}\n   */\n  public static override base: Address = import.meta.env\n    .VITE_SIGNER_VALIDATOR_BASE;\n  /**\n   * @inheritdoc\n   *\n   * @public\n   * @static\n   * @type {RegistryType}\n   */\n  public static override registryType: RegistryType = RegistryType.VALIDATOR;\n\n  /**\n   * The set of authorized signers\n   *\n   * @public\n   * @async\n   * @param {Address} address\n   * @param {?ReadParams<typeof signerValidatorAbi, 'signers'>} [params]\n   * @returns {unknown}\n   */\n  public async signers(\n    address: Address,\n    params?: ReadParams<typeof signerValidatorAbi, 'signers'>,\n  ) {\n    return readSignerValidatorSigners(this._config, {\n      address: this.assertValidAddress(),\n      args: [address],\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   * Retrieve the hash and signer data for a given hash\n   *\n   * @public\n   * @async\n   * @param {SignerValidatorSignaturePayload} payload\n   * @param {?ReadParams<typeof signerValidatorAbi, 'hashSignerData'>} [params]\n   * @returns {unknown}\n   */\n  public async hashSignerData(\n    payload: SignerValidatorSignaturePayload,\n    params?: ReadParams<typeof signerValidatorAbi, 'hashSignerData'>,\n  ) {\n    return readSignerValidatorHashSignerData(this._config, {\n      address: this.assertValidAddress(),\n      args: [\n        payload.boostId,\n        payload.incentiveQuantity,\n        payload.claimant,\n        payload.incentiveData,\n      ],\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   * Validate that the action has been completed successfully. The data payload is expected to be a tuple of (address signer, bytes32 hash, bytes signature). The signature is expected to be a valid ECDSA or EIP-1271 signature of a unique hash by an authorized signer.\n   *\n   * @public\n   * @async\n   * @param {SignerValidatorValidatePayload} payload\n   * @param {?WriteParams<typeof signerValidatorAbi, 'validate'>} [params]\n   * @returns {Promise<boolean>} - True if the action has been validated based on the data payload\n   */\n  public async validate(\n    payload: SignerValidatorValidatePayload,\n    params?: WriteParams<typeof signerValidatorAbi, 'validate'>,\n  ) {\n    return this.awaitResult(this.validateRaw(payload, params));\n  }\n\n  /**\n   * Validate that the action has been completed successfully. The data payload is expected to be a tuple of (address signer, bytes32 hash, bytes signature). The signature is expected to be a valid ECDSA or EIP-1271 signature of a unique hash by an authorized signer.\n   *\n   * @public\n   * @async\n   * @param {SignerValidatorValidatePayload} payload\n   * @param {?WriteParams<typeof signerValidatorAbi, 'validate'>} [params]\n   * @returns {Promise<boolean>} - True if the action has been validated based on the data payload\n   */\n  public async validateRaw(\n    payload: SignerValidatorValidatePayload,\n    params?: ReadParams<typeof signerValidatorAbi, 'validate'>,\n  ) {\n    const { request, result } = await simulateSignerValidatorValidate(\n      this._config,\n      {\n        address: this.assertValidAddress(),\n        args: [\n          payload.boostId,\n          payload.incentiveId,\n          payload.claimant,\n          payload.claimData,\n        ],\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 writeSignerValidatorValidate(this._config, request);\n    return { hash, result };\n  }\n\n  /**\n   * Set the authorized status of a signer\n   *\n   * @public\n   * @async\n   * @param {Address[]} addresses - The list of signers to update\n   * @param {boolean[]} allowed - The authorized status of each signer\n   * @param {?WriteParams<typeof signerValidatorAbi, 'setAuthorized'>} [params]\n   * @returns {unknown}\n   */\n  public async setAuthorized(\n    addresses: Address[],\n    allowed: boolean[],\n    params?: WriteParams<typeof signerValidatorAbi, 'setAuthorized'>,\n  ) {\n    return this.awaitResult(this.setAuthorizedRaw(addresses, allowed, params));\n  }\n\n  /**\n   * Set the authorized status of a signer\n   *\n   * @public\n   * @async\n   * @param {Address[]} addresses - The list of signers to update\n   * @param {boolean[]} allowed - The authorized status of each signer\n   * @param {?WriteParams<typeof signerValidatorAbi, 'setAuthorized'>} [params]\n   * @returns {unknown}\n   */\n  public async setAuthorizedRaw(\n    addresses: Address[],\n    allowed: boolean[],\n    params?: WriteParams<typeof signerValidatorAbi, 'setAuthorized'>,\n  ) {\n    const { request, result } = await simulateSignerValidatorSetAuthorized(\n      this._config,\n      {\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    );\n    const hash = await writeSignerValidatorSetAuthorized(this._config, request);\n    return { hash, result };\n  }\n\n  public async setValidatorCallerRaw(\n    address: Address,\n    params?: WriteParams<typeof signerValidatorAbi, 'setValidatorCaller'>,\n  ) {\n    const { request, result } = await simulateSignerValidatorSetValidatorCaller(\n      this._config,\n      {\n        address: this.assertValidAddress(),\n        args: [address],\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 writeSignerValidatorSetValidatorCaller(\n      this._config,\n      request,\n    );\n    return { hash, result };\n  }\n\n  public async setValidatorCaller(\n    address: Address,\n    params?: WriteParams<typeof signerValidatorAbi, 'setValidatorCaller'>,\n  ) {\n    return this.awaitResult(this.setValidatorCallerRaw(address, params));\n  }\n\n  /**\n   * @inheritdoc\n   *\n   * @public\n   * @param {?SignerValidatorPayload} [_payload]\n   * @param {?DeployableOptions} [_options]\n   * @returns {GenericDeployableParams}\n   */\n  public override buildParameters(\n    _payload?: SignerValidatorPayload,\n    _options?: DeployableOptions,\n  ): GenericDeployableParams {\n    const [payload, options] = this.validateDeploymentConfig(\n      _payload,\n      _options,\n    );\n    return {\n      abi: signerValidatorAbi,\n      bytecode: bytecode as Hex,\n      args: [prepareSignerValidatorPayload(payload)],\n      ...this.optionallyAttachAccount(options.account),\n    };\n  }\n}\n"],"names":["_SignerValidator","DeployableTarget","signerValidatorAbi","address","params","readSignerValidatorSigners","payload","readSignerValidatorHashSignerData","request","result","simulateSignerValidatorValidate","writeSignerValidatorValidate","addresses","allowed","simulateSignerValidatorSetAuthorized","writeSignerValidatorSetAuthorized","simulateSignerValidatorSetValidatorCaller","writeSignerValidatorSetValidatorCaller","_payload","_options","options","bytecode","prepareSignerValidatorPayload","RegistryType","SignerValidator"],"mappings":"03hBAuDaA,EAAN,MAAMA,UAAwBC,EAAAA,gBAGnC,CAHK,aAAA,CAAA,MAAA,GAAA,SAAA,EAIL,KAAyB,IAAMC,GAAA,CA4B/B,MAAa,QACXC,EACAC,EACA,CACO,OAAAC,EAAA,GAA2B,KAAK,QAAS,CAC9C,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACF,CAAO,EAEd,GAAIC,CAAA,CACL,CACH,CAWA,MAAa,eACXE,EACAF,EACA,CACO,OAAAG,EAAA,GAAkC,KAAK,QAAS,CACrD,QAAS,KAAK,mBAAmB,EACjC,KAAM,CACJD,EAAQ,QACRA,EAAQ,kBACRA,EAAQ,SACRA,EAAQ,aACV,EAEA,GAAIF,CAAA,CACL,CACH,CAWA,MAAa,SACXE,EACAF,EACA,CACA,OAAO,KAAK,YAAY,KAAK,YAAYE,EAASF,CAAM,CAAC,CAC3D,CAWA,MAAa,YACXE,EACAF,EACA,CACA,KAAM,CAAE,QAAAI,EAAS,OAAAC,CAAO,EAAI,MAAMC,EAAA,GAChC,KAAK,QACL,CACE,QAAS,KAAK,mBAAmB,EACjC,KAAM,CACJJ,EAAQ,QACRA,EAAQ,YACRA,EAAQ,SACRA,EAAQ,SACV,EACA,GAAG,KAAK,wBAAwB,EAEhC,GAAIF,CACN,CAAA,EAGK,MAAA,CAAE,KADI,MAAMO,EAA6B,GAAA,KAAK,QAASH,CAAO,EACtD,OAAAC,EACjB,CAYA,MAAa,cACXG,EACAC,EACAT,EACA,CACA,OAAO,KAAK,YAAY,KAAK,iBAAiBQ,EAAWC,EAAST,CAAM,CAAC,CAC3E,CAYA,MAAa,iBACXQ,EACAC,EACAT,EACA,CACA,KAAM,CAAE,QAAAI,EAAS,OAAAC,CAAO,EAAI,MAAMK,EAAA,GAChC,KAAK,QACL,CACE,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACF,EAAWC,CAAO,EACzB,GAAG,KAAK,wBAAwB,EAEhC,GAAIT,CACN,CAAA,EAGK,MAAA,CAAE,KADI,MAAMW,EAAkC,GAAA,KAAK,QAASP,CAAO,EAC3D,OAAAC,EACjB,CAEA,MAAa,sBACXN,EACAC,EACA,CACA,KAAM,CAAE,QAAAI,EAAS,OAAAC,CAAO,EAAI,MAAMO,EAAA,GAChC,KAAK,QACL,CACE,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACb,CAAO,EACd,GAAG,KAAK,wBAAwB,EAEhC,GAAIC,CACN,CAAA,EAMK,MAAA,CAAE,KAJI,MAAMa,EAAA,GACjB,KAAK,QACLT,CAAA,EAEa,OAAAC,EACjB,CAEA,MAAa,mBACXN,EACAC,EACA,CACA,OAAO,KAAK,YAAY,KAAK,sBAAsBD,EAASC,CAAM,CAAC,CACrE,CAUgB,gBACdc,EACAC,EACyB,CACzB,KAAM,CAACb,EAASc,CAAO,EAAI,KAAK,yBAC9BF,EACAC,CAAA,EAEK,MAAA,CACL,IAAKjB,EAAA,EACL,SAAAmB,EACA,KAAM,CAACC,gCAA8BhB,CAAO,CAAC,EAC7C,GAAG,KAAK,wBAAwBc,EAAQ,OAAO,CAAA,CAEnD,CACF,EA5MyBpB,EAAA,KAAgB,6CASvCA,EAAuB,aAA6BuB,EAAa,aAAA,UArB5D,IAAMC,EAANxB"}
+{"version":3,"file":"SignerValidator.cjs","sources":["../../src/Validators/SignerValidator.ts"],"sourcesContent":["import {\n  readSignerValidatorHashSignerData,\n  readSignerValidatorSigners,\n  signerValidatorAbi,\n  simulateSignerValidatorSetAuthorized,\n  simulateSignerValidatorSetValidatorCaller,\n  simulateSignerValidatorValidate,\n  writeSignerValidatorSetAuthorized,\n  writeSignerValidatorSetValidatorCaller,\n  writeSignerValidatorValidate,\n} from '@boostxyz/evm';\nimport { bytecode } from '@boostxyz/evm/artifacts/contracts/validators/SignerValidator.sol/SignerValidator.json';\nimport {\n  type Address,\n  type ContractEventName,\n  type Hex,\n  type PrivateKeyAccount,\n  encodeAbiParameters,\n} from 'viem';\nimport { signTypedData } from 'viem/accounts';\nimport type {\n  DeployableOptions,\n  GenericDeployableParams,\n} from '../Deployable/Deployable';\nimport { DeployableTarget } from '../Deployable/DeployableTarget';\nimport {\n  type GenericLog,\n  type ReadParams,\n  RegistryType,\n  type WriteParams,\n} from '../utils';\n\nexport { signerValidatorAbi };\n\n/**\n * Object reprentation of a {@link SignerValidator} initialization payload\n *\n * @export\n * @interface SignerValidatorPayload\n * @typedef {SignerValidatorPayload}\n */\nexport interface SignerValidatorPayload {\n  /**\n   * The list of authorized signers. The first address in the list will be the initial owner of the contract.\n   *\n   * @type {Address[]}\n   */\n  signers: Address[];\n  /**\n   * The authorized caller of the {@link prepareSignerValidator} function\n   * @type {Address}\n   */\n  validatorCaller: Address;\n}\n\n/**\n * Description placeholder\n *\n * @export\n * @interface SignerValidatorValidatePayload\n * @typedef {SignerValidatorValidatePayload}\n */\nexport interface SignerValidatorValidatePayload {\n  /**\n   * The ID of the boost.\n   *\n   * @type {bigint}\n   */\n  boostId: bigint;\n  /**\n   * The ID of the incentive.\n   *\n   * @type {bigint}\n   */\n  incentiveId: bigint;\n  /**\n   * The address of the claimant.\n   *\n   * @type {Address}\n   */\n  claimant: Address;\n  /**\n   * The claim data.\n   *\n   * @type {Hex}\n   */\n  claimData: Hex;\n}\n\n/**\n * Object reprentation of a {@link SignerValidator} initialization payload\n *\n * @export\n * @interface SignerValidatorPayload\n * @typedef {SignerValidatorPayload}\n */\nexport interface SignerValidatorPayload {\n  /**\n   * The list of authorized signers. The first address in the list will be the initial owner of the contract.\n   *\n   * @type {Address[]}\n   */\n  signers: Address[];\n  /**\n   * The authorized caller of the {@link prepareSignerValidator} function\n   * @type {Address}\n   */\n  validatorCaller: Address;\n}\n\n/**\n * Description placeholder\n *\n * @export\n * @interface SignerValidatorValidatePayload\n * @typedef {SignerValidatorValidatePayload}\n */\nexport interface SignerValidatorValidatePayload {\n  /**\n   * The ID of the boost.\n   *\n   * @type {bigint}\n   */\n  boostId: bigint;\n  /**\n   * The ID of the incentive.\n   *\n   * @type {bigint}\n   */\n  incentiveId: bigint;\n  /**\n   * The address of the claimant.\n   *\n   * @type {Address}\n   */\n  claimant: Address;\n  /**\n   * The claim data.\n   *\n   * @type {Hex}\n   */\n  claimData: Hex;\n}\n\n/**\n * Signer Validator Claim Data Payload\n *\n * @export\n * @interface SignerValidatorClaimDataParams\n * @typedef {SignerValidatorClaimDataParams}\n */\nexport interface SignerValidatorClaimDataParams {\n  /**\n   * The signer with which to sign the input\n   *\n   * @type {{\n   *     account: Address;\n   *     key: Hex;\n   *     privateKey: PrivateKeyAccount;\n   *   }}\n   */\n  signer: {\n    account: Address;\n    key: Hex;\n    privateKey: PrivateKeyAccount;\n  };\n  /**\n   * The encoded data to provide the underlying incentive. You can use {@link prepareAllowListIncentivePayload}, {@link prepareCGDAIncentivePayload}, {@link prepareERC20IncentivePayload}, {@link prepareERC1155IncentivePayload}, or {@link preparePointsIncentivePayload}\n   *\n   * @type {Hex}\n   */\n  incentiveData: Hex;\n  /**\n   * The chain id to target\n   *\n   * @type {number}\n   */\n  chainId: number;\n  /**\n   * The address of the validator\n   *\n   * @type {Address}\n   */\n  validator: Address;\n  /**\n   * The incentive quantity.\n   *\n   * @type {number}\n   */\n  incentiveQuantity: number;\n  /**\n   * The address of the claimant\n   *\n   * @type {Address}\n   */\n  claimant: Address;\n  /**\n   * The ID of the boost\n   *\n   * @type {bigint}\n   */\n  boostId: bigint;\n}\n\n/**\n * Object representation of a {@link SignerValidatorInputParams} initialization payload\n *\n * @export\n * @interface SignerValidatorInputParams\n * @typedef {SignerValidatorInputParams}\n */\nexport interface SignerValidatorInputParams {\n  /**\n   * The signer address.\n   *\n   * @type {Address}\n   */\n  signer: Address;\n\n  /**\n   * The signature data.\n   *\n   * @type {string}\n   */\n  signature: Hex;\n\n  /**\n   * The incentive quantity.\n   *\n   * @type {number}\n   */\n  incentiveQuantity: number;\n}\n\n/**\n * Object representing the payload for signing before validaton.\n *\n * @export\n * @interface SignerValidatorSignaturePayload\n * @typedef {SignerValidatorSignaturePayload}\n */\nexport interface SignerValidatorSignaturePayload {\n  /**\n   * The ID of the boost.\n   *\n   * @type {bigint}\n   */\n  boostId: bigint;\n  /**\n   * The ID of the incentive.\n   *\n   * @type {number}\n   */\n  incentiveQuantity: number;\n  /**\n   * The address of the claimant.\n   *\n   * @type {Address}\n   */\n  claimant: Address;\n  /**\n   * The claim data.\n   *\n   * @type {Hex}\n   */\n  incentiveData: Hex;\n}\n\n/**\n * A generic `viem.Log` event with support for `BoostCore` event types.\n *\n * @export\n * @typedef {SignerValidatorLog}\n * @template {ContractEventName<\n *     typeof signerValidatorAbi\n *   >} [event=ContractEventName<typeof signerValidatorAbi>]\n */\nexport type SignerValidatorLog<\n  event extends ContractEventName<\n    typeof signerValidatorAbi\n  > = ContractEventName<typeof signerValidatorAbi>,\n> = GenericLog<typeof signerValidatorAbi, event>;\n\n/**\n *  A simple implementation of a Validator that verifies a given signature and checks the recovered address against a set of authorized signers\n *\n * @export\n * @class SignerValidator\n * @typedef {SignerValidator}\n * @extends {DeployableTarget<SignerValidatorPayload>}\n */\nexport class SignerValidator extends DeployableTarget<\n  SignerValidatorPayload,\n  typeof signerValidatorAbi\n> {\n  /**\n   * @inheritdoc\n   *\n   * @public\n   * @readonly\n   * @type {*}\n   */\n  public override readonly abi = signerValidatorAbi;\n  /**\n   * @inheritdoc\n   *\n   * @public\n   * @static\n   * @type {Address}\n   */\n  public static override base: Address = import.meta.env\n    .VITE_SIGNER_VALIDATOR_BASE;\n  /**\n   * @inheritdoc\n   *\n   * @public\n   * @static\n   * @type {RegistryType}\n   */\n  public static override registryType: RegistryType = RegistryType.VALIDATOR;\n\n  /**\n   * The set of authorized signers\n   *\n   * @public\n   * @async\n   * @param {Address} address\n   * @param {?ReadParams<typeof signerValidatorAbi, 'signers'>} [params]\n   * @returns {unknown}\n   */\n  public async signers(\n    address: Address,\n    params?: ReadParams<typeof signerValidatorAbi, 'signers'>,\n  ) {\n    return await readSignerValidatorSigners(this._config, {\n      address: this.assertValidAddress(),\n      args: [address],\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   * Retrieve the hash and signer data for a given hash\n   *\n   * @public\n   * @async\n   * @param {SignerValidatorSignaturePayload} payload\n   * @param {?ReadParams<typeof signerValidatorAbi, 'hashSignerData'>} [params]\n   * @returns {unknown}\n   */\n  public async hashSignerData(\n    payload: SignerValidatorSignaturePayload,\n    params?: ReadParams<typeof signerValidatorAbi, 'hashSignerData'>,\n  ) {\n    return await readSignerValidatorHashSignerData(this._config, {\n      address: this.assertValidAddress(),\n      args: [\n        payload.boostId,\n        payload.incentiveQuantity,\n        payload.claimant,\n        payload.incentiveData,\n      ],\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   * Validate that the action has been completed successfully. The data payload is expected to be a tuple of (address signer, bytes32 hash, bytes signature). The signature is expected to be a valid ECDSA or EIP-1271 signature of a unique hash by an authorized signer.\n   *\n   * @public\n   * @async\n   * @param {SignerValidatorValidatePayload} payload\n   * @param {?WriteParams<typeof signerValidatorAbi, 'validate'>} [params]\n   * @returns {Promise<boolean>} - True if the action has been validated based on the data payload\n   */\n  protected async validate(\n    payload: SignerValidatorValidatePayload,\n    params?: WriteParams<typeof signerValidatorAbi, 'validate'>,\n  ) {\n    return await this.awaitResult(this.validateRaw(payload, params));\n  }\n\n  /**\n   * Validate that the action has been completed successfully. The data payload is expected to be a tuple of (address signer, bytes32 hash, bytes signature). The signature is expected to be a valid ECDSA or EIP-1271 signature of a unique hash by an authorized signer.\n   *\n   * @public\n   * @async\n   * @param {SignerValidatorValidatePayload} payload\n   * @param {?WriteParams<typeof signerValidatorAbi, 'validate'>} [params]\n   * @returns {Promise<boolean>} - True if the action has been validated based on the data payload\n   */\n  protected async validateRaw(\n    payload: SignerValidatorValidatePayload,\n    params?: ReadParams<typeof signerValidatorAbi, 'validate'>,\n  ) {\n    const { request, result } = await simulateSignerValidatorValidate(\n      this._config,\n      {\n        address: this.assertValidAddress(),\n        args: [\n          payload.boostId,\n          payload.incentiveId,\n          payload.claimant,\n          payload.claimData,\n        ],\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 writeSignerValidatorValidate(this._config, request);\n    return { hash, result };\n  }\n\n  /**\n   * Set the authorized status of a signer\n   *\n   * @public\n   * @async\n   * @param {Address[]} addresses - The list of signers to update\n   * @param {boolean[]} allowed - The authorized status of each signer\n   * @param {?WriteParams<typeof signerValidatorAbi, 'setAuthorized'>} [params]\n   * @returns {unknown}\n   */\n  public async setAuthorized(\n    addresses: Address[],\n    allowed: boolean[],\n    params?: WriteParams<typeof signerValidatorAbi, 'setAuthorized'>,\n  ) {\n    return await this.awaitResult(\n      this.setAuthorizedRaw(addresses, allowed, params),\n    );\n  }\n\n  /**\n   * Set the authorized status of a signer\n   *\n   * @public\n   * @async\n   * @param {Address[]} addresses - The list of signers to update\n   * @param {boolean[]} allowed - The authorized status of each signer\n   * @param {?WriteParams<typeof signerValidatorAbi, 'setAuthorized'>} [params]\n   * @returns {unknown}\n   */\n  public async setAuthorizedRaw(\n    addresses: Address[],\n    allowed: boolean[],\n    params?: WriteParams<typeof signerValidatorAbi, 'setAuthorized'>,\n  ) {\n    const { request, result } = await simulateSignerValidatorSetAuthorized(\n      this._config,\n      {\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    );\n    const hash = await writeSignerValidatorSetAuthorized(this._config, request);\n    return { hash, result };\n  }\n\n  /**\n   * Update the authorized caller of the validator function\n   *\n   * @public\n   * @async\n   * @param {Address} address\n   * @param {?WriteParams<typeof signerValidatorAbi, 'setValidatorCaller'>} [params]\n   * @returns {unknown}\n   */\n  public async setValidatorCallerRaw(\n    address: Address,\n    params?: WriteParams<typeof signerValidatorAbi, 'setValidatorCaller'>,\n  ) {\n    const { request, result } = await simulateSignerValidatorSetValidatorCaller(\n      this._config,\n      {\n        address: this.assertValidAddress(),\n        args: [address],\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 writeSignerValidatorSetValidatorCaller(\n      this._config,\n      request,\n    );\n    return { hash, result };\n  }\n\n  /**\n   * Update the authorized caller of the validator function\n   *\n   * @public\n   * @async\n   * @param {Address} address\n   * @param {?WriteParams<typeof signerValidatorAbi, 'setValidatorCaller'>} [params]\n   * @returns {unknown}\n   */\n  public async setValidatorCaller(\n    address: Address,\n    params?: WriteParams<typeof signerValidatorAbi, 'setValidatorCaller'>,\n  ) {\n    return await this.awaitResult(this.setValidatorCallerRaw(address, params));\n  }\n\n  /**\n   * Properly encodes the data needed to claim\n   *\n   * @public\n   * @async\n   * @param {SignerValidatorClaimDataParams} params\n   * @returns {Promise<Hex>}\n   */\n  public async encodeClaimData(\n    params: Omit<SignerValidatorClaimDataParams, 'validator'>,\n  ): Promise<Hex> {\n    return await prepareSignerValidatorClaimDataPayload({\n      ...params,\n      validator: this.assertValidAddress(),\n    });\n  }\n\n  /**\n   * @inheritdoc\n   *\n   * @public\n   * @param {?SignerValidatorPayload} [_payload]\n   * @param {?DeployableOptions} [_options]\n   * @returns {GenericDeployableParams}\n   */\n  public override buildParameters(\n    _payload?: SignerValidatorPayload,\n    _options?: DeployableOptions,\n  ): GenericDeployableParams {\n    const [payload, options] = this.validateDeploymentConfig(\n      _payload,\n      _options,\n    );\n    return {\n      abi: signerValidatorAbi,\n      bytecode: bytecode as Hex,\n      args: [prepareSignerValidatorPayload(payload)],\n      ...this.optionallyAttachAccount(options.account),\n    };\n  }\n}\n\n/**\n * Signer Validator Claim Data Payload Preparation\n *\n * @export\n * @async\n * @param {SignerValidatorClaimDataParams} param0\n * @param {{ account: Address; key: Hex; privateKey: PrivateKeyAccount; }} param0.signer\n * @param {Hex} param0.incentiveData\n * @param {number} param0.chainId\n * @param {Address} param0.validator\n * @param {number} param0.incentiveQuantity\n * @param {Address} param0.claimant\n * @param {bigint} param0.boostId\n * @returns {Promise<Hex>}\n */\nexport async function prepareSignerValidatorClaimDataPayload({\n  signer,\n  incentiveData,\n  chainId,\n  validator,\n  incentiveQuantity,\n  claimant,\n  boostId,\n}: SignerValidatorClaimDataParams): Promise<Hex> {\n  const domain = {\n    name: 'SignerValidator',\n    version: '1',\n    chainId: chainId,\n    verifyingContract: validator,\n  };\n  const typedData = {\n    domain,\n    types: {\n      SignerValidatorData: [\n        { name: 'boostId', type: 'uint256' },\n        { name: 'incentiveQuantity', type: 'uint8' },\n        { name: 'claimant', type: 'address' },\n        { name: 'incentiveData', type: 'bytes' },\n      ],\n    },\n    primaryType: 'SignerValidatorData' as const,\n    message: {\n      boostId,\n      incentiveQuantity,\n      claimant,\n      incentiveData: incentiveData,\n    },\n  };\n\n  const trustedSignature = await signTypedData({\n    ...typedData,\n    privateKey: signer.key,\n  });\n\n  // Prepare the claim data payload using the new helper\n  const validatorData = prepareSignerValidatorInputParams({\n    signer: signer.account,\n    signature: trustedSignature,\n    incentiveQuantity, // Adjust incentive quantity as necessary\n  });\n\n  const boostClaimDataPayload = encodeAbiParameters(\n    [\n      {\n        type: 'tuple',\n        name: 'BoostClaimData',\n        components: [\n          { type: 'bytes', name: 'validatorData' },\n          { type: 'bytes', name: 'incentiveData' },\n        ],\n      },\n    ],\n    [{ validatorData, incentiveData }],\n  );\n\n  return boostClaimDataPayload;\n}\n\n/**\n * Given a {@link SignerValidatorInputParams}, properly encode the initialization payload.\n *\n * @param {SignerValidatorInputParams} param0\n * @param {Address} param0.signer\n * @param {Hex} param0.signature\n * @param {number} param0.incentiveQuantity\n * @returns {Hex}\n */\nexport function prepareSignerValidatorInputParams({\n  signer,\n  signature,\n  incentiveQuantity,\n}: SignerValidatorInputParams) {\n  return encodeAbiParameters(\n    [\n      {\n        type: 'tuple',\n        name: 'SignerValidatorInputParams',\n        components: [\n          { type: 'address', name: 'signer' },\n          { type: 'bytes', name: 'signature' },\n          { type: 'uint8', name: 'incentiveQuantity' },\n        ],\n      },\n    ],\n    [{ signer, signature, incentiveQuantity }],\n  );\n}\n\n/**\n * Given a {@link SignerValidatorPayload}, properly encode the initialization payload.\n *\n * @param {SignerValidatorPayload} param0\n * @param {Address[]} param0.signers\n * @param {Address} param0.validatorCaller\n * @returns {Hex}\n */\nexport function prepareSignerValidatorPayload({\n  signers,\n  validatorCaller,\n}: SignerValidatorPayload) {\n  return encodeAbiParameters(\n    [\n      { type: 'address[]', name: 'signers' },\n      { type: 'address', name: 'validatorCaller' },\n    ],\n    [signers, validatorCaller],\n  );\n}\n"],"names":["_SignerValidator","DeployableTarget","signerValidatorAbi","address","params","readSignerValidatorSigners","payload","readSignerValidatorHashSignerData","request","result","simulateSignerValidatorValidate","writeSignerValidatorValidate","addresses","allowed","simulateSignerValidatorSetAuthorized","writeSignerValidatorSetAuthorized","simulateSignerValidatorSetValidatorCaller","writeSignerValidatorSetValidatorCaller","prepareSignerValidatorClaimDataPayload","_payload","_options","options","bytecode","prepareSignerValidatorPayload","RegistryType","SignerValidator","signer","incentiveData","chainId","validator","incentiveQuantity","claimant","boostId","typedData","trustedSignature","signTypedData","validatorData","prepareSignerValidatorInputParams","encodeAbiParameters","signature","signers","validatorCaller"],"mappings":"u6hBAmSaA,EAAN,MAAMA,UAAwBC,EAAAA,gBAGnC,CAHK,aAAA,CAAA,MAAA,GAAA,SAAA,EAWL,KAAyB,IAAMC,GAAA,CA4B/B,MAAa,QACXC,EACAC,EACA,CACO,OAAA,MAAMC,EAAAA,GAA2B,KAAK,QAAS,CACpD,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACF,CAAO,EAEd,GAAIC,CAAA,CACL,CACH,CAWA,MAAa,eACXE,EACAF,EACA,CACO,OAAA,MAAMG,EAAAA,GAAkC,KAAK,QAAS,CAC3D,QAAS,KAAK,mBAAmB,EACjC,KAAM,CACJD,EAAQ,QACRA,EAAQ,kBACRA,EAAQ,SACRA,EAAQ,aACV,EAEA,GAAIF,CAAA,CACL,CACH,CAWA,MAAgB,SACdE,EACAF,EACA,CACA,OAAO,MAAM,KAAK,YAAY,KAAK,YAAYE,EAASF,CAAM,CAAC,CACjE,CAWA,MAAgB,YACdE,EACAF,EACA,CACA,KAAM,CAAE,QAAAI,EAAS,OAAAC,CAAO,EAAI,MAAMC,EAAA,GAChC,KAAK,QACL,CACE,QAAS,KAAK,mBAAmB,EACjC,KAAM,CACJJ,EAAQ,QACRA,EAAQ,YACRA,EAAQ,SACRA,EAAQ,SACV,EACA,GAAG,KAAK,wBAAwB,EAEhC,GAAIF,CACN,CAAA,EAGK,MAAA,CAAE,KADI,MAAMO,EAA6B,GAAA,KAAK,QAASH,CAAO,EACtD,OAAAC,EACjB,CAYA,MAAa,cACXG,EACAC,EACAT,EACA,CACA,OAAO,MAAM,KAAK,YAChB,KAAK,iBAAiBQ,EAAWC,EAAST,CAAM,CAAA,CAEpD,CAYA,MAAa,iBACXQ,EACAC,EACAT,EACA,CACA,KAAM,CAAE,QAAAI,EAAS,OAAAC,CAAO,EAAI,MAAMK,EAAA,GAChC,KAAK,QACL,CACE,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACF,EAAWC,CAAO,EACzB,GAAG,KAAK,wBAAwB,EAEhC,GAAIT,CACN,CAAA,EAGK,MAAA,CAAE,KADI,MAAMW,EAAkC,GAAA,KAAK,QAASP,CAAO,EAC3D,OAAAC,EACjB,CAWA,MAAa,sBACXN,EACAC,EACA,CACA,KAAM,CAAE,QAAAI,EAAS,OAAAC,CAAO,EAAI,MAAMO,EAAA,GAChC,KAAK,QACL,CACE,QAAS,KAAK,mBAAmB,EACjC,KAAM,CAACb,CAAO,EACd,GAAG,KAAK,wBAAwB,EAEhC,GAAIC,CACN,CAAA,EAMK,MAAA,CAAE,KAJI,MAAMa,EAAA,GACjB,KAAK,QACLT,CAAA,EAEa,OAAAC,EACjB,CAWA,MAAa,mBACXN,EACAC,EACA,CACA,OAAO,MAAM,KAAK,YAAY,KAAK,sBAAsBD,EAASC,CAAM,CAAC,CAC3E,CAUA,MAAa,gBACXA,EACc,CACd,OAAO,MAAMc,EAAuC,CAClD,GAAGd,EACH,UAAW,KAAK,mBAAmB,CAAA,CACpC,CACH,CAUgB,gBACde,EACAC,EACyB,CACzB,KAAM,CAACd,EAASe,CAAO,EAAI,KAAK,yBAC9BF,EACAC,CAAA,EAEK,MAAA,CACL,IAAKlB,EAAA,EACL,SAAAoB,EACA,KAAM,CAACC,EAA8BjB,CAAO,CAAC,EAC7C,GAAG,KAAK,wBAAwBe,EAAQ,OAAO,CAAA,CAEnD,CACF,EAjPyBrB,EAAA,KAAgB,6CASvCA,EAAuB,aAA6BwB,EAAa,aAAA,UA5B5D,IAAMC,EAANzB,EAqRP,eAAsBkB,EAAuC,CAC3D,OAAAQ,EACA,cAAAC,EACA,QAAAC,EACA,UAAAC,EACA,kBAAAC,EACA,SAAAC,EACA,QAAAC,CACF,EAAiD,CAO/C,MAAMC,EAAY,CAChB,OAPa,CACb,KAAM,kBACN,QAAS,IACT,QAAAL,EACA,kBAAmBC,CAAA,EAInB,MAAO,CACL,oBAAqB,CACnB,CAAE,KAAM,UAAW,KAAM,SAAU,EACnC,CAAE,KAAM,oBAAqB,KAAM,OAAQ,EAC3C,CAAE,KAAM,WAAY,KAAM,SAAU,EACpC,CAAE,KAAM,gBAAiB,KAAM,OAAQ,CACzC,CACF,EACA,YAAa,sBACb,QAAS,CACP,QAAAG,EACA,kBAAAF,EACA,SAAAC,EACA,cAAAJ,CACF,CAAA,EAGIO,EAAmB,MAAMC,gBAAc,CAC3C,GAAGF,EACH,WAAYP,EAAO,GAAA,CACpB,EAGKU,EAAgBC,EAAkC,CACtD,OAAQX,EAAO,QACf,UAAWQ,EACX,kBAAAJ,CAAA,CACD,EAgBM,OAduBQ,EAAA,oBAC5B,CACE,CACE,KAAM,QACN,KAAM,iBACN,WAAY,CACV,CAAE,KAAM,QAAS,KAAM,eAAgB,EACvC,CAAE,KAAM,QAAS,KAAM,eAAgB,CACzC,CACF,CACF,EACA,CAAC,CAAE,cAAAF,EAAe,cAAAT,EAAe,CAAA,CAIrC,CAWO,SAASU,EAAkC,CAChD,OAAAX,EACA,UAAAa,EACA,kBAAAT,CACF,EAA+B,CACtB,OAAAQ,EAAA,oBACL,CACE,CACE,KAAM,QACN,KAAM,6BACN,WAAY,CACV,CAAE,KAAM,UAAW,KAAM,QAAS,EAClC,CAAE,KAAM,QAAS,KAAM,WAAY,EACnC,CAAE,KAAM,QAAS,KAAM,mBAAoB,CAC7C,CACF,CACF,EACA,CAAC,CAAE,OAAAZ,EAAQ,UAAAa,EAAW,kBAAAT,EAAmB,CAAA,CAE7C,CAUO,SAASP,EAA8B,CAC5C,QAAAiB,EACA,gBAAAC,CACF,EAA2B,CAClB,OAAAH,EAAA,oBACL,CACE,CAAE,KAAM,YAAa,KAAM,SAAU,EACrC,CAAE,KAAM,UAAW,KAAM,iBAAkB,CAC7C,EACA,CAACE,EAASC,CAAe,CAAA,CAE7B"}

package/dist/Validators/SignerValidator.d.ts

@@ -1,10 +1,234 @@
 import { signerValidatorAbi } from '@boostxyz/evm';
-import type { Address, ContractEventName } from 'viem';
+import { type Address, type ContractEventName, type Hex, type PrivateKeyAccount } from 'viem';
 import type { DeployableOptions, GenericDeployableParams } from '../Deployable/Deployable';
 import { DeployableTarget } from '../Deployable/DeployableTarget';
-import { type GenericLog, type ReadParams, RegistryType, type SignerValidatorPayload, type SignerValidatorSignaturePayload, type SignerValidatorValidatePayload, type WriteParams } from '../utils';
+import { type GenericLog, type ReadParams, RegistryType, type WriteParams } from '../utils';
 export { signerValidatorAbi };
-export type { SignerValidatorPayload };
+/**
+ * Object reprentation of a {@link SignerValidator} initialization payload
+ *
+ * @export
+ * @interface SignerValidatorPayload
+ * @typedef {SignerValidatorPayload}
+ */
+export interface SignerValidatorPayload {
+    /**
+     * The list of authorized signers. The first address in the list will be the initial owner of the contract.
+     *
+     * @type {Address[]}
+     */
+    signers: Address[];
+    /**
+     * The authorized caller of the {@link prepareSignerValidator} function
+     * @type {Address}
+     */
+    validatorCaller: Address;
+}
+/**
+ * Description placeholder
+ *
+ * @export
+ * @interface SignerValidatorValidatePayload
+ * @typedef {SignerValidatorValidatePayload}
+ */
+export interface SignerValidatorValidatePayload {
+    /**
+     * The ID of the boost.
+     *
+     * @type {bigint}
+     */
+    boostId: bigint;
+    /**
+     * The ID of the incentive.
+     *
+     * @type {bigint}
+     */
+    incentiveId: bigint;
+    /**
+     * The address of the claimant.
+     *
+     * @type {Address}
+     */
+    claimant: Address;
+    /**
+     * The claim data.
+     *
+     * @type {Hex}
+     */
+    claimData: Hex;
+}
+/**
+ * Object reprentation of a {@link SignerValidator} initialization payload
+ *
+ * @export
+ * @interface SignerValidatorPayload
+ * @typedef {SignerValidatorPayload}
+ */
+export interface SignerValidatorPayload {
+    /**
+     * The list of authorized signers. The first address in the list will be the initial owner of the contract.
+     *
+     * @type {Address[]}
+     */
+    signers: Address[];
+    /**
+     * The authorized caller of the {@link prepareSignerValidator} function
+     * @type {Address}
+     */
+    validatorCaller: Address;
+}
+/**
+ * Description placeholder
+ *
+ * @export
+ * @interface SignerValidatorValidatePayload
+ * @typedef {SignerValidatorValidatePayload}
+ */
+export interface SignerValidatorValidatePayload {
+    /**
+     * The ID of the boost.
+     *
+     * @type {bigint}
+     */
+    boostId: bigint;
+    /**
+     * The ID of the incentive.
+     *
+     * @type {bigint}
+     */
+    incentiveId: bigint;
+    /**
+     * The address of the claimant.
+     *
+     * @type {Address}
+     */
+    claimant: Address;
+    /**
+     * The claim data.
+     *
+     * @type {Hex}
+     */
+    claimData: Hex;
+}
+/**
+ * Signer Validator Claim Data Payload
+ *
+ * @export
+ * @interface SignerValidatorClaimDataParams
+ * @typedef {SignerValidatorClaimDataParams}
+ */
+export interface SignerValidatorClaimDataParams {
+    /**
+     * The signer with which to sign the input
+     *
+     * @type {{
+     *     account: Address;
+     *     key: Hex;
+     *     privateKey: PrivateKeyAccount;
+     *   }}
+     */
+    signer: {
+        account: Address;
+        key: Hex;
+        privateKey: PrivateKeyAccount;
+    };
+    /**
+     * The encoded data to provide the underlying incentive. You can use {@link prepareAllowListIncentivePayload}, {@link prepareCGDAIncentivePayload}, {@link prepareERC20IncentivePayload}, {@link prepareERC1155IncentivePayload}, or {@link preparePointsIncentivePayload}
+     *
+     * @type {Hex}
+     */
+    incentiveData: Hex;
+    /**
+     * The chain id to target
+     *
+     * @type {number}
+     */
+    chainId: number;
+    /**
+     * The address of the validator
+     *
+     * @type {Address}
+     */
+    validator: Address;
+    /**
+     * The incentive quantity.
+     *
+     * @type {number}
+     */
+    incentiveQuantity: number;
+    /**
+     * The address of the claimant
+     *
+     * @type {Address}
+     */
+    claimant: Address;
+    /**
+     * The ID of the boost
+     *
+     * @type {bigint}
+     */
+    boostId: bigint;
+}
+/**
+ * Object representation of a {@link SignerValidatorInputParams} initialization payload
+ *
+ * @export
+ * @interface SignerValidatorInputParams
+ * @typedef {SignerValidatorInputParams}
+ */
+export interface SignerValidatorInputParams {
+    /**
+     * The signer address.
+     *
+     * @type {Address}
+     */
+    signer: Address;
+    /**
+     * The signature data.
+     *
+     * @type {string}
+     */
+    signature: Hex;
+    /**
+     * The incentive quantity.
+     *
+     * @type {number}
+     */
+    incentiveQuantity: number;
+}
+/**
+ * Object representing the payload for signing before validaton.
+ *
+ * @export
+ * @interface SignerValidatorSignaturePayload
+ * @typedef {SignerValidatorSignaturePayload}
+ */
+export interface SignerValidatorSignaturePayload {
+    /**
+     * The ID of the boost.
+     *
+     * @type {bigint}
+     */
+    boostId: bigint;
+    /**
+     * The ID of the incentive.
+     *
+     * @type {number}
+     */
+    incentiveQuantity: number;
+    /**
+     * The address of the claimant.
+     *
+     * @type {Address}
+     */
+    claimant: Address;
+    /**
+     * The claim data.
+     *
+     * @type {Hex}
+     */
+    incentiveData: Hex;
+}
 /**
  * A generic `viem.Log` event with support for `BoostCore` event types.
  *
@@ -24,6 +248,13 @@ export type SignerValidatorLog<event extends ContractEventName<typeof signerVali
  * @extends {DeployableTarget<SignerValidatorPayload>}
  */
 export declare class SignerValidator extends DeployableTarget<SignerValidatorPayload, typeof signerValidatorAbi> {
+    /**
+     * @inheritdoc
+     *
+     * @public
+     * @readonly
+     * @type {*}
+     */
     readonly abi: readonly [{
         readonly type: "constructor";
         readonly inputs: readonly [];
@@ -395,7 +626,7 @@ export declare class SignerValidator extends DeployableTarget<SignerValidatorPay
      * @param {?WriteParams<typeof signerValidatorAbi, 'validate'>} [params]
      * @returns {Promise<boolean>} - True if the action has been validated based on the data payload
      */
-    validate(payload: SignerValidatorValidatePayload, params?: WriteParams<typeof signerValidatorAbi, 'validate'>): Promise<boolean>;
+    protected validate(payload: SignerValidatorValidatePayload, params?: WriteParams<typeof signerValidatorAbi, 'validate'>): Promise<boolean>;
     /**
      * Validate that the action has been completed successfully. The data payload is expected to be a tuple of (address signer, bytes32 hash, bytes signature). The signature is expected to be a valid ECDSA or EIP-1271 signature of a unique hash by an authorized signer.
      *
@@ -405,7 +636,7 @@ export declare class SignerValidator extends DeployableTarget<SignerValidatorPay
      * @param {?WriteParams<typeof signerValidatorAbi, 'validate'>} [params]
      * @returns {Promise<boolean>} - True if the action has been validated based on the data payload
      */
-    validateRaw(payload: SignerValidatorValidatePayload, params?: ReadParams<typeof signerValidatorAbi, 'validate'>): Promise<{
+    protected validateRaw(payload: SignerValidatorValidatePayload, params?: ReadParams<typeof signerValidatorAbi, 'validate'>): Promise<{
         hash: `0x${string}`;
         result: boolean;
     }>;
@@ -434,11 +665,38 @@ export declare class SignerValidator extends DeployableTarget<SignerValidatorPay
         hash: `0x${string}`;
         result: void;
     }>;
+    /**
+     * Update the authorized caller of the validator function
+     *
+     * @public
+     * @async
+     * @param {Address} address
+     * @param {?WriteParams<typeof signerValidatorAbi, 'setValidatorCaller'>} [params]
+     * @returns {unknown}
+     */
     setValidatorCallerRaw(address: Address, params?: WriteParams<typeof signerValidatorAbi, 'setValidatorCaller'>): Promise<{
         hash: `0x${string}`;
         result: void;
     }>;
+    /**
+     * Update the authorized caller of the validator function
+     *
+     * @public
+     * @async
+     * @param {Address} address
+     * @param {?WriteParams<typeof signerValidatorAbi, 'setValidatorCaller'>} [params]
+     * @returns {unknown}
+     */
     setValidatorCaller(address: Address, params?: WriteParams<typeof signerValidatorAbi, 'setValidatorCaller'>): Promise<void>;
+    /**
+     * Properly encodes the data needed to claim
+     *
+     * @public
+     * @async
+     * @param {SignerValidatorClaimDataParams} params
+     * @returns {Promise<Hex>}
+     */
+    encodeClaimData(params: Omit<SignerValidatorClaimDataParams, 'validator'>): Promise<Hex>;
     /**
      * @inheritdoc
      *
@@ -449,4 +707,39 @@ export declare class SignerValidator extends DeployableTarget<SignerValidatorPay
      */
     buildParameters(_payload?: SignerValidatorPayload, _options?: DeployableOptions): GenericDeployableParams;
 }
+/**
+ * Signer Validator Claim Data Payload Preparation
+ *
+ * @export
+ * @async
+ * @param {SignerValidatorClaimDataParams} param0
+ * @param {{ account: Address; key: Hex; privateKey: PrivateKeyAccount; }} param0.signer
+ * @param {Hex} param0.incentiveData
+ * @param {number} param0.chainId
+ * @param {Address} param0.validator
+ * @param {number} param0.incentiveQuantity
+ * @param {Address} param0.claimant
+ * @param {bigint} param0.boostId
+ * @returns {Promise<Hex>}
+ */
+export declare function prepareSignerValidatorClaimDataPayload({ signer, incentiveData, chainId, validator, incentiveQuantity, claimant, boostId, }: SignerValidatorClaimDataParams): Promise<Hex>;
+/**
+ * Given a {@link SignerValidatorInputParams}, properly encode the initialization payload.
+ *
+ * @param {SignerValidatorInputParams} param0
+ * @param {Address} param0.signer
+ * @param {Hex} param0.signature
+ * @param {number} param0.incentiveQuantity
+ * @returns {Hex}
+ */
+export declare function prepareSignerValidatorInputParams({ signer, signature, incentiveQuantity, }: SignerValidatorInputParams): `0x${string}`;
+/**
+ * Given a {@link SignerValidatorPayload}, properly encode the initialization payload.
+ *
+ * @param {SignerValidatorPayload} param0
+ * @param {Address[]} param0.signers
+ * @param {Address} param0.validatorCaller
+ * @returns {Hex}
+ */
+export declare function prepareSignerValidatorPayload({ signers, validatorCaller, }: SignerValidatorPayload): `0x${string}`;
 //# sourceMappingURL=SignerValidator.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SignerValidator.d.ts","sourceRoot":"","sources":["../../src/Validators/SignerValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,kBAAkB,EAOnB,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAO,MAAM,MAAM,CAAC;AAC5D,OAAO,KAAK,EACV,iBAAiB,EACjB,uBAAuB,EACxB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EACL,KAAK,UAAU,EACf,KAAK,UAAU,EACf,YAAY,EACZ,KAAK,sBAAsB,EAC3B,KAAK,+BAA+B,EACpC,KAAK,8BAA8B,EACnC,KAAK,WAAW,EAEjB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,kBAAkB,EAAE,CAAC;AAC9B,YAAY,EAAE,sBAAsB,EAAE,CAAC;AAEvC;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,CAC5B,KAAK,SAAS,iBAAiB,CAC7B,OAAO,kBAAkB,CAC1B,GAAG,iBAAiB,CAAC,OAAO,kBAAkB,CAAC,IAC9C,UAAU,CAAC,OAAO,kBAAkB,EAAE,KAAK,CAAC,CAAC;AAEjD;;;;;;;GAOG;AACH,qBAAa,eAAgB,SAAQ,gBAAgB,CACnD,sBAAsB,EACtB,OAAO,kBAAkB,CAC1B;IACC,SAAyB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAAsB;IAClD;;;;;;OAMG;IACH,OAAuB,IAAI,EAAE,OAAO,CACN;IAC9B;;;;;;OAMG;IACH,OAAuB,YAAY,EAAE,YAAY,CAA0B;IAE3E;;;;;;;;OAQG;IACU,OAAO,CAClB,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,kBAAkB,EAAE,SAAS,CAAC;IAU3D;;;;;;;;OAQG;IACU,cAAc,CACzB,OAAO,EAAE,+BAA+B,EACxC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,kBAAkB,EAAE,gBAAgB,CAAC;IAelE;;;;;;;;OAQG;IACU,QAAQ,CACnB,OAAO,EAAE,8BAA8B,EACvC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,kBAAkB,EAAE,UAAU,CAAC;IAK7D;;;;;;;;OAQG;IACU,WAAW,CACtB,OAAO,EAAE,8BAA8B,EACvC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,kBAAkB,EAAE,UAAU,CAAC;;;;IAqB5D;;;;;;;;;OASG;IACU,aAAa,CACxB,SAAS,EAAE,OAAO,EAAE,EACpB,OAAO,EAAE,OAAO,EAAE,EAClB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,kBAAkB,EAAE,eAAe,CAAC;IAKlE;;;;;;;;;OASG;IACU,gBAAgB,CAC3B,SAAS,EAAE,OAAO,EAAE,EACpB,OAAO,EAAE,OAAO,EAAE,EAClB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,kBAAkB,EAAE,eAAe,CAAC;;;;IAgBrD,qBAAqB,CAChC,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,kBAAkB,EAAE,oBAAoB,CAAC;;;;IAmB1D,kBAAkB,CAC7B,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,kBAAkB,EAAE,oBAAoB,CAAC;IAKvE;;;;;;;OAOG;IACa,eAAe,CAC7B,QAAQ,CAAC,EAAE,sBAAsB,EACjC,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,uBAAuB;CAY3B"}
+{"version":3,"file":"SignerValidator.d.ts","sourceRoot":"","sources":["../../src/Validators/SignerValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,kBAAkB,EAOnB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,iBAAiB,EACtB,KAAK,GAAG,EACR,KAAK,iBAAiB,EAEvB,MAAM,MAAM,CAAC;AAEd,OAAO,KAAK,EACV,iBAAiB,EACjB,uBAAuB,EACxB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EACL,KAAK,UAAU,EACf,KAAK,UAAU,EACf,YAAY,EACZ,KAAK,WAAW,EACjB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,kBAAkB,EAAE,CAAC;AAE9B;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,SAAS,EAAE,GAAG,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,SAAS,EAAE,GAAG,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;;;;;;OAQG;IACH,MAAM,EAAE;QACN,OAAO,EAAE,OAAO,CAAC;QACjB,GAAG,EAAE,GAAG,CAAC;QACT,UAAU,EAAE,iBAAiB,CAAC;KAC/B,CAAC;IACF;;;;OAIG;IACH,aAAa,EAAE,GAAG,CAAC;IACnB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,SAAS,EAAE,GAAG,CAAC;IAEf;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,aAAa,EAAE,GAAG,CAAC;CACpB;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,kBAAkB,CAC5B,KAAK,SAAS,iBAAiB,CAC7B,OAAO,kBAAkB,CAC1B,GAAG,iBAAiB,CAAC,OAAO,kBAAkB,CAAC,IAC9C,UAAU,CAAC,OAAO,kBAAkB,EAAE,KAAK,CAAC,CAAC;AAEjD;;;;;;;GAOG;AACH,qBAAa,eAAgB,SAAQ,gBAAgB,CACnD,sBAAsB,EACtB,OAAO,kBAAkB,CAC1B;IACC;;;;;;OAMG;IACH,SAAyB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAAsB;IAClD;;;;;;OAMG;IACH,OAAuB,IAAI,EAAE,OAAO,CACN;IAC9B;;;;;;OAMG;IACH,OAAuB,YAAY,EAAE,YAAY,CAA0B;IAE3E;;;;;;;;OAQG;IACU,OAAO,CAClB,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,kBAAkB,EAAE,SAAS,CAAC;IAU3D;;;;;;;;OAQG;IACU,cAAc,CACzB,OAAO,EAAE,+BAA+B,EACxC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,kBAAkB,EAAE,gBAAgB,CAAC;IAelE;;;;;;;;OAQG;cACa,QAAQ,CACtB,OAAO,EAAE,8BAA8B,EACvC,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,kBAAkB,EAAE,UAAU,CAAC;IAK7D;;;;;;;;OAQG;cACa,WAAW,CACzB,OAAO,EAAE,8BAA8B,EACvC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,kBAAkB,EAAE,UAAU,CAAC;;;;IAqB5D;;;;;;;;;OASG;IACU,aAAa,CACxB,SAAS,EAAE,OAAO,EAAE,EACpB,OAAO,EAAE,OAAO,EAAE,EAClB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,kBAAkB,EAAE,eAAe,CAAC;IAOlE;;;;;;;;;OASG;IACU,gBAAgB,CAC3B,SAAS,EAAE,OAAO,EAAE,EACpB,OAAO,EAAE,OAAO,EAAE,EAClB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,kBAAkB,EAAE,eAAe,CAAC;;;;IAgBlE;;;;;;;;OAQG;IACU,qBAAqB,CAChC,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,kBAAkB,EAAE,oBAAoB,CAAC;;;;IAmBvE;;;;;;;;OAQG;IACU,kBAAkB,CAC7B,OAAO,EAAE,OAAO,EAChB,MAAM,CAAC,EAAE,WAAW,CAAC,OAAO,kBAAkB,EAAE,oBAAoB,CAAC;IAKvE;;;;;;;OAOG;IACU,eAAe,CAC1B,MAAM,EAAE,IAAI,CAAC,8BAA8B,EAAE,WAAW,CAAC,GACxD,OAAO,CAAC,GAAG,CAAC;IAOf;;;;;;;OAOG;IACa,eAAe,CAC7B,QAAQ,CAAC,EAAE,sBAAsB,EACjC,QAAQ,CAAC,EAAE,iBAAiB,GAC3B,uBAAuB;CAY3B;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,sCAAsC,CAAC,EAC3D,MAAM,EACN,aAAa,EACb,OAAO,EACP,SAAS,EACT,iBAAiB,EACjB,QAAQ,EACR,OAAO,GACR,EAAE,8BAA8B,GAAG,OAAO,CAAC,GAAG,CAAC,CAqD/C;AAED;;;;;;;;GAQG;AACH,wBAAgB,iCAAiC,CAAC,EAChD,MAAM,EACN,SAAS,EACT,iBAAiB,GAClB,EAAE,0BAA0B,iBAe5B;AAED;;;;;;;GAOG;AACH,wBAAgB,6BAA6B,CAAC,EAC5C,OAAO,EACP,eAAe,GAChB,EAAE,sBAAsB,iBAQxB"}