Merge branch 'release/2.7.0'

gmalouf · gmalouf · commit 047dcd995097 · 2025-02-13T13:41:52.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,18 @@
+# 2.7.0
+
+<!-- Release notes generated using configuration in .github/release.yml at release/2.7.0 -->
+
+## What's Changed
+### Enhancements
+* Comments: Regenerate code with the latest specification file (88320845) by @github-actions in https://github.com/algorand/java-algorand-sdk/pull/770
+* BlockHeaders: Implement blockheaders endpoint cross-SDK test. by @gmalouf in https://github.com/algorand/java-algorand-sdk/pull/771
+* API: Support for header-only flag on /v2/block algod endpoint. by @gmalouf in https://github.com/algorand/java-algorand-sdk/pull/774
+
+## New Contributors
+* @dependabot made their first contribution in https://github.com/algorand/java-algorand-sdk/pull/655
+
+**Full Changelog**: https://github.com/algorand/java-algorand-sdk/compare/2.6.0...2.7.0
+
 # 2.6.0
 
 <!-- Release notes generated using configuration in .github/release.yml at release/2.6.0 -->
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ Maven:
 <dependency>
     <groupId>com.algorand</groupId>
     <artifactId>algosdk</artifactId>
-    <version>2.6.0</version>
+    <version>2.7.0</version>
 </dependency>
 ```
 
diff --git a/examples/pom.xml b/examples/pom.xml
@@ -42,7 +42,7 @@
         <dependency>
             <groupId>com.squareup.okio</groupId>
             <artifactId>okio</artifactId>
-            <version>1.6.0</version>
+            <version>1.17.6</version>
         </dependency>
         <dependency>
             <groupId>commons-codec</groupId>
@@ -69,7 +69,7 @@
         <dependency>
             <groupId>org.bouncycastle</groupId>
             <artifactId>bcprov-jdk15to18</artifactId>
-            <version>1.66</version>
+            <version>1.78</version>
         </dependency>
         <dependency>
             <groupId>org.msgpack</groupId>
diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
 
     <groupId>com.algorand</groupId>
     <artifactId>algosdk</artifactId>
-    <version>2.6.0</version>
+    <version>2.7.0</version>
     <packaging>jar</packaging>
 
     <name>${project.groupId}:${project.artifactId}</name>
@@ -85,7 +85,7 @@
         <dependency>
           <groupId>com.squareup.okio</groupId>
           <artifactId>okio</artifactId>
-          <version>1.6.0</version>
+          <version>1.17.6</version>
         </dependency>
         <dependency>
           <groupId>commons-codec</groupId>
diff --git a/src/main/java/com/algorand/algosdk/v2/client/algod/GetBlock.java b/src/main/java/com/algorand/algosdk/v2/client/algod/GetBlock.java
@@ -25,6 +25,15 @@ public GetBlock(Client client, Long round) {
         this.round = round;
     }
 
+    /**
+     * If true, only the block header (exclusive of payset or certificate) may be
+     * included in response.
+     */
+    public GetBlock headerOnly(Boolean headerOnly) {
+        addQuery("header-only", String.valueOf(headerOnly));
+        return this;
+    }
+
    /**
     * Execute the query.
     * @return the query response object.
diff --git a/src/main/java/com/algorand/algosdk/v2/client/algod/GetBlockHeader.java b/src/main/java/com/algorand/algosdk/v2/client/algod/GetBlockHeader.java
diff --git a/src/main/java/com/algorand/algosdk/v2/client/common/AlgodClient.java b/src/main/java/com/algorand/algosdk/v2/client/common/AlgodClient.java
@@ -13,7 +13,6 @@
 import com.algorand.algosdk.v2.client.algod.GetBlock;
 import com.algorand.algosdk.v2.client.algod.GetBlockTxids;
 import com.algorand.algosdk.v2.client.algod.GetBlockHash;
-import com.algorand.algosdk.v2.client.algod.GetBlockHeader;
 import com.algorand.algosdk.v2.client.algod.GetTransactionProof;
 import com.algorand.algosdk.v2.client.algod.GetBlockLogs;
 import com.algorand.algosdk.v2.client.algod.GetSupply;
@@ -181,14 +180,6 @@ public GetBlockHash GetBlockHash(Long round) {
         return new GetBlockHash((Client) this, round);
     }
 
-    /**
-     * Get the block header for the block on the given round.
-     * /v2/blocks/{round}/header
-     */
-    public GetBlockHeader GetBlockHeader(Long round) {
-        return new GetBlockHeader((Client) this, round);
-    }
-
     /**
      * Get a proof for a transaction in a block.
      * /v2/blocks/{round}/transactions/{txid}/proof
diff --git a/src/main/java/com/algorand/algosdk/v2/client/indexer/LookupAccountByID.java b/src/main/java/com/algorand/algosdk/v2/client/indexer/LookupAccountByID.java
@@ -50,8 +50,7 @@ public LookupAccountByID includeAll(Boolean includeAll) {
     }
 
     /**
-     * Deprecated and disallowed. This parameter used to include results for a
-     * specified round. Requests with this parameter set are now rejected.
+     * Include results for the specified round.
      */
     public LookupAccountByID round(Long round) {
         addQuery("round", String.valueOf(round));
diff --git a/src/main/java/com/algorand/algosdk/v2/client/indexer/SearchForAccounts.java b/src/main/java/com/algorand/algosdk/v2/client/indexer/SearchForAccounts.java
@@ -104,8 +104,11 @@ public SearchForAccounts next(String next) {
     }
 
     /**
-     * Deprecated and disallowed. This parameter used to include results for a
-     * specified round. Requests with this parameter set are now rejected.
+     * Include results for the specified round. For performance reasons, this parameter
+     * may be disabled on some configurations. Using application-id or asset-id filters
+     * will return both creator and opt-in accounts. Filtering by include-all will
+     * return creator and opt-in accounts for deleted assets and accounts. Non-opt-in
+     * managers are not included in the results when asset-id is used.
      */
     public SearchForAccounts round(Long round) {
         addQuery("round", String.valueOf(round));
diff --git a/src/main/java/com/algorand/algosdk/v2/client/model/BlockHeaderResponse.java b/src/main/java/com/algorand/algosdk/v2/client/model/BlockHeaderResponse.java
diff --git a/src/test/java/com/algorand/algosdk/unit/AlgodPaths.java b/src/test/java/com/algorand/algosdk/unit/AlgodPaths.java
@@ -2,11 +2,7 @@
 
 import com.algorand.algosdk.crypto.Address;
 import com.algorand.algosdk.unit.utils.TestingUtils;
-import com.algorand.algosdk.v2.client.algod.AccountInformation;
-import com.algorand.algosdk.v2.client.algod.GetApplicationBoxes;
-import com.algorand.algosdk.v2.client.algod.GetPendingTransactions;
-import com.algorand.algosdk.v2.client.algod.GetPendingTransactionsByAddress;
-import com.algorand.algosdk.v2.client.algod.GetTransactionProof;
+import com.algorand.algosdk.v2.client.algod.*;
 import com.algorand.algosdk.v2.client.common.AlgodClient;
 import com.algorand.algosdk.v2.client.model.Enums;
 import io.cucumber.java.en.When;
@@ -59,6 +55,19 @@ public void getBlock(Long round, String format) {
         ps.q = algodClient.GetBlock(round);
     }
 
+    @When("we make a Get Block call for round {int} with format {string} and header-only {string}")
+    public void getBlockHeaderOnly(Integer round, String format, String headerOnly) {
+        GetBlock gb = algodClient.GetBlock(Long.valueOf(round));
+
+        boolean headerOnlyBool = Boolean.parseBoolean(headerOnly);
+
+        if (headerOnlyBool) {
+            gb.headerOnly(true);
+        }
+
+        ps.q = gb;
+    }
+
     @When("we make a GetAssetByID call for assetID {long}")
     public void getAssetByID(Long id) {
         ps.q = algodClient.GetAssetByID(id);
diff --git a/src/test/java/com/algorand/algosdk/unit/AlgodResponses.java b/src/test/java/com/algorand/algosdk/unit/AlgodResponses.java
@@ -139,6 +139,12 @@ public void the_parsed_Get_Block_response_should_have_rewards_pool(String string
         verifyResponse(blockResponse, shared.bodyFile);
     }
 
+    @Then("the parsed Get Block response should have rewards pool {string} and no certificate or payset")
+    public void the_parsed_get_block_response_should_have_rewards_pool_and_no_certificate_or_payset(String string) throws IOException {
+        verifyResponse(blockResponse, shared.bodyFile);
+    }
+
+
     @Then("the parsed Get Block response should have heartbeat address {string}")
     public void the_parsed_Get_Block_response_should_have_heartbeat_address(String string) throws IOException {
         verifyResponse(blockResponse, shared.bodyFile);
diff --git a/src/test/java/com/algorand/algosdk/unit/IndexerPaths.java b/src/test/java/com/algorand/algosdk/unit/IndexerPaths.java
@@ -12,6 +12,8 @@
 import java.security.NoSuchAlgorithmException;
 import java.text.ParseException;
 import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.stream.Collectors;
 
 public class IndexerPaths {
     IndexerClient indexerClient = new IndexerClient("localhost", 1234, "");;
@@ -134,6 +136,63 @@ public void oldSearchForTransactions(
                 addressRole, excludeCloseTo, "");
     }
 
+    @When("we make a Search For BlockHeaders call with minRound {long} " +
+            "maxRound {long} " +
+            "limit {long} " +
+            "nextToken {string} " +
+            "beforeTime {string} " +
+            "afterTime {string} " +
+            "proposers {string} " +
+            "expired {string} " +
+            "absent {string}")
+    public void SearchForBlockHeaders(Long minRound, Long maxRound, Long limit,
+                                      String next, String beforeTime, String afterTime,
+                                      String proposers, String expired, String absent)
+            throws ParseException {
+
+        SearchForBlockHeaders q = this.indexerClient.searchForBlockHeaders();
+        if (TestingUtils.notEmpty(minRound)) q.minRound(minRound);
+        if (TestingUtils.notEmpty(maxRound)) q.maxRound(maxRound);
+        if (TestingUtils.notEmpty(limit)) q.limit(limit);
+        if (TestingUtils.notEmpty(next)) q.next(next);
+        if (TestingUtils.notEmpty(beforeTime)) q.beforeTime(Utils.parseDate(beforeTime));
+        if (TestingUtils.notEmpty(afterTime)) q.afterTime(Utils.parseDate(afterTime));
+        if (TestingUtils.notEmpty(proposers)) {
+            q.proposers(
+                    Arrays.stream(proposers.split(",")).map(ea -> {
+                        try {
+                            return new Address(ea);
+                        } catch (NoSuchAlgorithmException e) {
+                            throw new RuntimeException(e);
+                        }
+                    }).collect(Collectors.toList())
+            );
+        }
+        if (TestingUtils.notEmpty(expired)) {
+            q.expired(
+                    Arrays.stream(expired.split(",")).map(ea -> {
+                        try {
+                            return new Address(ea);
+                        } catch (NoSuchAlgorithmException e) {
+                            throw new RuntimeException(e);
+                        }
+                    }).collect(Collectors.toList())
+            );
+        }
+        if (TestingUtils.notEmpty(absent)) {
+            q.absent(
+                    Arrays.stream(absent.split(",")).map(ea -> {
+                        try {
+                            return new Address(ea);
+                        } catch (NoSuchAlgorithmException e) {
+                            throw new RuntimeException(e);
+                        }
+                    }).collect(Collectors.toList())
+            );
+        }
+        ps.q = q;
+    }
+
     @When("we make a SearchForAssets call with limit {long} "
             + "creator {string} "
             + "name {string} "
diff --git a/src/test/java/com/algorand/algosdk/unit/IndexerResponses.java b/src/test/java/com/algorand/algosdk/unit/IndexerResponses.java
diff --git a/src/test/unit.tags b/src/test/unit.tags

Original file line number	Diff line number	Diff line change
`@@ -50,8 +50,7 @@ public LookupAccountByID includeAll(Boolean includeAll) {`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`/**`
`53`		`- * Deprecated and disallowed. This parameter used to include results for a`
`54`		`- * specified round. Requests with this parameter set are now rejected.`
	`53`	`+ * Include results for the specified round.`
`55`	`54`	`*/`
`56`	`55`	`public LookupAccountByID round(Long round) {`
`57`	`56`	`addQuery("round", String.valueOf(round));`