1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
// Copyright (C) 2019-2023 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand. If not, see <https://www.gnu.org/licenses/>.
package main
import (
"bytes"
"strings"
"github.com/spf13/cobra"
)
var boxName string
var maxBoxes uint64
func init() {
appCmd.AddCommand(appBoxCmd)
appBoxCmd.AddCommand(appBoxInfoCmd)
appBoxCmd.AddCommand(appBoxListCmd)
appBoxCmd.PersistentFlags().Uint64Var(&appIdx, "app-id", 0, "Application ID")
appBoxCmd.MarkFlagRequired("app-id")
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().Uint64VarP(&maxBoxes, "max", "m", 0, "Maximum number of boxes to list. 0 means no limit.")
}
var appBoxCmd = &cobra.Command{
Use: "box",
Short: "Read application box data",
Args: cobra.ArbitraryArgs,
Run: func(cmd *cobra.Command, args []string) {
// If no arguments passed, we should fallback to help
cmd.HelpFunc()(cmd, args)
},
}
var appBoxInfoCmd = &cobra.Command{
Use: "info",
Short: "Retrieve information about an application box.",
Args: validateNoPosArgsFn,
Run: func(cmd *cobra.Command, args []string) {
_, client := getDataDirAndClient()
// Ensure box name is specified
if boxName == "" {
reportErrorf(errorMissingBoxName)
}
// Get box info
box, err := client.GetApplicationBoxByName(appIdx, boxName)
if err != nil {
if strings.Contains(err.Error(), "box not found") {
reportErrorf("No box found for appid %d with name %s", appIdx, boxName)
}
reportErrorf(errorRequestFail, err)
}
// Print inputted box name, but check that it matches found box name first
// This reduces confusion of potentially receiving a different box name representation
boxNameBytes, err := newAppCallBytes(boxName).Raw()
if err != nil {
reportErrorf(errorInvalidBoxName, boxName, err)
}
if !bytes.Equal(box.Name, boxNameBytes) {
reportErrorf(errorBoxNameMismatch, box.Name, boxNameBytes)
}
reportInfof("Name: %s", boxName)
// Print box value
reportInfof("Value: %s", encodeBytesAsAppCallBytes(box.Value))
},
}
var appBoxListCmd = &cobra.Command{
Use: "list",
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) {
_, client := getDataDirAndClient()
// Get app boxes
boxesRes, err := client.ApplicationBoxes(appIdx, maxBoxes)
if err != nil {
reportErrorf(errorRequestFail, err)
}
boxes := boxesRes.Boxes
// Error if no boxes found
if len(boxes) == 0 {
reportErrorf("No boxes found for appid %d", appIdx)
}
// Print app boxes
for _, descriptor := range boxes {
encodedName := encodeBytesAsAppCallBytes(descriptor.Name)
reportInfof("%s", encodedName)
}
},
}
|
