feat(client/keys): support display discreetly for `keys add` #18663

Halimao · 2023-12-08T10:37:12Z

Description

Closes: #18662

This PR add support for displaying mnemonic discreetly.

Testing and Verifying

This change is already covered by existing tests, such as Test_runAddCmdBasic.

Summary by CodeRabbit

New Features
- Addition of a new flag flagIndiscreet in the constants section.
- Addition of discreet mnemonic display for <appd> keys add in client/keys.
- Added functionality to print sensitive information discreetly to an alternate screen.
Improvements
- Enhancement in <appd> q gov proposer by directly querying a proposal instead of tx events in x/gov.
Bug Fixes
- Implemented additional validation for DecCoins to prevent errors.
Refactor
- Updated client context with new methods for address codec management.
Documentation
- Updated CHANGELOG to reflect new features and improvements.

coderabbitai · 2023-12-08T10:37:19Z

Walkthrough

The changes involve enhancing security and usability features in a Go application. A new flag for discreet mnemonic display has been added, and the handling of mnemonic backup has been reworked. A function to print sensitive information discreetly has been introduced. Additionally, improvements have been made to querying governance proposals and providing address codecs in the client context. The CHANGELOG.md reflects these updates, including a new feature for sdk.DecCoins and enhancements in the x/gov module.

Changes

File(s)	Summary
`client/keys/add.go` `client/keys/utils.go`	Introduced `flagIndiscreet`, removed `noBackup` in favor of `showMnemonic` and `showMnemonicIndiscreetly`, updated `printCreate` function, and added `printDiscreetly` function for secure output handling.
`CHANGELOG.md`	Documented new features and improvements, including discreet mnemonic display, `AmountOfNoValidation` for `sdk.DecCoins`, and querying enhancements in `x/gov`.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on X ?

Tips

Chat with CodeRabbit Bot (`@coderabbitai`)

If you reply to a review comment from CodeRabbit, the bot will automatically respond.
To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
Note: Review comments are made on code diffs or files, not on the PR overview.
Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
The JSON schema for the configuration file is available here.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 833547f and 5fbb4ec.

Files ignored due to filter (2)

go.mod
go.sum

Files selected for processing (2)

client/keys/add.go (1 hunks)
client/keys/utils.go (2 hunks)

Additional comments: 4

client/keys/add.go (3)

357-363: The implementation of the displayDiscreetly function call seems correct, and it is appropriately handling the error by returning a formatted error message if the function fails. This aligns with the PR's objective to discreetly display the mnemonic phrase.

357-363: Please verify that the displayDiscreetly function is declared in the client/keys/utils.go file and is part of the public API as intended by the PR objectives.

357-363: Please verify that the test Test_runAddCmdBasic exists and has been updated to cover the new functionality of discreetly displaying the mnemonic phrase.

client/keys/utils.go (1)

76-88: The implementation of displayDiscreetly function appears to correctly handle the discreet display of sensitive information. However, ensure that error handling is consistent with the rest of the codebase, especially for the fmt.Scanln() call which might need to handle specific cases like EOF or interrupted input.

julienrbrt · 2023-12-08T10:50:16Z

981a197: you should run ./scripts/go-mod-tidy-all.sh

Halimao · 2023-12-08T10:54:16Z

981a197: you should run ./scripts/go-mod-tidy-all.sh

Thanks, I think I should update go.mod in simapp/go.mod instead of ./go.mod

julienrbrt · 2023-12-08T11:04:12Z

981a197: you should run ./scripts/go-mod-tidy-all.sh

Thanks, I think I should update go.mod in simapp/go.mod instead of ./go.mod

The script should do it right. If you have a go.work somewhere, please delete it and delete simapp/gomod2nix.toml and re-run the script. The diff shouldn't be that big.

Halimao · 2023-12-08T11:10:29Z

981a197: you should run ./scripts/go-mod-tidy-all.sh

Thanks, I think I should update go.mod in simapp/go.mod instead of ./go.mod

The script should do it right. If you have a go.work somewhere, please delete it and delete simapp/gomod2nix.toml and re-run the script. The diff shouldn't be that big.

