Merge pull request #128 from iExecBlockchainComputing/release/8.3.0

Release/8.3.0

Author: jbern0rd

CHANGELOG.md

@@ -2,17 +2,56 @@
 
 All notable changes to this project will be documented in this file.
 
+## [[8.3.0]](https://github.com/iExecBlockchainComputing/iexec-blockchain-adapter-api/releases/tag/v8.3.0) 2024-01-10
+
+### New Features
+
+- Send up to 2 blockchain transactions per block.
+  With a big enough latency, the nonce is properly computed in web3j library against the pending block. (#111)
+- Add `BlockchainAdapterService` class to implement interactions with REST API. (#117 #118 #119 126)
+- Expose version through prometheus endpoint and through VersionController. (#122 #123)
+
+### Bug Fixes
+
+- Remove `contribute` and `reveal` endpoints. (#110)
+- Fix web security depreciation warning. (#112)
+
+### Quality
+
+- Add and use a non-root user in the dockerfile. (#113)
+- Reindent `build.gradle` file. (#114)
+- Standardisation of the dockerfile and its location in regard to other java components. (#115)
+- Rename `Status` to `CommandStatus` in library. (#117)
+- Remove `com.iexec.blockchain.command.task.contribute` package. (#124)
+- Remove `com.iexec.blockchain.command.task.reveal` package. (#125)
+
+### Dependency Upgrades
+
+- Upgrade to `eclipse-temurin:11.0.21_9-jre-focal`. (#121)
+- Upgrade to Spring Boot 2.7.17. (#120)
+- Upgrade to Spring Dependency Management Plugin 1.1.4. (#120)
+- Upgrade to Spring Doc OpenAPI 1.7.0. (#122)
+- Upgrade to `jenkins-library` 2.7.4. (#116)
+- Upgrade to `iexec-commons-poco` 3.2.0. (#127)
+- Upgrade to `iexec-common` 8.3.1. (#127)
+
 ## [[8.2.0]](https://github.com/iExecBlockchainComputing/iexec-blockchain-adapter-api/releases/tag/v8.2.0) 2023-09-28
 
 ### Bug Fixes
+
 - Fix and harmonize `Dockerfile entrypoint` in all Spring Boot applications. (#102)
+
 ### Quality
+
 - Remove `nexus.intra.iex.ec` repository. (#96)
 - Upgrade to Gradle 8.2.1 with up-to-date plugins. (#100)
 - Clean TODOs. (#104)
-- `ChainConfig` instance is immutable and validated. Application will fail to start if chain config parameters violate constraints. (#105)
+- `ChainConfig` instance is immutable and validated. Application will fail to start if chain config parameters violate
+  constraints. (#105)
 - Remove `SignerService` class only used in integration tests. (#107)
+
 ### Dependency Upgrades
+
 - Upgrade to `eclipse-temurin` 11.0.20. (#98)
 - Upgrade to Spring Boot 2.7.14. (#99)
 - Upgrade to Spring Dependency Management Plugin 1.1.3. (#99)
@@ -24,41 +63,55 @@ All notable changes to this project will be documented in this file.
 ## [[8.1.1]](https://github.com/iExecBlockchainComputing/iexec-blockchain-adapter-api/releases/tag/v8.1.1) 2023-06-23
 
 ### Dependency Upgrades
+
 - Upgrade to `iexec-common` 8.2.1. (#94)
 - Upgrade to `iexec-commons-poco` 3.0.4. (#94)
 
 ## [[8.1.0]](https://github.com/iExecBlockchainComputing/iexec-blockchain-adapter-api/releases/tag/v8.1.0) 2023-06-07
 
 ### New Features
+
 - Enable Prometheus actuator. (#79)
 - Rework `QueueService` with a thread pool based on a `PriorityBlockingQueue`. (#84)
 - Do not use `broker` to match orders on chain. (#87 #88)
+
 ### Bug Fixes
+
 - Fix security rule to access Swagger API. (#79)
+
 ### Quality
+
 - Use `testcontainers` in integration tests. (#89)
 - Remove `com.iexec.blockchain.dataset` package and update `feign` client endpoints. (#91)
+
 ### Dependency Upgrades
+
 - Upgrade to `feign` 11.10. (#80)
 - Upgrade to `iexec-common` 8.2.0. (#83 #85 #90)
 - Upgrade to `iexec-commons-poco` 3.0.2. (#83 #85 #86 #90)
 
 ## [[8.0.1]](https://github.com/iExecBlockchainComputing/iexec-blockchain-adapter-api/releases/tag/v8.0.1) 2023-04-06
 
 ### Quality
+
 * Run integration tests on `[email protected]`. (#81)
 * Connect by default to iExec Bellecour blockchain. (#81)
 
 ## [[8.0.0]](https://github.com/iExecBlockchainComputing/iexec-blockchain-adapter-api/releases/tag/v8.0.0) 2023-03-03
 
 ### New Features
+
 * Expose a `BrokerClient` in library.
 * Add iExec banner at startup.
 * Show application version on banner.
+
 ### Quality
+
 * Improve code quality.
 * Use new TEE classes in tests.
+
 ### Dependency Upgrades
+
 * Replace the deprecated `openjdk` Docker base image with `eclipse-temurin` and upgrade to Java 11.0.18 patch.
 * Upgrade to Spring Boot 2.6.14.
 * Upgrade to Gradle 7.6.
@@ -83,7 +136,7 @@ All notable changes to this project will be documented in this file.
 
 * Hotfix integration tests.
 
-## [[7.1.0]](https://github.com/iExecBlockchainComputing/iexec-blockchain-adapter-api/releases/tag/v7.1.0) 2022-07-01 
+## [[7.1.0]](https://github.com/iExecBlockchainComputing/iexec-blockchain-adapter-api/releases/tag/v7.1.0) 2022-07-01
 
 * Add OpenFeign client library in dedicated iexec-blockchain-adapter-api-library jar.
 * Use Spring Boot 2.6.2.

Dockerfile

@@ -0,0 +1,20 @@
+# Build app container
+FROM eclipse-temurin:11.0.21_9-jre-focal
+
+ARG jar
+
+RUN test -n "$jar"
+
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends curl \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN groupadd --system appuser \
+    && useradd -g appuser -s /sbin/nologin -c "Docker image user" appuser
+
+WORKDIR /app
+COPY $jar iexec-blockchain-adapter-api.jar
+RUN chown -R appuser:appuser /app
+
+USER appuser
+ENTRYPOINT [ "java", "-Djava.security.egd=file:/dev/./urandom", "-jar", "iexec-blockchain-adapter-api.jar" ]

Jenkinsfile

@@ -1,8 +1,5 @@
-@Library('[email protected].3') _
+@Library('[email protected].4') _
 buildJavaProject(
-        buildInfo: getBuildInfo(),
         integrationTestsEnvVars: ['BROKER_PRIVATE_KEY'],
         shouldPublishJars: true,
-        shouldPublishDockerImages: true,
-        dockerfileDir: 'docker',
-        buildContext: '.')
+        shouldPublishDockerImages: true)

README.md

@@ -8,45 +8,49 @@ Incoming requests are locally stored in a database.
 Transactions related to these requests are being asynchronously sent to a blockchain node.
 At any time, the caller can retrieve the processing status for his request.
 
-The iExec Blockchain Adapter API is available as an OCI image on [Docker Hub](https://hub.docker.com/r/iexechub/iexec-blockchain-adapter-api/tags).
+The iExec Blockchain Adapter API is available as an OCI image
+on [Docker Hub](https://hub.docker.com/r/iexechub/iexec-blockchain-adapter-api/tags).
 
 To run properly, the iExec Blockchain Adapter API requires:
+
 * A blockchain node. iExec smart contracts must be deployed on the blockchain network.
 * A MongoDB instance to persist its data.
 * An Ethereum wallet to interact with smart contracts on the blockchain network.
 
 ## Configuration
 
-| Environment variable | Description | Type | Default value |
-| --- | --- | --- | --- |
-| `IEXEC_BLOCKCHAIN_ADAPTER_API_PORT` | Server HTTP port of the Blockchain Adapter API. | Positive integer | `13010` |
-| `IEXEC_BLOCKCHAIN_ADAPTER_API_USERNAME` | Login username of the server. | String | `admin` |
-| `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_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` |
+| Environment variable                                    | Description                                                                                            | Type             | Default value                                |
+|---------------------------------------------------------|--------------------------------------------------------------------------------------------------------|------------------|----------------------------------------------|
+| `IEXEC_BLOCKCHAIN_ADAPTER_API_PORT`                     | Server HTTP port of the Blockchain Adapter API.                                                        | Positive integer | `13010`                                      |
+| `IEXEC_BLOCKCHAIN_ADAPTER_API_USERNAME`                 | Login username of the server.                                                                          | String           | `admin`                                      |
+| `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_BLOCKCHAIN_ADAPTER_API_MAX_ALLOWED_TX_PER_BLOCK` | Max number of transactions per block, it can either be `1` or `2`.                                     | 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`                                   |
 
 ## Health checks
 
 A health endpoint (`/actuator/health`) is enabled by default and can be accessed on the **IEXEC_BLOCKCHAIN_ADAPTER_API_PORT**.
-This endpoint allows to define health checks in an orchestrator or a [compose file](https://github.com/compose-spec/compose-spec/blob/master/spec.md#healthcheck).
-No default strategy has been implemented in the [Dockerfile](docker/Dockerfile) at the moment.
+This endpoint allows to define health checks in an orchestrator or
+a [compose file](https://github.com/compose-spec/compose-spec/blob/master/spec.md#healthcheck).
+No default strategy has been implemented in the [Dockerfile](Dockerfile) at the moment.
 
 ## Running in development mode
 
 `./gradlew docker`
 
 ## CI/CD build
 
-`docker image build -f docker/Dockerfile .`
+`docker image build .`
 
 ## License