Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: CLI help for PayForBlob #2991

Merged
merged 3 commits into from
Jan 8, 2024
Merged

fix: CLI help for PayForBlob #2991

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f2bc1b8
fix: CLI help for PayForBlob
rootulp Jan 8, 2024
2f88919
Merge branch 'main' into rp/fix-help
rootulp Jan 8, 2024
2c37b37
docs: blob must be non-zero
rootulp Jan 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 28 additions & 26 deletions x/blob/client/cli/payforblob.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import (
"bufio"
"encoding/hex"
"encoding/json"
"errors"
"fmt"
"os"
"path/filepath"
Expand All @@ -31,15 +30,18 @@ const (
// submitting a PayForBlob.
FlagNamespaceVersion = "namespace-version"

// FlagFileInput allows the user to provide file path to the json file
// for submitting multiple blobs.
// FlagFileInput allows the user to provide the path to a JSON file for
// submitting multiple blobs.
FlagFileInput = "input-file"

// FileInputExtension is the only file extension supported for
// FlagFileInput.
FileInputExtension = ".json"
)

func CmdPayForBlob() *cobra.Command {
cmd := &cobra.Command{
Use: "PayForBlobs [namespaceID blob]",
// This example command can be run in a new terminal after running single-node.sh
Example: "celestia-appd tx blob PayForBlobs 0x00010203040506070809 0x48656c6c6f2c20576f726c6421 \\\n" +
"\t--chain-id private \\\n" +
"\t--from validator \\\n" +
Expand All @@ -52,27 +54,28 @@ func CmdPayForBlob() *cobra.Command {
"\t--keyring-backend test \\\n" +
"\t--fees 21000utia \\\n" +
"\t--yes \n",
Short: "Pay for a data blob(s) to be published to Celestia.",
Long: "Pay for a data blob(s) to be published to Celestia.\n" +
"User can use namespaceID and blob as argument for single blob submission \n" +
"or use --input-file flag with the path to a json file for multiple blobs submission, \n" +
`where the json file contains:

Short: "Pay for data blob(s) to be published to Celestia.",
Long: `Pay for data blob(s) to be published to Celestia.
To publish a single blob, specify the namespaceID and blob via CLI arguments.
To publish multiple blobs, use the --input-file flag with the path to a JSON file.
The JSON should look like:

{
"Blobs": [
{
"Blobs": [
{
"namespaceID": "0x00010203040506070809",
"blob": "0x48656c6c6f2c20576f726c6421"
},
{
"namespaceID": "0x00010203040506070809",
"blob": "0x48656c6c6f2c20576f726c6421"
}
]
"namespaceID": "0x00010203040506070809",
"blob": "0x48656c6c6f2c20576f726c6421"
},
{
"namespaceID": "0x00010203040506070809",
"blob": "0x48656c6c6f2c20576f726c6421"
}
]
}

namespaceID is the user-specifiable portion of a version 0 namespace. It must be a hex encoded string of 10 bytes.\n
blob must be a hex encoded string of any length.\n
The namespaceID is the user-specifiable portion of a version 0 namespace.
The namespaceID must be a hex encoded string of 10 bytes.
The blob must be a hex encoded string of any length.
rootulp marked this conversation as resolved.
Show resolved Hide resolved
`,
Aliases: []string{"PayForBlob"},
Args: func(cmd *cobra.Command, args []string) error {
Expand All @@ -81,17 +84,16 @@ func CmdPayForBlob() *cobra.Command {
return err
}

// If there is a file path input we'll check for the file extension
if path != "" {
if filepath.Ext(path) != ".json" {
return fmt.Errorf("invalid file extension, require json got %s", filepath.Ext(path))
if filepath.Ext(path) != FileInputExtension {
rootulp marked this conversation as resolved.
Show resolved Hide resolved
return fmt.Errorf("invalid file extension %v. The only supported extension is %s", filepath.Ext(path), FileInputExtension)
}

return nil
}

if len(args) < 2 {
return errors.New("PayForBlobs requires two arguments: namespaceID and blob")
return fmt.Errorf("PayForBlobs requires two arguments if %s isn't provided: namespaceID and blob", FlagFileInput)
}

return nil
Expand Down
Loading