Kaz-ookid commented 2 months ago

PR Description

Context

Throughout the app, users were previously referred to by their PoP Token, which was not user-friendly. This PR implements a deterministic username system to improve the user experience. A detailed documentation of the project's idea and motivations is to be found in #1915. It is recommended to read it before diving into this PR.

Summary of Changes

This PR implements the deterministic username system across various parts of the app, ensuring a consistent and user-friendly display of usernames derived from PoP Tokens. The changes have been done in collaboration with FE2 (#1918) to ensure consistency throughout both systems.

General Changes

PublicKey class now includes the getUsername() function, returning the username version of the hash.
Added a mnemonic deterministic username generator to GeneralUtils. The usernames are a concatenation of two mnemonics words, and a 4 digits number. The number corresponds to the 4 first digits in a token's hash, starting from the left

Example:

token : d_xeXEsurEnyWOp04mrrMxC3m4cS-3jK_9_Aw-UYfww= mnemonics words generated form the hash : spoon, issue first 4 digits : 0434 final username : spoonissue0434

Token

TokenFragment.kt: When participating in a RollCall, you receive a PoP Token that you can see in the Token Tab. The username is now displayed above the hash of the token in the Token tab.

Social Media

ChirpListAdapter.kt: The chirps feed now displays the username of a user instead of the full PoP Token hash.

Roll Call

RollCallArrayAdapter.kt, RollCallFragment.kt: The list of attendees now displays the username above the Token hash. Structural changes were made in RollCallArrayAdapter to include two TextViews per item, and enhancing the class overall.

Digital Cash

Refactored the digital cash folder to work with PublicKey instead of String (token hashes).
Displayed the username in appropriate places, simplifying the sending workflow and transaction history readability.
For organizer transactions, the full public key hash is displayed with "(organizer)" appended, as the public key is longer than 32 bits and cannot be instantiated as PublicKey. Also, it juste made no sense to label this public key under a username anyway.
Fixed a bug in the transaction history where title and value were inverted ("From" label, and Transaction ID). see screenshots below.
Fixed a bug where the current user's token was not correctly removed from the selection Spinner when issuing as an organizer, causing a crash if it was selected.

Bugs and Documentation

Numerous bugs were discovered during implementation and have been well documented.

Screenshots

Token fragment displaying the username.
Chirps feed displaying the username.
Roll call displaying the username.
Digital cash sending activity displaying the username.
Digital cash receipt activity displaying the username.
Digital cash transaction history activity displaying the username and the organizer hash.
Digital cash issuing activity.
Bugged UI in transaction history showing the corrected title and value (now fixed).

matteosz commented 2 months ago

Also, now that I'm looking at the screenshots, perhaps it's better to have the username using underscores or capitalized letters so the 2 words are more easily recognizable e.g. HomeSoldier0864, or home_soldier_0864, or any other fancy way of splitting the 2 words that you may prefer

Kaz-ookid commented 2 months ago

Also, now that I'm looking at the screenshots, perhaps it's better to have the username using underscores or capitalized letters so the 2 words are more easily recognizable e.g. HomeSoldier0864, or home_soldier_0864, or any other fancy way of splitting the 2 words that you may prefer

I'll check with FE1 and modify before merging

edit : we decided to go for the capitalized version : HomeSoldier0864