Boxes: Add convenience methods for encoding Box names

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

@@ -1,5 +1,7 @@
 package com.algorand.algosdk.transaction;
 
+import com.algorand.algosdk.util.BoxQueryEncoding;
+
 import java.util.Arrays;
 import java.util.Objects;
 
@@ -46,4 +48,8 @@ public String toString() {
                 ", name=" + Arrays.toString(name) +
                 '}';
     }
+
+    public String nameQueryEncoded() {
+        return BoxQueryEncoding.encodeBytes(this.getName());
+    }
 }

src/main/java/com/algorand/algosdk/util/BoxQueryEncoding.java

@@ -0,0 +1,25 @@
+package com.algorand.algosdk.util;
+
+import com.algorand.algosdk.transaction.AppBoxReference;
+import com.algorand.algosdk.transaction.Transaction;
+import com.algorand.algosdk.v2.client.model.Box;
+
+/**
+ * BoxQueryEncoding provides convenience methods to String encode box names for use with Box search APIs (e.g. GetApplicationBoxByName).
+ */
+public final class BoxQueryEncoding {
+
+    private static final String ENCODING_BASE64_PREFIX = "b64:";
+
+    public static String encodeBytes(byte[] xs) {
+        return ENCODING_BASE64_PREFIX + Encoder.encodeToBase64(xs);
+    }
+
+    public static String encodeBox(Box b) {
+        return encodeBytes(b.name);
+    }
+
+    public static String encodeBoxReference(Transaction.BoxReference br) {
+        return encodeBytes(br.getName());
+    }
+}

src/test/java/com/algorand/algosdk/transaction/TestAppBoxReference.java

@@ -8,7 +8,7 @@
 public class TestAppBoxReference {
 
     private AppBoxReference genConstant() {
-        return new AppBoxReference(Long.valueOf(5), "example".getBytes(StandardCharsets.US_ASCII));
+        return new AppBoxReference(5, "example".getBytes(StandardCharsets.US_ASCII));
     }
 
     @Test
@@ -20,4 +20,17 @@ public void testEqualsByReference() {
     public void testHashCode() {
         Assert.assertEquals(genConstant().hashCode(), genConstant().hashCode());
     }
+
+    @Test
+    public void testNameQueryEncoding() {
+        String example = "tkÿÿ";
+        String expectedEncoding = "b64:dGvDv8O/";
+
+        AppBoxReference abr = new AppBoxReference(0, example.getBytes(StandardCharsets.UTF_8));
+
+        Assert.assertEquals(
+                expectedEncoding,
+                abr.nameQueryEncoded()
+        );
+    }
 }

src/test/java/com/algorand/algosdk/util/TestBoxQueryEncoding.java

@@ -0,0 +1,53 @@
+package com.algorand.algosdk.util;
+
+import com.algorand.algosdk.transaction.AppBoxReference;
+import com.algorand.algosdk.transaction.Transaction;
+import com.algorand.algosdk.v2.client.model.Box;
+import org.junit.Assert;
+import org.junit.Test;
+
+import java.nio.charset.StandardCharsets;
+
+public class TestBoxQueryEncoding {
+
+    private static class Example {
+        final String source;
+        final String expectedEncoding;
+
+        public Example(String source, String expectedEncoding) {
+            this.source = source;
+            this.expectedEncoding = "b64:" + expectedEncoding;
+        }
+    }
+
+    private final Example e = new Example("tkÿÿ", "dGvDv8O/");
+
+    @Test
+    public void testEncodeBytes() {
+        Assert.assertEquals(
+                e.expectedEncoding,
+                BoxQueryEncoding.encodeBytes(e.source.getBytes(StandardCharsets.UTF_8))
+        );
+    }
+
+    @Test
+    public void testEncodeBox() {
+        Box b = new Box();
+        b.name(Encoder.encodeToBase64(e.source.getBytes(StandardCharsets.UTF_8)));
+
+        Assert.assertEquals(
+                e.expectedEncoding,
+                BoxQueryEncoding.encodeBox(b)
+        );
+    }
+
+    @Test
+    public void testEncodeBoxReference() {
+        Transaction.BoxReference br = new Transaction.BoxReference(0, e.source.getBytes(StandardCharsets.UTF_8));
+
+        Assert.assertEquals(
+                e.expectedEncoding,
+                BoxQueryEncoding.encodeBoxReference(br)
+        );
+    }
+}