init payloadV5 (#201)

* init payloadV5

* fix other v5 stuff

Author: agnxsh

tests/test_json_marshalling.nim

@@ -209,6 +209,7 @@ suite "JSON-RPC Quantity":
     checkRandomObject(ExecutionPayloadV1OrV2)
     checkRandomObject(ExecutionPayloadV3)
     checkRandomObject(BlobsBundleV1)
+    checkRandomObject(BlobsBundleV2)
     checkRandomObject(BlobAndProofV1)
     checkRandomObject(BlobAndProofV2)
     checkRandomObject(ExecutionPayloadBodyV1)

web3/conversions.nim

@@ -59,6 +59,7 @@ ExecutionPayloadV2.useDefaultSerializationIn JrpcConv
 ExecutionPayloadV1OrV2.useDefaultSerializationIn JrpcConv
 ExecutionPayloadV3.useDefaultSerializationIn JrpcConv
 BlobsBundleV1.useDefaultSerializationIn JrpcConv
+BlobsBundleV2.useDefaultSerializationIn JrpcConv
 BlobAndProofV1.useDefaultSerializationIn JrpcConv
 BlobAndProofV2.useDefaultSerializationIn JrpcConv
 ExecutionPayloadBodyV1.useDefaultSerializationIn JrpcConv
@@ -73,6 +74,7 @@ GetPayloadV2Response.useDefaultSerializationIn JrpcConv
 GetPayloadV2ResponseExact.useDefaultSerializationIn JrpcConv
 GetPayloadV3Response.useDefaultSerializationIn JrpcConv
 GetPayloadV4Response.useDefaultSerializationIn JrpcConv
+GetPayloadV5Response.useDefaultSerializationIn JrpcConv
 ClientVersionV1.useDefaultSerializationIn JrpcConv
 
 #------------------------------------------------------------------------------

web3/engine_api.nim

@@ -36,6 +36,7 @@ createRpcSigsFromNim(RpcClient):
   proc engine_getPayloadV2_exact(payloadId: Bytes8): GetPayloadV2ResponseExact
   proc engine_getPayloadV3(payloadId: Bytes8): GetPayloadV3Response
   proc engine_getPayloadV4(payloadId: Bytes8): GetPayloadV4Response
+  proc engine_getPayloadV5(payloadId: Bytes8): GetPayloadV5Response
   proc engine_getPayloadBodiesByHashV1(hashes: seq[Hash32]): seq[Opt[ExecutionPayloadBodyV1]]
   proc engine_getPayloadBodiesByRangeV1(start: Quantity, count: Quantity): seq[Opt[ExecutionPayloadBodyV1]]
   proc engine_getBlobsV1(blob_versioned_hashes: seq[VersionedHash]): GetBlobsV1Response
@@ -109,6 +110,12 @@ template getPayload*(
     payloadId: Bytes8): Future[GetPayloadV4Response] =
   engine_getPayloadV4(rpcClient, payloadId)
 
+template getPayload*(
+    rpcClient: RpcClient,
+    T: type GetPayloadV5Response,
+    payloadId: Bytes8): Future[GetPayloadV5Response] =
+  engine_getPayloadV5(rpcClient, payloadId)
+
 template getBlobs*(
     rpcClient: RpcClient,
     T: type GetBlobsV1Response,

web3/engine_api_types.nim

@@ -127,6 +127,11 @@ type
     proofs*: seq[KzgProof]
     blobs*: seq[Blob]
 
+  BlobsBundleV2* = object
+    commitments*: seq[KzgCommitment]
+    proofs*: seq[KzgProof]
+    blobs*: seq[Blob]
+
   # https://github.com/ethereum/execution-apis/blob/40088597b8b4f48c45184da002e27ffc3c37641f/src/engine/cancun.md#blobandproofv1
   BlobAndProofV1* = object
     blob*: Blob
@@ -226,6 +231,13 @@ type
     shouldOverrideBuilder*: bool
     executionRequests*: seq[seq[byte]]
 
+  GetPayloadV5Response* = object
+    executionPayload*: ExecutionPayloadV3
+    blockValue*: UInt256
+    blobsBundle*: BlobsBundleV2
+    shouldOverrideBuilder*: bool
+    executionRequests*: seq[seq[byte]]
+
   GetBlobsV1Response* = seq[BlobAndProofV1]
 
   GetBlobsV2Response* = seq[BlobAndProofV2]

web3/execution_types.nim

@@ -53,6 +53,7 @@ type
     executionPayload*: ExecutionPayload
     blockValue*: Opt[UInt256]
     blobsBundle*: Opt[BlobsBundleV1]
+    blobsBundleV2*: Opt[BlobsBundleV2]
     shouldOverrideBuilder*: Opt[bool]
     executionRequests*: Opt[seq[seq[byte]]]
 
@@ -61,6 +62,7 @@ type
     V2
     V3
     V4
+    V5
 
 func version*(payload: ExecutionPayload): Version =
   if payload.blobGasUsed.isSome or payload.excessBlobGas.isSome:
@@ -79,7 +81,10 @@ func version*(attr: PayloadAttributes): Version =
     Version.V1
 
 func version*(res: GetPayloadResponse): Version =
-  if res.executionRequests.isSome:
+  if res.blobsBundleV2.isSome and
+      res.blobsBundleV2.get.proofs.len == (CELLS_PER_EXT_BLOB * res.blobsBundleV2.get.blobs.len):
+     Version.V5
+  elif res.executionRequests.isSome:
     Version.V4
   elif res.blobsBundle.isSome or res.shouldOverrideBuilder.isSome:
     Version.V3
@@ -388,6 +393,15 @@ func V4*(res: GetPayloadResponse): GetPayloadV4Response =
     executionRequests: res.executionRequests.get,
   )
 
+func V5*(res: GetPayloadResponse): GetPayloadV5Response =
+  GetPayloadV5Response(
+    executionPayload: res.executionPayload.V3,
+    blockValue: res.blockValue.get,
+    blobsBundle: res.blobsBundleV2.get(BlobsBundleV2()),
+    shouldOverrideBuilder: res.shouldOverrideBuilder.get(false),
+    executionRequests: res.executionRequests.get,
+  )
+
 func getPayloadResponse*(x: ExecutionPayloadV1): GetPayloadResponse =
   GetPayloadResponse(executionPayload: x.executionPayload)
 
@@ -402,6 +416,7 @@ func getPayloadResponse*(x: GetPayloadV3Response): GetPayloadResponse =
     executionPayload: x.executionPayload.executionPayload,
     blockValue: Opt.some(x.blockValue),
     blobsBundle: Opt.some(x.blobsBundle),
+    blobsBundleV2: Opt.none(BlobsBundleV2),
     shouldOverrideBuilder: Opt.some(x.shouldOverrideBuilder)
   )
 
@@ -413,3 +428,13 @@ func getPayloadResponse*(x: GetPayloadV4Response): GetPayloadResponse =
     shouldOverrideBuilder: Opt.some(x.shouldOverrideBuilder),
     executionRequests: Opt.some(x.executionRequests),
   )
+
+func getPayloadResponse*(x: GetPayloadV5Response): GetPayloadResponse =
+  GetPayloadResponse(
+    executionPayload: x.executionPayload.executionPayload,
+    blockValue: Opt.some(x.blockValue),
+    blobsBundle: Opt.none(BlobsBundleV1),
+    blobsBundleV2: Opt.some(x.blobsBundle),
+    shouldOverrideBuilder: Opt.some(x.shouldOverrideBuilder),
+    executionRequests: Opt.some(x.executionRequests),
+  )