Improved handling of invalid responses; Handle seq[byte] results such as `eth_getCode`

json_rpc/client.nim

@@ -1,8 +1,12 @@
-import tables, json, macros
+import
-import chronos
+  tables, json, macros,
+  chronos,
+  jsonmarshal, errors
+
 from strutils import toLowerAscii
-import jsonmarshal
+
-export chronos
+export
+  chronos
 
 type
   ClientId* = int64
@@ -60,7 +64,8 @@ proc processMessage*(self: RpcClient, line: string) {.gcsafe.} =
   if "id" in node:
     let id = checkGet(node, "id", JInt)
 
-    if not self.awaiting.hasKey(id):
+    var requestFut: Future[Response]
+    if not self.awaiting.pop(id, requestFut):
       raise newException(ValueError,
         "Cannot find message id \"" & $node["id"].getInt & "\"")
 
@@ -73,12 +78,12 @@ proc processMessage*(self: RpcClient, line: string) {.gcsafe.} =
     if errorNode.isNil or errorNode.kind == JNull:
       var res = node{"result"}
       if not res.isNil:
-        self.awaiting[id].complete((false, res))
+        requestFut.complete((false, res))
-      self.awaiting.del(id)
-      # TODO: actions on unable find result node
       else:
-      self.awaiting[id].fail(newException(ValueError, $errorNode))
+        requestFut.fail(newException(InvalidResponse, "Missing `result` field"))
-      self.awaiting.del(id)
+    else:
+      requestFut.fail(newException(ValueError, $errorNode))
+
   elif "method" in node:
     # This could be subscription notification
     let name = node["method"].getStr()
@@ -175,9 +180,9 @@ proc createRpcFromSig*(clientType, rpcDecl: NimNode): NimNode =
     callBody.add(jsonToNim(procRes, returnType, jsonRpcResult, "result"))
   else:
     # native json expected so no work
-    callBody.add(quote do:
+    callBody.add quote do:
       `procRes` = `rpcResult`.result
-      )
+
   when defined(nimDumpRpcs):
     echo pathStr, ":\n", result.repr
 

json_rpc/errors.nim

@@ -0,0 +1,10 @@
+type
+  JsonRpcError* = object of CatchableError
+    ## Base type of all nim-json-rpc errors
+
+  ErrorResponse* = object of JsonRpcError
+    ## raised when the server responded with an error
+
+  InvalidResponse* = object of JsonRpcError
+    ## raised when the server response violates the JSON-RPC protocol
+

json_rpc/jsonmarshal.nim

@@ -1,4 +1,6 @@
-import macros, json, options, typetraits
+import
+  macros, json, options, typetraits,
+  stew/byteutils
 
 proc expect*(actual, expected: JsonNodeKind, argName: string) =
   if actual != expected: raise newException(ValueError, "Parameter [" & argName & "] expected " & $expected & " but got " & $actual)
@@ -111,6 +113,11 @@ proc fromJson*(n: JsonNode, argName: string, result: var string) =
   result = n.getStr()
 
 proc fromJson*[T](n: JsonNode, argName: string, result: var seq[T]) =
+  when T is byte:
+    if n.kind == JString:
+      result = hexToSeqByte n.getStr()
+      return
+
   n.kind.expect(JArray, argName)
   result = newSeq[T](n.len)
   for i in 0 ..< n.len: