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

refactor: keyring errors #14974

Merged
merged 7 commits into from
Feb 9, 2023
Merged

refactor: keyring errors #14974

merged 7 commits into from
Feb 9, 2023

Conversation

JulianToledano
Copy link
Contributor

Description

Closes:
#14970

As a part of #14940 this PR:

  • Uses cockroachdb/errors
  • Define errors as variables
  • Cosmetic style changes

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@JulianToledano JulianToledano requested a review from a team as a code owner February 9, 2023 13:07
tac0turtle
tac0turtle reviewed Feb 9, 2023
View reviewed changes
crypto/keyring/signing_algorithms_test.go Outdated
"github.com/cosmos/cosmos-sdk/crypto/hd"
"github.com/stretchr/testify/require"
Copy link
Member

@tac0turtle tac0turtle Feb 9, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please revert this import move.

We follow

std libs

third party libs

internal libs

seems like it moved around in other files as well

@julienrbrt julienrbrt linked an issue Feb 9, 2023 that may be closed by this pull request
Refactor of erros in keyring #14970
Closed
julienrbrt
julienrbrt reviewed Feb 9, 2023
View reviewed changes
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's many public errors and a few that are very specific and only used once.
What's the reason of extracting them all?

crypto/keyring/errors.go
// ErrLegacyToRecord is raised when cannot be converted to a Record
ErrLegacyToRecord = errors.New("unable to convert LegacyInfo to Record")
// ErrUnknownLegacyType is raised when a LegacyInfo type is unknown.
ErrUnknownLegacyType = errors.New("unknown LegacyInfo type")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Curious why extracting very specific errors like that. Will they be reused?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All this errors are returned at some point. I decided to make them public so other package can check against them and do what is convenient

alexanderbez
alexanderbez approved these changes Feb 9, 2023
View reviewed changes
Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for using cockroach errors 🙌

@julienrbrt julienrbrt added this pull request to the merge queue Feb 9, 2023
@julienrbrt
Copy link
Member

julienrbrt commented Feb 9, 2023 •
edited
Loading

@JulianToledano I think you still need to rebase. That new queue thing does not seem to do that with your fork.

@julienrbrt julienrbrt removed this pull request from the merge queue due to a manual request Feb 9, 2023
@julienrbrt julienrbrt added this pull request to the merge queue Feb 9, 2023
@julienrbrt julienrbrt removed this pull request from the merge queue due to a manual request Feb 9, 2023
@julienrbrt julienrbrt enabled auto-merge (squash) February 9, 2023 18:23
@julienrbrt julienrbrt merged commit a0aef94 into cosmos:main Feb 9, 2023
@JulianToledano JulianToledano deleted the feat/keyring-refactor-phase1 branch February 9, 2023 18:37
@faddat faddat mentioned this pull request Mar 28, 2023
Closed
19 tasks
tsenart pushed a commit to meka-dev/cosmos-sdk that referenced this pull request Apr 12, 2023
@JulianToledano @tsenart
refactor: keyring errors (cosmos#14974)
4ef9d2a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tac0turtle tac0turtle tac0turtle left review comments

@alexanderbez alexanderbez alexanderbez approved these changes

@julienrbrt julienrbrt julienrbrt approved these changes

@samricotta samricotta samricotta approved these changes

@aaronc aaronc Awaiting requested review from aaronc

@likhita-809 likhita-809 Awaiting requested review from likhita-809

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Refactor of erros in keyring
5 participants
@JulianToledano @julienrbrt @alexanderbez @tac0turtle @samricotta