Evm move (#2790)

Move EVM to a standalone module

Move the EVM classes to a standalone module. This is mostly moves but
some API re-resign to peel out some features not essential to the EVM,
such as privacy support and ties to the data storage subsystem.

Signed-off-by: Danno Ferrin <danno.ferrin@gmail.com>

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 21.10.0-RC1
 ### Additions and Improvements
+* The EVM has been factored out into a standalone module, suitable for inclusion as a library. [#2790](https://github.com/hyperledger/besu/pull/2790)
 
 ### Bug Fixes
 

acceptance-tests/dsl/build.gradle

@@ -13,6 +13,7 @@ dependencies {
   implementation project(path: ':ethereum:core', configuration: 'testSupportArtifacts')
   implementation project(':ethereum:eth')
   implementation project(':ethereum:p2p')
+  implementation project(':evm')
   implementation project(':datatypes')
   implementation project(':ethereum:permissioning')
   implementation project(':ethereum:rlp')

acceptance-tests/dsl/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/BlockUtils.java

@@ -21,7 +21,7 @@
 import org.hyperledger.besu.ethereum.core.BlockHeader;
 import org.hyperledger.besu.ethereum.core.BlockHeaderFunctions;
 import org.hyperledger.besu.ethereum.core.Difficulty;
-import org.hyperledger.besu.ethereum.core.LogsBloomFilter;
+import org.hyperledger.besu.evm.log.LogsBloomFilter;
 
 import org.apache.tuweni.bytes.Bytes;
 import org.web3j.protocol.core.methods.response.EthBlock.Block;

acceptance-tests/dsl/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/privacy/transaction/GetAllPrivateMarkerTransactionHashes.java

@@ -14,7 +14,8 @@
  */
 package org.hyperledger.besu.tests.acceptance.dsl.privacy.transaction;
 
-import org.hyperledger.besu.datatypes.Address;
+import static org.hyperledger.besu.ethereum.core.PrivacyParameters.DEFAULT_PRIVACY;
+
 import org.hyperledger.besu.tests.acceptance.dsl.transaction.NodeRequests;
 import org.hyperledger.besu.tests.acceptance.dsl.transaction.Transaction;
 
@@ -41,9 +42,7 @@ public List<String> execute(final NodeRequests node) {
             .getTransactions()
             .forEach(
                 t -> {
-                  if (((EthBlock.TransactionObject) t)
-                      .getTo()
-                      .equals(Address.DEFAULT_PRIVACY.toString())) {
+                  if (((EthBlock.TransactionObject) t).getTo().equals(DEFAULT_PRIVACY.toString())) {
                     toReturn.add(((EthBlock.TransactionObject) t).getHash());
                   }
                 });

acceptance-tests/dsl/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/transaction/privacy/PrivacyRequestFactory.java

@@ -17,6 +17,7 @@
 import static com.google.common.base.Preconditions.checkArgument;
 import static java.util.Collections.singletonList;
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.hyperledger.besu.ethereum.core.PrivacyParameters.ONCHAIN_PRIVACY_PROXY;
 
 import org.hyperledger.besu.crypto.SecureRandomProvider;
 import org.hyperledger.besu.datatypes.Address;
@@ -184,7 +185,7 @@ public String privxAddToPrivacyGroup(
             nonce,
             BigInteger.valueOf(1000),
             BigInteger.valueOf(3000000),
-            Address.ONCHAIN_PRIVACY_PROXY.toHexString(),
+            ONCHAIN_PRIVACY_PROXY.toHexString(),
             payload.toHexString(),
             Base64String.wrap(adder.getEnclaveKey()),
             privacyGroupId,
@@ -217,7 +218,7 @@ public String privxRemoveFromPrivacyGroup(
             nonce,
             BigInteger.valueOf(1000),
             BigInteger.valueOf(3000000),
-            Address.ONCHAIN_PRIVACY_PROXY.toHexString(),
+            ONCHAIN_PRIVACY_PROXY.toHexString(),
             payload.toHexString(),
             Base64String.wrap(removerTenant),
             privacyGroupId,
@@ -271,7 +272,7 @@ private String privxLockOrUnlockPrivacyGroup(
             nonce,
             BigInteger.valueOf(1000),
             BigInteger.valueOf(3000000),
-            Address.ONCHAIN_PRIVACY_PROXY.toHexString(),
+            ONCHAIN_PRIVACY_PROXY.toHexString(),
             callData,
             Base64String.wrap(locker.getEnclaveKey()),
             privacyGroupId,
@@ -311,7 +312,7 @@ public PrivxCreatePrivacyGroupResponse privxCreatePrivacyGroup(
             BigInteger.ZERO,
             BigInteger.valueOf(1000),
             BigInteger.valueOf(3000000),
-            Address.ONCHAIN_PRIVACY_PROXY.toHexString(),
+            ONCHAIN_PRIVACY_PROXY.toHexString(),
             payload.toHexString(),
             Base64String.wrap(privateFrom),
             Base64String.wrap(privacyGroupId.toArrayUnsafe()),

acceptance-tests/tests/src/test/java/org/hyperledger/besu/tests/acceptance/privacy/multitenancy/MultiTenancyAcceptanceTest.java

@@ -21,7 +21,7 @@
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static java.util.Collections.emptyList;
 import static java.util.Collections.singletonList;
-import static org.hyperledger.besu.datatypes.Address.DEFAULT_PRIVACY;
+import static org.hyperledger.besu.ethereum.core.PrivacyParameters.DEFAULT_PRIVACY;
 
 import org.hyperledger.besu.crypto.KeyPair;
 import org.hyperledger.besu.crypto.SignatureAlgorithm;

acceptance-tests/tests/src/test/java/org/hyperledger/besu/tests/web3j/privacy/OnChainPrivacyAcceptanceTest.java

@@ -16,9 +16,9 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.hyperledger.besu.ethereum.core.PrivacyParameters.ONCHAIN_PRIVACY_PROXY;
 import static org.junit.runners.Parameterized.Parameters;
 
-import org.hyperledger.besu.datatypes.Address;
 import org.hyperledger.besu.tests.acceptance.dsl.condition.eth.EthConditions;
 import org.hyperledger.besu.tests.acceptance.dsl.privacy.PrivacyNode;
 import org.hyperledger.besu.tests.acceptance.dsl.transaction.miner.MinerTransactions;
@@ -412,7 +412,7 @@ public void bobCanAddCharlieAfterBeingAddedByAlice() {
         new PrivateTransactionReceipt(
             null,
             alice.getAddress().toHexString(),
-            Address.ONCHAIN_PRIVACY_PROXY.toHexString(),
+            ONCHAIN_PRIVACY_PROXY.toHexString(),
             "0x",
             Collections.emptyList(),
             null,

acceptance-tests/tests/src/test/java/org/hyperledger/besu/tests/web3j/privacy/OnChainPrivacyAcceptanceTestBase.java

@@ -15,9 +15,9 @@
 package org.hyperledger.besu.tests.web3j.privacy;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.hyperledger.besu.ethereum.core.PrivacyParameters.ONCHAIN_PRIVACY_PROXY;
 import static org.hyperledger.besu.ethereum.privacy.group.OnChainGroupManagement.GET_PARTICIPANTS_METHOD_SIGNATURE;
 
-import org.hyperledger.besu.datatypes.Address;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.Quantity;
 import org.hyperledger.besu.tests.acceptance.dsl.privacy.PrivacyAcceptanceTestBase;
 import org.hyperledger.besu.tests.acceptance.dsl.privacy.PrivacyNode;
@@ -95,7 +95,7 @@ protected String callGetParticipantsMethodAndReturnCommitmentHash(
       final String privacyGroupId, final PrivacyNode groupCreator, final String privateFrom) {
     return groupCreator.execute(
         privateContractTransactions.callOnChainPermissioningSmartContract(
-            Address.ONCHAIN_PRIVACY_PROXY.toHexString(),
+            ONCHAIN_PRIVACY_PROXY.toHexString(),
             GET_PARTICIPANTS_METHOD_SIGNATURE.toString(),
             groupCreator.getTransactionSigningKey(),
             privateFrom,
@@ -128,7 +128,7 @@ protected PrivateTransactionReceipt buildExpectedAddMemberTransactionReceipt(
     return new PrivateTransactionReceipt(
         null,
         groupCreator.getAddress().toHexString(),
-        Address.ONCHAIN_PRIVACY_PROXY.toHexString(),
+        ONCHAIN_PRIVACY_PROXY.toHexString(),
         output.toString(),
         Collections.emptyList(),
         null,

acceptance-tests/tests/src/test/java/org/hyperledger/besu/tests/web3j/privacy/PrivacyClusterAcceptanceTest.java

@@ -15,9 +15,9 @@
 package org.hyperledger.besu.tests.web3j.privacy;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.hyperledger.besu.ethereum.core.PrivacyParameters.DEFAULT_PRIVACY;
 import static org.web3j.utils.Restriction.RESTRICTED;
 
-import org.hyperledger.besu.datatypes.Address;
 import org.hyperledger.besu.enclave.Enclave;
 import org.hyperledger.besu.enclave.EnclaveFactory;
 import org.hyperledger.besu.enclave.types.ReceiveResponse;
@@ -205,7 +205,7 @@ public void aliceCanUsePrivDistributeTransaction() {
             BigInteger.ZERO,
             BigInteger.valueOf(1000),
             BigInteger.valueOf(65000),
-            Address.DEFAULT_PRIVACY.toString(),
+            DEFAULT_PRIVACY.toString(),
             transactionKey);
 
     final String signedPmt =

besu/build.gradle

@@ -49,6 +49,7 @@ dependencies {
   implementation project(':ethereum:trie')
   implementation project(':ethereum:stratum')
   implementation project(':ethereum:ethstats')
+  implementation project(':evm')
   implementation project(':metrics:core')
   implementation project(':nat')
   implementation project(':plugin-api')

besu/src/main/java/org/hyperledger/besu/RunnerBuilder.java

@@ -19,11 +19,11 @@
 import static java.util.function.Predicate.isEqual;
 import static java.util.function.Predicate.not;
 import static org.hyperledger.besu.controller.BesuController.CACHE_PATH;
+import static org.hyperledger.besu.ethereum.core.PrivacyParameters.ONCHAIN_PRIVACY;
 
 import org.hyperledger.besu.cli.config.EthNetworkConfig;
 import org.hyperledger.besu.controller.BesuController;
 import org.hyperledger.besu.crypto.NodeKey;
-import org.hyperledger.besu.datatypes.Address;
 import org.hyperledger.besu.ethereum.ProtocolContext;
 import org.hyperledger.besu.ethereum.api.ApiConfiguration;
 import org.hyperledger.besu.ethereum.api.graphql.GraphQLConfiguration;
@@ -915,7 +915,7 @@ private void createPrivateTransactionObserver(
                   .getProtocolSchedule()
                   .getByBlockNumber(1)
                   .getPrecompileContractRegistry()
-                  .get(Address.ONCHAIN_PRIVACY);
+                  .get(ONCHAIN_PRIVACY);
       onchainPrivacyPrecompiledContract.addPrivateTransactionObserver(privateTransactionObserver);
     }
   }

besu/src/main/java/org/hyperledger/besu/chainimport/JsonBlockImporter.java

@@ -26,8 +26,8 @@
 import org.hyperledger.besu.ethereum.core.BlockHeader;
 import org.hyperledger.besu.ethereum.core.BlockImporter;
 import org.hyperledger.besu.ethereum.core.Transaction;
-import org.hyperledger.besu.ethereum.core.WorldState;
 import org.hyperledger.besu.ethereum.mainnet.HeaderValidationMode;
+import org.hyperledger.besu.evm.worldstate.WorldState;
 
 import java.io.IOException;
 import java.util.ArrayList;

besu/src/main/java/org/hyperledger/besu/chainimport/internal/BlockData.java

@@ -17,9 +17,9 @@
 import org.hyperledger.besu.chainimport.internal.TransactionData.NonceProvider;
 import org.hyperledger.besu.datatypes.Address;
 import org.hyperledger.besu.datatypes.Hash;
-import org.hyperledger.besu.ethereum.core.Account;
 import org.hyperledger.besu.ethereum.core.Transaction;
-import org.hyperledger.besu.ethereum.core.WorldState;
+import org.hyperledger.besu.evm.account.Account;
+import org.hyperledger.besu.evm.worldstate.WorldState;
 
 import java.util.HashMap;
 import java.util.List;

besu/src/main/java/org/hyperledger/besu/cli/BesuCommand.java

@@ -113,7 +113,6 @@
 import org.hyperledger.besu.ethereum.eth.sync.SynchronizerConfiguration;
 import org.hyperledger.besu.ethereum.eth.transactions.TransactionPoolConfiguration;
 import org.hyperledger.besu.ethereum.mainnet.FrontierTargetingGasLimitCalculator;
-import org.hyperledger.besu.ethereum.mainnet.precompiles.AbstractAltBnPrecompiledContract;
 import org.hyperledger.besu.ethereum.p2p.config.DiscoveryConfiguration;
 import org.hyperledger.besu.ethereum.p2p.peers.EnodeDnsConfiguration;
 import org.hyperledger.besu.ethereum.p2p.peers.EnodeURLImpl;
@@ -134,6 +133,7 @@
 import org.hyperledger.besu.ethereum.worldstate.WorldStateArchive;
 import org.hyperledger.besu.ethereum.worldstate.WorldStatePreimageStorage;
 import org.hyperledger.besu.ethereum.worldstate.WorldStateStorage;
+import org.hyperledger.besu.evm.precompile.AbstractAltBnPrecompiledContract;
 import org.hyperledger.besu.metrics.BesuMetricCategory;
 import org.hyperledger.besu.metrics.MetricCategoryRegistryImpl;
 import org.hyperledger.besu.metrics.MetricsProtocol;

besu/src/main/java/org/hyperledger/besu/services/BesuEventsImpl.java

@@ -20,12 +20,12 @@
 import org.hyperledger.besu.ethereum.chain.Blockchain;
 import org.hyperledger.besu.ethereum.core.BlockBody;
 import org.hyperledger.besu.ethereum.core.Difficulty;
-import org.hyperledger.besu.ethereum.core.LogTopic;
 import org.hyperledger.besu.ethereum.core.LogWithMetadata;
 import org.hyperledger.besu.ethereum.core.TransactionReceipt;
 import org.hyperledger.besu.ethereum.eth.sync.BlockBroadcaster;
 import org.hyperledger.besu.ethereum.eth.sync.state.SyncState;
 import org.hyperledger.besu.ethereum.eth.transactions.TransactionPool;
+import org.hyperledger.besu.evm.log.LogTopic;
 import org.hyperledger.besu.plugin.data.AddedBlockContext;
 import org.hyperledger.besu.plugin.data.Address;
 import org.hyperledger.besu.plugin.data.BlockHeader;

besu/src/test/java/org/hyperledger/besu/PrivacyReorgTest.java

@@ -15,6 +15,7 @@
 package org.hyperledger.besu;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.hyperledger.besu.ethereum.core.PrivacyParameters.DEFAULT_PRIVACY;
 import static org.hyperledger.besu.ethereum.privacy.PrivateStateRootResolver.EMPTY_ROOT_HASH;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.mock;
@@ -26,7 +27,6 @@
 import org.hyperledger.besu.crypto.NodeKeyUtils;
 import org.hyperledger.besu.crypto.SignatureAlgorithm;
 import org.hyperledger.besu.crypto.SignatureAlgorithmFactory;
-import org.hyperledger.besu.datatypes.Address;
 import org.hyperledger.besu.datatypes.Hash;
 import org.hyperledger.besu.datatypes.Wei;
 import org.hyperledger.besu.enclave.Enclave;
@@ -41,7 +41,6 @@
 import org.hyperledger.besu.ethereum.core.Difficulty;
 import org.hyperledger.besu.ethereum.core.InMemoryKeyValueStorageProvider;
 import org.hyperledger.besu.ethereum.core.InMemoryPrivacyStorageProvider;
-import org.hyperledger.besu.ethereum.core.LogsBloomFilter;
 import org.hyperledger.besu.ethereum.core.MiningParameters;
 import org.hyperledger.besu.ethereum.core.PrivacyParameters;
 import org.hyperledger.besu.ethereum.core.Transaction;
@@ -56,6 +55,7 @@
 import org.hyperledger.besu.ethereum.privacy.storage.PrivacyStorageProvider;
 import org.hyperledger.besu.ethereum.privacy.storage.PrivateStateStorage;
 import org.hyperledger.besu.ethereum.rlp.BytesValueRLPOutput;
+import org.hyperledger.besu.evm.log.LogsBloomFilter;
 import org.hyperledger.besu.metrics.noop.NoOpMetricsSystem;
 import org.hyperledger.besu.plugin.data.Restriction;
 import org.hyperledger.besu.plugin.data.TransactionType;
@@ -461,7 +461,7 @@ private Transaction buildMarkerTransaction(final Bytes payload) {
         .gasPrice(Wei.of(1000))
         .nonce(0)
         .payload(payload)
-        .to(Address.DEFAULT_PRIVACY)
+        .to(DEFAULT_PRIVACY)
         .value(Wei.ZERO)
         .signAndBuild(KEY_PAIR);
   }

besu/src/test/java/org/hyperledger/besu/PrivacyTest.java

@@ -15,6 +15,8 @@
 package org.hyperledger.besu;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.hyperledger.besu.ethereum.core.PrivacyParameters.DEFAULT_PRIVACY;
+import static org.hyperledger.besu.ethereum.core.PrivacyParameters.ONCHAIN_PRIVACY;
 
 import org.hyperledger.besu.config.GenesisConfigFile;
 import org.hyperledger.besu.controller.BesuController;
@@ -28,10 +30,10 @@
 import org.hyperledger.besu.ethereum.eth.EthProtocolConfiguration;
 import org.hyperledger.besu.ethereum.eth.sync.SynchronizerConfiguration;
 import org.hyperledger.besu.ethereum.eth.transactions.TransactionPoolConfiguration;
-import org.hyperledger.besu.ethereum.mainnet.PrecompiledContract;
 import org.hyperledger.besu.ethereum.privacy.storage.PrivacyStorageProvider;
 import org.hyperledger.besu.ethereum.privacy.storage.keyvalue.PrivacyKeyValueStorageProviderBuilder;
 import org.hyperledger.besu.ethereum.storage.keyvalue.KeyValueSegmentIdentifier;
+import org.hyperledger.besu.evm.precompile.PrecompiledContract;
 import org.hyperledger.besu.metrics.noop.NoOpMetricsSystem;
 import org.hyperledger.besu.plugin.services.storage.rocksdb.RocksDBKeyValuePrivacyStorageFactory;
 import org.hyperledger.besu.plugin.services.storage.rocksdb.RocksDBKeyValueStorageFactory;
@@ -72,8 +74,7 @@ public void cleanUp() {
   public void defaultPrivacy() throws IOException, URISyntaxException {
     final BesuController besuController = setUpControllerWithPrivacyEnabled(false);
 
-    final PrecompiledContract precompiledContract =
-        getPrecompile(besuController, Address.DEFAULT_PRIVACY);
+    final PrecompiledContract precompiledContract = getPrecompile(besuController, DEFAULT_PRIVACY);
 
     assertThat(precompiledContract.getName()).isEqualTo("Privacy");
   }
@@ -83,7 +84,7 @@ public void onchainEnabledPrivacy() throws IOException, URISyntaxException {
     final BesuController besuController = setUpControllerWithPrivacyEnabled(true);
 
     final PrecompiledContract onchainPrecompiledContract =
-        getPrecompile(besuController, Address.ONCHAIN_PRIVACY);
+        getPrecompile(besuController, ONCHAIN_PRIVACY);
 
     assertThat(onchainPrecompiledContract.getName()).isEqualTo("OnChainPrivacy");
   }

besu/src/test/java/org/hyperledger/besu/cli/BesuCommandTest.java

@@ -64,13 +64,13 @@
 import org.hyperledger.besu.ethereum.core.PrivacyParameters;
 import org.hyperledger.besu.ethereum.eth.sync.SyncMode;
 import org.hyperledger.besu.ethereum.eth.sync.SynchronizerConfiguration;
-import org.hyperledger.besu.ethereum.mainnet.precompiles.AbstractAltBnPrecompiledContract;
 import org.hyperledger.besu.ethereum.p2p.peers.EnodeURLImpl;
 import org.hyperledger.besu.ethereum.permissioning.LocalPermissioningConfiguration;
 import org.hyperledger.besu.ethereum.permissioning.PermissioningConfiguration;
 import org.hyperledger.besu.ethereum.permissioning.SmartContractPermissioningConfiguration;
 import org.hyperledger.besu.ethereum.worldstate.DataStorageConfiguration;
 import org.hyperledger.besu.ethereum.worldstate.PrunerConfiguration;
+import org.hyperledger.besu.evm.precompile.AbstractAltBnPrecompiledContract;
 import org.hyperledger.besu.metrics.StandardMetricCategory;
 import org.hyperledger.besu.metrics.prometheus.MetricsConfiguration;
 import org.hyperledger.besu.nat.NatMethod;

consensus/clique/build.gradle

@@ -40,6 +40,7 @@ dependencies {
   implementation project(':ethereum:eth')
   implementation project(':ethereum:p2p')
   implementation project(':ethereum:rlp')
+  implementation project(':evm')
   implementation project(':services:kvstore')
   implementation project(':util')
 

consensus/clique/src/test/java/org/hyperledger/besu/consensus/clique/CliqueBlockHashingTest.java

@@ -21,7 +21,7 @@
 import org.hyperledger.besu.ethereum.core.BlockHeader;
 import org.hyperledger.besu.ethereum.core.BlockHeaderBuilder;
 import org.hyperledger.besu.ethereum.core.Difficulty;
-import org.hyperledger.besu.ethereum.core.LogsBloomFilter;
+import org.hyperledger.besu.evm.log.LogsBloomFilter;
 
 import java.util.Arrays;
 import java.util.List;

consensus/common/build.gradle

@@ -39,6 +39,7 @@ dependencies {
   implementation project(':ethereum:eth')
   implementation project(':ethereum:p2p')
   implementation project(':ethereum:rlp')
+  implementation project(':evm')
   implementation project(':util')
 
   implementation 'com.fasterxml.jackson.core:jackson-databind'

consensus/ibft/build.gradle

@@ -38,6 +38,7 @@ dependencies {
   implementation project(':ethereum:eth')
   implementation project(':ethereum:p2p')
   implementation project(':ethereum:rlp')
+  implementation project(':evm')
   implementation project(':services:kvstore')
 
   implementation 'com.google.guava:guava'

consensus/ibft/src/test/java/org/hyperledger/besu/consensus/ibft/BftBlockHashingTest.java

@@ -31,9 +31,9 @@
 import org.hyperledger.besu.ethereum.core.BlockHeader;
 import org.hyperledger.besu.ethereum.core.BlockHeaderBuilder;
 import org.hyperledger.besu.ethereum.core.Difficulty;
-import org.hyperledger.besu.ethereum.core.LogsBloomFilter;
 import org.hyperledger.besu.ethereum.core.Util;
 import org.hyperledger.besu.ethereum.rlp.BytesValueRLPOutput;
+import org.hyperledger.besu.evm.log.LogsBloomFilter;
 
 import java.util.Arrays;
 import java.util.List;

consensus/ibftlegacy/build.gradle

@@ -24,6 +24,7 @@ dependencies {
   implementation project(':ethereum:eth')
   implementation project(':ethereum:p2p')
   implementation project(':ethereum:rlp')
+  implementation project(':evm')
   implementation project(':metrics:core')
   implementation project(':services:kvstore')