Merge branch 'release/1.16.0'

Author: algolucky

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 1.16.0
+
+## What's Changed
+* adding method to abi result object by @barnjamin in https://github.com/algorand/java-algorand-sdk/pull/334
+* adding tests and methods for getMethodByName by @barnjamin in https://github.com/algorand/java-algorand-sdk/pull/337
+
 # 1.15.0
 
 ## What's Changed

Makefile

@@ -1,5 +1,5 @@
 unit:
-	mvn test -Dcucumber.filter.tags="@unit.offline or @unit.algod or @unit.indexer or @unit.rekey or @unit.indexer.rekey or @unit.transactions or @unit.transactions.keyreg or @unit.responses or @unit.applications or @unit.dryrun or @unit.tealsign or @unit.responses.messagepack or @unit.responses.231 or @unit.responses.messagepack.231 or @unit.feetest or @unit.indexer.logs or @unit.abijson or @unit.atomic_transaction_composer or @unit.transactions.payment or @unit.responses.unlimited_assets or @unit.algod.ledger_refactoring or @unit.indexer.ledger_refactoring or @unit.dryrun.trace.application"
+	mvn test -Dcucumber.filter.tags="@unit.offline or @unit.algod or @unit.indexer or @unit.rekey or @unit.indexer.rekey or @unit.transactions or @unit.transactions.keyreg or @unit.responses or @unit.applications or @unit.dryrun or @unit.tealsign or @unit.responses.messagepack or @unit.responses.231 or @unit.responses.messagepack.231 or @unit.feetest or @unit.indexer.logs or @unit.abijson or @unit.abijson.byname or @unit.atomic_transaction_composer or @unit.transactions.payment or @unit.responses.unlimited_assets or @unit.algod.ledger_refactoring or @unit.indexer.ledger_refactoring or @unit.dryrun.trace.application"
 
 integration:
 	mvn test -Dcucumber.filter.tags="@algod or @assets or @auction or @kmd or @send or @send.keyregtxn or @indexer or @rekey or @applications.verified or @applications or @compile or @dryrun or @indexer.applications or @indexer.231 or @abi or @c2c"

README.md

@@ -19,7 +19,7 @@ Maven:
 <dependency>
     <groupId>com.algorand</groupId>
     <artifactId>algosdk</artifactId>
