Merge pull request #119 from kryptokrauts/dev

v2.2.1

Author: mitch-lbw

docs/changelog.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [v2.2.1](https://github.com/kryptokrauts/aepp-sdk-java/releases/tag/v2.2.1)
+
+This release ships an enhancement.
+
+### Enhancements
+- [#116](../../../issues/116) support includes for compiling, deploying and calling contracts
+  - we identified this was missing when developing the [contraect-maven-plugin](https://github.com/kryptokrauts/contraect-maven-plugin)
+
 ## [v2.2.0](https://github.com/kryptokrauts/aepp-sdk-java/releases/tag/v2.2.0)
 
 This release ships some fixes and enhancements.

gradle.properties

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

src/main/java/com/kryptokrauts/aeternity/sdk/service/compiler/CompilerService.java

@@ -5,6 +5,7 @@
 import com.kryptokrauts.aeternity.sdk.service.compiler.domain.ACIResult;
 import io.reactivex.Single;
 import java.util.List;
+import java.util.Map;
 
 public interface CompilerService {
 
@@ -14,28 +15,59 @@ public interface CompilerService {
    * @param contractCode the sourcecode of the contract
    * @param function the name of the function to call
    * @param arguments the params that should be passed to the function
-   * @return asynchronous result handler (RxJava Single) for encoded calldata
+   * @return asynchronous result handler (RxJava Single) for encoded calldata * @deprecated use
+   *     {@link asyncEncodeCalldata(String contractCode, String function, List<String> arguments,
+   *     Map<String, String> fileSystem)} instead. this method will be removed in future releases
    */
+  @Deprecated
   Single<StringResultWrapper> asyncEncodeCalldata(
       String contractCode, String function, List<String> arguments);
 
+  /**
+   * asynchronously gets the encoded calldata for this contractCode
+   *
+   * @param contractCode the sourcecode of the contract
+   * @param function the name of the function to call
+   * @param arguments the params that should be passed to the function
+   * @param fileSystem map with libraryName and code which is passed to the compiler
+   * @return asynchronous result handler (RxJava Single) for encoded calldata
+   */
+  Single<StringResultWrapper> asyncEncodeCalldata(
+      String contractCode, String function, List<String> arguments, Map<String, String> fileSystem);
+
   /**
    * synchronously gets the encoded calldata for this contractCode
    *
    * @param contractCode the sourcecode of the contract
    * @param function the name of the function to call
    * @param arguments the params that should be passed to the function
    * @return encoded calldata
+   * @deprecated use {@link blockingEncodeCalldata(String contractCode, String function,
+   *     List<String> arguments, Map<String, String> fileSystem)} instead. this method will be
+   *     removed in future releases
    */
+  @Deprecated
   StringResultWrapper blockingEncodeCalldata(
       String contractCode, String function, List<String> arguments);
 
+  /**
+   * synchronously gets the encoded calldata for this contractCode
+   *
+   * @param contractCode the sourcecode of the contract
+   * @param function the name of the function to call
+   * @param arguments the params that should be passed to the function
+   * @param fileSystem map with libraryName and code which is passed to the compiler
+   * @return encoded calldata
+   */
+  StringResultWrapper blockingEncodeCalldata(
+      String contractCode, String function, List<String> arguments, Map<String, String> fileSystem);
+
   /**
    * asynchronously gets the contract bytecode for this contractCode
    *
    * @param contractCode the sourcecode of the contract
    * @param srcFile untested compileOpts value: set null
-   * @param fileSystem untested compileOpts value: set null
+   * @param fileSystem map with libraryName and code which is passed to the compiler
    * @return asynchronous result handler (RxJava Single) for byteCode of the compiled contract
    */
   Single<StringResultWrapper> asyncCompile(String contractCode, String srcFile, Object fileSystem);
@@ -45,7 +77,7 @@ StringResultWrapper blockingEncodeCalldata(
    *
    * @param contractCode the sourcecode of the contract
    * @param srcFile untested compileOpts value: set null
-   * @param fileSystem untested compileOpts value: set null
+   * @param fileSystem map with libraryName and code which is passed to the compiler
    * @return byteCode of the compiled contract
    */
   StringResultWrapper blockingCompile(String contractCode, String srcFile, Object fileSystem);
@@ -76,10 +108,31 @@ StringResultWrapper blockingEncodeCalldata(
    * @param callResult the received resultType (ok | error | revert)
    * @param callValue the received value
    * @return the decoded sophia call result
+   * @deprecated use {@link asyncDecodeCallResult(String source, String function, String callResult,
+   *     String callValue, Map<String, String> fileSystem)} instead. this method will be removed in
+   *     future releases
    */
+  @Deprecated
   Single<ObjectResultWrapper> asyncDecodeCallResult(
       String source, String function, String callResult, String callValue);
 
+  /**
+   * asynchronously decodes callresult of contract-calls
+   *
+   * @param source the contract source
+   * @param function the called function
+   * @param callResult the received resultType (ok | error | revert)
+   * @param callValue the received value
+   * @param fileSystem map with libraryName and code which is passed to the compiler
+   * @return the decoded sophia call result
+   */
+  Single<ObjectResultWrapper> asyncDecodeCallResult(
+      String source,
+      String function,
+      String callResult,
+      String callValue,
+      Map<String, String> fileSystem);
+
   /**
    * synchronously decodes callresult of contract-calls
    *
@@ -88,17 +141,38 @@ Single<ObjectResultWrapper> asyncDecodeCallResult(
    * @param callResult the received resultType (ok | error | revert)
    * @param callValue the received value
    * @return the decoded sophia call result
+   * @deprecated use {@link blockingDecodeCallResult(String source, String function, String
+   *     callResult, String callValue, Map<String, String> fileSystem)} instead. this method will be
+   *     removed in future releases
    */
+  @Deprecated
   ObjectResultWrapper blockingDecodeCallResult(
       String source, String function, String callResult, String callValue);
 
+  /**
+   * synchronously decodes callresult of contract-calls
+   *
+   * @param source the contract source
+   * @param function the called function
+   * @param callResult the received resultType (ok | error | revert)
+   * @param callValue the received value
+   * @param fileSystem map with libraryName and code which is passed to the compiler
+   * @return the decoded sophia call result
+   */
+  ObjectResultWrapper blockingDecodeCallResult(
+      String source,
+      String function,
+      String callResult,
+      String callValue,
+      Map<String, String> fileSystem);
+
   /**
    * asynchronously generates the ACI for this contractCode
    * https://github.com/aeternity/aesophia/blob/master/docs/aeso_aci.md
    *
    * @param contractCode the sourcecode of the contract
    * @param srcFile untested compileOpts value: set null
-   * @param fileSystem untested compileOpts value: set null
+   * @param fileSystem map with libraryName and code which is passed to the compiler
    * @return asynchronous result handler (RxJava Single) for {@link ACIResult}
    */
   Single<ACIResult> asyncGenerateACI(String contractCode, String srcFile, Object fileSystem);
@@ -109,7 +183,7 @@ ObjectResultWrapper blockingDecodeCallResult(
    *
    * @param contractCode the sourcecode of the contract
    * @param srcFile untested compileOpts value: set null
-   * @param fileSystem untested compileOpts value: set null
+   * @param fileSystem map with libraryName and code which is passed to the compiler
    * @return result of {@link ACIResult}
    */
   ACIResult blockingGenerateACI(String contractCode, String srcFile, Object fileSystem);

src/main/java/com/kryptokrauts/aeternity/sdk/service/compiler/impl/SophiaCompilerServiceImpl.java

@@ -15,6 +15,7 @@
 import io.netty.util.internal.StringUtil;
 import io.reactivex.Single;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 import lombok.NonNull;
 import lombok.RequiredArgsConstructor;
@@ -29,27 +30,41 @@ public final class SophiaCompilerServiceImpl implements CompilerService {
   @Override
   public Single<StringResultWrapper> asyncEncodeCalldata(
       String sourceCode, String function, List<String> arguments) {
+    return this.asyncEncodeCalldata(sourceCode, function, arguments, null);
+  }
+
+  @Override
+  public Single<StringResultWrapper> asyncEncodeCalldata(
+      String sourceCode, String function, List<String> arguments, Map<String, String> fileSystem) {
     return StringResultWrapper.builder()
         .build()
         .asyncGet(
             this.compilerApi
-                .rxEncodeCalldata(buildFunctionCallInput(sourceCode, function, arguments))
+                .rxEncodeCalldata(
+                    buildFunctionCallInput(sourceCode, function, arguments, fileSystem))
                 .map(calldata -> calldata.getCalldata()));
   }
 
   @Override
   public StringResultWrapper blockingEncodeCalldata(
       String sourceCode, String function, List<String> arguments) {
+    return this.blockingEncodeCalldata(sourceCode, function, arguments, null);
+  }
+
+  @Override
+  public StringResultWrapper blockingEncodeCalldata(
+      String sourceCode, String function, List<String> arguments, Map<String, String> fileSystem) {
     return StringResultWrapper.builder()
         .build()
         .blockingGet(
             this.compilerApi
-                .rxEncodeCalldata(buildFunctionCallInput(sourceCode, function, arguments))
+                .rxEncodeCalldata(
+                    buildFunctionCallInput(sourceCode, function, arguments, fileSystem))
                 .map(calldata -> calldata.getCalldata()));
   }
 
   private FunctionCallInput buildFunctionCallInput(
-      String sourceCode, String function, List<String> arguments) {
+      String sourceCode, String function, List<String> arguments, Map<String, String> fileSystem) {
     FunctionCallInput body = new FunctionCallInput();
     body.source(sourceCode);
     body.function(function);
@@ -59,6 +74,9 @@ private FunctionCallInput buildFunctionCallInput(
       }
     }
     body.options(new CompileOpts().backend(config.getTargetVM().getBackendEnum()));
+    if (fileSystem != null) {
+      body.getOptions().fileSystem(fileSystem);
+    }
     return body;
   }
 
@@ -89,22 +107,44 @@ public ObjectResultWrapper blockingDecodeCalldata(String calldata, String sophia
   @Override
   public Single<ObjectResultWrapper> asyncDecodeCallResult(
       String source, String function, String callResult, String callValue) {
+    return this.asyncDecodeCallResult(source, function, callResult, callValue, null);
+  }
+
+  @Override
+  public Single<ObjectResultWrapper> asyncDecodeCallResult(
+      String source,
+      String function,
+      String callResult,
+      String callValue,
+      Map<String, String> fileSystem) {
     return ObjectResultWrapper.builder()
         .build()
         .asyncGet(
             this.compilerApi
-                .rxDecodeCallResult(buildDecodeBody(source, function, callResult, callValue))
+                .rxDecodeCallResult(
+                    buildDecodeBody(source, function, callResult, callValue, fileSystem))
                 .map(decodeResult -> Optional.ofNullable(decodeResult).orElse("")));
   }
 
   @Override
   public ObjectResultWrapper blockingDecodeCallResult(
       String source, String function, String callResult, String callValue) {
+    return this.blockingDecodeCallResult(source, function, callResult, callValue, null);
+  }
+
+  @Override
+  public ObjectResultWrapper blockingDecodeCallResult(
+      String source,
+      String function,
+      String callResult,
+      String callValue,
+      Map<String, String> fileSystem) {
     return ObjectResultWrapper.builder()
         .build()
         .blockingGet(
             this.compilerApi
-                .rxDecodeCallResult(buildDecodeBody(source, function, callResult, callValue))
+                .rxDecodeCallResult(
+                    buildDecodeBody(source, function, callResult, callValue, fileSystem))
                 .map(decodeResult -> Optional.ofNullable(decodeResult).orElse("")));
   }
 
@@ -116,14 +156,21 @@ private SophiaBinaryData buildDecodeBody(String calldata, String sophiaType) {
   }
 
   private SophiaCallResultInput buildDecodeBody(
-      String source, String function, String callResult, String callValue) {
+      String source,
+      String function,
+      String callResult,
+      String callValue,
+      Map<String, String> fileSystem) {
     SophiaCallResultInput body = new SophiaCallResultInput();
     body.setSource(source);
     body.setFunction(function);
     body.setCallResult(callResult);
     body.setCallValue(callValue);
     CompileOpts compileOpts = new CompileOpts();
     compileOpts.setBackend(config.getTargetVM().getBackendEnum());
+    if (fileSystem != null) {
+      compileOpts.setFileSystem(fileSystem);
+    }
     body.setOptions(compileOpts);
     return body;
   }