beacon/engine,eth/catalyst: add Is(..) method to PayloadID to check v…

…ersion Co-authored-by: lightclient <[email protected]> Co-authored-by: Martin Holst Swende <[email protected]>
ethereum · Oct 16, 2023 · 05d844c · 05d844c
1 parent f84c3ad
commit 05d844c
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 4 deletions.
diff --git a/beacon/engine/types.go b/beacon/engine/types.go
@@ -125,10 +125,21 @@ type TransitionConfigurationV1 struct {
 // PayloadID is an identifier of the payload build process
 type PayloadID [8]byte
 
+// Version returns the payload version associated with the identifier.
 func (b PayloadID) Version() PayloadVersion {
 	return PayloadVersion(b[0])
 }
 
+// Is returns whether the identifier matches any of provided payload versions.
+func (b PayloadID) Is(versions ...PayloadVersion) bool {
+	for _, v := range versions {
+		if v == b.Version() {
+			return true
+		}
+	}
+	return false
+}
+
 func (b PayloadID) String() string {
 	return hexutil.Encode(b[:])
 }

diff --git a/eth/catalyst/api.go b/eth/catalyst/api.go
@@ -412,7 +412,7 @@ func (api *ConsensusAPI) ExchangeTransitionConfigurationV1(config engine.Transit
 
 // GetPayloadV1 returns a cached payload by id.
 func (api *ConsensusAPI) GetPayloadV1(payloadID engine.PayloadID) (*engine.ExecutableData, error) {
-	if payloadID.Version() != engine.PayloadV1 {
+	if !payloadID.Is(engine.PayloadV1) {
 		return nil, engine.UnsupportedFork
 	}
 	data, err := api.getPayload(payloadID, false)
@@ -424,16 +424,15 @@ func (api *ConsensusAPI) GetPayloadV1(payloadID engine.PayloadID) (*engine.Execu
 
 // GetPayloadV2 returns a cached payload by id.
 func (api *ConsensusAPI) GetPayloadV2(payloadID engine.PayloadID) (*engine.ExecutionPayloadEnvelope, error) {
-	version := payloadID.Version()
-	if version != engine.PayloadV1 && version != engine.PayloadV2 {
+	if !payloadID.Is(engine.PayloadV1, engine.PayloadV2) {
 		return nil, engine.UnsupportedFork
 	}
 	return api.getPayload(payloadID, false)
 }
 
 // GetPayloadV3 returns a cached payload by id.
 func (api *ConsensusAPI) GetPayloadV3(payloadID engine.PayloadID) (*engine.ExecutionPayloadEnvelope, error) {
-	if payloadID.Version() != engine.PayloadV3 {
+	if !payloadID.Is(engine.PayloadV3) {
 		return nil, engine.UnsupportedFork
 	}
 	return api.getPayload(payloadID, false)