-    <version>1.15.0</version>
+    <version>1.16.0</version>
 </dependency>
 ```
 

pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>com.algorand</groupId>
     <artifactId>algosdk</artifactId>
-    <version>1.15.0</version>
+    <version>1.16.0</version>
     <packaging>jar</packaging>
 
     <name>${project.groupId}:${project.artifactId}</name>

src/main/java/com/algorand/algosdk/abi/Contract.java

@@ -1,5 +1,6 @@
 package com.algorand.algosdk.abi;
 
+import com.algorand.algosdk.algod.client.StringUtil;
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
@@ -55,6 +56,11 @@ public Method getMethodByIndex(int index) {
         return this.methods.get(index);
     }
 
+    @JsonIgnore
+    public Method getMethodByName(String name) {
+        return Method.getMethodByName(this.methods, name);
+    }
+
     @Override
     public boolean equals(Object o) {
         if (o == null || getClass() != o.getClass()) return false;

src/main/java/com/algorand/algosdk/abi/Interface.java

@@ -1,5 +1,6 @@
 package com.algorand.algosdk.abi;
 
+import com.algorand.algosdk.algod.client.StringUtil;
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
@@ -44,6 +45,11 @@ public Method getMethodByIndex(int index) {
         return this.methods.get(index);
     }
 
+    @JsonIgnore
+    public Method getMethodByName(String name) {
+        return Method.getMethodByName(this.methods, name);
+    }
+
     @Override
     public boolean equals(Object o) {
         if (o == null || getClass() != o.getClass()) return false;

src/main/java/com/algorand/algosdk/abi/Method.java

@@ -180,6 +180,32 @@ public boolean equals(Object o) {
                 Objects.equals(args, method.args) && Objects.equals(returns, method.returns);
     }
 
+
+    @JsonIgnore
+    public static Method getMethodByName(List<Method> methods,  String name) {
+        List<Method> filteredMethods = new ArrayList<>();
+        for(Method m: methods){
+            if(m.name.equals(name)){
+                filteredMethods.add(m);
+            }
+        }
+
+        if(filteredMethods.size()>1){
+            String[] sigs = new String[filteredMethods.size()];
+            for(int idx=0;idx<filteredMethods.size();idx++){
+               sigs[idx] = filteredMethods.get(idx).getSignature();
+            }
+            String found = StringUtil.join(sigs, ",");
+            throw new IllegalArgumentException(String.format("found %d methods with the same name: %s", filteredMethods.size(), found));
+        }
+
+        if(filteredMethods.size()==0){
+            throw new IllegalArgumentException(String.format("found 0 methods with the name %s", name));
+        }
+
+        return filteredMethods.get(0);
+    }
+
     @JsonInclude(JsonInclude.Include.NON_DEFAULT)
     public static class Returns {
         @JsonIgnore

src/main/java/com/algorand/algosdk/transaction/AtomicTransactionComposer.java

@@ -277,6 +277,7 @@ public ExecuteResult execute(AlgodClient client, int waitRounds) throws Exceptio
                             signedTxns.get(i).transactionID,
                             null,
                             null,
+                            this.methodMap.get(i),
                             new Exception(resp.message()),
                             null
                     ));
@@ -290,6 +291,7 @@ public ExecuteResult execute(AlgodClient client, int waitRounds) throws Exceptio
                         currentTxInfo.txn.transactionID,
                         null,
                         null,
+                        this.methodMap.get(i),
                         null,
                         currentTxInfo
                 ));
@@ -315,6 +317,7 @@ public ExecuteResult execute(AlgodClient client, int waitRounds) throws Exceptio
                     currentTxInfo.txn.transactionID,
                     abiEncoded,
                     decoded,
+                    this.methodMap.get(i),
                     parseError,
                     currentTxInfo
             ));
@@ -349,14 +352,16 @@ public static class ReturnValue {
         public String txID;
         public byte[] rawValue;
         public Object value;
+        public Method method;
         public Exception parseError;
         public PendingTransactionResponse txInfo;
 
-        public ReturnValue(String txID, byte[] rawValue, Object value,
+        public ReturnValue(String txID, byte[] rawValue, Object value, Method method, 
                            Exception parseError, PendingTransactionResponse txInfo) {
             this.txID = txID;
             this.rawValue = rawValue;
             this.value = value;
+            this.method = method;
             this.parseError = parseError;
             this.txInfo = txInfo;
         }

src/test/java/com/algorand/algosdk/integration/AtomicTxnComposer.java

@@ -42,7 +42,6 @@ public class AtomicTxnComposer {
     AtomicTransactionComposer.ExecuteResult execRes;
     SplitAndProcessMethodArgs abiArgProcessor;
     Long appID;
-    List<Method> composerMethods;
     String nonce;
 
     public AtomicTxnComposer(Stepdefs stepdefs, Applications apps, TransactionSteps steps) {
@@ -79,7 +78,6 @@ public void an_application_id(Integer int1) {
     @Given("a new AtomicTransactionComposer")
     public void a_new_atomic_transaction_composer() {
         this.atc = new AtomicTransactionComposer();
-        composerMethods = new ArrayList<>();
     }
 
     @When("I make a transaction signer for the transient account.")
@@ -139,11 +137,10 @@ public void i_execute_the_current_transaction_group_with_the_composer() throws E
     public void the_app_should_have_returned(String string) {
         String[] splitEncoding = string.split(",");
         assertThat(execRes.methodResults.size()).isEqualTo(splitEncoding.length);
-        assertThat(execRes.methodResults.size()).isEqualTo(composerMethods.size());
 
         for (int i = 0; i < splitEncoding.length; i++) {
             AtomicTransactionComposer.ReturnValue execRetVal = execRes.methodResults.get(i);
-            Method currMethod = composerMethods.get(i);
+            Method currMethod = execRetVal.method;
             assertThat(execRetVal.parseError).isNull();
 
             if (splitEncoding[i].isEmpty()) {
@@ -324,7 +321,6 @@ public void the_composer_should_have_a_status_of(String string) {
     @When("I add a method call with the transient account, the current application, suggested params, on complete {string}, current transaction signer, current method arguments.")
     public void i_add_a_method_call_with_the_signing_account_the_current_application_suggested_params_on_complete_current_transaction_signer_current_method_arguments(String onComplete) {
         Address senderAddress = applications.transientAccount.transientAccount.getAddress();
-        composerMethods.add(method);
 
         optionBuilder
                 .onComplete(Transaction.OnCompletion.String(onComplete))
@@ -345,7 +341,6 @@ public void i_add_a_method_call_with_the_signing_account_the_current_application
     @When("I add a nonced method call with the transient account, the current application, suggested params, on complete {string}, current transaction signer, current method arguments.")
     public void i_add_a_nonced_method_call_with_the_transient_account_the_current_application_suggested_params_on_complete_current_transaction_signer_current_method_arguments(String onComplete) {
         Address senderAddress = applications.transientAccount.transientAccount.getAddress();
-        composerMethods.add(method);
 
         optionBuilder
                 .onComplete(Transaction.OnCompletion.String(onComplete))
@@ -373,7 +368,6 @@ public void i_add_a_method_call_with_the_transient_account_the_current_applicati
         } catch (Exception e) {
             throw new IllegalArgumentException("cannot read resource from specified TEAL files");
         }
-        composerMethods.add(method);
 
         Address senderAddress = applications.transientAccount.transientAccount.getAddress();
 
@@ -410,7 +404,6 @@ public void i_add_a_method_call_with_the_transient_account_the_current_applicati
         } catch (Exception e) {
             throw new IllegalArgumentException("cannot read resource from specified TEAL files");
         }
-        composerMethods.add(method);
 
         Address senderAddress = applications.transientAccount.transientAccount.getAddress();
 

src/test/java/com/algorand/algosdk/unit/ABIJson.java

@@ -19,6 +19,7 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.List;
 
 public class ABIJson {
     private enum CHECK_FIELD {
@@ -35,6 +36,9 @@ private enum CHECK_FIELD {
     String jsonContract = null;
     CHECK_FIELD state = null;
 
+    List<Method> methods = null;
+    String errString = null;
+
     @When("I create the Method object from method signature {string}")
     public void i_create_the_method_object_from_method_signature(String string) {
         this.method = new Method(string);
@@ -149,4 +153,52 @@ public void the_deserialized_json_should_equal_the_original_contract_object() th
         Contract deserialized = new ObjectMapper().readValue(this.jsonContract, Contract.class);
         assertThat(this.contract).isEqualTo(deserialized);
     }
+
+    @When("I append to my Method objects list in the case of a non-empty signature {string}")
+    public void i_append_to_my_method_objects_list_in_the_case_of_a_non_empty_signature(String methodsig) {
+        if(this.methods == null){
+            this.methods = new ArrayList<>();
+        }
+
+        if(!methodsig.isEmpty()){
+            this.methods.add(new Method(methodsig));
+        }
+    }
+
+    @When("I create an Interface object from my Method objects list")
+    public void i_create_an_interface_object_from_my_method_objects_list() {
+        this.interfaceObj = new Interface("", "", this.methods);
+    }
+    @When("I get the method from the Interface by name {string}")
+    public void i_get_the_method_from_the_interface_by_name(String name) {
+        try {
+            this.method = this.interfaceObj.getMethodByName(name);
+        }catch(Exception e){
+            this.errString = e.getMessage();
+        }
+    }
+
+    @When("I create a Contract object from my Method objects list")
+    public void i_create_a_contract_object_from_my_method_objects_list() {
+        this.contract = new Contract("", "", null, this.methods);
+    }
+
+    @When("I get the method from the Contract by name {string}")
+    public void i_get_the_method_from_the_contract_by_name(String name) {
+        try {
+            this.method = this.contract.getMethodByName(name);
+        }catch(Exception e){
+            this.errString = e.getMessage();
+        }
+    }
+
+    @Then("the produced method signature should equal {string}. If there is an error it begins with {string}")
+    public void the_produced_method_signature_should_equal_if_there_is_an_error_it_begins_with(String sig, String errstr) {
+        if(!errstr.isEmpty()){
+            assertThat(this.errString).startsWith(errstr);
+        }else{
+            assertThat(this.method.getSignature()).isEqualTo(sig);
+        }
+    }
+
 }