Replace CredentialsService with SignerService (#143)

Author: jbern0rd

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 ## [[NEXT]](https://github.com/iExecBlockchainComputing/iexec-blockchain-adapter-api/releases/tag/vNEXT) 2024
 
+### New Features
+
+- Replace `CredentialsService` with `SignerService`. (#143)
+
 ### Quality
 
 - Use `Instant` instead of `DateTimeUtils`. (#138)

gradle.properties

@@ -1,6 +1,6 @@
 version=8.4.0
 iexecCommonVersion=8.4.0
-iexecCommonsPocoVersion=3.2.0
+iexecCommonsPocoVersion=4.0.0-NEXT-SNAPSHOT
 
 nexusUser
 nexusPassword

src/itest/java/com/iexec/blockchain/IntegrationTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021-2023 IEXEC BLOCKCHAIN TECH
+ * Copyright 2021-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.
@@ -20,7 +20,6 @@
 import com.iexec.blockchain.api.BlockchainAdapterApiClientBuilder;
 import com.iexec.blockchain.broker.BrokerService;
 import com.iexec.blockchain.tool.ChainConfig;
-import com.iexec.blockchain.tool.CredentialsService;
 import com.iexec.blockchain.tool.IexecHubService;
 import com.iexec.common.chain.adapter.args.TaskFinalizeArgs;
 import com.iexec.common.sdk.broker.BrokerOrder;
@@ -54,7 +53,6 @@
 import org.testcontainers.junit.jupiter.Container;
 import org.testcontainers.junit.jupiter.Testcontainers;
 import org.web3j.crypto.Hash;
-import org.web3j.crypto.Sign;
 import org.web3j.protocol.core.methods.response.TransactionReceipt;
 
 import java.io.File;
@@ -111,16 +109,16 @@ static void registerProperties(DynamicPropertyRegistry registry) {
     private int randomServerPort;
 
     private final IexecHubService iexecHubService;
-    private final CredentialsService credentialsService;
+    private final SignerService signerService;
     private final BrokerService brokerService;
     private final ChainConfig chainConfig;
     private BlockchainAdapterApiClient appClient;
 
     @Autowired
-    IntegrationTests(IexecHubService iexecHubService, CredentialsService credentialsService,
+    IntegrationTests(IexecHubService iexecHubService, SignerService signerService,
                      BrokerService brokerService, ChainConfig chainConfig) {
         this.iexecHubService = iexecHubService;
-        this.credentialsService = credentialsService;
+        this.signerService = signerService;
         this.brokerService = brokerService;
         this.chainConfig = chainConfig;
     }
@@ -138,7 +136,7 @@ private static String getServiceUrl(String serviceHost, int servicePort) {
     }
 
     @Test
-    public void shouldBeFinalized() throws Exception {
+    void shouldBeFinalized() throws Exception {
         TransactionReceipt receipt;
         String dealId = triggerDeal(1);
 
@@ -176,7 +174,7 @@ public void shouldBeFinalized() throws Exception {
     }
 
     @Test
-    public void shouldBurstTransactionsWithAverageOfOneTxPerBlock() {
+    void shouldBurstTransactionsWithAverageOfOneTxPerBlock() {
         int taskVolume = 10;//small volume ensures reasonable execution time on CI/CD
         String dealId = triggerDeal(taskVolume);
         List<CompletableFuture<Void>> txCompletionWatchers = new ArrayList<>();
@@ -226,14 +224,14 @@ private String triggerDeal(int taskVolume) {
         log.info("Created datasetAddress: {}", datasetAddress);
 
         OrderSigner orderSigner = new OrderSigner(
-                chainConfig.getId(), chainConfig.getHubAddress(), credentialsService.getCredentials().getEcKeyPair());
+                chainConfig.getId(), chainConfig.getHubAddress(), signerService.getCredentials().getEcKeyPair());
         AppOrder signedAppOrder = orderSigner.signAppOrder(buildAppOrder(appAddress, taskVolume));
         WorkerpoolOrder signedWorkerpoolOrder = orderSigner.signWorkerpoolOrder(buildWorkerpoolOrder(workerpool, taskVolume));
         DatasetOrder signedDatasetOrder = orderSigner.signDatasetOrder(buildDatasetOrder(datasetAddress, taskVolume));
         RequestOrder signedRequestOrder = orderSigner.signRequestOrder(buildRequestOrder(signedAppOrder,
                 signedWorkerpoolOrder,
                 signedDatasetOrder,
-                credentialsService.getCredentials().getAddress(),
+                signerService.getAddress(),
                 DealParams.builder()
                         .iexecArgs("abc")
                         .iexecResultStorageProvider("ipfs")
@@ -377,20 +375,19 @@ private void waitBeforeFinalizing(String chainTaskId) {
 
     public WorkerpoolAuthorization mockAuthorization(String chainTaskId,
                                                      String enclaveChallenge) {
-        String workerWallet = credentialsService.getCredentials().getAddress();
-        String hash = HashUtils.concatenateAndHash(
+        final String workerWallet = signerService.getAddress();
+        final String hash = HashUtils.concatenateAndHash(
                 workerWallet,
                 chainTaskId,
                 enclaveChallenge);
 
-        Sign.SignatureData sign = Sign.signPrefixedMessage(BytesUtils.stringToBytes(hash),
-                credentialsService.getCredentials().getEcKeyPair());
+        final Signature signature = signerService.signMessageHash(hash);
 
         return WorkerpoolAuthorization.builder()
                 .workerWallet(workerWallet)
                 .chainTaskId(chainTaskId)
                 .enclaveChallenge(enclaveChallenge)
-                .signature(new Signature(sign))
+                .signature(signature)
                 .build();
     }
 

src/main/java/com/iexec/blockchain/tool/CredentialsService.java

@@ -17,10 +17,7 @@
 package com.iexec.blockchain.tool;
 
 import com.iexec.common.worker.result.ResultUtils;
-import com.iexec.commons.poco.chain.ChainDeal;
-import com.iexec.commons.poco.chain.ChainTask;
-import com.iexec.commons.poco.chain.ChainTaskStatus;
-import com.iexec.commons.poco.chain.IexecHubAbstractService;
+import com.iexec.commons.poco.chain.*;
 import com.iexec.commons.poco.utils.BytesUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.stereotype.Service;
@@ -38,11 +35,11 @@
 @Service
 public class IexecHubService extends IexecHubAbstractService {
 
-    public IexecHubService(CredentialsService credentialsService,
+    public IexecHubService(SignerService signerService,
                            Web3jService web3jService,
                            ChainConfig chainConfig) {
         super(
-                credentialsService.getCredentials(),
+                signerService.getCredentials(),
                 web3jService,
                 chainConfig.getHubAddress()
         );

src/main/java/com/iexec/blockchain/tool/IexecHubService.java

@@ -0,0 +1,36 @@
+/*
+ * 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.blockchain.tool;
+
+import com.iexec.commons.poco.chain.SignerService;
+import lombok.Value;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.ConstructorBinding;
+import org.springframework.context.annotation.Bean;
+
+@Value
+@ConstructorBinding
+@ConfigurationProperties(prefix = "wallet")
+public class WalletConfiguration {
+    String path;
+    String password;
+
+    @Bean
+    SignerService signerService(Web3jService web3jService, ChainConfig chainConfig) throws Exception {
+        return new SignerService(web3jService.getWeb3j(), chainConfig.getId(), password, path);
+    }
+}

src/main/java/com/iexec/blockchain/tool/WalletConfiguration.java

@@ -16,6 +16,7 @@
 
 package com.iexec.blockchain.tool;
 
+import com.iexec.commons.poco.chain.SignerService;
 import com.iexec.commons.poco.contract.generated.IexecHubContract;
 import lombok.SneakyThrows;
 import org.junit.jupiter.api.BeforeEach;
@@ -39,7 +40,7 @@ class IexecHubServiceTests {
             .hubAddress("0xC129e7917b7c7DeDfAa5Fff1FB18d5D7050fE8ca")
             .build();
     @Mock
-    private CredentialsService credentialsService;
+    private SignerService signerService;
     @Mock
     private IexecHubContract iexecHubContract;
     @Mock
@@ -52,8 +53,8 @@ class IexecHubServiceTests {
     void init() {
         MockitoAnnotations.openMocks(this);
         Credentials credentials = createEthereumCredentials();
-        when(credentialsService.getCredentials()).thenReturn(credentials);
-        iexecHubService = new IexecHubService(credentialsService, web3jService, chainConfig);
+        when(signerService.getCredentials()).thenReturn(credentials);
+        iexecHubService = new IexecHubService(signerService, web3jService, chainConfig);
         ReflectionTestUtils.setField(iexecHubService, "iexecHubContract", iexecHubContract);
     }
 

src/test/java/com/iexec/blockchain/tool/IexecHubServiceTests.java

@@ -0,0 +1,49 @@
+/*
+ * 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.blockchain.tool;
+
+import com.iexec.commons.poco.chain.SignerService;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.web3j.crypto.WalletUtils;
+
+import java.io.File;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class WalletConfigurationTest {
+    private final ApplicationContextRunner runner = new ApplicationContextRunner();
+    @TempDir
+    private File tempWalletDir;
+
+    @Test
+    void shouldCreateBeans() throws Exception {
+        final String tempWalletName = WalletUtils.generateFullNewWalletFile("changeit", tempWalletDir);
+        final String tempWalletPath = tempWalletDir.getAbsolutePath() + File.separator + tempWalletName;
+        runner.withBean(ChainConfig.class, 65535, "http://localhost:8545", 5, "0xC129e7917b7c7DeDfAa5Fff1FB18d5D7050fE8ca", true, 1.0f, 0L, 2)
+                .withBean(IexecHubService.class)
+                .withBean(WalletConfiguration.class, tempWalletPath, "changeit")
+                .withBean(Web3jService.class)
+                .run(context -> assertThat(context)
+                        .hasSingleBean(ChainConfig.class)
+                        .hasSingleBean(IexecHubService.class)
+                        .hasSingleBean(SignerService.class)
+                        .hasSingleBean(WalletConfiguration.class)
+                        .hasSingleBean(Web3jService.class));
+    }
+}