Cleanup unnecessary logic around world state (#1591)

* #1408 - Code cleanup; update to use Immutables

Signed-off-by: David Mechler <david.mechler@consensys.net>

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

@@ -17,24 +17,24 @@ package org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods;
 
 import org.hyperledger.besu.ethereum.api.jsonrpc.RpcMethod;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequestContext;
-import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcError;
-import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcErrorResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcSuccessResponse;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.ImmutableMinerDataResult;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.ImmutableUncleRewardResult;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.MinerDataResult;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.MinerDataResult.UncleRewardResult;
 import org.hyperledger.besu.ethereum.api.query.BlockWithMetadata;
 import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
 import org.hyperledger.besu.ethereum.api.query.TransactionReceiptWithMetadata;
 import org.hyperledger.besu.ethereum.api.query.TransactionWithMetadata;
-import org.hyperledger.besu.ethereum.core.Address;
 import org.hyperledger.besu.ethereum.core.BlockHeader;
 import org.hyperledger.besu.ethereum.core.Hash;
 import org.hyperledger.besu.ethereum.core.Wei;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSpec;
 
-import java.util.HashMap;
+import java.util.ArrayList;
-import java.util.Map;
+import java.util.List;
 import java.util.Optional;
 import java.util.function.Supplier;
 
@@ -70,14 +70,6 @@ public class EthGetMinerDataByBlockHash implements JsonRpcMethod {
 
     MinerDataResult minerDataResult = null;
     if (block != null) {
-      if (!blockchain
-          .get()
-          .getWorldStateArchive()
-          .isWorldStateAvailable(block.getHeader().getStateRoot())) {
-        return new JsonRpcErrorResponse(
-            requestContext.getRequest().getId(), JsonRpcError.WORLD_STATE_UNAVAILABLE);
-      }
-
       minerDataResult = createMinerDataResult(block, protocolSchedule, blockchain.get());
     }
 
@@ -109,7 +101,7 @@ public class EthGetMinerDataByBlockHash implements JsonRpcMethod {
     final Wei uncleInclusionReward =
         staticBlockReward.multiply(block.getOmmers().size()).divide(32);
     final Wei netBlockReward = staticBlockReward.add(transactionFee).add(uncleInclusionReward);
-    final Map<Hash, Address> uncleRewards = new HashMap<>();
+    final List<UncleRewardResult> uncleRewards = new ArrayList<>();
     blockchainQueries
         .getBlockchain()
         .getBlockByNumber(block.getHeader().getNumber())
@@ -118,17 +110,24 @@ public class EthGetMinerDataByBlockHash implements JsonRpcMethod {
                 blockBody
                     .getBody()
                     .getOmmers()
-                    .forEach(header -> uncleRewards.put(header.getHash(), header.getCoinbase())));
+                    .forEach(
+                        header ->
+                            uncleRewards.add(
+                                ImmutableUncleRewardResult.builder()
+                                    .hash(header.getHash().toHexString())
+                                    .coinbase(header.getCoinbase().toHexString())
+                                    .build())));
 
-    return new MinerDataResult(
+    return ImmutableMinerDataResult.builder()
-        netBlockReward,
+        .netBlockReward(netBlockReward.toHexString())
-        staticBlockReward,
+        .staticBlockReward(staticBlockReward.toHexString())
-        transactionFee,
+        .transactionFee(transactionFee.toHexString())
-        uncleInclusionReward,
+        .uncleInclusionReward(uncleInclusionReward.toHexString())
-        uncleRewards,
+        .uncleRewards(uncleRewards)
-        blockHeader.getCoinbase(),
+        .coinbase(blockHeader.getCoinbase().toHexString())
-        blockHeader.getExtraData(),
+        .extraData(blockHeader.getExtraData().toHexString())
-        blockHeader.getDifficulty(),
+        .difficulty(blockHeader.getDifficulty().toHexString())
-        block.getTotalDifficulty());
+        .totalDifficulty(block.getTotalDifficulty().toHexString())
+        .build();
   }
 }

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

@@ -18,8 +18,6 @@ package org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods;
 import org.hyperledger.besu.ethereum.api.jsonrpc.RpcMethod;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequestContext;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.BlockParameter;
