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

Update bech32 human readable spec #2103

Merged
merged 2 commits into from
Aug 26, 2018
Merged

Update bech32 human readable spec #2103

merged 2 commits into from
Aug 26, 2018

Conversation

jaekwon
Copy link
Contributor

@jaekwon jaekwon commented Aug 21, 2018

The existing bech32 human readable prefix is too long esp for user accounts. This shortens them.

For employee accounts, we need to ensure that we convert correctly by first decoding using the old prefix, then encoding again with the new prefix, as it changes the last few base32 checksum characters.

@jaekwon jaekwon requested a review from zramsay as a code owner August 21, 2018 03:42
@jaekwon jaekwon changed the title Update bech32 human readible spec Update bech32 human readable spec Aug 21, 2018
@codecov
Copy link

codecov bot commented Aug 21, 2018

Codecov Report

Merging #2103 into develop will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #2103   +/-   ##
========================================
  Coverage    64.86%   64.86%           
========================================
  Files          115      115           
  Lines         6863     6863           
========================================
  Hits          4452     4452           
  Misses        2127     2127           
  Partials       284      284

| `cosmosaccpub` | Cosmos Account Public Key |
| `cosmosvaladdr` | Cosmos Consensus Address |
| `cosmosvalpub` | Cosmos Consensus Public Key|
| `cosa` | Cosmos Account Address |
Copy link
Contributor

Choose a reason for hiding this comment

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

This does indeed shorten them, but I actually find this harder to reason about & read.

Copy link
Collaborator

@fedekunze fedekunze Aug 21, 2018

Choose a reason for hiding this comment

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

cosa means "thing" in spanish

Copy link
Member

Choose a reason for hiding this comment

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

I'm with @alexanderbez here. I don't mind how verbose they are because the descriptions are actually human readable.

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree; human-readable prefixes are more helpful for newer users, for whom distinguishability is most critical.

Copy link
Contributor

Choose a reason for hiding this comment

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

++

Copy link
Member

Choose a reason for hiding this comment

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

I like that quite a bit. Much improved @jaekwon!

Copy link
Contributor

Choose a reason for hiding this comment

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

++

Copy link
Contributor

Choose a reason for hiding this comment

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

+++

Copy link
Contributor

Choose a reason for hiding this comment

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

++++

Copy link
Member

Choose a reason for hiding this comment

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

+++++

@fedekunze fedekunze added S:proposed spec T: API Breaking Breaking changes that impact APIs and the SDK only (not state machine). S:proposal accepted and removed S:proposed labels Aug 21, 2018
@alexanderbez
Copy link
Contributor

fat fingered -- sorry!

@alexanderbez alexanderbez reopened this Aug 23, 2018
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.

There seems to be consensus on this. Should we merge and create a PR for the actual Bech32 changes?

@cwgoes
Copy link
Contributor

cwgoes commented Aug 23, 2018

@alexanderbez I don't think the Markdown file was updated to reflect the comments?

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.

Indeed @cwgoes -- you are correct

@jaekwon jaekwon merged commit 305589f into develop Aug 26, 2018
| `cosmos` | Cosmos Account Address |
| `cosmospub` | Cosmos Account Public Key |
| `cosmosval` | Cosmos Validator Consensus Address |
| `cosmosval` | Cosmos Validator Consensus Public Key|
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oops, merged the wrong thing, will fix this to be "cosmosvalpub" on develop.

@cwgoes cwgoes deleted the jae/bech32 branch August 27, 2018 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S:proposal accepted spec T: API Breaking Breaking changes that impact APIs and the SDK only (not state machine).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants