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.

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

Set the value_name for the pclientd --view option #3625

Merged
merged 1 commit into from
Jan 18, 2024

Conversation

jessepinho
Copy link
Contributor

@jessepinho jessepinho commented Jan 18, 2024

The --help docs are a bit unclear about what should be passed to the --view option. This change makes it clear that the argument should be a full viewing key.

Before

$ cargo run --bin pclientd init --help
...
pclientd-init
Generate configs for `pclientd` in view or custody mode

USAGE:
    pclientd init [OPTIONS]

OPTIONS:
        --view <VIEW>
            If provided, initialize in view mode with the given full viewing key

        --custody <CUSTODY>
            If provided, initialize in custody mode with the given seed phrase.

            If the value '-' is provided, the seed phrase will be read from stdin.

        --bind-addr <BIND_ADDR>
            Sets the address to bind to to serve gRPC

            [default: 127.0.0.1:8081]

        --grpc-url <GRPC_URL>
            Sets the URL of the gRPC endpoint used to talk to pd

            [default: https://grpc.testnet.penumbra.zone]

    -h, --help
            Print help information

After

$ cargo run --bin pclientd init --help
...
pclientd-init
Generate configs for `pclientd` in view or custody mode

USAGE:
    pclientd init [OPTIONS]

OPTIONS:
        --view <FULL_VIEWING_KEY>
            If provided, initialize in view mode with the given full viewing key

        --custody <CUSTODY>
            If provided, initialize in custody mode with the given seed phrase.

            If the value '-' is provided, the seed phrase will be read from stdin.

        --bind-addr <BIND_ADDR>
            Sets the address to bind to to serve gRPC

            [default: 127.0.0.1:8081]

        --grpc-url <GRPC_URL>
            Sets the URL of the gRPC endpoint used to talk to pd

            [default: https://grpc.testnet.penumbra.zone]

    -h, --help
            Print help information

@jessepinho jessepinho force-pushed the jessepinho/fix-pclientd-docs branch from b6e43da to 4d6bb6a Compare January 18, 2024 00:56
@jessepinho jessepinho marked this pull request as ready for review January 18, 2024 01:00
@erwanor erwanor merged commit 803114a into main Jan 18, 2024
7 checks passed
@erwanor erwanor deleted the jessepinho/fix-pclientd-docs branch January 18, 2024 01:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants