Portal: Cleanup JSON-RPC InvalidRequest usage (#3858)

kdeme · web-flow · commit b16ccf1d4f38 · 2025-12-03T23:16:54.000Z
diff --git a/portal/rpc/rpc_portal_beacon_api.nim b/portal/rpc/rpc_portal_beacon_api.nim
@@ -77,7 +77,7 @@ proc installPortalBeaconApiHandlers*(rpcServer: RpcServer, p: PortalProtocol) =
     let
       keyBytes = ContentKeyByteList.init(hexToSeqByte(contentKey))
       contentId = p.toContentId(keyBytes).valueOr:
-        raise invalidKeyErr()
+        raise invalidContentKeyError()
 
       contentLookupResult = (await p.contentLookup(keyBytes, contentId)).valueOr:
         raise contentNotFoundErr()
@@ -91,7 +91,7 @@ proc installPortalBeaconApiHandlers*(rpcServer: RpcServer, p: PortalProtocol) =
     let
       keyBytes = ContentKeyByteList.init(hexToSeqByte(contentKey))
       contentId = p.toContentId(keyBytes).valueOr:
-        raise invalidKeyErr()
+        raise invalidContentKeyError()
 
     # TODO: Might want to restructure the lookup result here. Potentially doing
     # the json conversion in this module.
@@ -110,7 +110,7 @@ proc installPortalBeaconApiHandlers*(rpcServer: RpcServer, p: PortalProtocol) =
       keyBytes = ContentKeyByteList.init(hexToSeqByte(contentKey))
       offerValueBytes = hexToSeqByte(contentValue)
       contentId = p.toContentId(keyBytes).valueOr:
-        raise invalidKeyErr()
+        raise invalidContentKeyError()
 
     # TODO: Do we need to convert the received offer to a value without proofs before storing?
     p.storeContent(keyBytes, contentId, offerValueBytes)
@@ -119,7 +119,7 @@ proc installPortalBeaconApiHandlers*(rpcServer: RpcServer, p: PortalProtocol) =
     let
       keyBytes = ContentKeyByteList.init(hexToSeqByte(contentKey))
       contentId = p.toContentId(keyBytes).valueOr:
-        raise invalidKeyErr()
+        raise invalidContentKeyError()
 
       valueBytes = p.dbGet(keyBytes, contentId).valueOr:
         raise contentNotFoundErr()
@@ -132,7 +132,7 @@ proc installPortalBeaconApiHandlers*(rpcServer: RpcServer, p: PortalProtocol) =
     let
       keyBytes = ContentKeyByteList.init(hexToSeqByte(contentKey))
       _ = p.toContentId(keyBytes).valueOr:
-        raise invalidKeyErr()
+        raise invalidContentKeyError()
       offerValueBytes = hexToSeqByte(contentValue)
 
       # TODO: Do we need to convert the received offer to a value without proofs before storing?
diff --git a/portal/rpc/rpc_portal_history_api.nim b/portal/rpc/rpc_portal_history_api.nim
@@ -45,7 +45,7 @@ proc installPortalHistoryApiHandlers*(rpcServer: RpcServer, n: HistoryNetwork) =
     let
       contentKeyByteList = ContentKeyByteList.init(hexToSeqByte(contentKeyBytes))
       contentKey = decode(contentKeyByteList).valueOr:
-        raise invalidKeyErr()
+        raise invalidContentKeyError()
       contentId = toContentId(contentKey)
 
     n.portalProtocol.getLocalContent(contentKeyByteList, contentId).isErrOr:
@@ -66,7 +66,7 @@ proc installPortalHistoryApiHandlers*(rpcServer: RpcServer, n: HistoryNetwork) =
     let
       contentKeyByteList = ContentKeyByteList.init(hexToSeqByte(contentKeyBytes))
       contentKey = decode(contentKeyByteList).valueOr:
-        raise invalidKeyErr()
+        raise invalidContentKeyError()
       contentId = toContentId(contentKey)
 
     n.portalProtocol.getLocalContent(contentKeyByteList, contentId).isErrOr:
@@ -96,7 +96,7 @@ proc installPortalHistoryApiHandlers*(rpcServer: RpcServer, n: HistoryNetwork) =
     let
       contentKeyByteList = ContentKeyByteList.init(hexToSeqByte(contentKeyBytes))
       _ = decode(contentKeyByteList).valueOr:
-        raise invalidKeyErr()
+        raise invalidContentKeyError()
       offerValueBytes = hexToSeqByte(contentValueBytes)
 
       # Note: Not validating content as this would have a high impact on bridge
@@ -128,15 +128,15 @@ proc installPortalHistoryApiHandlers*(rpcServer: RpcServer, n: HistoryNetwork) =
       contentKeyByteList = ContentKeyByteList.init(hexToSeqByte(contentKeyBytes))
       offerValueBytes = hexToSeqByte(contentValueBytes)
       contentId = n.portalProtocol.toContentId(contentKeyByteList).valueOr:
-        raise invalidKeyErr()
+        raise invalidContentKeyError()
 
     n.portalProtocol.storeContent(contentKeyByteList, contentId, offerValueBytes)
 
   rpcServer.rpc("portal_historyLocalContent") do(contentKeyBytes: string) -> string:
     let
       contentKeyByteList = ContentKeyByteList.init(hexToSeqByte(contentKeyBytes))
       contentId = n.portalProtocol.toContentId(contentKeyByteList).valueOr:
-        raise invalidKeyErr()
+        raise invalidContentKeyError()
 
       valueBytes = n.portalProtocol.getLocalContent(contentKeyByteList, contentId).valueOr:
         raise contentNotFoundErr()
@@ -145,7 +145,7 @@ proc installPortalHistoryApiHandlers*(rpcServer: RpcServer, n: HistoryNetwork) =
 
   rpcServer.rpc("portal_historyGetBlockBody") do(headerBytes: string) -> string:
     let header = decodeRlp(hexToSeqByte(headerBytes), Header).valueOr:
-      raise invalidRequest((code: -39005, msg: "Failed to decode header: " & error))
+      raise applicationError((code: -39010, msg: "Failed to decode header: " & error))
 
     let blockBody = (await n.getBlockBody(header)).valueOr:
       raise contentNotFoundErr()
@@ -154,7 +154,7 @@ proc installPortalHistoryApiHandlers*(rpcServer: RpcServer, n: HistoryNetwork) =
 
   rpcServer.rpc("portal_historyGetReceipts") do(headerBytes: string) -> string:
     let header = decodeRlp(hexToSeqByte(headerBytes), Header).valueOr:
-      raise invalidRequest((code: -39005, msg: "Failed to decode header: " & error))
+      raise applicationError((code: -39010, msg: "Failed to decode header: " & error))
 
     let receipts = (await n.getReceipts(header)).valueOr:
       raise contentNotFoundErr()
diff --git a/portal/rpc/rpc_types.nim b/portal/rpc/rpc_types.nim
@@ -20,7 +20,8 @@ export jsonmarshal, routing_table, enr, node, results
 # Portal Network JSON-RPC errors
 
 const
-  # These errors are defined in the portal jsonrpc spec: https://github.com/ethereum/portal-network-specs/tree/master/jsonrpc
+  # These errors (code + msg) are defined in the Portal JSON-RPC spec:
+  # https://github.com/ethereum/portal-network-specs/tree/master/jsonrpc
   ContentNotFoundError* = (code: -39001, msg: "Content not found")
   ContentNotFoundErrorWithTrace* = (code: -39002, msg: "Content not found")
   PayloadTypeNotSupportedError* = (code: -39004, msg: "Payload type not supported")
@@ -32,11 +33,10 @@ const
     msg: "The client has blocked users from specifying the payload for this extension",
   )
 
-  # These errors are used by Nimbus Portal but are not yet in the spec
-  InvalidContentKeyError* = (code: -32602, msg: "Invalid content key")
-  InvalidContentValueError* = (code: -32603, msg: "Invalid content value")
+  # Errors used by Nimbus Portal but that are not part of current Portal JSON-RPC spec
+  InvalidContentKeyError* = (code: -39008, msg: "Invalid content key")
 
-template applicationError(error: (int, string)): auto =
+template applicationError*(error: (int, string)): auto =
   (ref ApplicationError)(code: error.code, msg: error.msg)
 
 template contentNotFoundErr*(): auto =
@@ -65,14 +65,8 @@ template payloadTypeRequiredError*(): auto =
 template userSpecifiedPayloadBlockedByClientError*(): auto =
   UserSpecifiedPayloadBlockedByClientError.applicationError()
 
-template invalidRequest*(error: (int, string)): auto =
-  (ref errors.InvalidRequest)(code: error.code, msg: error.msg)
-
-template invalidKeyErr*(): auto =
-  InvalidContentKeyError.invalidRequest()
-
-template invalidValueErr*(): auto =
-  InvalidContentValueError.invalidRequest()
+template invalidContentKeyError*(): auto =
+  InvalidContentKeyError.applicationError()
 
 type
   NodeInfo* = object
