@walletmesh/aztec-rpc-wallet 0.3.0 → 0.4.0

package/dist/wallet/handlers/senders.js

@@ -0,0 +1,92 @@
+import { createLogger } from '@aztec/foundation/log';
+const logger = createLogger('aztec-rpc-wallet:senders');
+/**
+ * Creates handlers for managing authorized senders in an Aztec wallet via JSON-RPC.
+ * Authorized senders are {@link AztecAddress}es permitted to submit transactions
+ * on behalf of the user's account. This functionality is crucial for delegation,
+ * enabling other accounts or smart contracts to act for the user under controlled conditions.
+ *
+ * Each handler function receives an {@link AztecHandlerContext}, providing access to the
+ * {@link AccountWallet} instance necessary for sender management.
+ *
+ * @returns An object where keys are sender-related method names
+ *          (e.g., "aztec_registerSender", "aztec_getSenders", "aztec_removeSender")
+ *          and values are their corresponding handler functions.
+ * @see {@link AztecWalletMethodMap} for method definitions.
+ */
+export function createSenderHandlers() {
+    return {
+        /**
+         * Handles the "aztec_registerSender" JSON-RPC method.
+         * Registers a new {@link AztecAddress} as an authorized sender for the account
+         * managed by the {@link AccountWallet} in the context.
+         *
+         * This allows the specified sender address to initiate transactions on behalf of the user.
+         * Common use cases include:
+         * - Delegating transaction submission to a different account.
+         * - Authorizing a smart contract to perform actions for the user.
+         * - Setting up automated transaction systems or relayers.
+         *
+         * @param ctx - The {@link AztecHandlerContext} containing the `wallet` instance.
+         * @param paramsTuple - A tuple containing the sender's address to register.
+         *                      Defined by {@link AztecWalletMethodMap.aztec_registerSender.params}.
+         * @param paramsTuple.0 - The {@link AztecAddress} to authorize as a sender.
+         * @returns A promise that resolves to the registered {@link AztecAddress}.
+         *          Type defined by {@link AztecWalletMethodMap.aztec_registerSender.result}.
+         * @throws {Error} If the `sender` parameter is missing or invalid, though type checking
+         *                 and serializer validation should catch this earlier.
+         */
+        aztec_registerSender: async (ctx, paramsTuple) => {
+            const [sender] = paramsTuple;
+            logger.debug(`[HANDLER] aztec_registerSender: sender = ${sender?.toString()}`);
+            if (!sender || typeof sender.toString !== 'function') {
+                // Basic check
+                throw new Error('Invalid sender parameter received in tuple');
+            }
+            return await ctx.wallet.registerSender(sender);
+        },
+        /**
+         * Handles the "aztec_getSenders" JSON-RPC method.
+         * Retrieves a list of all {@link AztecAddress}es currently authorized to send
+         * transactions on behalf of the account managed by the {@link AccountWallet} in the context.
+         * This is useful for auditing and managing delegation permissions.
+         *
+         * @param ctx - The {@link AztecHandlerContext} containing the `wallet` instance.
+         * @param _paramsTuple - Parameters for this method (expected to be an empty array).
+         *                       Defined by {@link AztecWalletMethodMap.aztec_getSenders.params}.
+         * @returns A promise that resolves to an array of authorized {@link AztecAddress}es.
+         *          Type defined by {@link AztecWalletMethodMap.aztec_getSenders.result}.
+         */
+        aztec_getSenders: async (ctx, _paramsTuple) => {
+            logger.debug('[HANDLER] aztec_getSenders');
+            return await ctx.wallet.getSenders();
+        },
+        /**
+         * Handles the "aztec_removeSender" JSON-RPC method.
+         * Revokes the authorization for a previously registered sender for the account
+         * managed by the {@link AccountWallet} in the context.
+         * After successful removal, the specified address will no longer be able to
+         * submit transactions on behalf of this wallet.
+         *
+         * @param ctx - The {@link AztecHandlerContext} containing the `wallet` instance.
+         * @param paramsTuple - A tuple containing the sender's address to remove.
+         *                      Defined by {@link AztecWalletMethodMap.aztec_removeSender.params}.
+         * @param paramsTuple.0 - The {@link AztecAddress} to remove from the list of authorized senders.
+         * @returns A promise that resolves to `true` if the removal was successful.
+         *          Type defined by {@link AztecWalletMethodMap.aztec_removeSender.result}.
+         * @throws {Error} If the `sender` parameter is missing or invalid, though type checking
+         *                 and serializer validation should catch this earlier.
+         */
+        aztec_removeSender: async (ctx, paramsTuple) => {
+            const [sender] = paramsTuple;
+            logger.debug(`[HANDLER] aztec_removeSender: sender = ${sender?.toString()}`);
+            if (!sender || typeof sender.toString !== 'function') {
+                // Basic check
+                throw new Error('Invalid sender parameter received in tuple');
+            }
+            await ctx.wallet.removeSender(sender);
+            return true;
+        },
+    };
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VuZGVycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy93YWxsZXQvaGFuZGxlcnMvc2VuZGVycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFFQSxPQUFPLEVBQUUsWUFBWSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFFckQsTUFBTSxNQUFNLEdBQUcsWUFBWSxDQUFDLDBCQUEwQixDQUFDLENBQUM7QUFFeEQ7Ozs7Ozs7Ozs7Ozs7R0FhRztBQUNILE1BQU0sVUFBVSxvQkFBb0I7SUFDbEMsT0FBTztRQUNMOzs7Ozs7Ozs7Ozs7Ozs7Ozs7O1dBbUJHO1FBQ0gsb0JBQW9CLEVBQUUsS0FBSyxFQUN6QixHQUF3QixFQUN4QixXQUFtRSxFQUNGLEVBQUU7WUFDbkUsTUFBTSxDQUFDLE1BQU0sQ0FBQyxHQUFHLFdBQVcsQ0FBQztZQUM3QixNQUFNLENBQUMsS0FBSyxDQUFDLDRDQUE0QyxNQUFNLEVBQUUsUUFBUSxFQUFFLEVBQUUsQ0FBQyxDQUFDO1lBQy9FLElBQUksQ0FBQyxNQUFNLElBQUksT0FBTyxNQUFNLENBQUMsUUFBUSxLQUFLLFVBQVUsRUFBRSxDQUFDO2dCQUNyRCxjQUFjO2dCQUNkLE1BQU0sSUFBSSxLQUFLLENBQUMsNENBQTRDLENBQUMsQ0FBQztZQUNoRSxDQUFDO1lBQ0QsT0FBTyxNQUFNLEdBQUcsQ0FBQyxNQUFNLENBQUMsY0FBYyxDQUFDLE1BQU0sQ0FBQyxDQUFDO1FBQ2pELENBQUM7UUFFRDs7Ozs7Ozs7Ozs7V0FXRztRQUNILGdCQUFnQixFQUFFLEtBQUssRUFDckIsR0FBd0IsRUFDeEIsWUFBZ0UsRUFDSCxFQUFFO1lBQy9ELE1BQU0sQ0FBQyxLQUFLLENBQUMsNEJBQTRCLENBQUMsQ0FBQztZQUMzQyxPQUFPLE1BQU0sR0FBRyxDQUFDLE1BQU0sQ0FBQyxVQUFVLEVBQUUsQ0FBQztRQUN2QyxDQUFDO1FBRUQ7Ozs7Ozs7Ozs7Ozs7OztXQWVHO1FBQ0gsa0JBQWtCLEVBQUUsS0FBSyxFQUN2QixHQUF3QixFQUN4QixXQUFpRSxFQUNGLEVBQUU7WUFDakUsTUFBTSxDQUFDLE1BQU0sQ0FBQyxHQUFHLFdBQVcsQ0FBQztZQUM3QixNQUFNLENBQUMsS0FBSyxDQUFDLDBDQUEwQyxNQUFNLEVBQUUsUUFBUSxFQUFFLEVBQUUsQ0FBQyxDQUFDO1lBQzdFLElBQUksQ0FBQyxNQUFNLElBQUksT0FBTyxNQUFNLENBQUMsUUFBUSxLQUFLLFVBQVUsRUFBRSxDQUFDO2dCQUNyRCxjQUFjO2dCQUNkLE1BQU0sSUFBSSxLQUFLLENBQUMsNENBQTRDLENBQUMsQ0FBQztZQUNoRSxDQUFDO1lBQ0QsTUFBTSxHQUFHLENBQUMsTUFBTSxDQUFDLFlBQVksQ0FBQyxNQUFNLENBQUMsQ0FBQztZQUN0QyxPQUFPLElBQUksQ0FBQztRQUNkLENBQUM7S0FDRixDQUFDO0FBQ0osQ0FBQyJ9

package/dist/wallet/handlers/transaction.d.ts

@@ -0,0 +1,123 @@
+import type { AztecHandlerContext } from './index.js';
+import type { AztecWalletMethodMap } from '../../types.js';
+/**
+ * Creates handlers for transaction-related Aztec wallet JSON-RPC methods.
+ * These handlers are responsible for the core lifecycle of an Aztec transaction,
+ * including proving, sending, simulating, and retrieving receipts.
+ *
+ * Each handler function receives an {@link AztecHandlerContext}, providing access to the
+ * {@link AccountWallet} and {@link PXE} client instances necessary for these operations.
+ *
+ * @returns An object where keys are transaction-related method names
+ *          (e.g., "aztec_proveTx", "aztec_sendTx") and values are their
+ *          corresponding handler functions.
+ * @see {@link AztecWalletMethodMap} for method definitions.
+ */
+export declare function createTransactionHandlers(): {
+    /**
+     * Handles the "aztec_proveTx" JSON-RPC method.
+     * Generates zero-knowledge proofs for a given {@link TxExecutionRequest}.
+     * If the {@link PrivateExecutionResult} is not provided, this handler will first
+     * simulate the private execution of the transaction to obtain it.
+     *
+     * @param ctx - The {@link AztecHandlerContext} containing the `wallet` instance.
+     * @param paramsTuple - A tuple containing the transaction execution request and an optional private execution result.
+     *                      Defined by {@link AztecWalletMethodMap.aztec_proveTx.params}.
+     * @param paramsTuple.0 - The {@link TxExecutionRequest} to prove.
+     * @param paramsTuple.1 - Optional: The {@link PrivateExecutionResult} from a prior private simulation.
+     *                        If not provided, a private simulation will be performed internally.
+     * @returns A promise that resolves to the {@link TxProvingResult}, which includes the proven transaction.
+     *          Type defined by {@link AztecWalletMethodMap.aztec_proveTx.result}.
+     * @throws {Error} If `txRequest` is missing, or if simulation is needed but fails to produce a `PrivateExecutionResult`.
+     */
+    aztec_proveTx: (ctx: AztecHandlerContext, paramsTuple: AztecWalletMethodMap["aztec_proveTx"]["params"]) => Promise<AztecWalletMethodMap["aztec_proveTx"]["result"]>;
+    /**
+     * Handles the "aztec_sendTx" JSON-RPC method.
+     * Sends a proven {@link Tx} (transaction object) to the Aztec network via the
+     * {@link AccountWallet} in the context.
+     *
+     * This is typically the final step in submitting a transaction after it has been
+     * successfully proven by `aztec_proveTx`.
+     *
+     * @param ctx - The {@link AztecHandlerContext} containing the `wallet` instance.
+     * @param paramsTuple - A tuple containing the proven transaction.
+     *                      Defined by {@link AztecWalletMethodMap.aztec_sendTx.params}.
+     * @param paramsTuple.0 - The proven {@link Tx} object to send.
+     * @returns A promise that resolves to the {@link TxHash} of the sent transaction.
+     *          Type defined by {@link AztecWalletMethodMap.aztec_sendTx.result}.
+     * @throws {Error} If the `tx` parameter is missing or invalid.
+     */
+    aztec_sendTx: (ctx: AztecHandlerContext, paramsTuple: AztecWalletMethodMap["aztec_sendTx"]["params"]) => Promise<AztecWalletMethodMap["aztec_sendTx"]["result"]>;
+    /**
+     * Handles the "aztec_getTxReceipt" JSON-RPC method.
+     * Retrieves the {@link TxReceipt} for a transaction identified by its {@link TxHash},
+     * using the {@link AccountWallet} in the context.
+     *
+     * The receipt provides information about the transaction's execution status
+     * (e.g., success, failure, reverted), block inclusion, and any emitted events.
+     *
+     * @param ctx - The {@link AztecHandlerContext} containing the `wallet` instance.
+     * @param paramsTuple - A tuple containing the transaction hash.
+     *                      Defined by {@link AztecWalletMethodMap.aztec_getTxReceipt.params}.
+     * @param paramsTuple.0 - The {@link TxHash} of the transaction.
+     * @returns A promise that resolves to the {@link TxReceipt}.
+     *          Type defined by {@link AztecWalletMethodMap.aztec_getTxReceipt.result}.
+     * @throws {Error} If the `txHash` parameter is missing or invalid.
+     */
+    aztec_getTxReceipt: (ctx: AztecHandlerContext, paramsTuple: AztecWalletMethodMap["aztec_getTxReceipt"]["params"]) => Promise<AztecWalletMethodMap["aztec_getTxReceipt"]["result"]>;
+    /**
+     * Handles the "aztec_simulateTx" JSON-RPC method.
+     * Simulates the execution of a {@link TxExecutionRequest} without actually proving
+     * or sending it to the network. This is useful for estimating gas, verifying
+     * correctness, or debugging.
+     *
+     * @param ctx - The {@link AztecHandlerContext} containing the `wallet` instance.
+     * @param paramsTuple - A tuple containing the parameters for simulation.
+     *                      Defined by {@link AztecWalletMethodMap.aztec_simulateTx.params}.
+     * @param paramsTuple.0 - The {@link TxExecutionRequest} to simulate.
+     * @param paramsTuple.1 - Optional: Boolean indicating whether to simulate public parts of the transaction. Defaults to `false`.
+     * @param paramsTuple.2 - Optional: The {@link AztecAddress} of the message sender for simulation context.
+     * @param paramsTuple.3 - Optional: Boolean flag to skip transaction validation during simulation.
+     * @param paramsTuple.4 - Optional: Boolean flag to skip fee enforcement during simulation.
+     * @returns A promise that resolves to the {@link TxSimulationResult}.
+     *          Type defined by {@link AztecWalletMethodMap.aztec_simulateTx.result}.
+     * @throws {Error} If the `txRequest` parameter is missing or invalid.
+     */
+    aztec_simulateTx: (ctx: AztecHandlerContext, paramsTuple: AztecWalletMethodMap["aztec_simulateTx"]["params"]) => Promise<AztecWalletMethodMap["aztec_simulateTx"]["result"]>;
+    /**
+     * Handles the "aztec_profileTx" JSON-RPC method.
+     * Profiles a {@link TxExecutionRequest} to gather performance metrics, such as
+     * gate counts and execution steps, without sending it to the network.
+     *
+     * @param ctx - The {@link AztecHandlerContext} containing the `wallet` instance.
+     * @param paramsTuple - A tuple containing the parameters for profiling.
+     *                      Defined by {@link AztecWalletMethodMap.aztec_profileTx.params}.
+     * @param paramsTuple.0 - The {@link TxExecutionRequest} to profile.
+     * @param paramsTuple.1 - Optional: The profiling mode ('gates', 'execution-steps', or 'full'). Defaults to 'gates'.
+     * @param paramsTuple.2 - Optional: Boolean flag to skip proof generation during profiling.
+     * @param paramsTuple.3 - Optional: The {@link AztecAddress} of the message sender for profiling context.
+     * @returns A promise that resolves to the {@link TxProfileResult}.
+     *          Type defined by {@link AztecWalletMethodMap.aztec_profileTx.result}.
+     * @throws {Error} If the `txRequest` parameter is missing or invalid.
+     */
+    aztec_profileTx: (ctx: AztecHandlerContext, paramsTuple: AztecWalletMethodMap["aztec_profileTx"]["params"]) => Promise<AztecWalletMethodMap["aztec_profileTx"]["result"]>;
+    /**
+     * Handles the "aztec_simulateUtility" JSON-RPC method.
+     * Simulates a call to a utility (view) function on a contract. Utility functions
+     * are read-only and do not modify state or require a transaction.
+     *
+     * @param ctx - The {@link AztecHandlerContext} containing the `wallet` instance.
+     * @param paramsTuple - A tuple containing the parameters for the utility function call.
+     *                      Defined by {@link AztecWalletMethodMap.aztec_simulateUtility.params}.
+     * @param paramsTuple.0 - The name of the utility function to call.
+     * @param paramsTuple.1 - An array of arguments for the function call.
+     * @param paramsTuple.2 - The {@link AztecAddress} of the contract or account to call.
+     * @param paramsTuple.3 - Optional: An array of {@link AuthWitness} for authorization, if needed.
+     * @param paramsTuple.4 - Optional: The {@link AztecAddress} of the sender, if relevant for the utility call.
+     * @returns A promise that resolves to the {@link UtilitySimulationResult}.
+     *          Type defined by {@link AztecWalletMethodMap.aztec_simulateUtility.result}.
+     * @throws {Error} If required parameters like `functionName`, `args`, or `to` are missing or invalid.
+     */
+    aztec_simulateUtility: (ctx: AztecHandlerContext, paramsTuple: AztecWalletMethodMap["aztec_simulateUtility"]["params"]) => Promise<AztecWalletMethodMap["aztec_simulateUtility"]["result"]>;
+};
+//# sourceMappingURL=transaction.d.ts.map

package/dist/wallet/handlers/transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../../src/wallet/handlers/transaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAK3D;;;;;;;;;;;;GAYG;AACH,wBAAgB,yBAAyB;IAErC;;;;;;;;;;;;;;;OAeG;yBAEI,mBAAmB,eACX,oBAAoB,CAAC,eAAe,CAAC,CAAC,QAAQ,CAAC,KAC3D,OAAO,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC,QAAQ,CAAC,CAAC;IAgC3D;;;;;;;;;;;;;;;OAeG;wBAEI,mBAAmB,eACX,oBAAoB,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,KAC1D,OAAO,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,CAAC;IAU1D;;;;;;;;;;;;;;;OAeG;8BAEI,mBAAmB,eACX,oBAAoB,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,KAChE,OAAO,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC,QAAQ,CAAC,CAAC;IAUhE;;;;;;;;;;;;;;;;;OAiBG;4BAEI,mBAAmB,eACX,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,KAC9D,OAAO,CAAC,oBAAoB,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,CAAC;IA0B9D;;;;;;;;;;;;;;;OAeG;2BAEI,mBAAmB,eACX,oBAAoB,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,KAC7D,OAAO,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,CAAC;IAY7D;;;;;;;;;;;;;;;;OAgBG;iCAEI,mBAAmB,eACX,oBAAoB,CAAC,uBAAuB,CAAC,CAAC,QAAQ,CAAC,KACnE,OAAO,CAAC,oBAAoB,CAAC,uBAAuB,CAAC,CAAC,QAAQ,CAAC,CAAC;EAUtE"}

package/dist/wallet/handlers/transaction.js

@@ -0,0 +1,191 @@
+import { createLogger } from '@aztec/foundation/log';
+const logger = createLogger('aztec-rpc-wallet:transaction');
+/**
+ * Creates handlers for transaction-related Aztec wallet JSON-RPC methods.
+ * These handlers are responsible for the core lifecycle of an Aztec transaction,
+ * including proving, sending, simulating, and retrieving receipts.
+ *
+ * Each handler function receives an {@link AztecHandlerContext}, providing access to the
+ * {@link AccountWallet} and {@link PXE} client instances necessary for these operations.
+ *
+ * @returns An object where keys are transaction-related method names
+ *          (e.g., "aztec_proveTx", "aztec_sendTx") and values are their
+ *          corresponding handler functions.
+ * @see {@link AztecWalletMethodMap} for method definitions.
+ */
+export function createTransactionHandlers() {
+    return {
+        /**
+         * Handles the "aztec_proveTx" JSON-RPC method.
+         * Generates zero-knowledge proofs for a given {@link TxExecutionRequest}.
+         * If the {@link PrivateExecutionResult} is not provided, this handler will first
+         * simulate the private execution of the transaction to obtain it.
+         *
+         * @param ctx - The {@link AztecHandlerContext} containing the `wallet` instance.
+         * @param paramsTuple - A tuple containing the transaction execution request and an optional private execution result.
+         *                      Defined by {@link AztecWalletMethodMap.aztec_proveTx.params}.
+         * @param paramsTuple.0 - The {@link TxExecutionRequest} to prove.
+         * @param paramsTuple.1 - Optional: The {@link PrivateExecutionResult} from a prior private simulation.
+         *                        If not provided, a private simulation will be performed internally.
+         * @returns A promise that resolves to the {@link TxProvingResult}, which includes the proven transaction.
+         *          Type defined by {@link AztecWalletMethodMap.aztec_proveTx.result}.
+         * @throws {Error} If `txRequest` is missing, or if simulation is needed but fails to produce a `PrivateExecutionResult`.
+         */
+        aztec_proveTx: async (ctx, paramsTuple) => {
+            let [txRequest, privateExecutionResult] = paramsTuple; // privateExecutionResult can now be undefined
+            logger.debug(`[HANDLER] aztec_proveTx: txRequest received = ${!!txRequest}`);
+            if (!txRequest) {
+                // Only txRequest is mandatory now
+                throw new Error('Invalid parameters received in tuple for aztec_proveTx: txRequest is missing');
+            }
+            if (!privateExecutionResult) {
+                logger.debug('[HANDLER] aztec_proveTx: privateExecutionResult not provided, simulating transaction first.');
+                // Simulate the private part of the transaction to get the PrivateExecutionResult
+                // Pass false for simulatePublic, as we only need the private execution.
+                // Pass undefined for msgSender, skipTxValidation, skipFeeEnforcement to use defaults.
+                const simulationResult = await ctx.wallet.simulateTx(txRequest, false, undefined, undefined, undefined);
+                privateExecutionResult = simulationResult.privateExecutionResult;
+                if (!privateExecutionResult) {
+                    throw new Error('Failed to obtain PrivateExecutionResult from simulation for aztec_proveTx');
+                }
+                logger.debug('[HANDLER] aztec_proveTx: privateExecutionResult obtained from simulation.');
+            }
+            return await ctx.wallet.proveTx(txRequest, privateExecutionResult);
+        },
+        /**
+         * Handles the "aztec_sendTx" JSON-RPC method.
+         * Sends a proven {@link Tx} (transaction object) to the Aztec network via the
+         * {@link AccountWallet} in the context.
+         *
+         * This is typically the final step in submitting a transaction after it has been
+         * successfully proven by `aztec_proveTx`.
+         *
+         * @param ctx - The {@link AztecHandlerContext} containing the `wallet` instance.
+         * @param paramsTuple - A tuple containing the proven transaction.
+         *                      Defined by {@link AztecWalletMethodMap.aztec_sendTx.params}.
+         * @param paramsTuple.0 - The proven {@link Tx} object to send.
+         * @returns A promise that resolves to the {@link TxHash} of the sent transaction.
+         *          Type defined by {@link AztecWalletMethodMap.aztec_sendTx.result}.
+         * @throws {Error} If the `tx` parameter is missing or invalid.
+         */
+        aztec_sendTx: async (ctx, paramsTuple) => {
+            const [tx] = paramsTuple;
+            logger.debug(`[HANDLER] aztec_sendTx: tx hash = ${tx?.getTxHash()?.toString()}`);
+            if (!tx) {
+                // tx is mandatory
+                throw new Error('Invalid tx parameter received in tuple');
+            }
+            return await ctx.wallet.sendTx(tx);
+        },
+        /**
+         * Handles the "aztec_getTxReceipt" JSON-RPC method.
+         * Retrieves the {@link TxReceipt} for a transaction identified by its {@link TxHash},
+         * using the {@link AccountWallet} in the context.
+         *
+         * The receipt provides information about the transaction's execution status
+         * (e.g., success, failure, reverted), block inclusion, and any emitted events.
+         *
+         * @param ctx - The {@link AztecHandlerContext} containing the `wallet` instance.
+         * @param paramsTuple - A tuple containing the transaction hash.
+         *                      Defined by {@link AztecWalletMethodMap.aztec_getTxReceipt.params}.
+         * @param paramsTuple.0 - The {@link TxHash} of the transaction.
+         * @returns A promise that resolves to the {@link TxReceipt}.
+         *          Type defined by {@link AztecWalletMethodMap.aztec_getTxReceipt.result}.
+         * @throws {Error} If the `txHash` parameter is missing or invalid.
+         */
+        aztec_getTxReceipt: async (ctx, paramsTuple) => {
+            const [txHash] = paramsTuple;
+            logger.debug(`[HANDLER] aztec_getTxReceipt: txHash = ${txHash?.toString()}`);
+            if (!txHash) {
+                // txHash is mandatory
+                throw new Error('Invalid txHash parameter received in tuple');
+            }
+            return await ctx.wallet.getTxReceipt(txHash);
+        },
+        /**
+         * Handles the "aztec_simulateTx" JSON-RPC method.
+         * Simulates the execution of a {@link TxExecutionRequest} without actually proving
+         * or sending it to the network. This is useful for estimating gas, verifying
+         * correctness, or debugging.
+         *
+         * @param ctx - The {@link AztecHandlerContext} containing the `wallet` instance.
+         * @param paramsTuple - A tuple containing the parameters for simulation.
+         *                      Defined by {@link AztecWalletMethodMap.aztec_simulateTx.params}.
+         * @param paramsTuple.0 - The {@link TxExecutionRequest} to simulate.
+         * @param paramsTuple.1 - Optional: Boolean indicating whether to simulate public parts of the transaction. Defaults to `false`.
+         * @param paramsTuple.2 - Optional: The {@link AztecAddress} of the message sender for simulation context.
+         * @param paramsTuple.3 - Optional: Boolean flag to skip transaction validation during simulation.
+         * @param paramsTuple.4 - Optional: Boolean flag to skip fee enforcement during simulation.
+         * @returns A promise that resolves to the {@link TxSimulationResult}.
+         *          Type defined by {@link AztecWalletMethodMap.aztec_simulateTx.result}.
+         * @throws {Error} If the `txRequest` parameter is missing or invalid.
+         */
+        aztec_simulateTx: async (ctx, paramsTuple) => {
+            const [txRequest, simulatePublicInput, // simulatePublic is optional in PXE interface
+            msgSender, skipTxValidation, skipFeeEnforcementInput, // skipFeeEnforcement is optional in PXE interface
+            ] = paramsTuple;
+            // Handle optional params with defaults if necessary, matching PXE behavior
+            const simulatePublic = simulatePublicInput === undefined ? false : simulatePublicInput;
+            const skipFeeEnforcement = skipFeeEnforcementInput === undefined ? false : skipFeeEnforcementInput;
+            logger.debug(`[HANDLER] aztec_simulateTx: txRequest received = ${!!txRequest}`);
+            if (!txRequest) {
+                // txRequest is mandatory
+                throw new Error('Invalid txRequest parameter received in tuple');
+            }
+            return await ctx.wallet.simulateTx(txRequest, simulatePublic, msgSender, skipTxValidation, skipFeeEnforcement);
+        },
+        /**
+         * Handles the "aztec_profileTx" JSON-RPC method.
+         * Profiles a {@link TxExecutionRequest} to gather performance metrics, such as
+         * gate counts and execution steps, without sending it to the network.
+         *
+         * @param ctx - The {@link AztecHandlerContext} containing the `wallet` instance.
+         * @param paramsTuple - A tuple containing the parameters for profiling.
+         *                      Defined by {@link AztecWalletMethodMap.aztec_profileTx.params}.
+         * @param paramsTuple.0 - The {@link TxExecutionRequest} to profile.
+         * @param paramsTuple.1 - Optional: The profiling mode ('gates', 'execution-steps', or 'full'). Defaults to 'gates'.
+         * @param paramsTuple.2 - Optional: Boolean flag to skip proof generation during profiling.
+         * @param paramsTuple.3 - Optional: The {@link AztecAddress} of the message sender for profiling context.
+         * @returns A promise that resolves to the {@link TxProfileResult}.
+         *          Type defined by {@link AztecWalletMethodMap.aztec_profileTx.result}.
+         * @throws {Error} If the `txRequest` parameter is missing or invalid.
+         */
+        aztec_profileTx: async (ctx, paramsTuple) => {
+            const [txRequest, profileModeInput, skipProofGeneration, msgSender] = paramsTuple;
+            const profileMode = profileModeInput === undefined ? 'gates' : profileModeInput; // Default for optional
+            logger.debug(`[HANDLER] aztec_profileTx: txRequest received = ${!!txRequest}`);
+            if (!txRequest) {
+                // txRequest is mandatory
+                throw new Error('Invalid txRequest parameter received in tuple');
+            }
+            return await ctx.wallet.profileTx(txRequest, profileMode, skipProofGeneration, msgSender);
+        },
+        /**
+         * Handles the "aztec_simulateUtility" JSON-RPC method.
+         * Simulates a call to a utility (view) function on a contract. Utility functions
+         * are read-only and do not modify state or require a transaction.
+         *
+         * @param ctx - The {@link AztecHandlerContext} containing the `wallet` instance.
+         * @param paramsTuple - A tuple containing the parameters for the utility function call.
+         *                      Defined by {@link AztecWalletMethodMap.aztec_simulateUtility.params}.
+         * @param paramsTuple.0 - The name of the utility function to call.
+         * @param paramsTuple.1 - An array of arguments for the function call.
+         * @param paramsTuple.2 - The {@link AztecAddress} of the contract or account to call.
+         * @param paramsTuple.3 - Optional: An array of {@link AuthWitness} for authorization, if needed.
+         * @param paramsTuple.4 - Optional: The {@link AztecAddress} of the sender, if relevant for the utility call.
+         * @returns A promise that resolves to the {@link UtilitySimulationResult}.
+         *          Type defined by {@link AztecWalletMethodMap.aztec_simulateUtility.result}.
+         * @throws {Error} If required parameters like `functionName`, `args`, or `to` are missing or invalid.
+         */
+        aztec_simulateUtility: async (ctx, paramsTuple) => {
+            const [functionName, args, to, authWits, from] = paramsTuple;
+            logger.debug(`[HANDLER] aztec_simulateUtility: functionName = ${functionName}, to = ${to?.toString()}`);
+            if (!functionName || !args || !to) {
+                // Mandatory params
+                throw new Error('Invalid parameters received in tuple for aztec_simulateUtility');
+            }
+            return await ctx.wallet.simulateUtility(functionName, args, to, authWits, from);
+        },
+    };
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHJhbnNhY3Rpb24uanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvd2FsbGV0L2hhbmRsZXJzL3RyYW5zYWN0aW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBLE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSx1QkFBdUIsQ0FBQztBQUVyRCxNQUFNLE1BQU0sR0FBRyxZQUFZLENBQUMsOEJBQThCLENBQUMsQ0FBQztBQUU1RDs7Ozs7Ozs7Ozs7O0dBWUc7QUFDSCxNQUFNLFVBQVUseUJBQXlCO0lBQ3ZDLE9BQU87UUFDTDs7Ozs7Ozs7Ozs7Ozs7O1dBZUc7UUFDSCxhQUFhLEVBQUUsS0FBSyxFQUNsQixHQUF3QixFQUN4QixXQUE0RCxFQUNGLEVBQUU7WUFDNUQsSUFBSSxDQUFDLFNBQVMsRUFBRSxzQkFBc0IsQ0FBQyxHQUFHLFdBQVcsQ0FBQyxDQUFDLDhDQUE4QztZQUNyRyxNQUFNLENBQUMsS0FBSyxDQUFDLGlEQUFpRCxDQUFDLENBQUMsU0FBUyxFQUFFLENBQUMsQ0FBQztZQUM3RSxJQUFJLENBQUMsU0FBUyxFQUFFLENBQUM7Z0JBQ2Ysa0NBQWtDO2dCQUNsQyxNQUFNLElBQUksS0FBSyxDQUFDLDhFQUE4RSxDQUFDLENBQUM7WUFDbEcsQ0FBQztZQUVELElBQUksQ0FBQyxzQkFBc0IsRUFBRSxDQUFDO2dCQUM1QixNQUFNLENBQUMsS0FBSyxDQUNWLDZGQUE2RixDQUM5RixDQUFDO2dCQUNGLGlGQUFpRjtnQkFDakYsd0VBQXdFO2dCQUN4RSxzRkFBc0Y7Z0JBQ3RGLE1BQU0sZ0JBQWdCLEdBQUcsTUFBTSxHQUFHLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FDbEQsU0FBUyxFQUNULEtBQUssRUFDTCxTQUFTLEVBQ1QsU0FBUyxFQUNULFNBQVMsQ0FDVixDQUFDO2dCQUNGLHNCQUFzQixHQUFHLGdCQUFnQixDQUFDLHNCQUFzQixDQUFDO2dCQUNqRSxJQUFJLENBQUMsc0JBQXNCLEVBQUUsQ0FBQztvQkFDNUIsTUFBTSxJQUFJLEtBQUssQ0FBQywyRUFBMkUsQ0FBQyxDQUFDO2dCQUMvRixDQUFDO2dCQUNELE1BQU0sQ0FBQyxLQUFLLENBQUMsMkVBQTJFLENBQUMsQ0FBQztZQUM1RixDQUFDO1lBRUQsT0FBTyxNQUFNLEdBQUcsQ0FBQyxNQUFNLENBQUMsT0FBTyxDQUFDLFNBQVMsRUFBRSxzQkFBc0IsQ0FBQyxDQUFDO1FBQ3JFLENBQUM7UUFFRDs7Ozs7Ozs7Ozs7Ozs7O1dBZUc7UUFDSCxZQUFZLEVBQUUsS0FBSyxFQUNqQixHQUF3QixFQUN4QixXQUEyRCxFQUNGLEVBQUU7WUFDM0QsTUFBTSxDQUFDLEVBQUUsQ0FBQyxHQUFHLFdBQVcsQ0FBQztZQUN6QixNQUFNLENBQUMsS0FBSyxDQUFDLHFDQUFxQyxFQUFFLEVBQUUsU0FBUyxFQUFFLEVBQUUsUUFBUSxFQUFFLEVBQUUsQ0FBQyxDQUFDO1lBQ2pGLElBQUksQ0FBQyxFQUFFLEVBQUUsQ0FBQztnQkFDUixrQkFBa0I7Z0JBQ2xCLE1BQU0sSUFBSSxLQUFLLENBQUMsd0NBQXdDLENBQUMsQ0FBQztZQUM1RCxDQUFDO1lBQ0QsT0FBTyxNQUFNLEdBQUcsQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQyxDQUFDO1FBQ3JDLENBQUM7UUFFRDs7Ozs7Ozs7Ozs7Ozs7O1dBZUc7UUFDSCxrQkFBa0IsRUFBRSxLQUFLLEVBQ3ZCLEdBQXdCLEVBQ3hCLFdBQWlFLEVBQ0YsRUFBRTtZQUNqRSxNQUFNLENBQUMsTUFBTSxDQUFDLEdBQUcsV0FBVyxDQUFDO1lBQzdCLE1BQU0sQ0FBQyxLQUFLLENBQUMsMENBQTBDLE1BQU0sRUFBRSxRQUFRLEVBQUUsRUFBRSxDQUFDLENBQUM7WUFDN0UsSUFBSSxDQUFDLE1BQU0sRUFBRSxDQUFDO2dCQUNaLHNCQUFzQjtnQkFDdEIsTUFBTSxJQUFJLEtBQUssQ0FBQyw0Q0FBNEMsQ0FBQyxDQUFDO1lBQ2hFLENBQUM7WUFDRCxPQUFPLE1BQU0sR0FBRyxDQUFDLE1BQU0sQ0FBQyxZQUFZLENBQUMsTUFBTSxDQUFDLENBQUM7UUFDL0MsQ0FBQztRQUVEOzs7Ozs7Ozs7Ozs7Ozs7OztXQWlCRztRQUNILGdCQUFnQixFQUFFLEtBQUssRUFDckIsR0FBd0IsRUFDeEIsV0FBK0QsRUFDRixFQUFFO1lBQy9ELE1BQU0sQ0FDSixTQUFTLEVBQ1QsbUJBQW1CLEVBQUUsOENBQThDO1lBQ25FLFNBQVMsRUFDVCxnQkFBZ0IsRUFDaEIsdUJBQXVCLEVBQUUsa0RBQWtEO2FBQzVFLEdBQUcsV0FBVyxDQUFDO1lBQ2hCLDJFQUEyRTtZQUMzRSxNQUFNLGNBQWMsR0FBRyxtQkFBbUIsS0FBSyxTQUFTLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsbUJBQW1CLENBQUM7WUFDdkYsTUFBTSxrQkFBa0IsR0FBRyx1QkFBdUIsS0FBSyxTQUFTLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsdUJBQXVCLENBQUM7WUFFbkcsTUFBTSxDQUFDLEtBQUssQ0FBQyxvREFBb0QsQ0FBQyxDQUFDLFNBQVMsRUFBRSxDQUFDLENBQUM7WUFDaEYsSUFBSSxDQUFDLFNBQVMsRUFBRSxDQUFDO2dCQUNmLHlCQUF5QjtnQkFDekIsTUFBTSxJQUFJLEtBQUssQ0FBQywrQ0FBK0MsQ0FBQyxDQUFDO1lBQ25FLENBQUM7WUFDRCxPQUFPLE1BQU0sR0FBRyxDQUFDLE1BQU0sQ0FBQyxVQUFVLENBQ2hDLFNBQVMsRUFDVCxjQUFjLEVBQ2QsU0FBUyxFQUNULGdCQUFnQixFQUNoQixrQkFBa0IsQ0FDbkIsQ0FBQztRQUNKLENBQUM7UUFFRDs7Ozs7Ozs7Ozs7Ozs7O1dBZUc7UUFDSCxlQUFlLEVBQUUsS0FBSyxFQUNwQixHQUF3QixFQUN4QixXQUE4RCxFQUNGLEVBQUU7WUFDOUQsTUFBTSxDQUFDLFNBQVMsRUFBRSxnQkFBZ0IsRUFBRSxtQkFBbUIsRUFBRSxTQUFTLENBQUMsR0FBRyxXQUFXLENBQUM7WUFDbEYsTUFBTSxXQUFXLEdBQUcsZ0JBQWdCLEtBQUssU0FBUyxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLGdCQUFnQixDQUFDLENBQUMsdUJBQXVCO1lBRXhHLE1BQU0sQ0FBQyxLQUFLLENBQUMsbURBQW1ELENBQUMsQ0FBQyxTQUFTLEVBQUUsQ0FBQyxDQUFDO1lBQy9FLElBQUksQ0FBQyxTQUFTLEVBQUUsQ0FBQztnQkFDZix5QkFBeUI7Z0JBQ3pCLE1BQU0sSUFBSSxLQUFLLENBQUMsK0NBQStDLENBQUMsQ0FBQztZQUNuRSxDQUFDO1lBQ0QsT0FBTyxNQUFNLEdBQUcsQ0FBQyxNQUFNLENBQUMsU0FBUyxDQUFDLFNBQVMsRUFBRSxXQUFXLEVBQUUsbUJBQW1CLEVBQUUsU0FBUyxDQUFDLENBQUM7UUFDNUYsQ0FBQztRQUVEOzs7Ozs7Ozs7Ozs7Ozs7O1dBZ0JHO1FBQ0gscUJBQXFCLEVBQUUsS0FBSyxFQUMxQixHQUF3QixFQUN4QixXQUFvRSxFQUNGLEVBQUU7WUFDcEUsTUFBTSxDQUFDLFlBQVksRUFBRSxJQUFJLEVBQUUsRUFBRSxFQUFFLFFBQVEsRUFBRSxJQUFJLENBQUMsR0FBRyxXQUFXLENBQUM7WUFDN0QsTUFBTSxDQUFDLEtBQUssQ0FBQyxtREFBbUQsWUFBWSxVQUFVLEVBQUUsRUFBRSxRQUFRLEVBQUUsRUFBRSxDQUFDLENBQUM7WUFDeEcsSUFBSSxDQUFDLFlBQVksSUFBSSxDQUFDLElBQUksSUFBSSxDQUFDLEVBQUUsRUFBRSxDQUFDO2dCQUNsQyxtQkFBbUI7Z0JBQ25CLE1BQU0sSUFBSSxLQUFLLENBQUMsZ0VBQWdFLENBQUMsQ0FBQztZQUNwRixDQUFDO1lBQ0QsT0FBTyxNQUFNLEdBQUcsQ0FBQyxNQUFNLENBQUMsZUFBZSxDQUFDLFlBQVksRUFBRSxJQUFJLEVBQUUsRUFBRSxFQUFFLFFBQVEsRUFBRSxJQUFJLENBQUMsQ0FBQztRQUNsRixDQUFDO0tBQ0YsQ0FBQztBQUNKLENBQUMifQ==

package/dist/wallet/serializers.d.ts

@@ -0,0 +1,75 @@
+/**
+ * @module @walletmesh/aztec-rpc-wallet/wallet/serializers
+ *
+ * This module provides the primary JSON-RPC serializer (`AztecWalletSerializer`)
+ * for handling Aztec-specific data types over JSON-RPC. It leverages Zod schemas
+ * from `@aztec/foundation/schemas` and `@aztec/aztec.js` for robust serialization
+ * and deserialization of parameters and results for all Aztec wallet methods.
+ *
+ * It also includes a helper function `registerAztecSerializers` for applying these
+ * serializers to a `JSONRPCNode` instance, typically used on the wallet-side
+ * implementation (e.g., in `createAztecWalletNode`).
+ *
+ * The serialization strategy involves:
+ * - Using Aztec's `jsonStringify` and `jsonParseWithSchema` for types that have
+ *   corresponding Zod schemas.
+ * - Custom logic for arrays of specific types (e.g., `AztecAddress[]`).
+ * - A fallback serializer for parameters and results not explicitly covered.
+ * - Detailed parameter deserialization logic within `AztecWalletSerializer.params.deserialize`
+ *   to reconstruct complex Aztec objects from their JSON representations.
+ */
+import type { AztecWalletMethodMap } from '../types.js';
+import type { JSONRPCNode, JSONRPCSerializer, JSONRPCParams } from '@walletmesh/jsonrpc';
+/**
+ * A comprehensive {@link JSONRPCSerializer} for all Aztec wallet methods.
+ *
+ * This serializer handles both parameters and results:
+ *
+ * **Parameters (`params`):**
+ *  - `serialize`: Currently uses a fallback mechanism (`createFallbackSerializer`) which
+ *    stringifies parameters using `jsonStringify`. This assumes the client-side
+ *    (e.g., {@link AztecDappWallet} via {@link AztecRouterProvider}) sends parameters
+ *    already in a format that can be processed by the `deserialize` logic after
+ *    basic JSON parsing.
+ *  - `deserialize`: Contains detailed, method-specific logic to parse the JSON string
+ *    of incoming parameters and reconstruct them into their correct Aztec types
+ *    (e.g., `AztecAddress.fromString`, `TxExecutionRequest.schema.parse`). It uses
+ *    Zod schemas and helper functions (`ensureParam`, `getOptionalParam`) for
+ *    validation and type conversion.
+ *
+ * **Results (`result`):**
+ *  - `serialize`: For each method, it attempts to use a specific serializer defined in
+ *    `RESULT_SERIALIZERS`. These typically use `jsonStringify` with a Zod schema
+ *    for the specific result type (e.g., `AztecAddress.schema`, `TxHash.schema`).
+ *    If no specific serializer is found, it uses `createFallbackSerializer`.
+ *  - `deserialize`: Similar to result serialization, it uses `RESULT_SERIALIZERS`
+ *    to find a method-specific deserializer, often employing `jsonParseWithSchema`
+ *    with the appropriate Zod schema. If no specific deserializer exists, it may
+ *    return the raw data or attempt a simple JSON parse.
+ *
+ * This serializer is crucial for ensuring that complex Aztec objects maintain their
+ * type integrity and structure when transmitted over JSON-RPC.
+ *
+ * @see {@link AztecWalletMethodMap} for the definitions of methods, params, and results.
+ * @see {@link JSONRPCSerializer} for the interface it implements.
+ */
+export declare const AztecWalletSerializer: JSONRPCSerializer<JSONRPCParams, unknown>;
+/**
+ * Registers the {@link AztecWalletSerializer} for all relevant Aztec JSON-RPC methods
+ * on a given {@link JSONRPCNode} instance.
+ *
+ * This function is typically called on the wallet-side (e.g., within
+ * `createAztecWalletNode`) to equip the node with the necessary serialization
+ * capabilities for handling Aztec methods.
+ *
+ * It iterates through a predefined list of Aztec methods and associates each
+ * with the `AztecWalletSerializer`.
+ *
+ * @param node - The {@link JSONRPCNode} instance on which to register the serializers.
+ *               This node should be typed with {@link AztecWalletMethodMap}.
+ *
+ * @see {@link createAztecWalletNode} where this function is used.
+ * @see {@link AztecWalletSerializer} which provides the serialization logic.
+ */
+export declare function registerAztecSerializers(node: JSONRPCNode<AztecWalletMethodMap>): void;
+//# sourceMappingURL=serializers.d.ts.map

package/dist/wallet/serializers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializers.d.ts","sourceRoot":"","sources":["../../src/wallet/serializers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAExD,OAAO,KAAK,EACV,WAAW,EACX,iBAAiB,EAEjB,aAAa,EACd,MAAM,qBAAqB,CAAC;AA2M7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,qBAAqB,EAAE,iBAAiB,CAAC,aAAa,EAAE,OAAO,CAwQ3E,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,WAAW,CAAC,oBAAoB,CAAC,QAsC/E"}