fix: leading zeros stripped from request id (#312)

Author: ScottyPoi

packages/discv5/src/message/create.ts

@@ -1,5 +1,5 @@
 import { randomBytes, toBytes } from "@noble/hashes/utils";
-import { bytesToBigint, SequenceNumber, ENR } from "@chainsafe/enr";
+import { SequenceNumber, ENR } from "@chainsafe/enr";
 
 import {
   RequestId,
@@ -12,7 +12,7 @@ import {
 } from "./types.js";
 
 export function createRequestId(): RequestId {
-  return bytesToBigint(randomBytes(8));
+  return randomBytes(8);
 }
 
 export function createPingMessage(enrSeq: SequenceNumber): IPingMessage {

packages/discv5/src/message/decode.ts

@@ -53,7 +53,7 @@ function decodePing(data: Uint8Array): IPingMessage {
   }
   return {
     type: MessageType.PING,
-    id: bytesToBigint(rlpRaw[0]),
+    id: rlpRaw[0],
     enrSeq: bytesToBigint(rlpRaw[1]),
   };
 }
@@ -78,7 +78,7 @@ function decodePong(data: Uint8Array): IPongMessage {
 
   return {
     type: MessageType.PONG,
-    id: bytesToBigint(rlpRaw[0]),
+    id: rlpRaw[0],
     enrSeq: bytesToBigint(rlpRaw[1]),
     addr: { ip, port },
   };
@@ -95,7 +95,7 @@ function decodeFindNode(data: Uint8Array): IFindNodeMessage {
   const distances = (rlpRaw[1] as Uint8Array[]).map((x) => (x.length ? Number(bytesToBigint(x)) : 0));
   return {
     type: MessageType.FINDNODE,
-    id: bytesToBigint(rlpRaw[0]),
+    id: rlpRaw[0],
     distances,
   };
 }
@@ -107,7 +107,7 @@ function decodeNodes(data: Uint8Array): INodesMessage {
   }
   return {
     type: MessageType.NODES,
-    id: bytesToBigint(rlpRaw[0] as Uint8Array),
+    id: rlpRaw[0] as Uint8Array,
     total: rlpRaw[1].length ? Number(bytesToBigint(rlpRaw[1] as Uint8Array)) : 0,
     enrs: rlpRaw[2].map((enrRaw) => ENR.decodeFromValues(enrRaw as Uint8Array[])),
   };
@@ -120,7 +120,7 @@ function decodeTalkReq(data: Uint8Array): ITalkReqMessage {
   }
   return {
     type: MessageType.TALKREQ,
-    id: bytesToBigint(rlpRaw[0]),
+    id: rlpRaw[0],
     protocol: rlpRaw[1],
     request: rlpRaw[2],
   };
@@ -133,7 +133,7 @@ function decodeTalkResp(data: Uint8Array): ITalkRespMessage {
   }
   return {
     type: MessageType.TALKRESP,
-    id: bytesToBigint(rlpRaw[0]),
+    id: rlpRaw[0],
     response: rlpRaw[1],
   };
 }
@@ -145,7 +145,7 @@ function decodeRegTopic(data: Uint8Array): IRegTopicMessage {
   }
   return {
     type: MessageType.REGTOPIC,
-    id: bytesToBigint(rlpRaw[0]),
+    id: rlpRaw[0],
     topic: rlpRaw[1],
     enr: ENR.decodeFromValues(rlpRaw[2] as Uint8Array[]),
     ticket: rlpRaw[3],
@@ -159,7 +159,7 @@ function decodeTicket(data: Uint8Array): ITicketMessage {
   }
   return {
     type: MessageType.TICKET,
-    id: bytesToBigint(rlpRaw[0]),
+    id: rlpRaw[0],
     ticket: rlpRaw[1],
     waitTime: rlpRaw[2].length ? Number(bytesToBigint(rlpRaw[2] as Uint8Array)) : 0,
   };
@@ -172,7 +172,7 @@ function decodeRegConfirmation(data: Uint8Array): IRegConfirmationMessage {
   }
   return {
     type: MessageType.REGCONFIRMATION,
-    id: bytesToBigint(rlpRaw[0]),
+    id: rlpRaw[0],
     topic: rlpRaw[1],
   };
 }
@@ -184,7 +184,7 @@ function decodeTopicQuery(data: Uint8Array): ITopicQueryMessage {
   }
   return {
     type: MessageType.TOPICQUERY,
-    id: bytesToBigint(rlpRaw[0]),
+    id: rlpRaw[0],
     topic: rlpRaw[1],
   };
 }

packages/discv5/src/message/encode.ts

@@ -43,7 +43,7 @@ export function encode(message: Message): Uint8Array {
 }
 
 export function encodePingMessage(m: IPingMessage): Uint8Array {
-  return concatBytes(Uint8Array.from([MessageType.PING]), RLP.encode([bigintToBytes(m.id), bigintToBytes(m.enrSeq)]));
+  return concatBytes(Uint8Array.from([MessageType.PING]), RLP.encode([m.id, bigintToBytes(m.enrSeq)]));
 }
 
 export function encodePongMessage(m: IPongMessage): Uint8Array {
@@ -52,44 +52,44 @@ export function encodePongMessage(m: IPongMessage): Uint8Array {
   }
   return concatBytes(
     Uint8Array.from([MessageType.PONG]),
-    RLP.encode([bigintToBytes(m.id), bigintToBytes(m.enrSeq), ipToBytes(m.addr.ip), m.addr.port])
+    RLP.encode([m.id, bigintToBytes(m.enrSeq), ipToBytes(m.addr.ip), m.addr.port])
   );
 }
 
 export function encodeFindNodeMessage(m: IFindNodeMessage): Uint8Array {
-  return concatBytes(Uint8Array.from([MessageType.FINDNODE]), RLP.encode([bigintToBytes(m.id), m.distances]));
+  return concatBytes(Uint8Array.from([MessageType.FINDNODE]), RLP.encode([m.id, m.distances]));
 }
 
 export function encodeNodesMessage(m: INodesMessage): Uint8Array {
   return concatBytes(
     Uint8Array.from([MessageType.NODES]),
-    RLP.encode([bigintToBytes(m.id), m.total, m.enrs.map((enr) => enr.encodeToValues())])
+    RLP.encode([m.id, m.total, m.enrs.map((enr) => enr.encodeToValues())])
   );
 }
 
 export function encodeTalkReqMessage(m: ITalkReqMessage): Uint8Array {
-  return concatBytes(Uint8Array.from([MessageType.TALKREQ]), RLP.encode([bigintToBytes(m.id), m.protocol, m.request]));
+  return concatBytes(Uint8Array.from([MessageType.TALKREQ]), RLP.encode([m.id, m.protocol, m.request]));
 }
 
 export function encodeTalkRespMessage(m: ITalkRespMessage): Uint8Array {
-  return concatBytes(Uint8Array.from([MessageType.TALKRESP]), RLP.encode([bigintToBytes(m.id), m.response]));
+  return concatBytes(Uint8Array.from([MessageType.TALKRESP]), RLP.encode([m.id, m.response]));
 }
 
 export function encodeRegTopicMessage(m: IRegTopicMessage): Uint8Array {
   return concatBytes(
     Uint8Array.from([MessageType.REGTOPIC]),
-    RLP.encode([bigintToBytes(m.id), m.topic, m.enr.encodeToValues(), m.ticket])
+    RLP.encode([m.id, m.topic, m.enr.encodeToValues(), m.ticket])
   );
 }
 
 export function encodeTicketMessage(m: ITicketMessage): Uint8Array {
-  return concatBytes(Uint8Array.from([MessageType.TICKET]), RLP.encode([bigintToBytes(m.id), m.ticket, m.waitTime]));
+  return concatBytes(Uint8Array.from([MessageType.TICKET]), RLP.encode([m.id, m.ticket, m.waitTime]));
 }
 
 export function encodeRegConfirmMessage(m: IRegConfirmationMessage): Uint8Array {
-  return concatBytes(Uint8Array.from([MessageType.REGCONFIRMATION]), RLP.encode([bigintToBytes(m.id), m.topic]));
+  return concatBytes(Uint8Array.from([MessageType.REGCONFIRMATION]), RLP.encode([m.id, m.topic]));
 }
 
 export function encodeTopicQueryMessage(m: ITopicQueryMessage): Uint8Array {
-  return concatBytes(Uint8Array.from([MessageType.TOPICQUERY]), RLP.encode([bigintToBytes(m.id), m.topic]));
+  return concatBytes(Uint8Array.from([MessageType.TOPICQUERY]), RLP.encode([m.id, m.topic]));
 }

packages/discv5/src/message/types.ts

@@ -1,7 +1,7 @@
 import { SequenceNumber, ENR } from "@chainsafe/enr";
 import { SocketAddress } from "../util/ip.js";
 
-export type RequestId = bigint;
+export type RequestId = Uint8Array;
 
 export type NodeAddressIP = {
   family: 4 | 6;

packages/discv5/src/service/service.ts

@@ -3,7 +3,15 @@ import debug from "debug";
 import { randomBytes } from "@noble/hashes/utils";
 import { Multiaddr } from "@multiformats/multiaddr";
 import { PeerId, PrivateKey } from "@libp2p/interface";
-import { createPeerIdFromPublicKey, ENR, NodeId, MAX_RECORD_SIZE, createNodeId, SignableENR } from "@chainsafe/enr";
+import {
+  createPeerIdFromPublicKey,
+  ENR,
+  NodeId,
+  MAX_RECORD_SIZE,
+  createNodeId,
+  SignableENR,
+  bytesToBigint,
+} from "@chainsafe/enr";
 
 import { BindAddrs, IPMode, ITransportService, UDPTransportService } from "../transport/index.js";
 import { MAX_PACKET_SIZE } from "../packet/index.js";
@@ -496,7 +504,7 @@ export class Discv5 extends (EventEmitter as { new (): Discv5EventEmitter }) {
    */
   private sendRpcRequest<T extends RequestMessage, U extends ResponseType>(activeRequest: IActiveRequest<T, U>): void {
     this.activeRequests.set(
-      activeRequest.request.id,
+      bytesToBigint(activeRequest.request.id),
       activeRequest as unknown as IActiveRequest<RequestMessage, ResponseType>
     );
 
@@ -506,7 +514,7 @@ export class Discv5 extends (EventEmitter as { new (): Discv5EventEmitter }) {
       this.sessionService.sendRequest(activeRequest.contact, activeRequest.request);
       this.metrics?.sentMessageCount.inc({ type: MessageType[activeRequest.request.type] });
     } catch (e) {
-      this.activeRequests.delete(activeRequest.request.id);
+      this.activeRequests.delete(bytesToBigint(activeRequest.request.id));
       log("Error sending RPC to node: %o, :Error: %s", nodeAddr, (e as Error).message);
     }
   }
@@ -843,12 +851,12 @@ export class Discv5 extends (EventEmitter as { new (): Discv5EventEmitter }) {
 
     // verify we know of the rpc id
 
-    const activeRequest = this.activeRequests.get(response.id);
+    const activeRequest = this.activeRequests.get(bytesToBigint(response.id));
     if (!activeRequest) {
       log("Received an RPC response which doesn't match a request. Id: &s", response.id);
       return;
     }
-    this.activeRequests.delete(response.id);
+    this.activeRequests.delete(bytesToBigint(response.id));
 
     // Check that the responder matches the expected request
     const requestNodeAddr = getNodeAddress(activeRequest.contact);
@@ -962,15 +970,15 @@ export class Discv5 extends (EventEmitter as { new (): Discv5EventEmitter }) {
 
     // handle the case that there is more than one response
     if (message.total > 1) {
-      const currentResponse = this.activeNodesResponses.get(message.id) || { count: 1, enrs: [] };
-      this.activeNodesResponses.delete(message.id);
+      const currentResponse = this.activeNodesResponses.get(bytesToBigint(message.id)) || { count: 1, enrs: [] };
+      this.activeNodesResponses.delete(bytesToBigint(message.id));
       log("NODES response: %d of %d received, length: %d", currentResponse.count, message.total, message.enrs.length);
       // If there are more requests coming, store the nodes and wait for another response
       if (currentResponse.count < 5 && currentResponse.count < message.total) {
         currentResponse.count += 1;
         currentResponse.enrs.push(...message.enrs);
-        this.activeRequests.set(message.id, activeRequest as IActiveRequest<RequestMessage>);
-        this.activeNodesResponses.set(message.id, currentResponse);
+        this.activeRequests.set(bytesToBigint(message.id), activeRequest as IActiveRequest<RequestMessage>);
+        this.activeNodesResponses.set(bytesToBigint(message.id), currentResponse);
         return false;
       }
 
@@ -984,7 +992,7 @@ export class Discv5 extends (EventEmitter as { new (): Discv5EventEmitter }) {
       nodeAddr
     );
 
-    this.activeNodesResponses.delete(message.id);
+    this.activeNodesResponses.delete(bytesToBigint(message.id));
 
     this.discovered(nodeAddr.nodeId, message.enrs, lookupId);
 
@@ -1003,22 +1011,22 @@ export class Discv5 extends (EventEmitter as { new (): Discv5EventEmitter }) {
   /**
    * A session could not be established or an RPC request timed out
    */
-  private rpcFailure = (rpcId: bigint, error: RequestErrorType): void => {
+  private rpcFailure = (rpcId: RequestId, error: RequestErrorType): void => {
     log("RPC error, removing request. Reason: %s, id %s", RequestErrorType[error], rpcId);
-    const req = this.activeRequests.get(rpcId);
+    const req = this.activeRequests.get(bytesToBigint(rpcId));
     if (!req) {
       return;
     }
     const { request, contact, lookupId, callbackPromise } = req;
-    this.activeRequests.delete(request.id);
+    this.activeRequests.delete(bytesToBigint(request.id));
 
     const nodeId = getNodeId(contact);
     // If a failed FindNodes Request, ensure we haven't partially received responses.
     // If so, process the partially found nodes
     if (request.type === MessageType.FINDNODE) {
-      const nodesResponse = this.activeNodesResponses.get(request.id);
+      const nodesResponse = this.activeNodesResponses.get(bytesToBigint(request.id));
       if (nodesResponse) {
-        this.activeNodesResponses.delete(request.id);
+        this.activeNodesResponses.delete(bytesToBigint(request.id));
 
         if (nodesResponse.enrs.length) {
           log("NODES response failed, but was partially processed from Node: %s", nodeId);

packages/discv5/src/session/service.ts

@@ -643,7 +643,7 @@ export class SessionService extends (EventEmitter as { new (): StrictEventEmitte
       // Check if this response matches these
       const requestId = session.awaitingEnr;
       if (requestId !== undefined) {
-        if (requestId === message.id) {
+        if (equalsBytes(requestId, message.id)) {
           delete session.awaitingEnr;
           if (message.type === MessageType.NODES) {
             // Received the requested ENR
@@ -696,7 +696,7 @@ export class SessionService extends (EventEmitter as { new (): StrictEventEmitte
       return;
     }
 
-    if (requestCall.request.id !== response.id) {
+    if (!equalsBytes(requestCall.request.id, response.id)) {
       log("Received an RPC Response to an unknown request. Likely late response. %o", nodeAddr);
       return;
     }

packages/discv5/src/session/types.ts

@@ -2,7 +2,7 @@ import { Multiaddr } from "@multiformats/multiaddr";
 import { NodeId, ENR } from "@chainsafe/enr";
 
 import { IPacket } from "../packet/index.js";
-import { RequestMessage, ResponseMessage } from "../message/index.js";
+import { RequestId, RequestMessage, ResponseMessage } from "../message/index.js";
 import { INodeAddress, NodeContact } from "./nodeInfo.js";
 
 export type NodeAddressString = string;
@@ -152,5 +152,5 @@ export interface ISessionEvents {
   /**
    * An RPC request failed.
    */
-  requestFailed: (requestId: bigint, error: RequestErrorType) => void;
+  requestFailed: (requestId: RequestId, error: RequestErrorType) => void;
 }