Merge pull request #102 from iExecBlockchainComputing/release/4.1.0

Release/4.1.0

CHANGELOG.md

@@ -2,6 +2,30 @@
 
 All notable changes to this project will be documented in this file.
 
+## [[4.1.0]](https://github.com/iExecBlockchainComputing/iexec-commons-poco/releases/tag/v4.1.0) 2024-06-17
+
+### New Features
+
+- Add `AbstractAssetDeploymentService` and move `getNonce` method. (#92)
+- Estimate gas and submit a transaction in a single method. (#97)
+- Add method to fetch on-chain deal without app or dataset details. (#98)
+- Add encodings to call PoCo assets address prediction functions. (#101)
+
+### Quality
+
+- Configure Gradle JVM Test Suite Plugin. (#89)
+- Remove unused `predictApp`, `predictDataset` and `predictWorkerpool` methods. (#93)
+- Remove empty `ChainStatus` interface. (#94)
+- Remove `com.iexec.commons.poco.notification` package. (#95)
+- Restrict several methods visibility in `IexecHubAbstractService`. (#96)
+- Avoid exceptions during `IexecHubAbstractService` and `Web3jAbstractService` objects creation. (#99)
+- Improve `SignatureUtils`: remove dead code and remove cleanly unused parameter in `hashAndSign`. (#100)
+
+### Dependency Upgrades
+
+- Upgrade to Gradle 8.7. (#90)
+- Upgrade to Spring Boot 2.7.18. (#91)
+
 ## [[4.0.0]](https://github.com/iExecBlockchainComputing/iexec-commons-poco/releases/tag/v4.0.0) 2024-04-12
 
 ### New features

build.gradle

@@ -1,9 +1,9 @@
 plugins {
     id 'java-library'
+    id 'io.freefair.lombok' version '8.6'
     id 'jacoco'
-    id 'org.sonarqube' version '4.2.1.3168'
+    id 'org.sonarqube' version '5.0.0.4638'
     id 'maven-publish'
-    id 'io.freefair.lombok' version '8.2.2'
 }
 
 group = 'com.iexec.commons'
@@ -34,7 +34,7 @@ repositories {
 }
 
 dependencies {
-    implementation platform('org.springframework.boot:spring-boot-dependencies:2.7.17')
+    implementation platform('org.springframework.boot:spring-boot-dependencies:2.7.18')
 
     // web3j
     api 'org.web3j:core:4.9.7'
@@ -55,19 +55,6 @@ dependencies {
 
     // javax annotations like PostConstruct
     implementation 'javax.annotation:javax.annotation-api'
-
-    // tests
-    testImplementation 'org.junit.jupiter:junit-jupiter'
-    testRuntimeOnly("org.junit.platform:junit-platform-launcher")
-    testImplementation 'org.mockito:mockito-junit-jupiter'
-    testImplementation 'org.assertj:assertj-core'
-    testImplementation "org.testcontainers:junit-jupiter:$testContainersVersion"
-
-    // spring-test for ReflectionTestUtils
-    testImplementation 'org.springframework:spring-test'
-
-    // logback
-    testRuntimeOnly 'ch.qos.logback:logback-classic'
 }
 
 java {
@@ -80,9 +67,26 @@ java {
     withSourcesJar()
 }
 
+testing {
+    suites {
+        test {
+            useJUnitJupiter()
+            dependencies {
+                implementation 'org.junit.jupiter:junit-jupiter'
+                implementation 'org.mockito:mockito-junit-jupiter'
+                implementation 'org.assertj:assertj-core'
+                implementation "org.testcontainers:junit-jupiter:$testContainersVersion"
+                // spring-test for ReflectionTestUtils
+                implementation 'org.springframework:spring-test'
+                // logback
+                runtimeOnly 'ch.qos.logback:logback-classic'
+            }
+        }
+    }
+}
+
 tasks.withType(Test).configureEach {
     finalizedBy jacocoTestReport
-    useJUnitPlatform()
 }
 
 test {

gradle.properties

@@ -1,3 +1,3 @@
-version=4.0.0
+version=4.1.0
 nexusUser
 nexusPassword

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradlew

@@ -83,7 +83,8 @@ done
 # This is normally unused
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -144,15 +145,15 @@ if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
         # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045
+        # shellcheck disable=SC2039,SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
         # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045
+        # shellcheck disable=SC2039,SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -201,11 +202,11 @@ fi
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
-# Collect all arguments for the java command;
-#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-#     shell script including quotes and variable substitutions, so put them in
-#     double quotes to make sure that they get re-expanded; and
-#   * put everything else in single quotes, so that it's not re-expanded.
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
 
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \

gradlew.bat

@@ -43,11 +43,11 @@ set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
 if %ERRORLEVEL% equ 0 goto execute
 
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -57,11 +57,11 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
 if exist "%JAVA_EXE%" goto execute
 
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 

src/main/java/com/iexec/commons/poco/chain/AbstractAssetDeploymentService.java

@@ -0,0 +1,68 @@
+/*
+ * Copyright 2024 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.
+ * 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 com.iexec.commons.poco.chain;
+
+import com.iexec.commons.poco.encoding.AssetDataEncoder;
+import lombok.extern.slf4j.Slf4j;
+import org.web3j.utils.Numeric;
+
+import java.io.IOException;
+import java.math.BigInteger;
+import java.util.Objects;
+
+@Slf4j
+public abstract class AbstractAssetDeploymentService {
+    private static final String ASSET_REGISTRY_ADDRESS_INITIALIZATION_NEEDED =
+            "Registry address has not been initialized, please call initRegistryAddress";
+    protected final SignerService signerService;
+
+    private final String assetRegistrySelector;
+    private String assetRegistryAddress;
+
+    protected AbstractAssetDeploymentService(SignerService signerService, String assetRegistrySelector) {
+        this.signerService = signerService;
+        this.assetRegistrySelector = assetRegistrySelector;
+    }
+
+    public void initRegistryAddress(String iexecHubAddress) throws IOException {
+        if (this.assetRegistryAddress != null) {
+            return;
+        }
+        this.assetRegistryAddress = toEthereumAddress(signerService.sendCall(iexecHubAddress, assetRegistrySelector));
+    }
+
+    public String callCreateAsset(String assetTxData) throws IOException {
+        Objects.requireNonNull(assetRegistryAddress, ASSET_REGISTRY_ADDRESS_INITIALIZATION_NEEDED);
+        return toEthereumAddress(signerService.sendCall(assetRegistryAddress, assetTxData));
+    }
+
+    public boolean isAssetDeployed(String address) throws IOException {
+        Objects.requireNonNull(assetRegistryAddress, ASSET_REGISTRY_ADDRESS_INITIALIZATION_NEEDED);
+        final String isRegisteredTxData = AssetDataEncoder.encodeIsRegistered(address);
+        return Numeric.toBigInt(signerService.sendCall(assetRegistryAddress, isRegisteredTxData)).equals(BigInteger.ONE);
+    }
+
+    public String submitAssetTxData(BigInteger nonce, BigInteger gasPrice, String assetTxData) throws IOException {
+        Objects.requireNonNull(assetRegistryAddress, ASSET_REGISTRY_ADDRESS_INITIALIZATION_NEEDED);
+        return signerService.signAndSendTransaction(nonce, gasPrice, assetRegistryAddress, assetTxData);
+    }
+
+    private String toEthereumAddress(String hexaString) {
+        return Numeric.toHexStringWithPrefixZeroPadded(
+                Numeric.toBigInt(hexaString), 40);
+    }
+}

src/main/java/com/iexec/commons/poco/chain/ChainContributionStatus.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2023 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2024 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.
@@ -18,7 +18,7 @@
 
 import java.math.BigInteger;
 
-public enum ChainContributionStatus implements ChainStatus {
+public enum ChainContributionStatus {
     UNSET,
     CONTRIBUTED,
     REVEALED,

src/main/java/com/iexec/commons/poco/chain/ChainDeal.java

@@ -62,10 +62,21 @@ public boolean containsDataset() {
                 !getChainDataset().getChainDatasetId().equals(BytesUtils.EMPTY_ADDRESS);
     }
 
+    public static ChainDeal parts2ChainDeal(String chainDealId, IexecHubContract.Deal deal, ChainCategory category) {
+        if (deal == null || category == null) {
+            return ChainDeal.builder().build();
+        }
+        return create(chainDealId, deal, category, null, null);
+    }
+
     public static ChainDeal parts2ChainDeal(String chainDealId, IexecHubContract.Deal deal, ChainApp app, ChainCategory category, ChainDataset dataset) {
         if (deal == null || app == null || category == null) {
             return ChainDeal.builder().build();
         }
+        return create(chainDealId, deal, category, app, dataset);
+    }
+
+    private static ChainDeal create(String chainDealId, IexecHubContract.Deal deal, ChainCategory category, ChainApp app, ChainDataset dataset) {
         return ChainDeal.builder()
                 .chainDealId(chainDealId)
                 .chainApp(app)

src/main/java/com/iexec/commons/poco/chain/ChainTaskStatus.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2023 IEXEC BLOCKCHAIN TECH
+ * Copyright 2020-2024 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.
@@ -18,12 +18,12 @@
 
 import java.math.BigInteger;
 
-public enum ChainTaskStatus implements ChainStatus {
+public enum ChainTaskStatus {
     UNSET,     // Work order not yet initialized (invalid address)
-    ACTIVE,    // Marketed to constributions are open
+    ACTIVE,    // Marketed, contributions are open
     REVEALING, // Starting consensus reveal
-    COMPLETED, // Concensus achieved
-    FAILLED;    // Failed consensus
+    COMPLETED, // Consensus achieved
+    FAILED;    // Failed consensus
 
     public static ChainTaskStatus getValue(int i) {
         return ChainTaskStatus.values()[i];