API: Revert boxes pagination

cmd/goal/account.go

@@ -574,6 +574,7 @@
 		}
 
 		printAccountAssetsInformation(accountAddress, response)
+
 	},
 }
 var infoCmd = &cobra.Command{
@@ -777,7 +778,7 @@
 	fmt.Printf("Account: %s\n", address)
 	fmt.Printf("Round: %d\n", response.Round)
 	if response.NextToken != nil {
-		fmt.Printf("NextToken (use with --next to retrieve more account assets): %s\n", *response.NextToken)
+		fmt.Printf("NextToken (to retrieve more account assets): %s\n", *response.NextToken)
 	}
 	fmt.Printf("Assets:\n")
 	for _, asset := range *response.AssetHoldings {

cmd/goal/box.go

@@ -20,17 +20,11 @@
 	"bytes"
 	"strings"
 
-	"github.com/algorand/go-algorand/cmd/util/datadir"
 	"github.com/spf13/cobra"
 )
 
-var (
-	boxName string
-	// next    uint64 // declared in account.go
-	// limit   uint64 // declared in account.go
-	boxPrefix string
-	boxValues bool
-)
+var boxName string
+var maxBoxes uint64
 
 func init() {
 	appCmd.AddCommand(appBoxCmd)
@@ -43,10 +37,7 @@
 	appBoxInfoCmd.Flags().StringVarP(&boxName, "name", "n", "", "Application box name. Use the same form as app-arg to name the box.")
 	appBoxInfoCmd.MarkFlagRequired("name")
 
-	appBoxListCmd.Flags().StringVarP(&boxPrefix, "prefix", "p", "", "Return only boxes that begin with the supplied prefix.")
-	appBoxListCmd.Flags().StringVarP(&next, "next", "n", "", "The next-token returned from a previous call, used for pagination.")
-	appBoxListCmd.Flags().Uint64VarP(&limit, "limit", "l", 0, "The maximum number of boxes to list. 0 means no limit.")
-	appBoxListCmd.Flags().BoolVarP(&boxValues, "values", "v", false, "Request and display box values.")
+	appBoxListCmd.Flags().Uint64VarP(&maxBoxes, "max", "m", 0, "Maximum number of boxes to list. 0 means no limit.")
 }
 
 var appBoxCmd = &cobra.Command{
@@ -92,42 +83,36 @@
 		reportInfof("Name:  %s", boxName)
 
 		// Print box value
-		reportInfof("Value: %s", encodeBytesAsAppCallBytes(*box.Value))
+		reportInfof("Value: %s", encodeBytesAsAppCallBytes(box.Value))
 	},
 }
 
 var appBoxListCmd = &cobra.Command{
 	Use:   "list",
-	Short: "List application boxes belonging to an application",
-	Long: "List application boxes belonging to an application.\n" +
-		"Printable names and values are formatted as 'str:hello' otherwise 'b64:A=='.",
+	Short: "List all application boxes belonging to an application",
+	Long: "List all application boxes belonging to an application.\n" +
+		"For printable strings, the box name is formatted as 'str:hello'\n" +
+		"For everything else, the box name is formatted as 'b64:A=='. ",
 	Args: validateNoPosArgsFn,
 	Run: func(cmd *cobra.Command, args []string) {
-		dataDir := datadir.EnsureSingleDataDir()
-		client := ensureAlgodClient(dataDir)
+		_, client := getDataDirAndClient()
 
-		response, err := client.ApplicationBoxes(appIdx, boxPrefix, &next, limit, boxValues)
+		// Get app boxes
+		boxesRes, err := client.ApplicationBoxes(appIdx, maxBoxes)
 		if err != nil {
 			reportErrorf(errorRequestFail, err)
 		}
+		boxes := boxesRes.Boxes
 
-		// Endpoint did not originally report the Round, so don't show it if it's 0
-		if response.Round != 0 {
-			reportInfof("Round: %d", response.Round)
-		}
-		// There will only be a next-token if there are more boxes to list
-		if response.NextToken != nil {
-			encoded := encodeBytesAsAppCallBytes([]byte(*response.NextToken))
-			reportInfof("NextToken (use with --next to retrieve more boxes): %s", encoded)
+		// Error if no boxes found
+		if len(boxes) == 0 {
+			reportErrorf("No boxes found for appid %d", appIdx)
 		}
-		reportInfoln("Boxes:")
-		for _, descriptor := range response.Boxes {
-			name := encodeBytesAsAppCallBytes(descriptor.Name)
-			if boxValues {
-				reportInfof("%s : %s", name, encodeBytesAsAppCallBytes(*descriptor.Value))
-			} else {
-				reportInfoln(name)
-			}
+
+		// Print app boxes
+		for _, descriptor := range boxes {
+			encodedName := encodeBytesAsAppCallBytes(descriptor.Name)
+			reportInfof("%s", encodedName)
 		}
 	},
 }

daemon/algod/api/algod.oas2.json

@@ -1744,11 +1744,11 @@
     },
     "/v2/applications/{application-id}/boxes": {
       "get": {
-        "description": "Given an application ID, return boxes in lexographical order by name. If the results must be truncated, a next-token is supplied to continue the request.",
+        "description": "Given an application ID, return all Box names. No particular ordering is guaranteed. Request fails when client or server-side configured limits prevent returning all Box names.",
         "tags": ["public", "nonparticipating"],
         "produces": ["application/json"],
         "schemes": ["http"],
-        "summary": "Get boxes for a given application.",
+        "summary": "Get all box names for a given application.",
         "operationId": "GetApplicationBoxes",
         "parameters": [
           {
@@ -1757,27 +1757,9 @@
           {
             "type": "integer",
             "format": "uint64",
-            "description": "Maximum number of boxes to return. Server may impose a lower limit.",
+            "description": "Max number of box names to return. If max is not set, or max == 0, returns all box-names.",
             "name": "max",
             "in": "query"
-          },
-          {
-            "type": "string",
-            "description": "A box name prefix, in the goal app call arg form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.",
-            "name": "prefix",
-            "in": "query"
-          },
-          {
-            "type": "string",
-            "description": "A box name, in the goal app call arg form 'encoding:value'. When provided, the returned boxes begin (lexographically) with the supplied name. Callers may implement pagination by reinvoking the endpoint with the token from a previous call's next-token.",
-            "name": "next",
-            "in": "query"
-          },
-          {
-            "type": "boolean",
-            "description": "If true, box values will be returned.",
-            "name": "values",
-            "in": "query"
           }
         ],
         "responses": {
@@ -3421,7 +3403,7 @@
     "Box": {
       "description": "Box name and its content.",
       "type": "object",
-      "required": ["name"],
+      "required": ["round","name","value"],
       "properties": {
         "round": {
           "description": "The round for which this information is relevant",
@@ -3440,6 +3422,20 @@
         }
       }
     },
+    "BoxDescriptor": {
+      "description": "Box descriptor describes a Box.",
+      "type": "object",
+      "required": [
+        "name"
+      ],
+      "properties": {
+        "name": {
+          "description": "Base64 encoded box name",
+          "type": "string",
+          "format": "byte"
+        }
+      }
+    },
     "BoxReference": {
       "description": "References a box of an application.",
       "type": "object",
@@ -4749,24 +4745,15 @@
       }
     },
     "BoxesResponse": {
-      "description": "Boxes of an application",
+      "description": "Box names of an application",
       "schema": {
         "type": "object",
-        "required": ["round", "boxes"],
+        "required": ["boxes"],
         "properties": {
-          "round": {
-            "description": "The round for which this information is relevant.",
-            "type": "integer",
-            "x-go-type": "basics.Round"
-          },
-          "next-token": {
-            "description": "Used for pagination, when making another request provide this token with the next parameter.",
-            "type": "string"
-          },
           "boxes": {
             "type": "array",
             "items": {
-              "$ref": "#/definitions/Box"
+              "$ref": "#/definitions/BoxDescriptor"
             }
           }
         }

daemon/algod/api/algod.oas3.yml

@@ -363,29 +363,19 @@
               "properties": {
                 "boxes": {
                   "items": {
-                    "$ref": "#/components/schemas/Box"
+                    "$ref": "#/components/schemas/BoxDescriptor"
                   },
                   "type": "array"
-                },
-                "next-token": {
-                  "description": "Used for pagination, when making another request provide this token with the next parameter.",
-                  "type": "string"
-                },
-                "round": {
-                  "description": "The round for which this information is relevant.",
-                  "type": "integer",
-                  "x-go-type": "basics.Round"
                 }
               },
               "required": [
-                "boxes",
-                "round"
+                "boxes"
               ],
               "type": "object"
             }
           }
         },
-        "description": "Boxes of an application"
+        "description": "Box names of an application"
       },
       "CatchpointAbortResponse": {
         "content": {
@@ -1690,6 +1680,23 @@
             "type": "string"
           }
         },
+        "required": [
+          "name",
+          "round",
+          "value"
+        ],
+        "type": "object"
+      },
+      "BoxDescriptor": {
+        "description": "Box descriptor describes a Box.",
+        "properties": {
+          "name": {
+            "description": "Base64 encoded box name",
+            "format": "byte",
+            "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+            "type": "string"
+          }
+        },
         "required": [
           "name"
         ],
@@ -3936,7 +3943,7 @@
     },
     "/v2/applications/{application-id}/boxes": {
       "get": {
-        "description": "Given an application ID, return boxes in lexographical order by name. If the results must be truncated, a next-token is supplied to continue the request.",
+        "description": "Given an application ID, return all Box names. No particular ordering is guaranteed. Request fails when client or server-side configured limits prevent returning all Box names.",
         "operationId": "GetApplicationBoxes",
         "parameters": [
           {
@@ -3952,37 +3959,13 @@
             "x-go-type": "basics.AppIndex"
           },
           {
-            "description": "Maximum number of boxes to return. Server may impose a lower limit.",
+            "description": "Max number of box names to return. If max is not set, or max == 0, returns all box-names.",
             "in": "query",
             "name": "max",
             "schema": {
               "format": "uint64",
               "type": "integer"
             }
-          },
-          {
-            "description": "A box name prefix, in the goal app call arg form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.",
-            "in": "query",
-            "name": "prefix",
-            "schema": {
-              "type": "string"
-            }
-          },
-          {
-            "description": "A box name, in the goal app call arg form 'encoding:value'. When provided, the returned boxes begin (lexographically) with the supplied name. Callers may implement pagination by reinvoking the endpoint with the token from a previous call's next-token.",
-            "in": "query",
-            "name": "next",
-            "schema": {
-              "type": "string"
-            }
-          },
-          {
-            "description": "If true, box values will be returned.",
-            "in": "query",
-            "name": "values",
-            "schema": {
-              "type": "boolean"
-            }
           }
         ],
         "responses": {
@@ -3993,29 +3976,19 @@
                   "properties": {
                     "boxes": {
                       "items": {
-                        "$ref": "#/components/schemas/Box"
+                        "$ref": "#/components/schemas/BoxDescriptor"
                       },
                       "type": "array"
-                    },
-                    "next-token": {
-                      "description": "Used for pagination, when making another request provide this token with the next parameter.",
-                      "type": "string"
-                    },
-                    "round": {
-                      "description": "The round for which this information is relevant.",
-                      "type": "integer",
-                      "x-go-type": "basics.Round"
                     }
                   },
                   "required": [
-                    "boxes",
-                    "round"
+                    "boxes"
                   ],
                   "type": "object"
                 }
               }
             },
-            "description": "Boxes of an application"
+            "description": "Box names of an application"
           },
           "400": {
             "content": {
@@ -4052,7 +4025,7 @@
             "description": "Unknown Error"
           }
         },
-        "summary": "Get boxes for a given application.",
+        "summary": "Get all box names for a given application.",
         "tags": [
           "public",
           "nonparticipating"

daemon/algod/api/client/restClient.go

@@ -475,16 +475,12 @@
 }
 
 type applicationBoxesParams struct {
-	Prefix string  `url:"prefix,omitempty"`
-	Next   *string `url:"next,omitempty"`
-	Max    uint64  `url:"max,omitempty"`
-	Values bool    `url:"values,omitempty"`
+	Max uint64 `url:"max,omitempty"`
 }
 
 // ApplicationBoxes gets the BoxesResponse associated with the passed application ID
-func (client RestClient) ApplicationBoxes(appID basics.AppIndex, prefix string, next *string, limit uint64, values bool) (response model.BoxesResponse, err error) {
-	err = client.get(&response, fmt.Sprintf("/v2/applications/%d/boxes", appID),
-		applicationBoxesParams{prefix, next, limit, values})
+func (client RestClient) ApplicationBoxes(appID basics.AppIndex, maxBoxNum uint64) (response model.BoxesResponse, err error) {
+	err = client.get(&response, fmt.Sprintf("/v2/applications/%d/boxes", appID), applicationBoxesParams{maxBoxNum})
 	return
 }