normalize DataStorageConfiguration plugin and storage interfaces

Signed-off-by: garyschulte <garyschulte@gmail.com>
hyperledger · Oct 24, 2024 · 757b592 · 757b592
1 parent 5e01e01
commit 757b592
Show file tree

Hide file tree

Showing 12 changed files with 20 additions and 15 deletions.
diff --git a/besu/src/main/java/org/hyperledger/besu/services/BesuConfigurationImpl.java b/besu/src/main/java/org/hyperledger/besu/services/BesuConfigurationImpl.java
@@ -133,7 +133,7 @@ public DataStoreConfigurationImpl(final DataStorageConfiguration dataStorageConf
     }
 
     @Override
-    public DataStorageFormat getDatabaseFormat() {
+    public DataStorageFormat getDataStorageFormat() {
       return dataStorageConfiguration.getDataStorageFormat();
     }
 

diff --git a/...core/src/main/java/org/hyperledger/besu/ethereum/worldstate/DataStorageConfiguration.java b/...core/src/main/java/org/hyperledger/besu/ethereum/worldstate/DataStorageConfiguration.java
@@ -14,13 +14,15 @@
  */
 package org.hyperledger.besu.ethereum.worldstate;
 
+import org.hyperledger.besu.plugin.Unstable;
 import org.hyperledger.besu.plugin.services.storage.DataStorageFormat;
 
 import org.immutables.value.Value;
 
 @Value.Immutable
 @Value.Enclosing
-public interface DataStorageConfiguration {
+public interface DataStorageConfiguration
+    extends org.hyperledger.besu.plugin.services.storage.DataStorageConfiguration {
 
   long DEFAULT_BONSAI_MAX_LAYERS_TO_LOAD = 512;
   boolean DEFAULT_BONSAI_LIMIT_TRIE_LOGS_ENABLED = true;
@@ -56,15 +58,13 @@ public interface DataStorageConfiguration {
           .unstable(Unstable.DEFAULT)
           .build();
 
-  DataStorageFormat getDataStorageFormat();
-
   Long getBonsaiMaxLayersToLoad();
 
   @Value.Default
+  @Override
   default boolean getHashPreImageStorageEnabled() {
     return DEFAULT_HASH_PREIMAGE_STORAGE_ENABLED;
   }
-  ;
 
   @Value.Default
   default boolean getBonsaiLimitTrieLogsEnabled() {
@@ -77,6 +77,7 @@ default int getBonsaiTrieLogPruningWindowSize() {
   }
 
   @Value.Default
+  @Override
   default boolean getReceiptCompactionEnabled() {
     return DEFAULT_RECEIPT_COMPACTION_ENABLED;
   }

diff --git a/...test/java/org/hyperledger/besu/ethereum/trie/diffbased/bonsai/AbstractIsolationTests.java b/...test/java/org/hyperledger/besu/ethereum/trie/diffbased/bonsai/AbstractIsolationTests.java
@@ -237,7 +237,7 @@ public Wei getMinGasPrice() {
                   getDataStorageConfiguration() {
                 return new org.hyperledger.besu.plugin.services.storage.DataStorageConfiguration() {
                   @Override
-                  public DataStorageFormat getDatabaseFormat() {
+                  public DataStorageFormat getDataStorageFormat() {
                     return DataStorageFormat.BONSAI;
                   }
 

diff --git a/evm/src/main/java/org/hyperledger/besu/evm/worldstate/AbstractWorldUpdater.java b/evm/src/main/java/org/hyperledger/besu/evm/worldstate/AbstractWorldUpdater.java
@@ -40,7 +40,9 @@
 public abstract class AbstractWorldUpdater<W extends WorldView, A extends Account>
     implements WorldUpdater {
 
+  /** The worldview associated with this updater. */
   protected final W world;
+
   private final EvmConfiguration evmConfiguration;
 
   /** The Updated accounts. */

diff --git a/plugin-api/build.gradle b/plugin-api/build.gradle
@@ -71,7 +71,7 @@ Calculated : ${currentHash}
 tasks.register('checkAPIChanges', FileStateChecker) {
   description = "Checks that the API for the Plugin-API project does not change without deliberate thought"
   files = sourceSets.main.allJava.files
-  knownHash = '1RyHu/1awWJrbvx2sEeXdGO1tGq1RuAfsZmONrD2K7M='
+  knownHash = 'qXX4LwLi4ibYNDrXEUEFfNWCvUpcibJyeBBeltWo99k='
 }
 check.dependsOn('checkAPIChanges')
 

diff --git a/.../src/main/java/org/hyperledger/besu/plugin/services/storage/DataStorageConfiguration.java b/.../src/main/java/org/hyperledger/besu/plugin/services/storage/DataStorageConfiguration.java
@@ -26,7 +26,7 @@ public interface DataStorageConfiguration {
    * @return Database format.
    */
   @Unstable
-  DataStorageFormat getDatabaseFormat();
+  DataStorageFormat getDataStorageFormat();
 
   /**
    * Whether receipt compaction is enabled. When enabled this reduces the storage needed for
@@ -40,6 +40,8 @@ public interface DataStorageConfiguration {
   /**
    * Indicates whether to persist hash preimages to storage. When enabled this option will persist
    * Account and Hash preimages to storage upon their writing.
+   *
+   * @return whether preimage persistent storage is enabled
    */
   @Unstable
   boolean getHashPreImageStorageEnabled();

diff --git a/...a/org/hyperledger/besu/plugin/services/storage/rocksdb/RocksDBKeyValueStorageFactory.java b/...a/org/hyperledger/besu/plugin/services/storage/rocksdb/RocksDBKeyValueStorageFactory.java
@@ -222,7 +222,7 @@ private DatabaseMetadata readDatabaseMetadata(final BesuConfiguration commonConf
       if (!metadata
           .getVersionedStorageFormat()
           .getFormat()
-          .equals(commonConfiguration.getDataStorageConfiguration().getDatabaseFormat())) {
+          .equals(commonConfiguration.getDataStorageConfiguration().getDataStorageFormat())) {
         handleFormatMismatch(commonConfiguration, dataDir, metadata);
       }
 
@@ -278,7 +278,7 @@ private static void handleFormatMismatch(
                 + "Please check your config.",
             dataDir,
             existingMetadata.getVersionedStorageFormat().getFormat().name(),
-            commonConfiguration.getDataStorageConfiguration().getDatabaseFormat());
+            commonConfiguration.getDataStorageConfiguration().getDataStorageFormat());
 
     throw new StorageException(error);
   }

diff --git a/...ledger/besu/plugin/services/storage/rocksdb/configuration/BaseVersionedStorageFormat.java b/...ledger/besu/plugin/services/storage/rocksdb/configuration/BaseVersionedStorageFormat.java
@@ -62,7 +62,7 @@ public enum BaseVersionedStorageFormat implements VersionedStorageFormat {
    */
   public static BaseVersionedStorageFormat defaultForNewDB(
       final DataStorageConfiguration configuration) {
-    return switch (configuration.getDatabaseFormat()) {
+    return switch (configuration.getDataStorageFormat()) {
       case FOREST -> FOREST_WITH_RECEIPT_COMPACTION;
       case BONSAI -> BONSAI_WITH_RECEIPT_COMPACTION;
     };

diff --git a/...ger/besu/plugin/services/storage/rocksdb/configuration/PrivacyVersionedStorageFormat.java b/...ger/besu/plugin/services/storage/rocksdb/configuration/PrivacyVersionedStorageFormat.java
@@ -63,7 +63,7 @@ public enum PrivacyVersionedStorageFormat implements VersionedStorageFormat {
    */
   public static VersionedStorageFormat defaultForNewDB(
       final DataStorageConfiguration configuration) {
-    return switch (configuration.getDatabaseFormat()) {
+    return switch (configuration.getDataStorageFormat()) {
       case FOREST -> FOREST_WITH_RECEIPT_COMPACTION;
       case BONSAI -> BONSAI_WITH_RECEIPT_COMPACTION;
     };

diff --git a/...java/org/hyperledger/besu/plugin/services/storage/rocksdb/NearestKeyValueStorageTest.java b/...java/org/hyperledger/besu/plugin/services/storage/rocksdb/NearestKeyValueStorageTest.java
@@ -310,7 +310,7 @@ private static void mockCommonConfiguration(final Path tempDataDir) {
     when(commonConfiguration.getStoragePath()).thenReturn(tempDataDir);
     when(commonConfiguration.getDataPath()).thenReturn(tempDataDir);
     DataStorageConfiguration dataStorageConfiguration = mock(DataStorageConfiguration.class);
-    when(dataStorageConfiguration.getDatabaseFormat()).thenReturn(DataStorageFormat.BONSAI);
+    when(dataStorageConfiguration.getDataStorageFormat()).thenReturn(DataStorageFormat.BONSAI);
     lenient()
         .when(commonConfiguration.getDataStorageConfiguration())
         .thenReturn(dataStorageConfiguration);

diff --git a/...ledger/besu/plugin/services/storage/rocksdb/RocksDBKeyValuePrivacyStorageFactoryTest.java b/...ledger/besu/plugin/services/storage/rocksdb/RocksDBKeyValuePrivacyStorageFactoryTest.java
@@ -185,7 +185,7 @@ private void mockCommonConfiguration(
       final DataStorageFormat dataStorageFormat) {
     when(commonConfiguration.getStoragePath()).thenReturn(tempDatabaseDir);
     when(commonConfiguration.getDataPath()).thenReturn(tempDataDir);
-    when(dataStorageConfiguration.getDatabaseFormat()).thenReturn(dataStorageFormat);
+    when(dataStorageConfiguration.getDataStorageFormat()).thenReturn(dataStorageFormat);
     lenient()
         .when(commonConfiguration.getDataStorageConfiguration())
         .thenReturn(dataStorageConfiguration);

diff --git a/...g/hyperledger/besu/plugin/services/storage/rocksdb/RocksDBKeyValueStorageFactoryTest.java b/...g/hyperledger/besu/plugin/services/storage/rocksdb/RocksDBKeyValueStorageFactoryTest.java
@@ -306,7 +306,7 @@ private void mockCommonConfiguration(
       final Path tempDataDir, final Path tempDatabaseDir, final DataStorageFormat format) {
     when(commonConfiguration.getStoragePath()).thenReturn(tempDatabaseDir);
     when(commonConfiguration.getDataPath()).thenReturn(tempDataDir);
-    lenient().when(dataStorageConfiguration.getDatabaseFormat()).thenReturn(format);
+    lenient().when(dataStorageConfiguration.getDataStorageFormat()).thenReturn(format);
     lenient()
         .when(commonConfiguration.getDataStorageConfiguration())
         .thenReturn(dataStorageConfiguration);