Proper setup of test_rpc (#2969)

Instead of using ancient/dirty code to setup the rpc test, now using newest method from TxPool and ForkedChain.
Also fix some bugs in server_api discovered when using this new setup.

Author: jangko

nimbus/core/chain/forked_chain.nim

@@ -682,11 +682,11 @@ func isInMemory*(c: ForkedChainRef, blockHash: Hash32): bool =
 func memoryBlock*(c: ForkedChainRef, blockHash: Hash32): BlockDesc =
   c.blocks.getOrDefault(blockHash)
 
-func memoryTransaction*(c: ForkedChainRef, txHash: Hash32): Opt[Transaction] =
+func memoryTransaction*(c: ForkedChainRef, txHash: Hash32): Opt[(Transaction, BlockNumber)] =
   let (blockHash, index) = c.txRecords.getOrDefault(txHash, (Hash32.default, 0'u64))
   c.blocks.withValue(blockHash, val) do:
-    return Opt.some(val.blk.transactions[index])
-  return Opt.none(Transaction)
+    return Opt.some( (val.blk.transactions[index], val.blk.header.number) )
+  return Opt.none((Transaction, BlockNumber))
 
 proc latestBlock*(c: ForkedChainRef): Block =
   c.blocks.withValue(c.cursorHash, val) do:
@@ -740,6 +740,9 @@ proc blockByNumber*(c: ForkedChainRef, number: BlockNumber): Result[Block, strin
   if number < c.baseHeader.number:
     return c.db.getEthBlock(number)
 
+  if number == c.baseHeader.number:
+    return c.db.getEthBlock(c.baseHash)
+
   shouldNotKeyError "blockByNumber":
     var prevHash = c.cursorHash
     while prevHash != c.baseHash:

nimbus/rpc/common.nim

@@ -45,7 +45,7 @@ proc setupCommonRpc*(node: EthereumNode, conf: NimbusConf, server: RpcServer) =
     let numPeers = node.numPeers
     result = numPeers < conf.maxPeers
 
-  server.rpc("net_peerCount") do() -> Web3Quantity:
+  server.rpc("net_peerCount") do() -> Quantity:
     let peerCount = uint node.numPeers
     result = w3Qty(peerCount)
 

nimbus/rpc/server_api.nim

@@ -50,7 +50,7 @@ proc getTotalDifficulty*(api: ServerAPIRef, blockHash: Hash32): UInt256 =
   return totalDifficulty
 
 proc getProof*(
-    accDB: LedgerRef, address: eth_types.Address, slots: seq[UInt256]
+    accDB: LedgerRef, address: Address, slots: seq[UInt256]
 ): ProofResponse =
   let
     acc = accDB.getEthAccount(address)
@@ -142,7 +142,7 @@ proc setupServerAPI*(api: ServerAPIRef, server: RpcServer, ctx: EthContext) =
 
   server.rpc("eth_getTransactionCount") do(
     data: Address, blockTag: BlockTag
-  ) -> Web3Quantity:
+  ) -> Quantity:
     ## Returns the number of transactions ak.s. nonce sent from an address.
     let
       ledger = api.ledgerFromTag(blockTag).valueOr:
@@ -151,11 +151,11 @@ proc setupServerAPI*(api: ServerAPIRef, server: RpcServer, ctx: EthContext) =
       nonce = ledger.getNonce(address)
     Quantity(nonce)
 
-  server.rpc("eth_blockNumber") do() -> Web3Quantity:
+  server.rpc("eth_blockNumber") do() -> Quantity:
     ## Returns integer of the current block number the client is on.
     Quantity(api.chain.latestNumber)
 
-  server.rpc("eth_chainId") do() -> Web3Quantity:
+  server.rpc("eth_chainId") do() -> Quantity:
     return Quantity(distinctBase(api.com.chainId))
 
   server.rpc("eth_getCode") do(data: Address, blockTag: BlockTag) -> seq[byte]:
@@ -376,7 +376,7 @@ proc setupServerAPI*(api: ServerAPIRef, server: RpcServer, ctx: EthContext) =
 
         idx.inc
 
-  server.rpc("eth_estimateGas") do(args: TransactionArgs) -> Web3Quantity:
+  server.rpc("eth_estimateGas") do(args: TransactionArgs) -> Quantity:
     ## Generates and returns an estimate of how much gas is necessary to allow the transaction to complete.
     ## The transaction will not be added to the blockchain. Note that the estimate may be significantly more than
     ## the amount of gas actually used by the transaction, for a variety of reasons including EVM mechanics and node performance.
@@ -392,64 +392,64 @@ proc setupServerAPI*(api: ServerAPIRef, server: RpcServer, ctx: EthContext) =
         raise newException(ValueError, "rpcEstimateGas error: " & $error.code)
     Quantity(gasUsed)
 
-  server.rpc("eth_gasPrice") do() -> Web3Quantity:
+  server.rpc("eth_gasPrice") do() -> Quantity:
     ## Returns an integer of the current gas price in wei.
     w3Qty(calculateMedianGasPrice(api.chain).uint64)
 
-  server.rpc("eth_accounts") do() -> seq[eth_types.Address]:
+  server.rpc("eth_accounts") do() -> seq[Address]:
     ## Returns a list of addresses owned by client.
-    result = newSeqOfCap[eth_types.Address](ctx.am.numAccounts)
+    result = newSeqOfCap[Address](ctx.am.numAccounts)
     for k in ctx.am.addresses:
       result.add k
 
-  server.rpc("eth_getBlockTransactionCountByHash") do(data: Hash32) -> Web3Quantity:
+  server.rpc("eth_getBlockTransactionCountByHash") do(data: Hash32) -> Quantity:
     ## Returns the number of transactions in a block from a block matching the given block hash.
     ##
     ## data: hash of a block
     ## Returns integer of the number of transactions in this block.
     let blk = api.chain.blockByHash(data).valueOr:
       raise newException(ValueError, "Block not found")
 
-    Web3Quantity(blk.transactions.len)
+    Quantity(blk.transactions.len)
 
   server.rpc("eth_getBlockTransactionCountByNumber") do(
     blockTag: BlockTag
-  ) -> Web3Quantity:
+  ) -> Quantity:
     ## Returns the number of transactions in a block from a block matching the given block number.
     ##
     ## blockTag: integer of a block number, or the string "latest", "earliest" or "pending", see the default block parameter.
     ## Returns integer of the number of transactions in this block.
     let blk = api.blockFromTag(blockTag).valueOr:
       raise newException(ValueError, "Block not found")
 
-    Web3Quantity(blk.transactions.len)
+    Quantity(blk.transactions.len)
 
-  server.rpc("eth_getUncleCountByBlockHash") do(data: Hash32) -> Web3Quantity:
+  server.rpc("eth_getUncleCountByBlockHash") do(data: Hash32) -> Quantity:
     ## Returns the number of uncles in a block from a block matching the given block hash.
     ##
     ## data: hash of a block.
     ## Returns integer of the number of uncles in this block.
     let blk = api.chain.blockByHash(data).valueOr:
       raise newException(ValueError, "Block not found")
 
-    Web3Quantity(blk.uncles.len)
+    Quantity(blk.uncles.len)
 
-  server.rpc("eth_getUncleCountByBlockNumber") do(blockTag: BlockTag) -> Web3Quantity:
+  server.rpc("eth_getUncleCountByBlockNumber") do(blockTag: BlockTag) -> Quantity:
     ## Returns the number of uncles in a block from a block matching the given block number.
     ##
     ## blockTag: integer of a block number, or the string "latest", see the default block parameter.
     ## Returns integer of the number of uncles in this block.
     let blk = api.blockFromTag(blockTag).valueOr:
       raise newException(ValueError, "Block not found")
 
-    Web3Quantity(blk.uncles.len)
+    Quantity(blk.uncles.len)
 
   template sign(privateKey: PrivateKey, message: string): seq[byte] =
     # message length encoded as ASCII representation of decimal
     let msgData = "\x19Ethereum Signed Message:\n" & $message.len & message
     @(sign(privateKey, msgData.toBytes()).toRaw())
 
-  server.rpc("eth_sign") do(data: eth_types.Address, message: seq[byte]) -> seq[byte]:
+  server.rpc("eth_sign") do(data: Address, message: seq[byte]) -> seq[byte]:
     ## The sign method calculates an Ethereum specific signature with: sign(keccak256("\x19Ethereum Signed Message:\n" + len(message) + message))).
     ## By adding a prefix to the message makes the calculated signature recognisable as an Ethereum specific signature.
     ## This prevents misuse where a malicious DApp can sign arbitrary data (e.g. transaction) and use the signature to impersonate the victim.
@@ -537,16 +537,15 @@ proc setupServerAPI*(api: ServerAPIRef, server: RpcServer, ctx: EthContext) =
     if res.isOk:
       return populateTransactionObject(res.get().tx, Opt.none(Hash32), Opt.none(uint64))
 
-    let txDetails = api.chain.db.getTransactionKey(txHash).valueOr:
-      return nil
-    if txDetails.index < 0:
+    block blockOne:
       let
         (blockHash, txid) = api.chain.txRecords(txHash)
-        tx = api.chain.memoryTransaction(txHash).valueOr:
-          return nil
-      return populateTransactionObject(tx, Opt.some(blockHash), Opt.some(txid))
-        # TODO: include block number
+        (tx, number) = api.chain.memoryTransaction(txHash).valueOr:
+                         break blockOne
+      return populateTransactionObject(tx, Opt.some(blockHash), Opt.some(number), Opt.some(txid))
 
+    let txDetails = api.chain.db.getTransactionKey(txHash).valueOr:
+      return nil
     let header = api.chain.db.getBlockHeader(txDetails.blockNumber).valueOr:
       return nil
     let tx = api.chain.db.getTransactionByIndex(header.txRoot, uint16(txDetails.index)).valueOr:
@@ -559,7 +558,7 @@ proc setupServerAPI*(api: ServerAPIRef, server: RpcServer, ctx: EthContext) =
     )
 
   server.rpc("eth_getTransactionByBlockHashAndIndex") do(
-    data: Hash32, quantity: Web3Quantity
+    data: Hash32, quantity: Quantity
   ) -> TransactionObject:
     ## Returns information about a transaction by block hash and transaction index position.
     ##
@@ -578,7 +577,7 @@ proc setupServerAPI*(api: ServerAPIRef, server: RpcServer, ctx: EthContext) =
     )
 
   server.rpc("eth_getTransactionByBlockNumberAndIndex") do(
-    quantityTag: BlockTag, quantity: Web3Quantity
+    quantityTag: BlockTag, quantity: Quantity
   ) -> TransactionObject:
     ## Returns information about a transaction by block number and transaction index position.
     ##
