Replace WithdrawalObject with Withdrawal and some cleanup (#180)

Author: git-ravenbin

tests/test_json_marshalling.nim

@@ -33,17 +33,17 @@ proc rand(_: type Address): Address =
 proc rand(_: type uint64): uint64 =
   var res: array[8, byte]
   discard randomBytes(res)
-  result = uint64.fromBytesBE(res)
+  uint64.fromBytesBE(res)
 
 proc rand[T: Quantity](_: type T): T =
   var res: array[8, byte]
   discard randomBytes(res)
-  result = T(uint64.fromBytesBE(res))
+  T(uint64.fromBytesBE(res))
 
 proc rand[T: ChainId](_: type T): T =
   var res: array[8, byte]
   discard randomBytes(res)
-  result = T(uint64.fromBytesBE(res))
+  T(uint64.fromBytesBE(res))
 
 proc rand(_: type RlpEncodedBytes): RlpEncodedBytes =
   discard randomBytes(distinctBase result)
@@ -52,22 +52,22 @@ proc rand(_: type TypedTransaction): TypedTransaction =
   discard randomBytes(distinctBase result)
 
 proc rand(_: type string): string =
-  result = "random bytes"
+  "random bytes"
 
 proc rand(_: type bool): bool =
   var x: array[1, byte]
   discard randomBytes(x)
-  result = x[0].int mod 2 == 0
+  x[0].int mod 2 == 0
 
 proc rand(_: type byte): byte =
   var x: array[1, byte]
   discard randomBytes(x)
-  result = x[0]
+  x[0]
 
 proc rand(_: type UInt256): UInt256 =
   var x: array[32, byte]
   discard randomBytes(x)
-  result = UInt256.fromBytesBE(x)
+  UInt256.fromBytesBE(x)
 
 proc rand(_: type RtBlockIdentifier): RtBlockIdentifier =
   RtBlockIdentifier(kind: bidNumber, number: rand(Quantity))
@@ -103,9 +103,9 @@ proc rand[X](T: type Opt[X]): T =
   var x: array[1, byte]
   discard randomBytes(x)
   if x[0] > 127:
-    result = Opt.some(rand(X))
+    Opt.some(rand(X))
   else:
-    result = Opt.none(X)
+    Opt.none(X)
 
 proc rand[X: object](T: type X): T =
   result = T()
@@ -184,7 +184,7 @@ suite "JSON-RPC Quantity":
 
   test "Random object encoding":
     checkRandomObject(SyncObject)
-    checkRandomObject(WithdrawalObject)
+    checkRandomObject(Withdrawal)
     checkRandomObject(AccessPair)
     checkRandomObject(AccessListResult)
     checkRandomObject(LogObject)
@@ -259,7 +259,7 @@ suite "JSON-RPC Quantity":
     checkType(Quantity)
 
   test "AccessListResult":
-    var z: AccessListResult
+    let z = AccessListResult()
     let w = JrpcConv.encode(z)
     check w == """{"accessList":[],"gasUsed":"0x0"}"""
 
@@ -271,6 +271,8 @@ suite "JSON-RPC Quantity":
     check w == """{"accessList":[],"error":"error","gasUsed":"0x0"}"""
 
   test "Authorization":
-    var z: Authorization
+    let z = Authorization()
     let w = JrpcConv.encode(z)
     check w == """{"chainId":"0x0","address":"0x0000000000000000000000000000000000000000","nonce":"0x0","v":"0x0","r":"0x0","s":"0x0"}"""
+    let x = JrpcConv.decode(w, Authorization)
+    check x == z

tests/test_signed_tx.nim

@@ -52,7 +52,7 @@ suite "Signed transactions":
     tx.nonce = Opt.some(Quantity(9))
     tx.`from` = Opt.some(Address(address))
     tx.value = Opt.some(1000000000000000000.u256)
-    tx.to = Opt.some(Address(hexToByteArray[20]("0x3535353535353535353535353535353535353535")))
+    tx.to = Opt.some(address"0x3535353535353535353535353535353535353535")
     tx.gas = Opt.some(Quantity(21000'u64))
     tx.gasPrice = Opt.some(Quantity(20000000000'i64))
 
@@ -69,12 +69,12 @@ suite "Signed transactions":
     tx.nonce = Opt.some(Quantity(9))
     tx.`from` = Opt.some(Address(address))
     tx.value = Opt.some(1000000000000000000.u256)
-    tx.to = Opt.some(Address(hexToByteArray[20]("0x3535353535353535353535353535353535353535")))
+    tx.to = Opt.some(address"0x3535353535353535353535353535353535353535")
     tx.gas = Opt.some(Quantity(21000'u64))
     tx.gasPrice = Opt.some(Quantity(20000000000'i64))
     tx.chainId = Opt.some(Quantity(1))
 
-    let txBytes = encodeTransaction(tx, privateKey, TxLegacy)
+    let txBytes = encodeTransaction(tx, privateKey)
     let txHex = "0x" & txBytes.toHex
     check txHex == "0xf86c098504a817c800825208943535353535353535353535353535353535353535880de0b6b3a76400008025a028ef61340bd939bc2195fe537567866003e1a15d3c71ff63e1590620aa636276a067cbe9d8997f761aecb703304b3800ccf555c9f3dc64214b297fb1966a3b6d83"
 
@@ -88,14 +88,14 @@ suite "Signed transactions":
     tx.nonce = Opt.some(Quantity(648))
     tx.`from` = Opt.some(Address(address))
     tx.value = Opt.some(51284.u256)
-    tx.to = Opt.some(Address(hexToByteArray[20]("0x6Eb893e3466931517a04a17D153a6330c3f2f1dD")))
+    tx.to = Opt.some(address"0x6Eb893e3466931517a04a17D153a6330c3f2f1dD")
     tx.gas = Opt.some(Quantity(157'u64))
     tx.gasPrice = Opt.some(Quantity(9086'u64))
     tx.chainId = Opt.some(Quantity(2214903583))
     tx.data = Opt.some(hexToSeqByte("0x889e365e59664fb881554ba1175519b5195b1d20390beb806d8f2cda7893e6f79848195dba4c905db6d7257ffb5eefea35f18ae33c"))
     tx.accessList = Opt.some(newSeq[AccessPair]())
 
-    let txBytes = encodeTransaction(tx, privateKey, TxEip2930)
+    let txBytes = encodeTransaction(tx, privateKey)
     let txHex = "0x" & txBytes.toHex
     check txHex == "0x01f89f848404bf1f82028882237e819d946eb893e3466931517a04a17d153a6330c3f2f1dd82c854b5889e365e59664fb881554ba1175519b5195b1d20390beb806d8f2cda7893e6f79848195dba4c905db6d7257ffb5eefea35f18ae33cc080a0775f29642af1045b40e5beae8e6bce2dc9e222023b7a50372be6824dbb7434fba05dacfff85752a0b9fd860bc751c17235a670d318a8b9494d664c1b87e33ac8dd"
 
@@ -109,15 +109,15 @@ suite "Signed transactions":
     tx.nonce = Opt.some(Quantity(648))
     tx.`from` = Opt.some(Address(address))
     tx.value = Opt.some(51284.u256)
-    tx.to = Opt.some(Address(hexToByteArray[20]("0x6Eb893e3466931517a04a17D153a6330c3f2f1dD")))
+    tx.to = Opt.some(address"0x6Eb893e3466931517a04a17D153a6330c3f2f1dD")
     tx.gas = Opt.some(Quantity(157'u64))
     tx.maxFeePerGas = Opt.some(Quantity(879596102'u64))
     tx.maxPriorityFeePerGas = Opt.some(Quantity(2915939'u64))
     tx.chainId = Opt.some(Quantity(2214903583))
     tx.data = Opt.some(hexToSeqByte("0x889e365e59664fb881554ba1175519b5195b1d20390beb806d8f2cda7893e6f79848195dba4c905db6d7257ffb5eefea35f18ae33c"))
     tx.accessList = Opt.some(newSeq[AccessPair]())
 
-    let txBytes = encodeTransaction(tx, privateKey, TxEip1559)
+    let txBytes = encodeTransaction(tx, privateKey)
     let txHex = "0x" & txBytes.toHex
     check txHex == "0x02f8a5848404bf1f820288832c7e6384346d9246819d946eb893e3466931517a04a17d153a6330c3f2f1dd82c854b5889e365e59664fb881554ba1175519b5195b1d20390beb806d8f2cda7893e6f79848195dba4c905db6d7257ffb5eefea35f18ae33cc080a0f1003f96c6c6620dd46db36d2ae9f12d363947eb0db088c678b6ad1cf494aa6fa06085b5abbf448de5d622dc820da590cfdb6bb77b41c6650962b998a941f8d701"
 

web3/conversions.nim

@@ -33,7 +33,7 @@ export eth_types_json_serialization except Topic
 #------------------------------------------------------------------------------
 
 SyncObject.useDefaultSerializationIn JrpcConv
-WithdrawalObject.useDefaultSerializationIn JrpcConv
+Withdrawal.useDefaultSerializationIn JrpcConv
 AccessPair.useDefaultSerializationIn JrpcConv
 AccessListResult.useDefaultSerializationIn JrpcConv
 LogObject.useDefaultSerializationIn JrpcConv
@@ -264,7 +264,7 @@ proc readValue*[F: CommonJsonFlavors](r: var JsonReader[F], val: var uint64)
        {.gcsafe, raises: [IOError, JsonReaderError].} =
   let hexStr = r.parseString()
   if hexStr.invalidQuantityPrefix:
-    r.raiseUnexpectedValue("Quantity value has invalid leading 0")
+    r.raiseUnexpectedValue("Uint64 value has invalid leading 0")
   wrapValueError:
     val = fromHex[uint64](hexStr)
 

web3/eth_api_types.nim

@@ -13,12 +13,14 @@ import
   stint,
   ./primitives
 
+from eth/common/blocks import Withdrawal
 from eth/common/transactions import AccessPair, Authorization
 
 export
   primitives,
   AccessPair,
-  Authorization
+  Authorization,
+  Withdrawal
 
 type
   SyncObject* = object
@@ -94,12 +96,6 @@ type
     parentBeaconBlockRoot*: Opt[Hash32]  # EIP-4788
     requestsHash*: Opt[Hash32]           # EIP-7685
 
-  WithdrawalObject* = object
-    index*: Quantity
-    validatorIndex*: Quantity
-    address*: Address
-    amount*: Quantity
-
   ## A block object, or null when no block was found
   BlockObject* = ref object
     number*: Quantity                        # the block number. null when its pending block.
@@ -123,7 +119,7 @@ type
     transactions*: seq[TxOrHash]             # list of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter.
     uncles*: seq[Hash32]                     # list of uncle hashes.
     baseFeePerGas*: Opt[UInt256]             # EIP-1559
-    withdrawals*: Opt[seq[WithdrawalObject]] # EIP-4895
+    withdrawals*: Opt[seq[Withdrawal]] # EIP-4895
     withdrawalsRoot*: Opt[Hash32]            # EIP-4895
     blobGasUsed*: Opt[Quantity]              # EIP-4844
     excessBlobGas*: Opt[Quantity]            # EIP-4844

web3/primitives.nim

@@ -54,7 +54,6 @@ template ethQuantity(typ: type) {.dirty.} =
   func `==`*(a, b: typ): bool {.borrow.}
 
 ethQuantity Quantity
-ethQuantity ChainId
 
 template toHex*(x: DynamicBytes): string =
   toHex(distinctBase x)

web3/transaction_signing.nim

@@ -94,7 +94,7 @@ func encodeTransactionEip7702(s: TransactionArgs, pk: PrivateKey): seq[byte] =
   tr.authorizationList = s.authorizationList.get
   rlp.encode(tr)
 
-func encodeTransaction*(s: TransactionArgs, pk: PrivateKey, txType: TxType = TxLegacy): seq[byte] =
+func encodeTransaction*(s: TransactionArgs, pk: PrivateKey, txType: TxType): seq[byte] =
   case txType
   of TxLegacy:
     encodeTransactionLegacy(s, pk)
@@ -107,6 +107,20 @@ func encodeTransaction*(s: TransactionArgs, pk: PrivateKey, txType: TxType = TxL
   of TxEip7702:
     encodeTransactionEip7702(s, pk)
 
+func txType(s: TransactionArgs): TxType =
+  if s.authorizationList.isSome:
+    return TxEip7702
+  if s.blobVersionedHashes.isSome:
+    return TxEip4844
+  if s.gasPrice.isNone:
+    return TxEip1559
+  if s.accessList.isSome:
+    return TxEip2930
+  TxLegacy
+
+func encodeTransaction*(s: TransactionArgs, pk: PrivateKey): seq[byte] =
+  encodeTransaction(s, pk, s.txType)
+
 func encodeTransaction*(s: TransactionArgs, pk: PrivateKey, chainId: ChainId): seq[byte] {.deprecated: "Provide chainId in TransactionArgs".} =
   var tr = Transaction(txType: TxLegacy, chainId: chainId)
   tr.gasLimit = s.gas.get.GasInt