fix(getBlobs): return null if node is syncing (#9394)

Signed-off-by: Gabriel-Trintinalia <[email protected]>

Author: Gabriel-Trintinalia

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/engine/EngineGetBlobsV1.java

@@ -36,6 +36,7 @@
 import org.hyperledger.besu.ethereum.mainnet.ValidationResult;
 
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
 import javax.annotation.Nullable;
@@ -90,12 +91,6 @@ public String getName() {
 
   @Override
   public JsonRpcResponse syncResponse(final JsonRpcRequestContext requestContext) {
-    long timestamp = protocolContext.getBlockchain().getChainHeadHeader().getTimestamp();
-    ValidationResult<RpcErrorType> forkValidationResult = validateForkSupported(timestamp);
-    if (!forkValidationResult.isValid()) {
-      return new JsonRpcErrorResponse(requestContext.getRequest().getId(), forkValidationResult);
-    }
-
     final VersionedHash[] versionedHashes;
     try {
       versionedHashes = requestContext.getRequiredParameter(0, VersionedHash[].class);
@@ -111,6 +106,15 @@ public JsonRpcResponse syncResponse(final JsonRpcRequestContext requestContext)
           requestContext.getRequest().getId(),
           RpcErrorType.INVALID_ENGINE_GET_BLOBS_TOO_LARGE_REQUEST);
     }
+    if (mergeContext.get().isSyncing()) {
+      final List<BlobAndProofV1> emptyResults = Collections.nCopies(versionedHashes.length, null);
+      return new JsonRpcSuccessResponse(requestContext.getRequest().getId(), emptyResults);
+    }
+    long timestamp = protocolContext.getBlockchain().getChainHeadHeader().getTimestamp();
+    ValidationResult<RpcErrorType> forkValidationResult = validateForkSupported(timestamp);
+    if (!forkValidationResult.isValid()) {
+      return new JsonRpcErrorResponse(requestContext.getRequest().getId(), forkValidationResult);
+    }
 
     final List<BlobAndProofV1> result = getBlobV1Result(versionedHashes);
 

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/engine/EngineGetBlobsV2.java

@@ -96,18 +96,20 @@ public String getName() {
 
   @Override
   public JsonRpcResponse syncResponse(final JsonRpcRequestContext requestContext) {
-    long timestamp = protocolContext.getBlockchain().getChainHeadHeader().getTimestamp();
-    ValidationResult<RpcErrorType> forkValidationResult = validateForkSupported(timestamp);
-    if (!forkValidationResult.isValid()) {
-      return new JsonRpcErrorResponse(requestContext.getRequest().getId(), forkValidationResult);
-    }
-
     final VersionedHash[] versionedHashes = extractVersionedHashes(requestContext);
     if (versionedHashes.length > REQUEST_MAX_VERSIONED_HASHES) {
       return new JsonRpcErrorResponse(
           requestContext.getRequest().getId(),
           RpcErrorType.INVALID_ENGINE_GET_BLOBS_TOO_LARGE_REQUEST);
     }
+    if (mergeContext.get().isSyncing()) {
+      return new JsonRpcSuccessResponse(requestContext.getRequest().getId(), null);
+    }
+    long timestamp = protocolContext.getBlockchain().getChainHeadHeader().getTimestamp();
+    ValidationResult<RpcErrorType> forkValidationResult = validateForkSupported(timestamp);
+    if (!forkValidationResult.isValid()) {
+      return new JsonRpcErrorResponse(requestContext.getRequest().getId(), forkValidationResult);
+    }
     requestedCounter.inc(versionedHashes.length);
     List<BlobProofBundle> validBundles = new ArrayList<>(versionedHashes.length);
     int missingBlobs = 0;

ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/engine/EngineGetBlobsV1Test.java

@@ -16,9 +16,11 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.engine.EngineTestSupport.fromErrorResp;
+import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.when;
 
+import org.hyperledger.besu.consensus.merge.MergeContext;
 import org.hyperledger.besu.crypto.KeyPair;
 import org.hyperledger.besu.crypto.SECPPrivateKey;
 import org.hyperledger.besu.crypto.SignatureAlgorithm;
@@ -85,13 +87,17 @@ public class EngineGetBlobsV1Test extends AbstractScheduledApiTest {
   @Mock private MutableBlockchain blockchain;
   @Mock private TransactionPool transactionPool;
   @Mock private BlockHeader blockHeader;
+  @Mock private MergeContext mergeContext;
 
   private EngineGetBlobsV1 method;
 
   private static final Vertx vertx = Vertx.vertx();
 
   @BeforeEach
   public void beforeEach() {
+    when(mergeContext.isSyncing()).thenReturn(false);
+    when(protocolContext.safeConsensusContext(any())).thenReturn(Optional.ofNullable(mergeContext));
+
     when(protocolContext.getBlockchain()).thenReturn(blockchain);
     when(blockHeader.getTimestamp()).thenReturn(cancunHardfork.milestone());
     when(blockchain.getChainHeadHeader()).thenReturn(blockHeader);
@@ -255,6 +261,16 @@ void shouldFailWhenOsakaActive() {
         .isEqualTo(RpcErrorType.UNSUPPORTED_FORK.getCode());
   }
 
+  @Test
+  public void shouldReturnNullWhenSyncing() {
+    when(mergeContext.isSyncing()).thenReturn(true);
+    var response = resp(new VersionedHash[] {VERSIONED_HASH_ZERO});
+    assertThat(response.getType()).isEqualTo(RpcResponseType.SUCCESS);
+    final List<BlobAndProofV1> blobAndProofV1s = fromSuccessResp(response);
+    assertThat(blobAndProofV1s).hasSize(1);
+    assertThat(blobAndProofV1s.getFirst()).isNull();
+  }
+
   Transaction createBlobTransaction() {
     BlobTestFixture blobTestFixture = new BlobTestFixture();
     BlobsWithCommitments bwc = blobTestFixture.createBlobsWithCommitments(6);

ethereum/api/src/test/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/engine/EngineGetBlobsV2Test.java

@@ -18,13 +18,15 @@
 import static org.hyperledger.besu.datatypes.BlobType.KZG_CELL_PROOFS;
 import static org.hyperledger.besu.datatypes.BlobType.KZG_PROOF;
 import static org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.engine.EngineTestSupport.fromErrorResp;
+import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.verifyNoInteractions;
 import static org.mockito.Mockito.when;
 
+import org.hyperledger.besu.consensus.merge.MergeContext;
 import org.hyperledger.besu.datatypes.Hash;
 import org.hyperledger.besu.datatypes.VersionedHash;
 import org.hyperledger.besu.ethereum.ProtocolContext;
@@ -49,6 +51,7 @@
 
 import java.util.Arrays;
 import java.util.List;
+import java.util.Optional;
 
 import io.vertx.core.Vertx;
 import org.junit.jupiter.api.BeforeEach;
@@ -73,11 +76,14 @@ public class EngineGetBlobsV2Test extends AbstractScheduledApiTest {
   @Mock Counter hitCounter;
   @Mock Counter missCounter;
   @Mock ObservableMetricsSystem metricsSystem;
+  @Mock MergeContext mergeContext;
 
   @BeforeEach
   public void setup() {
     transactionPool = mock(TransactionPool.class);
     ProtocolContext protocolContext = mock(ProtocolContext.class);
+    when(mergeContext.isSyncing()).thenReturn(false);
+    when(protocolContext.safeConsensusContext(any())).thenReturn(Optional.ofNullable(mergeContext));
     when(protocolContext.getBlockchain()).thenReturn(blockchain);
     when(blockHeader.getTimestamp()).thenReturn(osakaHardfork.milestone());
     when(blockchain.getChainHeadHeader()).thenReturn(blockHeader);
@@ -210,6 +216,19 @@ void shouldSucceedWhenOsakaActive() {
     assertThat(response.getType()).isEqualTo(RpcResponseType.SUCCESS);
   }
 
+  @Test
+  public void shouldReturnNullWhenSyncing() {
+    when(mergeContext.isSyncing()).thenReturn(true);
+    BlobProofBundle bundle = createBundleAndRegisterToPool();
+    JsonRpcSuccessResponse response =
+        getSuccessResponse(buildRequestContext(bundle.getVersionedHash()));
+    assertThat(response.getResult()).isNull();
+    verifyNoInteractions(requestedCounter);
+    verifyNoInteractions(availableCounter);
+    verifyNoInteractions(missCounter);
+    verifyNoInteractions(hitCounter);
+  }
+
   private BlobProofBundle createBundleAndRegisterToPool() {
     BlobTestFixture blobFixture = new BlobTestFixture();
     BlobProofBundle bundle = blobFixture.createBlobProofBundle(KZG_CELL_PROOFS);