Ok，thank you very much🙏. There is indeed a go.work file, I will delete it and retry again.

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 5fbb4ec and 2716ac2.

Files ignored due to filter (3)

simapp/go.mod
simapp/go.sum
simapp/gomod2nix.toml

Files selected for processing (2)

CHANGELOG.md (1 hunks)
client/keys/utils.go (2 hunks)

Files skipped from review as they are similar to previous changes (1)

client/keys/utils.go

Additional comments: 1

CHANGELOG.md (1)

59-59: The changes listed in the hunk for CHANGELOG.md correctly reflect the improvements and features added to the codebase as described in the summary. The links to the pull requests provide a clear reference for further details on each change.

julienrbrt

tACK: https://asciinema.org/a/ngiFJX2BjNMiGc2uQ9zIfggRt
Nice feature, maybe it will break some scripts however, can we add a flag to disable it?

CHANGELOG.md

Co-authored-by: Julien Robert <[email protected]>

Halimao · 2023-12-09T01:24:40Z

Sorry for mis-operate...

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between bfbaf12 and 0a1f7e2.

Files selected for processing (2)

CHANGELOG.md (1 hunks)
client/keys/add.go (8 hunks)

Files skipped from review as they are similar to previous changes (1)

CHANGELOG.md

Additional comments: 5

client/keys/add.go (5)

39-39: The addition of the flagIndiscreet constant aligns with the PR's objective to enhance privacy and security during the mnemonic display process.

333-335: The replacement of the noBackup flag with showMnemonic and showMnemonicDiscreetly variables is consistent with the PR's objective to provide a discreet mnemonic display option.

348-351: The modification of the printCreate function to handle the showMnemonicDiscreetly variable aligns with the PR's objective to allow for a discreet display of the mnemonic.

363-366: The use of the displayDiscreetly function within printCreate when showMnemonicDiscreetly is true is consistent with the PR's objective to discreetly display the mnemonic.

330-345: The updates to the runAddCmd function to handle the showMnemonicDiscreetly variable align with the PR's objective to introduce a discreet mnemonic display feature.

client/keys/add.go

alexanderbez

utACK!

client/keys/utils.go

alexanderbez · 2023-12-09T19:07:42Z

client/keys/utils.go

+	if _, err = fmt.Scanln(); err != nil {
+		return err
+	}
+	return nil


nit: since we're not wrapping the error with context (maybe we should), then you can just simply return the result

Suggested change

if _, err = fmt.Scanln(); err != nil {

return err

}

return nil

return fmt.Scanln()

@alexanderbez Hi, sir. As fmt.Scanln signature is func Scanln(a ...any) (n int, err error), but I just wanna return "error or not" for func displayDiscreetly

julienrbrt

tACK! +1 for bez comments.

…screetly

coderabbitai

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between ceff45f and ba41325.

Files selected for processing (2)

client/keys/add.go (9 hunks)
client/keys/utils.go (2 hunks)

Additional comments: 10

client/keys/add.go (7)

39-39: The addition of the flagIndiscreet constant is consistent with the PR's objective to introduce discreet mnemonic display.

88-88: The PR summary mentioned the removal of flagNoBackup, but it is still present. Please verify if this flag should be removed or if the summary is incorrect.

334-342: The logic for handling the display of mnemonics has been updated to use showMnemonic and showMnemonicIndiscreetly. Ensure that the new logic correctly implements the discreet display of mnemonics as intended.

349-349: The printCreate function has been modified to include showMnemonic and showMnemonicIndiscreetly parameters. Confirm that these parameters are used correctly within the function to handle mnemonic display as per the new feature.

369-371: The printDiscreetly function is called here, but its implementation is not provided. Please ensure that the function exists and correctly implements discreet printing as intended.

364-371: The logic for discreet and indiscreet mnemonic display in the printCreate function appears to be correctly implemented. Ensure that the discreet path does not leak sensitive information to the terminal's main screen.

366-366: The error handling for mnemonic display in the printCreate function is clear and provides context, which is good for debugging purposes.

client/keys/utils.go (3)

8-8: The addition of the termenv package is appropriate for the functionality being introduced.

