chore: CLI metadata help text (#15071)

(cherry picked from commit 9e5e8ea)
cosmos · Feb 20, 2023 · 9b01617 · 9b01617
1 parent 1d17910
commit 9b01617
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 2 deletions.
diff --git a/x/gov/client/cli/tx.go b/x/gov/client/cli/tx.go
@@ -104,11 +104,23 @@ Where proposal.json contains:
       "amount":[{"denom": "stake","amount": "10"}]
     }
   ],
-  "metadata: "4pIMOgIGx1vZGU=", // base64-encoded metadata
+  // metadata can be any of base64 encoded, raw text, stringified json, IPFS link to json
+  // see below for example metadata
+  "metadata: "4pIMOgIGx1vZGU=",
   "deposit": "10stake"
   "title: "My proposal"
   "summary": "A short summary of my proposal"
 }
+
+metadata example: 
+{
+	"title": "",
+	"authors": [""],
+	"summary": "",
+	"details": "", 
+	"proposal_forum_url": "",
+	"vote_option_context": "",
+}
 `,
 				version.AppName,
 			),

diff --git a/x/group/client/cli/tx.go b/x/group/client/cli/tx.go
@@ -570,9 +570,22 @@ Parameters:
 		"summary": "This is a proposal to send 10 stake to cosmos1...",
 	}
 	],
+	// metadata can be any of base64 encoded, raw text, stringified json, IPFS link to json
+	// see below for example metadata
 	"metadata": "4pIMOgIGx1vZGU=", // base64-encoded metadata
 	"proposers": ["cosmos1...", "cosmos1..."],
-}`, version.AppName),
+}
+
+metadata example: 
+{
+	"title": "",
+	"authors": [""],
+	"summary": "",
+	"details": "", 
+	"proposal_forum_url": "",
+	"vote_option_context": "",
+} 
+`, version.AppName),
 		Args: cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			prop, err := getCLIProposal(args[0])