-import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcError;
-import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcErrorResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.MinerDataResult;
 import org.hyperledger.besu.ethereum.api.query.BlockWithMetadata;
 import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
@@ -54,13 +52,6 @@ public class EthGetMinerDataByBlockNumber extends AbstractBlockParameterMethod {
 
     MinerDataResult minerDataResult = null;
     if (block != null) {
-      if (!getBlockchainQueries()
-          .getWorldStateArchive()
-          .isWorldStateAvailable(block.getHeader().getStateRoot())) {
-        return new JsonRpcErrorResponse(
-            request.getRequest().getId(), JsonRpcError.WORLD_STATE_UNAVAILABLE);
-      }
-
       minerDataResult =
           EthGetMinerDataByBlockHash.createMinerDataResult(
               block, protocolSchedule, getBlockchainQueries());

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/results/MinerDataResult.java

@@ -14,106 +14,34 @@
  */
 package org.hyperledger.besu.ethereum.api.jsonrpc.internal.results;
 
-import org.hyperledger.besu.ethereum.core.Address;
-import org.hyperledger.besu.ethereum.core.Difficulty;
-import org.hyperledger.besu.ethereum.core.Hash;
-import org.hyperledger.besu.ethereum.core.Wei;
-
 import java.util.List;
-import java.util.Map;
-import java.util.stream.Collectors;
 
-import org.apache.tuweni.bytes.Bytes;
+import org.immutables.value.Value;
 
-public class MinerDataResult implements JsonRpcResult {
+@Value.Immutable
-  private final String netBlockReward;
+public abstract class MinerDataResult implements JsonRpcResult {
-  private final String staticBlockReward;
+  abstract String getNetBlockReward();
-  private final String transactionFee;
-  private final String uncleInclusionReward;
-  private final List<UncleRewardResult> uncleRewards;
-  private final String coinbase;
-  private final String extraData;
-  private final String difficulty;
-  private final String totalDifficulty;
 
-  public MinerDataResult(
+  abstract String getStaticBlockReward();
-      final Wei netBlockReward,
-      final Wei staticBlockReward,
-      final Wei transactionFee,
-      final Wei uncleInclusionReward,
-      final Map<Hash, Address> uncleRewards,
-      final Address coinbase,
-      final Bytes extraData,
-      final Difficulty difficulty,
-      final Difficulty totalDifficulty) {
-    this.netBlockReward = Quantity.create(netBlockReward);
-    this.staticBlockReward = Quantity.create(staticBlockReward);
-    this.transactionFee = Quantity.create(transactionFee);
-    this.uncleInclusionReward = Quantity.create(uncleInclusionReward);
-    this.uncleRewards = setUncleRewards(uncleRewards);
-    this.coinbase = coinbase.toString();
-    this.extraData = extraData.toString();
-    this.difficulty = Quantity.create(difficulty);
-    this.totalDifficulty = Quantity.create(totalDifficulty);
-  }
 
-  public String getNetBlockReward() {
+  abstract String getTransactionFee();
-    return netBlockReward;
-  }
 
-  public String getStaticBlockReward() {
+  abstract String getUncleInclusionReward();
-    return staticBlockReward;
-  }
 
-  public String getTransactionFee() {
+  abstract List<UncleRewardResult> getUncleRewards();
-    return transactionFee;
-  }
 
-  public String getUncleInclusionReward() {
+  abstract String getCoinbase();
-    return uncleInclusionReward;
-  }
-
-  public List<UncleRewardResult> getUncleRewards() {
-    return uncleRewards;
-  }
 
-  public String getCoinbase() {
+  abstract String getExtraData();
-    return coinbase;
-  }
-
-  public String getExtraData() {
-    return extraData;
-  }
-
-  public String getDifficulty() {
-    return difficulty;
-  }
-
-  public String getTotalDifficulty() {
-    return totalDifficulty;
-  }
-
-  private List<UncleRewardResult> setUncleRewards(final Map<Hash, Address> uncleRewards) {
-    return uncleRewards.entrySet().stream()
-        .map(b -> new UncleRewardResult(b.getKey().toString(), b.getValue().toString()))
-        .collect(Collectors.toList());
-  }
 
-  private static class UncleRewardResult {
+  abstract String getDifficulty();
-    private final String hash;
-    private final String coinbase;
 
-    private UncleRewardResult(final String hash, final String coinbase) {
+  abstract String getTotalDifficulty();
-      this.hash = hash;
-      this.coinbase = coinbase;
-    }
 
-    public String getHash() {
+  @Value.Immutable
-      return hash;
+  public interface UncleRewardResult {
-    }
+    String getHash();
 
-    public String getCoinbase() {
+    String getCoinbase();
-      return coinbase;
-    }
   }
 }

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

@@ -17,7 +17,6 @@ package org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
-import static org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcError.WORLD_STATE_UNAVAILABLE;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.verifyNoMoreInteractions;
 import static org.mockito.Mockito.when;
@@ -25,7 +24,6 @@ import static org.mockito.Mockito.when;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequest;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequestContext;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.exception.InvalidJsonRpcParameters;
-import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcErrorResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcSuccessResponse;
 import org.hyperledger.besu.ethereum.api.query.BlockWithMetadata;
@@ -39,7 +37,6 @@ import org.hyperledger.besu.ethereum.core.Hash;
 import org.hyperledger.besu.ethereum.core.Wei;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSpec;
-import org.hyperledger.besu.ethereum.worldstate.WorldStateArchive;
 
 import java.util.Collections;
 import java.util.Optional;
@@ -56,7 +53,6 @@ import org.mockito.junit.MockitoJUnitRunner;
 public class EthGetMinerDataByBlockHashTest {
   @Mock private BlockchainQueries blockchainQueries;
   @Mock private ProtocolSchedule protocolSchedule;
-  @Mock private WorldStateArchive worldStateArchive;
   @Mock private ProtocolSpec protocolSpec;
   @Mock private Blockchain blockChain;
   private EthGetMinerDataByBlockHash method;
@@ -82,8 +78,6 @@ public class EthGetMinerDataByBlockHashTest {
             header, Collections.emptyList(), Collections.emptyList(), Difficulty.of(100L), 5);
 
     when(blockchainQueries.blockByHash(any())).thenReturn(Optional.of(blockWithMetadata));
-    when(blockchainQueries.getWorldStateArchive()).thenReturn(worldStateArchive);
-    when(blockchainQueries.getWorldStateArchive().isWorldStateAvailable(any())).thenReturn(true);
     when(protocolSchedule.getByBlockNumber(header.getNumber())).thenReturn(protocolSpec);
     when(protocolSpec.getBlockReward()).thenReturn(Wei.fromEth(2));
     when(blockchainQueries.getBlockchain()).thenReturn(blockChain);
@@ -110,30 +104,6 @@ public class EthGetMinerDataByBlockHashTest {
         .hasFieldOrProperty("totalDifficulty");
   }
 
-  @Test
-  public void worldStateMissingTest() {
-    final BlockHeader header = blockHeaderTestFixture.buildHeader();
-    final BlockWithMetadata<TransactionWithMetadata, Hash> blockWithMetadata =
-        new BlockWithMetadata<>(
-            header, Collections.emptyList(), Collections.emptyList(), Difficulty.of(100L), 5);
-
-    when(blockchainQueries.blockByHash(any())).thenReturn(Optional.of(blockWithMetadata));
-    when(blockchainQueries.getWorldStateArchive()).thenReturn(worldStateArchive);
-    when(blockchainQueries.getWorldStateArchive().isWorldStateAvailable(any())).thenReturn(false);
-
-    JsonRpcRequest request =
-        new JsonRpcRequest(
-            "2.0",
-            ETH_METHOD,
-            Arrays.array("0x1349e5d4002e72615ae371dc173ba530bf98a7bef886d5b3b00ca5f217565039"));
-    JsonRpcRequestContext requestContext = new JsonRpcRequestContext(request);
-    JsonRpcResponse response = method.response(requestContext);
-
-    assertThat(response).isNotNull().isInstanceOf(JsonRpcErrorResponse.class);
-    assertThat(((JsonRpcErrorResponse) response).getError()).isNotNull();
-    assertThat(((JsonRpcErrorResponse) response).getError()).isEqualTo(WORLD_STATE_UNAVAILABLE);
-  }
-
   @Test
   public void exceptionWhenNoHashSuppliedTest() {
     JsonRpcRequest request = new JsonRpcRequest("2.0", ETH_METHOD, Arrays.array());

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

@@ -17,8 +17,6 @@ package org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
-import static org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcError.WORLD_STATE_UNAVAILABLE;
-import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyLong;
 import static org.mockito.Mockito.verifyNoMoreInteractions;
 import static org.mockito.Mockito.when;
@@ -26,7 +24,6 @@ import static org.mockito.Mockito.when;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequest;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequestContext;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.exception.InvalidJsonRpcParameters;
-import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcErrorResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcResponse;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcSuccessResponse;
 import org.hyperledger.besu.ethereum.api.query.BlockWithMetadata;
@@ -40,7 +37,6 @@ import org.hyperledger.besu.ethereum.core.Hash;
 import org.hyperledger.besu.ethereum.core.Wei;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
 import org.hyperledger.besu.ethereum.mainnet.ProtocolSpec;
-import org.hyperledger.besu.ethereum.worldstate.WorldStateArchive;
 
 import java.util.Collections;
 import java.util.Optional;
@@ -56,7 +52,6 @@ import org.mockito.junit.MockitoJUnitRunner;
 public class EthGetMinerDataByBlockNumberTest {
   @Mock private BlockchainQueries blockchainQueries;
   @Mock private ProtocolSchedule protocolSchedule;
-  @Mock private WorldStateArchive worldStateArchive;
   @Mock private ProtocolSpec protocolSpec;
   @Mock private Blockchain blockChain;
   private EthGetMinerDataByBlockNumber method;
@@ -81,8 +76,6 @@ public class EthGetMinerDataByBlockNumberTest {
             header, Collections.emptyList(), Collections.emptyList(), Difficulty.of(100L), 5);
 
     when(blockchainQueries.blockByNumber(anyLong())).thenReturn(Optional.of(blockWithMetadata));
-    when(blockchainQueries.getWorldStateArchive()).thenReturn(worldStateArchive);
-    when(blockchainQueries.getWorldStateArchive().isWorldStateAvailable(any())).thenReturn(true);
     when(protocolSchedule.getByBlockNumber(header.getNumber())).thenReturn(protocolSpec);
     when(protocolSpec.getBlockReward()).thenReturn(Wei.fromEth(2));
     when(blockchainQueries.getBlockchain()).thenReturn(blockChain);
@@ -105,26 +98,6 @@ public class EthGetMinerDataByBlockNumberTest {
         .hasFieldOrProperty("totalDifficulty");
   }
 
-  @Test
-  public void worldStateMissingTest() {
-    final BlockHeader header = blockHeaderTestFixture.buildHeader();
-    final BlockWithMetadata<TransactionWithMetadata, Hash> blockWithMetadata =
-        new BlockWithMetadata<>(
-            header, Collections.emptyList(), Collections.emptyList(), Difficulty.of(100L), 5);
-
-    when(blockchainQueries.blockByNumber(anyLong())).thenReturn(Optional.of(blockWithMetadata));
-    when(blockchainQueries.getWorldStateArchive()).thenReturn(worldStateArchive);
-    when(blockchainQueries.getWorldStateArchive().isWorldStateAvailable(any())).thenReturn(false);
-
-    JsonRpcRequest request = new JsonRpcRequest("2.0", ETH_METHOD, Arrays.array("5094833"));
-    JsonRpcRequestContext requestContext = new JsonRpcRequestContext(request);
-    JsonRpcResponse response = method.response(requestContext);
-
-    assertThat(response).isNotNull().isInstanceOf(JsonRpcErrorResponse.class);
-    assertThat(((JsonRpcErrorResponse) response).getError()).isNotNull();
-    assertThat(((JsonRpcErrorResponse) response).getError()).isEqualTo(WORLD_STATE_UNAVAILABLE);
-  }
-
   @Test
   public void exceptionWhenNoNumberSuppliedTest() {
     JsonRpcRequest request = new JsonRpcRequest("2.0", ETH_METHOD, Arrays.array());