From 9e5e8ea89dc21f3b8e59396b90c82c5cd3be3d7f Mon Sep 17 00:00:00 2001 From: atheeshp <59333759+atheeshp@users.noreply.github.com> Date: Mon, 20 Feb 2023 19:39:49 +0530 Subject: [PATCH] chore: CLI metadata help text (#15071) --- x/gov/client/cli/tx.go | 14 +++++++++++++- x/group/client/cli/tx.go | 15 ++++++++++++++- 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/x/gov/client/cli/tx.go b/x/gov/client/cli/tx.go index 23641d4abc82..ea7f3e6a265d 100644 --- a/x/gov/client/cli/tx.go +++ b/x/gov/client/cli/tx.go @@ -105,12 +105,24 @@ 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", "expedited": false } + +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 index 36e7e8941d7c..93dc5627d16b 100644 --- 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])