Skip to content

Conversation

@GBKS
Copy link
Contributor

@GBKS GBKS commented May 20, 2022

Adds two paragraphs to the Address page in the Glossary.

  • Visual formatting of addresses
  • Validation of addresses

Also added a visual for the address reuse paragraph.

I could not find any good info on exactly how well address can be validated. In a recent podcast, someone said that in some formats, it is possible to identify which character is wrong. Maybe someone with more technical knowledge in this area could chime in.

This is only about on-chain addresses. We could consider what validation techniques we need in lightning in a separate issue (if there are any, haven't thought about it yet).

♠️Look, it's the preview!♣️

Closes #107, closes #806

Adds two paragraphs to the Address page in the Glossary.
- Visual formatting of addresses
- Validation of addresses

I could not find any good info on exactly how well address can be validated. In a recent podcast, someone said that in some formats, it is possible to identify which character is wrong. Maybe someone with more technical knowledge in this area could chime in.

Closes #107, closes #806
@GBKS GBKS added Copy Task is about improving text. Design Task is about designing something. Glossary Referring to the Glossary section. labels May 20, 2022
@GBKS GBKS self-assigned this May 20, 2022
enyipreshious
enyipreshious previously approved these changes May 20, 2022
@paulosacramento
Copy link
Contributor

Excellent! I love the green check / red exclamation point. Simple design features that can mean the world.

One small addition/question: is it a best practice to present addresses using monospaced fonts?

@GBKS
Copy link
Contributor Author

GBKS commented May 20, 2022

Something I forgot to add is that showing the first 4 characters of an address is not enough to actually compare anything. All SegWit and Taproot addresses start with "bc1q" and "bc1p" respectively. That means the first 4 characters convey no unique information. So if an address is shortened, it should be "XXXX XXXX...XXXX" and not "XXXX...XXXX".

@paulosacramento I don't think mono space fonts are 100% necessary at all times. I used mono space in the modal because that is specifically for investigating the address closely.

@paulosacramento
Copy link
Contributor

Copy link
Collaborator

@sbddesign sbddesign left a comment

Choose a reason for hiding this comment

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

I overall agree with the text and it looks very nice. I left an inline suggestion to clarify that segwit and taproot addresses have the advanced error detection you were trying to describe.

The majority of these images feature the old legacy addresses. Maybe it would be good to work in some segwit or taproot addresses? While we definitely need to encourage compatibility with sending to these legacy addresses, it just seems weird to have the old address format so prevalent in the imagery.

Bosch-0
Bosch-0 previously approved these changes May 23, 2022
Copy link
Collaborator

@Bosch-0 Bosch-0 left a comment

Choose a reason for hiding this comment

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

LGTM!

@GBKS GBKS dismissed stale reviews from Bosch-0 and enyipreshious via 2ab3015 May 23, 2022 07:19
@GBKS
Copy link
Contributor Author

GBKS commented May 23, 2022

Thanks for the feedback. I added notes about mono space fonts, updated the images to SegWit addresses, and resolved the conflict.

Copy link
Collaborator

@sbddesign sbddesign left a comment

Choose a reason for hiding this comment

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

🎉

@sbddesign sbddesign merged commit 900ebaa into master May 23, 2022
@GBKS GBKS deleted the feature/address-validation-and-formatting branch December 20, 2022 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Copy Task is about improving text. Design Task is about designing something. Glossary Referring to the Glossary section.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improvements regarding address validation Add tips for visual formatting of addresses to the Glossary> Addresses page

6 participants