76-88: The printDiscreetly function correctly implements the discreet display of sensitive information using an alternate screen, which aligns with the PR's objective to enhance security and privacy.

76-88: Verify that the existing test Test_runAddCmdBasic adequately covers the new printDiscreetly function, as claimed in the PR.

client/keys/utils.go

julienrbrt · 2023-12-10T16:57:45Z

Could you please fix the conflicts?

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between f942f87 and 094eb41.

Files ignored due to filter (2)

go.mod
x/accounts/go.mod

Files selected for processing (1)

client/keys/add.go (9 hunks)

Additional comments: 7

client/keys/add.go (7)

39-39: The addition of the flagIndiscreet constant is consistent with the PR's objective to support discreet mnemonic display.

88-88: The flagIndiscreet flag is added to the command flags with a clear description. It's important to ensure that the flag's behavior is correctly implemented in the rest of the code.

334-336: The showMnemonic and showMnemonicIndiscreetly variables are introduced to replace the noBackup variable. This change is in line with the PR's objective to provide more granular control over mnemonic display.

342-342: The showMnemonicIndiscreetly variable is explicitly set to false when recovering a key, which is a good security practice to prevent accidental display of sensitive information.

349-349: The printCreate function signature is modified to accept showMnemonic and showMnemonicIndiscreetly parameters. It's crucial to review the implementation of this function to ensure it handles these parameters correctly.

364-371: The logic to discreetly print the mnemonic phrase is added. It's important to verify that the printDiscreetly function is implemented correctly in client/keys/utils.go and that it uses the termenv package as intended to prevent the mnemonic from being displayed on the terminal's main screen.

374-374: The default case in the switch statement for outputFormat provides error handling for invalid formats. This is a good practice to ensure that the function can handle unexpected input gracefully.