@@ -597,7 +596,7 @@ proc setupServerAPI*(api: ServerAPIRef, server: RpcServer, ctx: EthContext) =
     )
 
   server.rpc("eth_getProof") do(
-    data: eth_types.Address, slots: seq[UInt256], quantityTag: BlockTag
+    data: Address, slots: seq[UInt256], quantityTag: BlockTag
   ) -> ProofResponse:
     ## Returns information about an account and storage slots (if the account is a contract
     ## and the slots are requested) along with account and storage proofs which prove the
@@ -662,7 +661,7 @@ proc setupServerAPI*(api: ServerAPIRef, server: RpcServer, ctx: EthContext) =
     except CatchableError as exc:
       return AccessListResult(error: Opt.some("createAccessList error: " & exc.msg))
 
-  server.rpc("eth_blobBaseFee") do() -> Web3Quantity:
+  server.rpc("eth_blobBaseFee") do() -> Quantity:
     ## Returns the base fee per blob gas in wei.
     let header = api.headerFromTag(blockId("latest")).valueOr:
       raise newException(ValueError, "Block not found")
@@ -677,7 +676,7 @@ proc setupServerAPI*(api: ServerAPIRef, server: RpcServer, ctx: EthContext) =
     return w3Qty blobBaseFee.truncate(uint64)
 
   server.rpc("eth_getUncleByBlockHashAndIndex") do(
-    data: Hash32, quantity: Web3Quantity
+    data: Hash32, quantity: Quantity
   ) -> BlockObject:
     ## Returns information about a uncle of a block by hash and uncle index position.
     ##
@@ -701,7 +700,7 @@ proc setupServerAPI*(api: ServerAPIRef, server: RpcServer, ctx: EthContext) =
     )
 
   server.rpc("eth_getUncleByBlockNumberAndIndex") do(
-    quantityTag: BlockTag, quantity: Web3Quantity
+    quantityTag: BlockTag, quantity: Quantity
   ) -> BlockObject:
     # Returns information about a uncle of a block by number and uncle index position.
     ##