fix: serialize bigints

Author: alexghr

yarn-project/end-to-end/scripts/web3signer/docker-compose.yml

@@ -7,7 +7,7 @@ configs:
 
 services:
   web3signer:
-    image: consensys/web3signer:25.3.0
+    image: consensys/web3signer:25.6.0
     ports:
       - "9000:9000"
     configs:
@@ -17,7 +17,7 @@ services:
       - --http-listen-port=9000
       - --http-host-allowlist=*
       - --key-store-path=/keys
-      - --logging=DEBUG
+      - --logging=ALL
       - eth1
       - --chain-id=31337
 

yarn-project/end-to-end/src/composed/web3signer/integration_remote_signer.test.ts

@@ -6,7 +6,11 @@ import { jest } from '@jest/globals';
 import type { TransactionSerializable, TypedDataDefinition } from 'viem';
 import { privateKeyToAddress } from 'viem/accounts';
 
-const { WEB3_SIGNER_URL, L1_CHAIN_ID = '31337', TEST_PRIVATE_KEY } = process.env;
+const {
+  WEB3_SIGNER_URL = 'http://localhost:9000',
+  L1_CHAIN_ID = '31337',
+  TEST_PRIVATE_KEY = '0x1111111111111111111111111111111111111111111111111111111111111111',
+} = process.env;
 
 describe('RemoteSigner integration: Web3Signer (compose)', () => {
   jest.setTimeout(180_000);
@@ -41,22 +45,24 @@ describe('RemoteSigner integration: Web3Signer (compose)', () => {
     remoteSigner = new RemoteSigner(address, web3SignerUrl);
   });
 
-  // the remote signer ends up calling a client? I'm not sure this is implemented in web3signer
-  it.skip('signs EIP-712 typed data and matches r/s with local', async () => {
+  it('signs EIP-712 typed data and matches r/s with local', async () => {
     const typedData: TypedDataDefinition = {
-      domain: { name: 'Aztec', version: '1', chainId: 1 },
+      domain: {
+        name: 'TallySlashingProposer',
+        version: '1',
+        chainId,
+        verifyingContract: EthAddress.random().toString(),
+      },
       types: {
-        Mail: [
-          { name: 'from', type: 'address' },
-          { name: 'to', type: 'address' },
-          { name: 'contents', type: 'string' },
+        Vote: [
+          { name: 'votes', type: 'bytes' },
+          { name: 'slot', type: 'uint256' },
         ],
       },
-      primaryType: 'Mail',
+      primaryType: 'Vote',
       message: {
-        from: address.toString(),
-        to: address.toString(),
-        contents: 'hello',
+        votes: '0x1234',
+        slot: '0x42',
       },
     };
 

yarn-project/node-keystore/src/signer.ts

@@ -5,9 +5,10 @@
  */
 import type { EthSigner } from '@aztec/ethereum';
 import { Buffer32 } from '@aztec/foundation/buffer';
-import { Secp256k1Signer, toRecoveryBit } from '@aztec/foundation/crypto';
+import { Secp256k1Signer, randomBytes, toRecoveryBit } from '@aztec/foundation/crypto';
 import type { EthAddress } from '@aztec/foundation/eth-address';
 import { Signature, type ViemTransactionSignature } from '@aztec/foundation/eth-signature';
+import { jsonStringify } from '@aztec/foundation/json-rpc';
 import { withHexPrefix } from '@aztec/foundation/string';
 
 import {
@@ -27,7 +28,7 @@ import type { EthRemoteSignerConfig } from './types.js';
 export class SignerError extends Error {
   constructor(
     message: string,
-    public method: 'eth_sign' | 'eth_signTransaction' | 'eth_signTypedData_v4',
+    public method: string,
     public url: string,
     public statusCode?: number,
     public errorCode?: number,
@@ -128,50 +129,12 @@ export class RemoteSigner implements EthSigner {
    * Make a JSON-RPC eth_sign request.
    */
   private async makeJsonRpcSignRequest(data: Buffer32): Promise<Signature> {
-    const url = this.getSignerUrl();
-
-    const body = {
-      jsonrpc: '2.0',
-      method: 'eth_sign',
-      params: [this.address.toString(), data.toString()],
-      id: 1,
-    };
-
-    const response = await this.fetch(url, {
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/json',
-      },
-      body: JSON.stringify(body),
-    });
-
-    if (!response.ok) {
-      const errorText = await response.text();
-      throw new SignerError(
-        `Web3Signer request failed for eth_sign at ${url}: ${response.status} ${response.statusText} - ${errorText}`,
-        'eth_sign',
-        url,
-        response.status,
-      );
-    }
-
-    const result = await response.json();
-
-    if (result.error) {
-      throw new SignerError(
-        `Web3Signer JSON-RPC error for eth_sign at ${url}: ${result.error.code} - ${result.error.message}`,
-        'eth_sign',
-        url,
-        undefined,
-        result.error.code,
-      );
-    }
+    let signatureHex = await this.makeJsonRpcRequest('eth_sign', this.address.toString(), data.toString());
 
-    if (!result.result) {
-      throw new Error('Invalid response from Web3Signer: no result found');
+    if (typeof signatureHex !== 'string') {
+      throw new Error('Invalid signature');
     }
 
-    let signatureHex = result.result;
     if (!signatureHex.startsWith('0x')) {
       signatureHex = '0x' + signatureHex;
     }
@@ -183,50 +146,12 @@ export class RemoteSigner implements EthSigner {
    * Make a JSON-RPC eth_signTypedData_v4 request.
    */
   private async makeJsonRpcSignTypedDataRequest(typedData: TypedDataDefinition): Promise<Signature> {
-    const url = this.getSignerUrl();
-
-    const body = {
-      jsonrpc: '2.0',
-      method: 'eth_signTypedData_v4',
-      params: [this.address.toString(), typedData],
-      id: 1,
-    };
-
-    const response = await this.fetch(url, {
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/json',
-      },
-      body: JSON.stringify(body),
-    });
-
-    if (!response.ok) {
-      const errorText = await response.text();
-      throw new SignerError(
-        `Web3Signer request failed for eth_signTypedData_v4 at ${url}: ${response.status} ${response.statusText} - ${errorText}`,
-        'eth_signTypedData_v4',
-        url,
-        response.status,
-      );
-    }
-
-    const result = await response.json();
-
-    if (result.error) {
-      throw new SignerError(
-        `Web3Signer JSON-RPC error for eth_signTypedData_v4 at ${url}: ${result.error.code} - ${result.error.message}`,
-        'eth_signTypedData_v4',
-        url,
-        undefined,
-        result.error.code,
-      );
-    }
+    let signatureHex = await this.makeJsonRpcRequest('eth_signTypedData', this.address.toString(), typedData);
 
-    if (!result.result) {
-      throw new Error('Invalid response from Web3Signer: no result found');
+    if (typeof signatureHex !== 'string') {
+      throw new Error('Invalid signature');
     }
 
-    let signatureHex = result.result;
     if (!signatureHex.startsWith('0x')) {
       signatureHex = '0x' + signatureHex;
     }
@@ -242,8 +167,6 @@ export class RemoteSigner implements EthSigner {
       throw new Error('This signer does not support tx type: ' + tx.type);
     }
 
-    const url = this.getSignerUrl();
-
     const txObject: RemoteSignerTxObject = {
       from: this.address.toString(),
       to: tx.to ?? null,
@@ -263,26 +186,49 @@ export class RemoteSigner implements EthSigner {
       // blobs: tx.blobs?.map(blob => (typeof blob === 'string' ? blob : bufferToHex(Buffer.from(blob)))),
     };
 
-    const body = {
-      jsonrpc: '2.0',
-      method: 'eth_signTransaction',
-      params: [txObject],
-      id: 1,
-    };
+    let rawTxHex = await this.makeJsonRpcRequest('eth_signTransaction', txObject);
+
+    if (typeof rawTxHex !== 'string') {
+      throw new Error('Invalid signed tx');
+    }
+
+    if (!rawTxHex.startsWith('0x')) {
+      rawTxHex = '0x' + rawTxHex;
+    }
+
+    // we get back to whole signed tx. Deserialize it in order to read the signature
+    const parsedTxWithSignature = parseTransaction(rawTxHex);
+    if (
+      parsedTxWithSignature.r === undefined ||
+      parsedTxWithSignature.s === undefined ||
+      parsedTxWithSignature.v === undefined
+    ) {
+      throw new Error('Tx not signed by Web3Signer');
+    }
+
+    return Signature.fromViemTransactionSignature(parsedTxWithSignature as ViemTransactionSignature);
+  }
+
+  /**
+   * Sends a JSON-RPC request and returns its result
+   */
+  private async makeJsonRpcRequest(method: string, ...params: any[]): Promise<any> {
+    const url = this.getSignerUrl();
+    const id = this.generateId();
 
     const response = await this.fetch(url, {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json',
       },
-      body: JSON.stringify(body),
+      body: jsonStringify({ jsonrpc: '2.0', method, params, id }),
     });
 
     if (!response.ok) {
       const errorText = await response.text();
       throw new SignerError(
-        `Web3Signer request failed for eth_signTransaction at ${url}: ${response.status} ${response.statusText} - ${errorText}`,
-        'eth_signTransaction',
+        `Web3Signer request failed for ${method} at ${url}: ${response.status} ${response.statusText} - ${errorText}`,
+        method,
         url,
         response.status,
       );
@@ -292,10 +238,10 @@ export class RemoteSigner implements EthSigner {
 
     if (result.error) {
       throw new SignerError(
-        `Web3Signer JSON-RPC error for eth_signTransaction at ${url}: ${result.error.code} - ${result.error.message}`,
-        'eth_signTransaction',
+        `Web3Signer JSON-RPC error for ${method} at ${url}: ${result.error.code} - ${result.error.message}`,
+        method,
         url,
-        undefined,
+        response.status,
         result.error.code,
       );
     }
@@ -304,22 +250,7 @@ export class RemoteSigner implements EthSigner {
       throw new Error('Invalid response from Web3Signer: no result found');
     }
 
-    let rawTxHex = result.result;
-    if (!rawTxHex.startsWith('0x')) {
-      rawTxHex = '0x' + rawTxHex;
-    }
-
-    // we get back to whole signed tx. Deserialize it in order to read the signature
-    const parsedTxWithSignature = parseTransaction(rawTxHex);
-    if (
-      parsedTxWithSignature.r === undefined ||
-      parsedTxWithSignature.s === undefined ||
-      parsedTxWithSignature.v === undefined
-    ) {
-      throw new Error('Tx not signed by Web3Signer');
-    }
-
-    return Signature.fromViemTransactionSignature(parsedTxWithSignature as ViemTransactionSignature);
+    return result.result;
   }
 
   /**
@@ -331,4 +262,11 @@ export class RemoteSigner implements EthSigner {
     }
     return this.config.remoteSignerUrl;
   }
+
+  /**
+   * Generate an id to use for a JSON-RPC call
+   */
+  private generateId(): string {
+    return randomBytes(4).toString('hex');
+  }
 }