* feat: secp256k1 public key constant time (cosmos#18026) Signed-off-by: bizk <[email protected]> * chore: Fixed changelog duplicated items (cosmos#18628) * adr: Un-Ordered Transaction Inclusion (cosmos#18553) Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Aleksandr Bezobchuk <[email protected]> * docs: lint ADR-070 (cosmos#18634) * fix(baseapp)!: postHandler should run regardless of result (cosmos#18627) * docs: fix typos in adr-007-specialization-groups.md (cosmos#18635) * chore: alphabetize labels (cosmos#18640) * docs(x/circuit): add note on ante handler (cosmos#18637) Co-authored-by: Aleksandr Bezobchuk <[email protected]> * fix: telemetry metric label variable (cosmos#18643) * chore: typos fix (cosmos#18642) * refactor(store/v2): updates from integration (cosmos#18633) * build(deps): Bump actions/setup-go from 4 to 5 (cosmos#18647) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> * feat(store/v2): snapshot manager (cosmos#18458) * chore(client/v2): fix typos in the README.md (cosmos#18657) * fix(baseapp): protocompat.go gogoproto.Merge does not work with custom types (cosmos#18654) Co-authored-by: unknown unknown <unknown@unknown> * chore: fix several minor typos (cosmos#18660) * chore(tools/confix/cmd): fix typo in view.go (cosmos#18659) * refactor(x/staking): check duplicate addresses in StakeAuthorization's params (cosmos#18655) * feat(accounts): use gogoproto API instead of protov2. (cosmos#18653) Co-authored-by: unknown unknown <unknown@unknown> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * fix(store/commitment/iavl): honor tree.Remove error firstly (cosmos#18651) * build(deps): Bump actions/stale from 8 to 9 (cosmos#18656) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(docs): fix typos & wording in docs (cosmos#18667) * chore: fix several typos. (cosmos#18666) * feat(telemetry): enable `statsd` and `dogstatsd` telemetry sinks (cosmos#18646) Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Aleksandr Bezobchuk <[email protected]> Co-authored-by: marbar3778 <[email protected]> Co-authored-by: Marko <[email protected]> * feat(store/v2): add SetInitialVersion in SC (cosmos#18665) * feat(client/keys): support display discreetly for `keys add` (cosmos#18663) Co-authored-by: Julien Robert <[email protected]> * ci: add misspell action (cosmos#18671) * chore: typos fix by misspell-fixer (cosmos#18683) Co-authored-by: github-merge-queue <[email protected]> Co-authored-by: Julien Robert <[email protected]> * chore: add v0.50.2 changelog to main (cosmos#18682) * build(deps): Bump github.com/jhump/protoreflect from 1.15.3 to 1.15.4 in /tests (cosmos#18678) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * refactor(bank): remove .String() calls (cosmos#18175) Co-authored-by: Facundo <[email protected]> * ci: use codespell instead of misspell-fixer (cosmos#18686) Co-authored-by: Marko <[email protected]> * feat(gov): add proposal types and spam votes (cosmos#18532) * feat(accounts): use account number as state prefix for account state (cosmos#18664) Co-authored-by: unknown unknown <unknown@unknown> * chore: typos fixes by cosmos-sdk bot (cosmos#18689) Co-authored-by: github-merge-queue <[email protected]> Co-authored-by: Julien Robert <[email protected]> Co-authored-by: marbar3778 <[email protected]> * feat(client/keys): support display discreetly for keys mnemonic (cosmos#18688) * refactor: remove panic usage in keeper methods (cosmos#18636) * ci: rename pr name in misspell job (cosmos#18693) Co-authored-by: Marko <[email protected]> * build(deps): Bump github.com/pelletier/go-toml/v2 from 2.1.0 to 2.1.1 in /tools/confix (cosmos#18702) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> * feat(client/keys): support display discreetly for keys export (cosmos#18684) * feat(x/gov): better gov genesis validation (cosmos#18707) --------- Signed-off-by: bizk <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Carlos Santiago Yanzon <[email protected]> Co-authored-by: yihuang <[email protected]> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Aleksandr Bezobchuk <[email protected]> Co-authored-by: Facundo Medica <[email protected]> Co-authored-by: Akaonetwo <[email protected]> Co-authored-by: Marko <[email protected]> Co-authored-by: Julien Robert <[email protected]> Co-authored-by: dreamweaverxyz <[email protected]> Co-authored-by: Pioua <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: cool-developer <[email protected]> Co-authored-by: leonarddt05 <[email protected]> Co-authored-by: testinginprod <[email protected]> Co-authored-by: unknown unknown <unknown@unknown> Co-authored-by: Sukey <[email protected]> Co-authored-by: axie <[email protected]> Co-authored-by: Luke Ma <[email protected]> Co-authored-by: Emmanuel T Odeke <[email protected]> Co-authored-by: 0xn4de <[email protected]> Co-authored-by: hattizai <[email protected]> Co-authored-by: Devon Bear <[email protected]> Co-authored-by: Marko <[email protected]> Co-authored-by: Halimao <[email protected]> Co-authored-by: Cosmos SDK <[email protected]> Co-authored-by: github-merge-queue <[email protected]> Co-authored-by: Facundo <[email protected]> Co-authored-by: Likhita Polavarapu <[email protected]>

feat: support display discreetly for keys add

5fbb4ec

Halimao requested a review from a team as a code owner December 8, 2023 10:37

coderabbitai bot reviewed Dec 8, 2023

View reviewed changes

fix: run gomod2nix generate

981a197

fix: run ./scripts/go-mod-tidy-all.sh

1ee275c

Halimao added 2 commits December 8, 2023 19:22

fix: delete go.work and rerun ./scripts/go-mod-tidy-all.sh

de96283

add changelog and fix lint

2716ac2

coderabbitai bot reviewed Dec 8, 2023

View reviewed changes

julienrbrt reviewed Dec 8, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

julienrbrt changed the title ~~feat: support display discreetly for keys add~~ feat(client/keys): support display discreetly for keys add Dec 8, 2023

Update CHANGELOG.md

bfbaf12

Co-authored-by: Julien Robert <[email protected]>

Halimao closed this Dec 9, 2023

Halimao reopened this Dec 9, 2023

feat: add --indiscreet option to disable it

0a1f7e2

coderabbitai bot reviewed Dec 9, 2023

View reviewed changes

fix: add missing flag register

ceff45f

julienrbrt reviewed Dec 9, 2023

View reviewed changes

client/keys/add.go Outdated Show resolved Hide resolved

fix: fix invert action

973c5d8

alexanderbez approved these changes Dec 9, 2023

View reviewed changes

julienrbrt approved these changes Dec 9, 2023

View reviewed changes

refactor: revert named return and change displayDiscreetly to printDi…

ba41325

…screetly

coderabbitai bot reviewed Dec 10, 2023

View reviewed changes

client/keys/utils.go Show resolved Hide resolved

Merge branch 'main' into feat/display-mnemonic-discreetly

f942f87

Halimao added 2 commits December 11, 2023 08:26

rerun ./scripts/go-mod-tidy-all.sh after conflict

008ae11

refactor: remove redundant type

094eb41

coderabbitai bot reviewed Dec 11, 2023

View reviewed changes

julienrbrt added this pull request to the merge queue Dec 11, 2023

Merged via the queue into cosmos:main with commit 978fffc Dec 11, 2023
53 of 56 checks passed

Halimao deleted the feat/display-mnemonic-discreetly branch December 11, 2023 01:23

coderabbitai bot mentioned this pull request Dec 12, 2023

refactor: remove panic usage in keeper methods #18636

Merged

12 tasks

marcello33 mentioned this pull request Jan 22, 2024

Upstream fetch (#2) #19163

Closed

12 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(client/keys): support display discreetly for `keys add` #18663

feat(client/keys): support display discreetly for `keys add` #18663

Halimao commented Dec 8, 2023 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 8, 2023 •

edited

Loading

Walkthrough

Changes

Chat with CodeRabbit Bot (`@coderabbitai`)

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

coderabbitai bot left a comment

julienrbrt commented Dec 8, 2023

Halimao commented Dec 8, 2023

julienrbrt commented Dec 8, 2023

Halimao commented Dec 8, 2023 •

edited

Loading

coderabbitai bot left a comment

julienrbrt left a comment •

edited

Loading

Halimao commented Dec 9, 2023 •

edited

Loading

coderabbitai bot left a comment

alexanderbez left a comment

alexanderbez Dec 9, 2023 •

edited

Loading

Halimao Dec 10, 2023

julienrbrt left a comment

coderabbitai bot left a comment

julienrbrt commented Dec 10, 2023

coderabbitai bot left a comment

feat(client/keys): support display discreetly for keys add #18663

feat(client/keys): support display discreetly for keys add #18663

Conversation

Halimao commented Dec 8, 2023 • edited by coderabbitai bot Loading

Description

Testing and Verifying

Summary by CodeRabbit

coderabbitai bot commented Dec 8, 2023 • edited Loading

Walkthrough

Changes

Chat with CodeRabbit Bot (@coderabbitai)

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

coderabbitai bot left a comment

Choose a reason for hiding this comment

julienrbrt commented Dec 8, 2023

Halimao commented Dec 8, 2023

julienrbrt commented Dec 8, 2023

Halimao commented Dec 8, 2023 • edited Loading

coderabbitai bot left a comment

Choose a reason for hiding this comment

julienrbrt left a comment • edited Loading

Choose a reason for hiding this comment

Halimao commented Dec 9, 2023 • edited Loading

coderabbitai bot left a comment

Choose a reason for hiding this comment

alexanderbez left a comment

Choose a reason for hiding this comment

alexanderbez Dec 9, 2023 • edited Loading

Choose a reason for hiding this comment

Halimao Dec 10, 2023

Choose a reason for hiding this comment

julienrbrt left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

julienrbrt commented Dec 10, 2023

coderabbitai bot left a comment

Choose a reason for hiding this comment

feat(client/keys): support display discreetly for `keys add` #18663

feat(client/keys): support display discreetly for `keys add` #18663

Halimao commented Dec 8, 2023 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 8, 2023 •

edited

Loading

Chat with CodeRabbit Bot (`@coderabbitai`)

CodeRabbit Configration File (`.coderabbit.yaml`)

Halimao commented Dec 8, 2023 •

edited

Loading

julienrbrt left a comment •

edited

Loading

Halimao commented Dec 9, 2023 •

edited

Loading

alexanderbez Dec 9, 2023 •

edited

Loading