Harmonize YML internal variables to proper case (#171)

Author: Natchica

CHANGELOG.md

@@ -13,6 +13,7 @@ All notable changes to this project will be documented in this file.
 
 - Use no more `iexec-commons-poco` deprecated code in integration tests. (#163)
 - Fix Spring Security deprecations after Spring Boot 3.3.8 upgrade. (#169)
+- Harmonize YML internal variables to proper case. (#171)
 
 ### Breaking API changes
 

README.md

@@ -26,13 +26,13 @@ To run properly, the iExec Blockchain Adapter API requires:
 | `IEXEC_BLOCKCHAIN_ADAPTER_API_PASSWORD`                 | Login password of the server.                                                                          | String           | `whatever`                                   |
 | `IEXEC_BLOCKCHAIN_ADAPTER_API_MONGO_HOST`               | Mongo server host. Cannot be set with URI.                                                             | String           | `localhost`                                  |
 | `IEXEC_BLOCKCHAIN_ADAPTER_API_MONGO_PORT`               | Mongo server port. Cannot be set with URI.                                                             | Positive integer | `13012`                                      |
-| `IEXEC_BLOCKCHAIN_ADAPTER_API_CHAIN_ID`                 | Chain ID of the blockchain network to connect.                                                         | Positive integer | `134`                                        |
-| `IEXEC_BLOCKCHAIN_ADAPTER_API_IS_SIDECHAIN`             | Define whether iExec on-chain protocol is built on top of token (`false`) or native currency (`true`). | Boolean          | `true`                                       |
-| `IEXEC_BLOCKCHAIN_ADAPTER_API_NODE_ADDRESS`             | URL to connect to the blockchain network.                                                              | URL              | `https://bellecour.iex.ec`                   |
-| `IEXEC_BLOCKCHAIN_ADAPTER_API_BLOCK_TIME`               | Duration between consecutive blocks on the blockchain network, in seconds.                             | Positive integer | `5`                                          |
-| `IEXEC_BLOCKCHAIN_ADAPTER_API_HUB_ADDRESS`              | Proxy contract address to interact with the iExec on-chain protocol.                                   | Ethereum Address | `0x3eca1B216A7DF1C7689aEb259fFB83ADFB894E7f` |
-| `IEXEC_BLOCKCHAIN_ADAPTER_API_GAS_PRICE_MULTIPLIER`     | Transactions will be sent with `networkGasPrice * gasPriceMultiplier`.                                 | Float            | `1.0`                                        |
-| `IEXEC_BLOCKCHAIN_ADAPTER_API_GAS_PRICE_CAP`            | In Wei, will be used for transactions if `networkGasPrice * gasPriceMultiplier > gasPriceCap`.         | Positive integer | `22000000000`                                |
+| `IEXEC_CHAIN_ID`                                        | Chain ID of the blockchain network to connect.                                                         | Positive integer | `134`                                        |
+| `IEXEC_IS_SIDECHAIN`                                    | Define whether iExec on-chain protocol is built on top of token (`false`) or native currency (`true`). | Boolean          | `true`                                       |
+| `IEXEC_BLOCKCHAIN_NODE_ADDRESS`                         | URL to connect to the blockchain network.                                                              | URL              | `https://bellecour.iex.ec`                   |
+| `IEXEC_BLOCK_TIME`                                      | Duration between consecutive blocks on the blockchain network, in seconds.                             | Positive integer | `5`                                          |
+| `IEXEC_HUB_ADDRESS`                                     | Proxy contract address to interact with the iExec on-chain protocol.                                   | Ethereum Address | `0x3eca1B216A7DF1C7689aEb259fFB83ADFB894E7f` |
+| `IEXEC_GAS_PRICE_MULTIPLIER`                            | Transactions will be sent with `networkGasPrice * gasPriceMultiplier`.                                 | Float            | `1.0`                                        |
+| `IEXEC_GAS_PRICE_CAP`                                   | In Wei, will be used for transactions if `networkGasPrice * gasPriceMultiplier > gasPriceCap`.         | Positive integer | `22000000000`                                |
 | `IEXEC_BLOCKCHAIN_ADAPTER_API_MAX_ALLOWED_TX_PER_BLOCK` | Max number of transactions per block, between `1` and `4`.                                             | Positive integer | `1`                                          |
 | `IEXEC_BLOCKCHAIN_ADAPTER_API_WALLET_PATH`              | Path to the wallet of the server.                                                                      | String           | `src/main/resources/wallet.json`             |
 | `IEXEC_BLOCKCHAIN_ADAPTER_API_WALLET_PASSWORD`          | Password to unlock the wallet of the server.                                                           | String           | `whatever`                                   |

src/main/java/com/iexec/blockchain/chain/ChainConfig.java

@@ -16,60 +16,52 @@
 
 package com.iexec.blockchain.chain;
 
-import com.iexec.common.chain.validation.ValidNonZeroEthereumAddress;
-import jakarta.annotation.PostConstruct;
-import jakarta.validation.*;
-import jakarta.validation.constraints.Max;
-import jakarta.validation.constraints.NotEmpty;
-import jakarta.validation.constraints.NotNull;
-import jakarta.validation.constraints.Positive;
+import com.iexec.commons.poco.chain.validation.ValidNonZeroEthereumAddress;
+import jakarta.validation.constraints.*;
 import lombok.Builder;
 import lombok.Value;
 import lombok.extern.slf4j.Slf4j;
 import org.hibernate.validator.constraints.URL;
+import org.hibernate.validator.constraints.time.DurationMax;
+import org.hibernate.validator.constraints.time.DurationMin;
 import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.validation.annotation.Validated;
 
-import java.util.Set;
+import java.time.Duration;
 
 @Slf4j
 @Value
 @Builder
+@Validated
 @ConfigurationProperties(prefix = "chain")
 public class ChainConfig {
 
-    @Positive(message = "Chain id should be positive")
-    @NotNull
+    @Positive(message = "Chain id must be greater than 0")
+    @NotNull(message = "Chain id must not be null")
     int id;
 
-    @URL
-    @NotEmpty
-    String nodeAddress;
+    boolean sidechain;
 
-    @Positive(message = "Block time should be positive")
-    @NotNull
-    int blockTime;
+    @URL(message = "Node address must be a valid URL")
+    @NotEmpty(message = "Node address must not be empty")
+    String nodeAddress;
 
-    @ValidNonZeroEthereumAddress
+    @ValidNonZeroEthereumAddress(message = "Hub address must be a valid non zero Ethereum address")
     String hubAddress;
 
-    boolean isSidechain;
+    @DurationMin(millis = 100, message = "Block time must be greater than 100ms")
+    @DurationMax(seconds = 20, message = "Block time must be less than 20s")
+    @NotNull(message = "Block time must not be null")
+    Duration blockTime;
 
+    @Positive(message = "Gas price multiplier must be greater than 0")
     float gasPriceMultiplier;
 
+    @PositiveOrZero(message = "Gas price cap must be greater or equal to 0")
     long gasPriceCap;
 
-    @Positive
-    @Max(value = 4)
+    @Positive(message = "Max allowed tx per block must be greater than 0")
+    @Max(value = 4, message = "Max allowed tx per block must be less or equal to 4")
     int maxAllowedTxPerBlock;
 
-    @PostConstruct
-    private void validate() {
-        try (ValidatorFactory factory = Validation.buildDefaultValidatorFactory()) {
-            Validator validator = factory.getValidator();
-            Set<ConstraintViolation<ChainConfig>> violations = validator.validate(this);
-            if (!violations.isEmpty()) {
-                throw new ConstraintViolationException(violations);
-            }
-        }
-    }
 }

src/main/java/com/iexec/blockchain/chain/Web3jService.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2024 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2025 IEXEC BLOCKCHAIN TECH
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,20 +19,18 @@
 import com.iexec.commons.poco.chain.Web3jAbstractService;
 import org.springframework.stereotype.Service;
 
-import java.time.Duration;
-
 @Service
 public class Web3jService extends Web3jAbstractService {
 
     public Web3jService(ChainConfig chainConfig) {
         super(
                 chainConfig.getId(),
                 chainConfig.getNodeAddress(),
-                Duration.ofSeconds(chainConfig.getBlockTime()),
+                chainConfig.getBlockTime(),
                 chainConfig.getGasPriceMultiplier(),
                 chainConfig.getGasPriceCap(),
                 chainConfig.isSidechain()
         );
     }
 
-}
+}

src/main/java/com/iexec/blockchain/chain/WebSocketBlockchainListener.java

@@ -63,7 +63,7 @@ public WebSocketBlockchainListener(final ChainConfig chainConfig, final SignerSe
         final String wsUrl = chainConfig.getNodeAddress().replace("http", "ws");
         this.webSocketService = new WebSocketService(wsUrl, false);
         this.web3Client = Web3j.build(new HttpService(chainConfig.getNodeAddress()),
-                chainConfig.getBlockTime(), Async.defaultExecutorService());
+                chainConfig.getBlockTime().toMillis(), Async.defaultExecutorService());
         lastSeenBlock = Metrics.gauge(LATEST_BLOCK_METRIC_NAME, new AtomicLong(0));
         latestTxGauge = Metrics.gauge(TX_COUNT_METRIC_NAME, List.of(Tag.of("block", "latest")), new AtomicLong(0));
         pendingTxGauge = Metrics.gauge(TX_COUNT_METRIC_NAME, List.of(Tag.of("block", "pending")), new AtomicLong(0));

src/main/resources/application.yml

@@ -14,18 +14,18 @@ spring:
       auto-index-creation: true
 
 chain:
-  id: ${IEXEC_BLOCKCHAIN_ADAPTER_API_CHAIN_ID:134}
-  node-address: ${IEXEC_BLOCKCHAIN_ADAPTER_API_NODE_ADDRESS:https://bellecour.iex.ec}
-  block-time: ${IEXEC_BLOCKCHAIN_ADAPTER_API_BLOCK_TIME:5} #in seconds
-  hub-address: ${IEXEC_BLOCKCHAIN_ADAPTER_API_HUB_ADDRESS:0x3eca1B216A7DF1C7689aEb259fFB83ADFB894E7f}
-  is-sidechain: ${IEXEC_BLOCKCHAIN_ADAPTER_API_IS_SIDECHAIN:true}
-  gas-price-multiplier: ${IEXEC_BLOCKCHAIN_ADAPTER_API_GAS_PRICE_MULTIPLIER:1.0} # txs will be sent with networkGasPrice*gasPriceMultiplier, 4.0 means super fast
-  gas-price-cap: ${IEXEC_BLOCKCHAIN_ADAPTER_API_GAS_PRICE_CAP:22000000000} #in Wei, will be used for txs if networkGasPrice*gasPriceMultiplier > gasPriceCap
+  id: ${IEXEC_CHAIN_ID:134}
+  node-address: ${IEXEC_BLOCKCHAIN_NODE_ADDRESS:https://bellecour.iex.ec}
+  block-time: ${IEXEC_BLOCK_TIME:PT5S} #in seconds
+  hub-address: ${IEXEC_HUB_ADDRESS:0x3eca1B216A7DF1C7689aEb259fFB83ADFB894E7f}
+  sidechain: ${IEXEC_IS_SIDECHAIN:true}
+  gas-price-multiplier: ${IEXEC_GAS_PRICE_MULTIPLIER:1.0} # txs will be sent with networkGasPrice*gasPriceMultiplier, 4.0 means super fast
+  gas-price-cap: ${IEXEC_GAS_PRICE_CAP:22000000000} #in Wei, will be used for txs if networkGasPrice*gasPriceMultiplier > gasPriceCap
   max-allowed-tx-per-block: ${IEXEC_BLOCKCHAIN_ADAPTER_API_MAX_ALLOWED_TX_PER_BLOCK:1} # 1 or 2
 wallet:
   path: ${IEXEC_BLOCKCHAIN_ADAPTER_API_WALLET_PATH:src/main/resources/wallet.json}
   password: ${IEXEC_BLOCKCHAIN_ADAPTER_API_WALLET_PASSWORD:whatever}
 
 springdoc:
-  packagesToScan: com.iexec.blockchain
-  pathsToMatch: /**
+  packages-to-scan: com.iexec.blockchain
+  paths-to-match: /**