Move web3j logic in executionclient module to a separate package (#5475)

Consensys · May 12, 2022 · 3a47c9f · 3a47c9f
1 parent 26c8a04
commit 3a47c9f
Show file tree

Hide file tree

Showing 21 changed files with 81 additions and 39 deletions.
diff --git a/.gitignore b/.gitignore
@@ -29,7 +29,6 @@ target/
 tmp/
 build/
 out/
-web3j/
 ganache-cli/
 pow/src/main/resources/keys.json
 !validator_test_data.json

diff --git a/...ient/Web3JExecutionBuilderClientTest.java → ...eb3j/Web3JExecutionBuilderClientTest.java b/...ient/Web3JExecutionBuilderClientTest.java → ...eb3j/Web3JExecutionBuilderClientTest.java
@@ -11,7 +11,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package tech.pegasys.teku.ethereum.executionclient;
+package tech.pegasys.teku.ethereum.executionclient.web3j;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.InstanceOfAssertFactories.INTEGER;

diff --git a/...lient/Web3JExecutionEngineClientTest.java → ...web3j/Web3JExecutionEngineClientTest.java b/...lient/Web3JExecutionEngineClientTest.java → ...web3j/Web3JExecutionEngineClientTest.java
@@ -11,7 +11,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package tech.pegasys.teku.ethereum.executionclient;
+package tech.pegasys.teku.ethereum.executionclient.web3j;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.InstanceOfAssertFactories.INTEGER;

diff --git a/...nclient/src/main/java/tech/pegasys/teku/ethereum/executionclient/OkHttpClientCreator.java b/...nclient/src/main/java/tech/pegasys/teku/ethereum/executionclient/OkHttpClientCreator.java
@@ -0,0 +1,46 @@
+/*
+ * Copyright 2022 ConsenSys AG.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+package tech.pegasys.teku.ethereum.executionclient;
+
+import java.time.Duration;
+import java.util.Optional;
+import okhttp3.OkHttpClient;
+import okhttp3.logging.HttpLoggingInterceptor;
+import okhttp3.logging.HttpLoggingInterceptor.Logger;
+import tech.pegasys.teku.ethereum.executionclient.auth.JwtAuthHttpInterceptor;
+import tech.pegasys.teku.ethereum.executionclient.auth.JwtConfig;
+import tech.pegasys.teku.infrastructure.time.TimeProvider;
+
+public class OkHttpClientCreator {
+
+  public static OkHttpClient create(
+      final Optional<JwtConfig> jwtConfig,
+      final Duration timeout,
+      final Optional<HttpLoggingInterceptor> loggingInterceptor,
+      final TimeProvider timeProvider) {
+    final OkHttpClient.Builder builder =
+        new OkHttpClient.Builder().readTimeout(timeout).writeTimeout(timeout);
+    loggingInterceptor.ifPresent(builder::addInterceptor);
+    jwtConfig.ifPresent(
+        config -> builder.addInterceptor(new JwtAuthHttpInterceptor(config, timeProvider)));
+    return builder.build();
+  }
+
+  public static HttpLoggingInterceptor createLoggingInterceptor(
+      Logger logger, HttpLoggingInterceptor.Level level) {
+    final HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor(logger);
+    loggingInterceptor.setLevel(level);
+    return loggingInterceptor;
+  }
+}
diff --git a/.../DefaultExecutionWeb3jClientProvider.java → .../DefaultExecutionWeb3jClientProvider.java b/.../DefaultExecutionWeb3jClientProvider.java → .../DefaultExecutionWeb3jClientProvider.java
@@ -11,7 +11,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package tech.pegasys.teku.ethereum.executionclient;
+package tech.pegasys.teku.ethereum.executionclient.web3j;
 
 import static com.google.common.base.Preconditions.checkNotNull;
 

diff --git a/...nclient/ExecutionWeb3jClientProvider.java → ...t/web3j/ExecutionWeb3jClientProvider.java b/...nclient/ExecutionWeb3jClientProvider.java → ...t/web3j/ExecutionWeb3jClientProvider.java
@@ -11,7 +11,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package tech.pegasys.teku.ethereum.executionclient;
+package tech.pegasys.teku.ethereum.executionclient.web3j;
 
 import static tech.pegasys.teku.spec.executionlayer.ExecutionLayerChannel.STUB_ENDPOINT_IDENTIFIER;
 

diff --git a/...ethereum/executionclient/Web3JClient.java → ...um/executionclient/web3j/Web3JClient.java b/...ethereum/executionclient/Web3JClient.java → ...um/executionclient/web3j/Web3JClient.java
@@ -11,7 +11,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package tech.pegasys.teku.ethereum.executionclient;
+package tech.pegasys.teku.ethereum.executionclient.web3j;
 
 import static tech.pegasys.teku.infrastructure.logging.EventLogger.EVENT_LOG;
 

diff --git a/...onclient/Web3JExecutionBuilderClient.java → ...nt/web3j/Web3JExecutionBuilderClient.java b/...onclient/Web3JExecutionBuilderClient.java → ...nt/web3j/Web3JExecutionBuilderClient.java
@@ -11,7 +11,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package tech.pegasys.teku.ethereum.executionclient;
+package tech.pegasys.teku.ethereum.executionclient.web3j;
 
 import static tech.pegasys.teku.spec.config.Constants.EL_BUILDER_GET_HEADER_TIMEOUT;
 import static tech.pegasys.teku.spec.config.Constants.EL_BUILDER_GET_PAYLOAD_TIMEOUT;
@@ -24,6 +24,7 @@
 import org.apache.tuweni.bytes.Bytes32;
 import org.apache.tuweni.bytes.Bytes48;
 import org.web3j.protocol.core.Request;
+import tech.pegasys.teku.ethereum.executionclient.ExecutionBuilderClient;
 import tech.pegasys.teku.ethereum.executionclient.schema.BlindedBeaconBlockV1;
 import tech.pegasys.teku.ethereum.executionclient.schema.BuilderBidV1;
 import tech.pegasys.teku.ethereum.executionclient.schema.ExecutionPayloadV1;

diff --git a/...ionclient/Web3JExecutionEngineClient.java → ...ent/web3j/Web3JExecutionEngineClient.java b/...ionclient/Web3JExecutionEngineClient.java → ...ent/web3j/Web3JExecutionEngineClient.java
@@ -11,7 +11,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package tech.pegasys.teku.ethereum.executionclient;
+package tech.pegasys.teku.ethereum.executionclient.web3j;
 
 import static tech.pegasys.teku.spec.config.Constants.EL_ENGINE_BLOCK_EXECUTION_TIMEOUT;
 import static tech.pegasys.teku.spec.config.Constants.EL_ENGINE_NON_BLOCK_EXECUTION_TIMEOUT;
@@ -25,6 +25,7 @@
 import org.web3j.protocol.core.DefaultBlockParameterName;
 import org.web3j.protocol.core.Request;
 import org.web3j.protocol.core.methods.response.EthBlock;
+import tech.pegasys.teku.ethereum.executionclient.ExecutionEngineClient;
 import tech.pegasys.teku.ethereum.executionclient.schema.ExecutionPayloadV1;
 import tech.pegasys.teku.ethereum.executionclient.schema.ForkChoiceStateV1;
 import tech.pegasys.teku.ethereum.executionclient.schema.ForkChoiceUpdatedResult;

diff --git a/...m/executionclient/Web3jClientBuilder.java → ...utionclient/web3j/Web3jClientBuilder.java b/...m/executionclient/Web3jClientBuilder.java → ...utionclient/web3j/Web3jClientBuilder.java
@@ -11,7 +11,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package tech.pegasys.teku.ethereum.executionclient;
+package tech.pegasys.teku.ethereum.executionclient.web3j;
 
 import static com.google.common.base.Preconditions.checkNotNull;
 

diff --git a/...reum/executionclient/Web3jHttpClient.java → ...xecutionclient/web3j/Web3jHttpClient.java b/...reum/executionclient/Web3jHttpClient.java → ...xecutionclient/web3j/Web3jHttpClient.java
@@ -11,7 +11,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package tech.pegasys.teku.ethereum.executionclient;
+package tech.pegasys.teku.ethereum.executionclient.web3j;
 
 import java.net.URI;
 import java.time.Duration;
@@ -22,7 +22,7 @@
 import org.apache.logging.log4j.Logger;
 import org.web3j.protocol.Web3jService;
 import org.web3j.protocol.http.HttpService;
-import tech.pegasys.teku.ethereum.executionclient.auth.JwtAuthHttpInterceptor;
+import tech.pegasys.teku.ethereum.executionclient.OkHttpClientCreator;
 import tech.pegasys.teku.ethereum.executionclient.auth.JwtConfig;
 import tech.pegasys.teku.infrastructure.time.TimeProvider;
 
@@ -35,23 +35,18 @@ class Web3jHttpClient extends Web3JClient {
       final Duration timeout,
       final Optional<JwtConfig> jwtConfig) {
     super(timeProvider);
-    final OkHttpClient okHttpClient = createOkHttpClient(jwtConfig, timeout, timeProvider);
-    Web3jService httpService = new HttpService(endpoint.toString(), okHttpClient);
-    initWeb3jService(httpService);
-  }
-
-  private OkHttpClient createOkHttpClient(
-      final Optional<JwtConfig> jwtConfig,
-      final Duration timeout,
-      final TimeProvider timeProvider) {
-    final OkHttpClient.Builder builder = new OkHttpClient.Builder().readTimeout(timeout);
+    final Optional<HttpLoggingInterceptor> loggingInterceptor;
     if (LOG.isTraceEnabled()) {
-      HttpLoggingInterceptor logging = new HttpLoggingInterceptor(LOG::trace);
-      logging.setLevel(HttpLoggingInterceptor.Level.BODY);
-      builder.addInterceptor(logging);
+      loggingInterceptor =
+          Optional.of(
+              OkHttpClientCreator.createLoggingInterceptor(
+                  LOG::trace, HttpLoggingInterceptor.Level.BODY));
+    } else {
+      loggingInterceptor = Optional.empty();
     }
-    jwtConfig.ifPresent(
-        config -> builder.addInterceptor(new JwtAuthHttpInterceptor(config, timeProvider)));
-    return builder.build();
+    final OkHttpClient okHttpClient =
+        OkHttpClientCreator.create(jwtConfig, timeout, loggingInterceptor, timeProvider);
+    Web3jService httpService = new HttpService(endpoint.toString(), okHttpClient);
+    initWeb3jService(httpService);
   }
 }
diff --git a/...ereum/executionclient/Web3jIpcClient.java → ...executionclient/web3j/Web3jIpcClient.java b/...ereum/executionclient/Web3jIpcClient.java → ...executionclient/web3j/Web3jIpcClient.java
@@ -11,7 +11,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package tech.pegasys.teku.ethereum.executionclient;
+package tech.pegasys.teku.ethereum.executionclient.web3j;
 
 import java.net.URI;
 import java.nio.file.Path;

diff --git a/...executionclient/Web3jWebsocketClient.java → ...ionclient/web3j/Web3jWebsocketClient.java b/...executionclient/Web3jWebsocketClient.java → ...ionclient/web3j/Web3jWebsocketClient.java
@@ -11,7 +11,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package tech.pegasys.teku.ethereum.executionclient;
+package tech.pegasys.teku.ethereum.executionclient.web3j;
 
 import java.net.ConnectException;
 import java.net.URI;

diff --git a/...reum/executionclient/Web3JClientTest.java → ...xecutionclient/web3j/Web3JClientTest.java b/...reum/executionclient/Web3JClientTest.java → ...xecutionclient/web3j/Web3JClientTest.java
@@ -11,7 +11,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package tech.pegasys.teku.ethereum.executionclient;
+package tech.pegasys.teku.ethereum.executionclient.web3j;
 
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;

diff --git a/...ecutionclient/Web3jClientBuilderTest.java → ...nclient/web3j/Web3jClientBuilderTest.java b/...ecutionclient/Web3jClientBuilderTest.java → ...nclient/web3j/Web3jClientBuilderTest.java
@@ -11,7 +11,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package tech.pegasys.teku.ethereum.executionclient;
+package tech.pegasys.teku.ethereum.executionclient.web3j;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;

diff --git a/...utionclient/Web3jWebsocketClientTest.java → ...lient/web3j/Web3jWebsocketClientTest.java b/...utionclient/Web3jWebsocketClientTest.java → ...lient/web3j/Web3jWebsocketClientTest.java
@@ -11,7 +11,7 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package tech.pegasys.teku.ethereum.executionclient;
+package tech.pegasys.teku.ethereum.executionclient.web3j;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.ArgumentMatchers.any;

diff --git a/...er/src/main/java/tech/pegasys/teku/ethereum/executionlayer/ExecutionLayerManagerImpl.java b/...er/src/main/java/tech/pegasys/teku/ethereum/executionlayer/ExecutionLayerManagerImpl.java
@@ -32,9 +32,6 @@
 import tech.pegasys.teku.ethereum.executionclient.ExecutionEngineClient;
 import tech.pegasys.teku.ethereum.executionclient.ThrottlingExecutionBuilderClient;
 import tech.pegasys.teku.ethereum.executionclient.ThrottlingExecutionEngineClient;
-import tech.pegasys.teku.ethereum.executionclient.Web3JClient;
-import tech.pegasys.teku.ethereum.executionclient.Web3JExecutionBuilderClient;
-import tech.pegasys.teku.ethereum.executionclient.Web3JExecutionEngineClient;
 import tech.pegasys.teku.ethereum.executionclient.schema.BlindedBeaconBlockV1;
 import tech.pegasys.teku.ethereum.executionclient.schema.BuilderBidV1;
 import tech.pegasys.teku.ethereum.executionclient.schema.ExecutionPayloadV1;
@@ -45,6 +42,9 @@
 import tech.pegasys.teku.ethereum.executionclient.schema.Response;
 import tech.pegasys.teku.ethereum.executionclient.schema.SignedMessage;
 import tech.pegasys.teku.ethereum.executionclient.schema.TransitionConfigurationV1;
+import tech.pegasys.teku.ethereum.executionclient.web3j.Web3JClient;
+import tech.pegasys.teku.ethereum.executionclient.web3j.Web3JExecutionBuilderClient;
+import tech.pegasys.teku.ethereum.executionclient.web3j.Web3JExecutionEngineClient;
 import tech.pegasys.teku.infrastructure.async.SafeFuture;
 import tech.pegasys.teku.infrastructure.exceptions.InvalidConfigurationException;
 import tech.pegasys.teku.infrastructure.logging.EventLogger;

diff --git a/...nlayer/src/main/java/tech/pegasys/teku/services/executionlayer/ExecutionLayerService.java b/...nlayer/src/main/java/tech/pegasys/teku/services/executionlayer/ExecutionLayerService.java
@@ -22,7 +22,7 @@
 import org.apache.logging.log4j.Logger;
 import org.hyperledger.besu.plugin.services.MetricsSystem;
 import tech.pegasys.teku.ethereum.events.SlotEventsChannel;
-import tech.pegasys.teku.ethereum.executionclient.ExecutionWeb3jClientProvider;
+import tech.pegasys.teku.ethereum.executionclient.web3j.ExecutionWeb3jClientProvider;
 import tech.pegasys.teku.ethereum.executionlayer.ExecutionLayerManager;
 import tech.pegasys.teku.ethereum.executionlayer.ExecutionLayerManagerImpl;
 import tech.pegasys.teku.ethereum.executionlayer.ExecutionLayerManagerStub;

diff --git a/...er/src/test/java/tech/pegasys/teku/services/executionlayer/ExecutionLayerServiceTest.java b/...er/src/test/java/tech/pegasys/teku/services/executionlayer/ExecutionLayerServiceTest.java
@@ -21,7 +21,7 @@
 
 import org.junit.jupiter.api.Test;
 import tech.pegasys.teku.ethereum.events.SlotEventsChannel;
-import tech.pegasys.teku.ethereum.executionclient.ExecutionWeb3jClientProvider;
+import tech.pegasys.teku.ethereum.executionclient.web3j.ExecutionWeb3jClientProvider;
 import tech.pegasys.teku.ethereum.executionlayer.ExecutionLayerManager;
 import tech.pegasys.teku.infrastructure.events.EventChannels;
 import tech.pegasys.teku.spec.executionlayer.ExecutionLayerChannel;

diff --git a/services/powchain/src/main/java/tech/pegasys/teku/services/powchain/PowchainService.java b/services/powchain/src/main/java/tech/pegasys/teku/services/powchain/PowchainService.java
@@ -46,7 +46,7 @@
 import tech.pegasys.teku.beacon.pow.TimeBasedEth1HeadTracker;
 import tech.pegasys.teku.beacon.pow.ValidatingEth1EventsPublisher;
 import tech.pegasys.teku.beacon.pow.Web3jEth1Provider;
-import tech.pegasys.teku.ethereum.executionclient.ExecutionWeb3jClientProvider;
+import tech.pegasys.teku.ethereum.executionclient.web3j.ExecutionWeb3jClientProvider;
 import tech.pegasys.teku.ethereum.pow.api.Eth1EventsChannel;
 import tech.pegasys.teku.infrastructure.async.AsyncRunner;
 import tech.pegasys.teku.infrastructure.async.ExceptionThrowingRunnable;

diff --git a/teku/src/main/java/tech/pegasys/teku/services/BeaconNodeServiceController.java b/teku/src/main/java/tech/pegasys/teku/services/BeaconNodeServiceController.java
@@ -15,7 +15,7 @@
 
 import java.util.Optional;
 import tech.pegasys.teku.config.TekuConfiguration;
-import tech.pegasys.teku.ethereum.executionclient.ExecutionWeb3jClientProvider;
+import tech.pegasys.teku.ethereum.executionclient.web3j.ExecutionWeb3jClientProvider;
 import tech.pegasys.teku.networking.nat.NatService;
 import tech.pegasys.teku.service.serviceutils.ServiceConfig;
 import tech.pegasys.teku.services.beaconchain.BeaconChainService;
-Original file line number
+Diff line change
@@ Expand Up / @@ -29,7 +29,6 @@ target/ @@
     tmp/
     build/
     out/
-    web3j/
     ganache-cli/
     pow/src/main/resources/keys.json
     !validator_test_data.json
@@ Expand Down @@