@boostxyz/sdk 1.1.0-alpha.22 → 1.1.0-alpha.24

package/src/Actions/EventAction.ts

@@ -6,24 +6,15 @@ import {
   writeEventActionExecute,
 } from '@boostxyz/evm';
 import { bytecode } from '@boostxyz/evm/artifacts/contracts/actions/EventAction.sol/EventAction.json';
-import events from '@boostxyz/signatures/events';
-import functions from '@boostxyz/signatures/functions';
-import {
-  GetTransactionReceiptParameters,
-  getTransaction,
-  getTransactionReceipt,
-} from '@wagmi/core';
+import { getTransaction, getTransactionReceipt } from '@wagmi/core';
 import { match } from 'ts-pattern';
 import {
-  type Abi,
   type AbiEvent,
   type AbiFunction,
   AbiItem,
   type Address,
-  type ContractEventName,
   type ContractFunctionName,
   type GetLogsReturnType,
-  type GetTransactionParameters,
   type Hex,
   type Log,
   type PublicClient,
@@ -34,6 +25,7 @@ import {
   fromHex,
   isAddress,
   isAddressEqual,
+  zeroAddress,
   zeroHash,
 } from 'viem';
 import { EventAction as EventActionBases } from '../../dist/deployments.json';
@@ -55,7 +47,6 @@ import {
   ValidationAbiMissingError,
 } from '../errors';
 import {
-  type GetLogsParams,
   type Overwrite,
   type ReadParams,
   RegistryType,
@@ -227,14 +218,14 @@ export interface ActionStep {
  * Parameters for validating an action step.
  *
  * @typedef {Object} ValidateActionStepParams
- * @property {Record<Hex, AbiEvent | AbiFunction>} [knownSignatures] - Optional record of known events, keyed by 32 byte selectors.
+ * @property {Record<Hex, AbiEvent | AbiFunction>} [knownSignatures] - Record of known events, keyed by 32 byte selectors. You can use [@boostxyz/signatures](https://www.npmjs.com/package/@boostxyz/signatures) to assemble this parameter.
  * @property {AbiEvent | AbiFunction} [abiItem] - Optional ABI item definition.
  * @property {EventLogs} [logs] - Event logs to validate against. Required if 'hash' is not provided.
  * @property {Hex} [hash] - Transaction hash to validate against. Required if 'logs' is not provided.
  * @property {number} [chainId] - Chain ID for the transaction. Required if 'hash' is provided.
  */
 export type ValidateActionStepParams = {
-  knownSignatures?: Record<Hex, AbiEvent | AbiFunction>;
+  knownSignatures: Record<Hex, AbiEvent | AbiFunction>;
   abiItem?: AbiEvent | AbiFunction;
 } & ({ logs: EventLogs } | { hash: Hex; chainId: number });
 
@@ -366,6 +357,7 @@ export class EventAction extends DeployableTarget<
    * @type {Record<number, Address>}
    */
   public static override bases: Record<number, Address> = {
+    31337: import.meta.env.VITE_EVENT_ACTION_BASE,
     ...(EventActionBases as Record<number, Address>),
   };
   /**
@@ -491,6 +483,8 @@ export class EventAction extends DeployableTarget<
   /**
    * Derives the action claimant address from a transaction based on the provided ActionClaimant configuration.
    * This method supports both event-based and function-based claimant derivation.
+   * **Important**: The claimant is considered to be `transaction.from` when `claimant.fieldIndex` is 255.
+   * This may have unintended side effects for bridged transactions and SCW transactions, so these are considered unsupported use cases for the time being.
    *
    ** @example
    * // Example usage
@@ -505,8 +499,11 @@ export class EventAction extends DeployableTarget<
    * const params: ValidateActionStepParams = {
    *   hash: '0x5678...',
    *   chainId: 1,
-   *   knownSignatures?: {
-   *     '0x1234...': {}
+   *   knownSignatures: {
+   *     '0x1234...': {
+   *       type: 'event',
+   *       name: 'Transfer(...)'
+   *     }
    *   }
    * };
    * const claimantAddress = await eventAction.deriveActionClaimantFromTransaction(claimant, params);
@@ -521,18 +518,37 @@ export class EventAction extends DeployableTarget<
     claimant: ActionClaimant,
     params: ValidateActionStepParams,
   ): Promise<Address | undefined> {
+    // find message sender and return it
+    // WARNING: this is error prone in bridged transactions and SCW transactions, as this will return exit node
+    if (claimant.fieldIndex === 255) {
+      if ('hash' in params) {
+        const transaction = await getTransaction(this._config, {
+          hash: params.hash,
+        });
+        return transaction.from;
+      }
+      if ('logs' in params) {
+        for (let log of params.logs) {
+          if (log.transactionHash) {
+            const transaction = await getTransaction(this._config, {
+              hash: log.transactionHash,
+            });
+            return transaction.from;
+          }
+        }
+      }
+      return undefined;
+    }
+
     const signature = claimant.signature;
+
     if (claimant.signatureType === SignatureType.EVENT) {
       let event: AbiEvent;
       if (params.abiItem) event = params.abiItem as AbiEvent;
       else {
-        const sigPool: Record<Hex, AbiEvent> = {
-          ...(events.abi as Record<Hex, AbiEvent>),
-          ...((params.knownSignatures as Record<Hex, AbiEvent>) || {}),
-        };
+        const sigPool = params.knownSignatures as Record<Hex, AbiEvent>;
         event = sigPool[signature] as AbiEvent;
       }
-
       if (!event) {
         throw new ValidationAbiMissingError(signature);
       }
@@ -578,10 +594,7 @@ export class EventAction extends DeployableTarget<
       let func: AbiFunction;
       if (params.abiItem) func = params.abiItem as AbiFunction;
       else {
-        const sigPool: Record<Hex, AbiFunction> = {
-          ...(functions.abi as Record<Hex, AbiFunction>),
-          ...((params.knownSignatures as Record<Hex, AbiFunction>) || {}),
-        };
+        const sigPool = params.knownSignatures as Record<Hex, AbiFunction>;
         func = sigPool[signature] as AbiFunction;
       }
       if (!func) {
@@ -664,10 +677,7 @@ export class EventAction extends DeployableTarget<
       let event: AbiEvent;
       if (params.abiItem) event = params.abiItem as AbiEvent;
       else {
-        const sigPool: Record<Hex, AbiEvent> = {
-          ...(events.abi as Record<Hex, AbiEvent>),
-          ...((params.knownSignatures as Record<Hex, AbiEvent>) || {}),
-        };
+        const sigPool = params.knownSignatures as Record<Hex, AbiEvent>;
         event = sigPool[signature] as AbiEvent;
       }
 
@@ -747,7 +757,7 @@ export class EventAction extends DeployableTarget<
    * @public
    * @param {ActionStep} actionStep - The action step containing the function to validate.
    * @param {Transaction} transaction - The transaction that will be validated against.
-   * @param {Object} [params] - Optional parameters for validation.
+   * @param {Object} [params] - Parameters for validation.
    * @param {AbiItem} [params.abiItem] - The ABI item for the function, if known.
    * @param {Record<Hex, AbiEvent | AbiFunction>} [params.knownSignatures] - A record of known signatures.
    * @returns {boolean} Returns true if the action function is valid, false otherwise.
@@ -757,18 +767,15 @@ export class EventAction extends DeployableTarget<
   public isActionFunctionValid(
     actionStep: ActionStep,
     transaction: Transaction,
-    params?: Pick<ValidateActionStepParams, 'abiItem' | 'knownSignatures'>,
+    params: Pick<ValidateActionStepParams, 'abiItem' | 'knownSignatures'>,
   ) {
     const criteria = actionStep.actionParameter;
     let signature = actionStep.signature;
 
     let func: AbiFunction;
-    if (params?.abiItem) func = params?.abiItem as AbiFunction;
+    if (params.abiItem) func = params?.abiItem as AbiFunction;
     else {
-      const sigPool: Record<Hex, AbiFunction> = {
-        ...(functions.abi as Record<Hex, AbiFunction>),
-        ...((params?.knownSignatures as Record<Hex, AbiFunction>) || {}),
-      };
+      const sigPool = params.knownSignatures as Record<Hex, AbiFunction>;
       func = sigPool[signature] as AbiFunction;
     }
     if (!func) {
@@ -1261,3 +1268,37 @@ export function anyActionParameter(): Criteria {
     filterData: zeroHash,
   };
 }
+
+/**
+ * Creates an ActionClaimant object that represents the transaction sender as the claimant.
+ * This function is useful when you want to set up an action where the transaction sender is always considered the valid claimant,
+ * regardless of the event or function parameters.
+ *
+ * The returned ActionClaimant has the following properties:
+ * - signatureType: Set to SignatureType.EVENT (though it doesn't matter for this case)
+ * - signature: Set to zeroHash (0x0000...0000)
+ * - fieldIndex: Set to 255, indicating "any" field
+ * - targetContract: Set to zeroAddress (0x0000...0000)
+ * - chainid: Set to 0, indicating it's valid for any chain
+ *
+ * @returns {ActionClaimant} An ActionClaimant object representing the msg.sender
+ *
+ * @example
+ * const eventAction = new EventAction();
+ * const payload: EventActionPayload = {
+ *   actionClaimant: transactionSenderClaimant(),
+ *   actionSteps: [
+ *     // ... define your action steps here
+ *   ]
+ * };
+ * await eventAction.deploy(payload);
+ */
+export function transactionSenderClaimant(): ActionClaimant {
+  return {
+    signatureType: SignatureType.EVENT,
+    signature: zeroHash,
+    fieldIndex: 255,
+    targetContract: zeroAddress,
+    chainid: 0,
+  };
+}

package/src/AllowLists/SimpleAllowList.ts

@@ -99,6 +99,7 @@ export class SimpleAllowList extends DeployableTargetWithRBAC<
    * @type {Record<number, Address>}
    */
   public static override bases: Record<number, Address> = {
+    31337: import.meta.env.VITE_SIMPLE_ALLOWLIST_BASE,
     ...(SimpleAllowListBases as Record<number, Address>),
   };
   /**

package/src/AllowLists/SimpleDenyList.ts

@@ -91,6 +91,7 @@ export class SimpleDenyList<
    * @type {Record<number, Address>}
    */
   public static override bases: Record<number, Address> = {
+    31337: import.meta.env.VITE_SIMPLE_DENYLIST_BASE,
     ...(SimpleDenyListBases as Record<number, Address>),
   };
   /**