Merge pull request #115 from kryptokrauts/dev

v2.2.0

Author: mitch-lbw

.env

@@ -1,4 +1,4 @@
-AETERNITY_TAG=v5.0.1
-SOPHIA_COMPILER_TAG=v4.0.0
-AETERNAL_TAG=0.11.1
+AETERNITY_TAG=v5.4.1
+SOPHIA_COMPILER_TAG=v4.2.0
+AETERNAL_TAG=0.13.0
 NGINX_TAG=1.13.8

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: ['https://kryptokrauts.com/support/']

README.md

@@ -1,5 +1,13 @@
-# aepp-sdk-java
-A community developed Java SDK to interact with the æternity blockchain powered by [kryptokrauts.com](https://kryptokrauts.com)!
+<p align="center">
+  <a href="https://kryptokrauts.com">
+    <img alt="kryptokrauts" src="https://kryptokrauts.com/img/logo.svg" width="60" />
+  </a>
+</p>
+<h1 align="center">
+  kryptokrauts.com
+</h1>
+
+The **aepp-sdk-java** is a community developed Java SDK to interact with the æternity blockchain.
 
 ## Latest release
  [ ![Download](https://api.bintray.com/packages/kryptokrauts/maven/aepp-sdk-java/images/download.svg) ](https://bintray.com/kryptokrauts/maven/aepp-sdk-java/_latestVersion)
@@ -15,14 +23,6 @@ Licensed under the [ISC License](LICENSE)
 
 ## Support us
 
-If you like this project we would appreciate your support:
-
-- [ak_5z1fmzTKR1GA1P7qiLDCC1s3V7AK2RRpNbXqUhfHQbUeg7mmV](https://explorer.aepps.com/#/account/ak_5z1fmzTKR1GA1P7qiLDCC1s3V7AK2RRpNbXqUhfHQbUeg7mmV)
-
-## Contributors
-
-Everybody is welcome to contribute to this project.
+If you like this project we would appreciate your support. You can find multiple ways to support us here:
 
-Contributors so far:
-- [Marco Walz](https://github.com/marc0olo)
-- [Michel Meier](https://github.com/mitch-lbw)
+- https://kryptokrauts.com/support

build.gradle

@@ -12,7 +12,8 @@ buildscript {
 plugins {
     id "com.jfrog.artifactory" version "4.8.1"
     id "com.jfrog.bintray" version "1.8.4"
-    id 'com.github.sherter.google-java-format' version '0.8'
+    id "com.github.sherter.google-java-format" version "0.8"
+    id "maven"
     id "maven-publish"
     id "jacoco"
     id "java"
@@ -53,7 +54,7 @@ ext {
     vertxVersion = "3.6.3"
     jacksonVersion = "2.9.8"
 
-    lombokVersion = "1.18.4"
+    lombokVersion = "1.18.10"
 
     bouncycastleVersion = "1.61"
     bitcoinjCoreVersion = "0.14.7"

docs/changelog.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## [v2.2.0](https://github.com/kryptokrauts/aepp-sdk-java/releases/tag/v2.2.0)
+
+This release ships some fixes and enhancements.
+
+### Fixes
+- [#91](../../../issues/91) show exception details on compiler and aeternal errors
+- [#95](../../../issues/95) fix default values in BaseConstants
+
+### Enhancements
+- [#96](../../../issues/96) add ResultWrapper for standard java types returned from service calls to omit exceptions being ignored
+- [#97](../../../issues/97) introduce configurable way to wait for tx being included in a block
+  - this is currently covered by the following properties and only relevant in `blockingPostTransaction` calls
+    - `waitForTxIncludedInBlockEnabled` (default=true)
+    - `numTrialsToWaitForTxIncludedInBlock` (default=60)
+    - `millisBetweenTrialsToWaitForTxIncludedInBlock` (default=1000)
+- [#98](../../../issues/98) provide a (more) user-friendly way to handle unit conversions
+  - we introduced a `UnitConversionService`-Interface with a `DefaultUnitConversionService`-Implementation that makes it a bit easier to handle conversions from `AE` to `aettos` or custom tokens that may have less decimals
+- [#99](../../../issues/99) prevent exceptions for TxModel classes
+- [#107](../../../issues/107) wait for confirmation of transaction
+  - now it is possible to wait for a transaction to be confirmed
+  - this is an asynchronous operation and can be configured through the following properties:
+    - `numOfConfirmations` (default=10)
+        - the number of confirmations (KeyBlocks) until a transaction is considered confirmed
+        - this value can also be explicitly set as method parameter
+    - `millisBetweenTrailsToWaitForConfirmation` (default=10000)
+- [#111](../../../issues/111) add "payloadDecoded" attribute to SpendTransactionModel
+  - now the payload for a SpendTx is automatically decoded
+
 ## [v2.1.0](https://github.com/kryptokrauts/aepp-sdk-java/releases/tag/v2.1.0)
 
 This release ships some fixes and enhancements. Additionally we renamed some attributes and model-classes. If you already used [v2.0.0](https://github.com/kryptokrauts/aepp-sdk-java/releases/tag/v2.0.0) it might be needed to fix these changes.

gradle.properties

@@ -1,4 +1,4 @@
 organization=kryptokrauts
 group=com.kryptokrauts
 name=aepp-sdk-java
-version=2.1.0-SNAPSHOT
+version=2.2.0-SNAPSHOT

src/integrationTest/java/com/kryptokrauts/aeternity/generated/api/AeternalServiceTest.java

@@ -12,7 +12,7 @@ public void testStatus(TestContext context) {
     this.executeTest(
         context,
         t -> {
-          Object result = this.aeternityServiceNative.aeternal.blockingGetMdwStatus();
+          Object result = this.aeternityServiceNative.aeternal.blockingGetMdwStatus().getResult();
           try {
             _logger.info("aeternal status: {}", objectMapper.writeValueAsString(result));
           } catch (JsonProcessingException e) {

src/integrationTest/java/com/kryptokrauts/aeternity/generated/api/BaseTest.java

@@ -3,6 +3,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.kryptokrauts.aeternity.sdk.constants.Network;
 import com.kryptokrauts.aeternity.sdk.constants.VirtualMachine;
+import com.kryptokrauts.aeternity.sdk.domain.ObjectResultWrapper;
 import com.kryptokrauts.aeternity.sdk.domain.secret.impl.BaseKeyPair;
 import com.kryptokrauts.aeternity.sdk.service.account.domain.AccountResult;
 import com.kryptokrauts.aeternity.sdk.service.aeternity.AeternityServiceConfiguration;
@@ -102,6 +103,7 @@ public void setupApiClient(TestContext context) throws ConfigurationException {
                     .baseKeyPair(baseKeyPair)
                     .vertx(vertx)
                     .targetVM(targetVM)
+                    .millisBetweenTrailsToWaitForConfirmation(500l)
                     .compile());
     aeternityServiceDebug =
         new AeternityServiceFactory()
@@ -252,8 +254,10 @@ protected void waitForBlockHeight(BigInteger blockHeight, Long timeoutMilli) thr
 
   protected String encodeCalldata(
       String contractSourceCode, String contractFunction, List<String> contractFunctionParams) {
-    return this.aeternityServiceNative.compiler.blockingEncodeCalldata(
-        contractSourceCode, contractFunction, contractFunctionParams);
+    return this.aeternityServiceNative
+        .compiler
+        .blockingEncodeCalldata(contractSourceCode, contractFunction, contractFunctionParams)
+        .getResult();
   }
 
   protected JsonObject decodeCalldata(String encodedValue, String sophiaReturnType) {
@@ -262,7 +266,7 @@ protected JsonObject decodeCalldata(String encodedValue, String sophiaReturnType
             encodedValue, sophiaReturnType));
   }
 
-  protected Object decodeCallResult(
+  protected ObjectResultWrapper decodeCallResult(
       String source, String function, String callResult, String callValue) {
     return this.aeternityServiceNative.compiler.blockingDecodeCallResult(
         source, function, callResult, callValue);

src/integrationTest/java/com/kryptokrauts/aeternity/generated/api/CompilerServiceTest.java

@@ -1,6 +1,7 @@
 package com.kryptokrauts.aeternity.generated.api;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.kryptokrauts.aeternity.sdk.domain.ObjectResultWrapper;
 import com.kryptokrauts.aeternity.sdk.service.compiler.domain.ACIResult;
 import io.vertx.core.json.JsonObject;
 import io.vertx.ext.unit.TestContext;
@@ -13,28 +14,19 @@
 
 public class CompilerServiceTest extends BaseTest {
 
-  @Test
-  public void testCompileContract(TestContext context) {
-    this.executeTest(
-        context,
-        t -> {
-          String byteCode =
-              this.aeternityServiceNative.compiler.blockingCompile(
-                  TestConstants.testContractSourceCode, null, null);
-          context.assertEquals(TestConstants.testContractByteCode, byteCode);
-        });
-  }
-
   @Test
   public void testCompileContractCall(TestContext context) {
     this.executeTest(
         context,
         t -> {
           String calldata =
-              this.aeternityServiceNative.compiler.blockingEncodeCalldata(
-                  TestConstants.testContractSourceCode,
-                  TestConstants.testContractFunction,
-                  TestConstants.testContractFunctionParams);
+              this.aeternityServiceNative
+                  .compiler
+                  .blockingEncodeCalldata(
+                      TestConstants.testContractSourceCode,
+                      TestConstants.testContractFunction,
+                      TestConstants.testContractFunctionParams)
+                  .getResult();
           context.assertEquals(TestConstants.encodedServiceCall, calldata);
         });
   }
@@ -45,16 +37,16 @@ public void testDecodeCalldata(TestContext context) {
         context,
         t -> {
           try {
-            Object callData =
+            ObjectResultWrapper callData =
                 this.aeternityServiceNative.compiler.blockingDecodeCalldata(
                     TestConstants.encodedServiceCallAnswer, "int");
-            _logger.info(callData.toString());
+            _logger.info(callData.getResult().toString());
             context.assertEquals(
                 new ObjectMapper()
                     .readValue(TestConstants.serviceCallAnswerJSON, Map.class)
                     .get("value")
                     .toString(),
-                JsonObject.mapFrom(callData).getInteger("value").toString());
+                JsonObject.mapFrom(callData.getResult()).getInteger("value").toString());
           } catch (IOException e) {
             context.fail(e);
           }
@@ -67,8 +59,10 @@ public void testEncodeCalldata(TestContext context) {
         context,
         t -> {
           String calldata =
-              this.aeternityServiceNative.compiler.blockingEncodeCalldata(
-                  TestConstants.testContractSourceCode, "init", null);
+              this.aeternityServiceNative
+                  .compiler
+                  .blockingEncodeCalldata(TestConstants.testContractSourceCode, "init", null)
+                  .getResult();
           context.assertEquals(TestConstants.testContractCallData, calldata);
         });
   }

src/integrationTest/java/com/kryptokrauts/aeternity/generated/api/PaymentSplitterContractTest.java

@@ -76,6 +76,8 @@ public void a_a_init(TestContext context) throws IOException {
   private String generateMapParam(Map<String, Integer> recipientConditions) {
     Set<String> recipientConditionSet = new HashSet<>();
     recipientConditions.forEach((k, v) -> recipientConditionSet.add("[" + k + "] = " + v));
+    System.out.println(
+        "{" + recipientConditionSet.stream().collect(Collectors.joining(", ")) + "}");
     return "{" + recipientConditionSet.stream().collect(Collectors.joining(", ")) + "}";
   }
 
@@ -86,11 +88,18 @@ public void a_deployPaymentSplitterTest(TestContext context) throws Throwable {
         t -> {
           try {
             String byteCode =
-                this.aeternityServiceNative.compiler.blockingCompile(
-                    paymentSplitterSource, null, null);
+                this.aeternityServiceNative
+                    .compiler
+                    .blockingCompile(paymentSplitterSource, null, null)
+                    .getResult();
             String callData =
-                this.aeternityServiceNative.compiler.blockingEncodeCalldata(
-                    paymentSplitterSource, "init", Arrays.asList(generateMapParam(initialWeights)));
+                this.aeternityServiceNative
+                    .compiler
+                    .blockingEncodeCalldata(
+                        paymentSplitterSource,
+                        "init",
+                        Arrays.asList(generateMapParam(initialWeights)))
+                    .getResult();
 
             _logger.info("contract bytecode: " + byteCode);
             _logger.info("contract calldata: " + callData);
@@ -113,8 +122,10 @@ public void a_deployPaymentSplitterTest(TestContext context) throws Throwable {
                     .build();
 
             String unsignedTx =
-                aeternityServiceNative.transactions.blockingCreateUnsignedTransaction(
-                    contractCreate);
+                aeternityServiceNative
+                    .transactions
+                    .blockingCreateUnsignedTransaction(contractCreate)
+                    .getResult();
             _logger.info("Unsigned Tx - hash - dryRun: " + unsignedTx);
 
             DryRunTransactionResults dryRunResults =
@@ -167,7 +178,8 @@ public void b_callPayAndSplitMethodTest(TestContext context) throws Throwable {
             BigInteger balanceRecipient1;
             BigInteger balanceRecipient2;
             BigInteger balanceRecipient3;
-            // if one of the accounts wasn't active we get an error and know that the
+            // if one of the accounts wasn't active we get an error and know
+            // that the
             // accounts don't have any balance
             balanceRecipient1 =
                 Optional.ofNullable(getAccount(initialReceiver1.getPublicKey()).getBalance())
@@ -181,8 +193,10 @@ public void b_callPayAndSplitMethodTest(TestContext context) throws Throwable {
 
             BigDecimal paymentValue = UnitConversionUtil.toAettos("1", Unit.AE);
             String calldata =
-                aeternityServiceNative.compiler.blockingEncodeCalldata(
-                    paymentSplitterSource, "payAndSplit", null);
+                aeternityServiceNative
+                    .compiler
+                    .blockingEncodeCalldata(paymentSplitterSource, "payAndSplit", null)
+                    .getResult();
             _logger.info("Contract ID: " + localDeployedContractId);
 
             DryRunTransactionResults dryRunResults =
@@ -237,7 +251,8 @@ public void b_callPayAndSplitMethodTest(TestContext context) throws Throwable {
                 aeternityServiceNative.transactions.computeTxHash(contractAfterDryRun));
             _logger.info("CreateContractTx hash: " + postTransactionResult.getTxHash());
 
-            // we wait until the tx is available and the payment should have been splitted
+            // we wait until the tx is available and the payment should have
+            // been splitted
             TransactionInfoResult txInfoObject =
                 waitForTxInfoObject(postTransactionResult.getTxHash());
             _logger.info(
@@ -277,8 +292,10 @@ public void c_callGetTotalAmountSplitted(TestContext context) throws Throwable {
           try {
             BigDecimal paymentValue = UnitConversionUtil.toAettos("0", Unit.AE);
             String calldata =
-                aeternityServiceNative.compiler.blockingEncodeCalldata(
-                    paymentSplitterSource, "getTotalAmountSplitted", null);
+                aeternityServiceNative
+                    .compiler
+                    .blockingEncodeCalldata(paymentSplitterSource, "getTotalAmountSplitted", null)
+                    .getResult();
             _logger.info("Contract ID: " + localDeployedContractId);
 
             DryRunTransactionResults dryRunResults =
@@ -329,8 +346,10 @@ public void d_callGetOwner(TestContext context) throws Throwable {
           try {
             BigDecimal paymentValue = UnitConversionUtil.toAettos("0", Unit.AE);
             String calldata =
-                aeternityServiceNative.compiler.blockingEncodeCalldata(
-                    paymentSplitterSource, "getOwner", null);
+                aeternityServiceNative
+                    .compiler
+                    .blockingEncodeCalldata(paymentSplitterSource, "getOwner", null)
+                    .getResult();
             _logger.info("Contract ID: " + localDeployedContractId);
 
             DryRunTransactionResults dryRunResults =
@@ -397,6 +416,6 @@ protected String createUnsignedContractCallTx(
             .virtualMachine(targetVM)
             .build();
 
-    return aeternityServiceNative.transactions.blockingCreateUnsignedTransaction(model);
+    return aeternityServiceNative.transactions.blockingCreateUnsignedTransaction(model).getResult();
   }
 }