feat!(307): add KeyringExecutionContext to user ops methods

src/contexts.ts

@@ -0,0 +1,7 @@
+/**
+ * Context used by a Keyring implementation.
+ */
+export type KeyringExecutionContext = {
+  /** The chain ID. */
+  chainId: string;
+};

src/index.ts

@@ -1,4 +1,5 @@
 export * from './api';
+export * from './contexts';
 export * from './eth';
 export * from './events';
 export * from './internal';

src/internal/eth/EthKeyring.ts

@@ -1,5 +1,6 @@
 import type { Json, Keyring } from '@metamask/utils';
 
+import type { KeyringExecutionContext } from '../../contexts';
 import type {
   EthBaseTransaction,
   EthBaseUserOperation,
@@ -13,11 +14,13 @@ export type EthKeyring<State extends Json> = Keyring<State> & {
    *
    * @param address - Address of the sender.
    * @param transactions - Base transactions to include in the UserOperation.
+   * @param chainId - Chain ID.
    * @returns A pseudo-UserOperation that can be used to construct a real.
    */
   prepareUserOperation?(
     address: string,
     transactions: EthBaseTransaction[],
+    context: KeyringExecutionContext,
   ): Promise<EthBaseUserOperation>;
 
   /**
@@ -26,22 +29,26 @@ export type EthKeyring<State extends Json> = Keyring<State> & {
    *
    * @param address - Address of the sender.
    * @param userOp - UserOperation to patch.
+   * @param chainId - Chain ID.
    * @returns A patch to apply to the UserOperation.
    */
   patchUserOperation?(
     address: string,
     userOp: EthUserOperation,
+    context: KeyringExecutionContext,
   ): Promise<EthUserOperationPatch>;
 
   /**
    * Signs an UserOperation.
    *
    * @param address - Address of the sender.
    * @param userOp - UserOperation to sign.
+   * @param chainId - Chain ID.
    * @returns The signature of the UserOperation.
    */
   signUserOperation?(
     address: string,
     userOp: EthUserOperation,
+    context: KeyringExecutionContext,
   ): Promise<string>;
 };