Displaying Deterministic Username for a given Token #1921

Kaz-ookid · 2024-06-12T19:15:51Z

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).

…ing and receipt

…rator in GeneralUtils

Refactored RollCall attendee list UI to show username above the hash

# Conflicts: # fe2-android/app/src/main/java/com/github/dedis/popstellar/ui/lao/event/rollcall/RollCallArrayAdapter.kt # fe2-android/app/src/main/java/com/github/dedis/popstellar/ui/lao/event/rollcall/RollCallFragment.kt # fe2-android/app/src/main/res/values/strings.xml

…ername' into work-fe2-maxime-deterministic-username # Conflicts: # fe2-android/app/src/main/java/com/github/dedis/popstellar/utility/Constants.kt

matteosz

Great job! That's going to be a great feature :)

Just some comments

fe2-android/app/src/main/java/com/github/dedis/popstellar/model/objects/security/PublicKey.kt

.../app/src/main/java/com/github/dedis/popstellar/ui/lao/digitalcash/DigitalCashSendFragment.kt

...droid/app/src/main/java/com/github/dedis/popstellar/ui/lao/digitalcash/HistoryListAdapter.kt

...mmon/java/com/github/dedis/popstellar/testutils/pages/lao/digitalcash/HistoryPageObject.java

matteosz · 2024-06-26T20:34:30Z

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 · 2024-06-26T22:02:42Z

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

- changed getUsername to getLabel (toUsername to label) in PublicKey - refactored getPublicKeyFromUsername to avoid code duplication (now in PublicKey as static) - removed unnecessary comments - disabled serialization of label in PublicKey

…ername' into work-fe2-maxime-deterministic-username # Conflicts: # fe2-android/app/src/main/java/com/github/dedis/popstellar/model/objects/security/PublicKey.kt # fe2-android/app/src/main/java/com/github/dedis/popstellar/ui/lao/digitalcash/DigitalCashIssueFragment.kt # fe2-android/app/src/main/java/com/github/dedis/popstellar/ui/lao/digitalcash/DigitalCashSendFragment.kt

sonarqubecloud · 2024-06-27T08:27:54Z

Quality Gate passed for 'PoP - PoPCHA-Web-Client'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

sonarqubecloud · 2024-06-27T08:30:29Z

Quality Gate passed for 'PoP - Be2-Scala'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

sonarqubecloud · 2024-06-27T08:30:49Z

Quality Gate passed for 'PoP - Be1-Go'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

sonarqubecloud · 2024-06-27T08:36:14Z

Quality Gate passed for 'PoP - Fe2-Android'

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
70.9% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

quadcopterman

Looks good to me, just one comment

quadcopterman · 2024-06-27T11:07:28Z

...oid/app/src/test/unit/java/com/github/dedis/popstellar/model/objects/security/KeyPairTest.kt

+    Assert.assertEquals(digits, pk.getLabel().substring(pk.getLabel().length - USERNAME_DIGITS))
+  }
+
+  @Test


Maybe you could add one or two more tests then just the empty username for the generateUsername function

quadcopterman · 2024-06-27T11:10:07Z

Oh too late, it was merged while I was reviewing it

Kaz-ookid added 8 commits June 11, 2024 15:07

finding some way to generate usernames

22811d7

username display in chirps feed

f57e54e

username display in DigitalCash : transactions history, issuing, send…

79224d1

…ing and receipt

PublicKey class now holding getUsername + username deterministic gene…

e590d64

…rator in GeneralUtils

Refactored RollCall attendee list UI to show username above the hash

6833acb

Refactored RollCall attendee list UI to show username above the hash

removed temporary tests

f58b83e

username in token fragment

287c210

documentations + fmt

fea4ea3

Kaz-ookid added the fe2-android label Jun 12, 2024

Kaz-ookid self-assigned this Jun 12, 2024

removed debug logs

07564de

Kaz-ookid mentioned this pull request Jun 12, 2024

[BUG] Digital Cash Transactions History Wrong Receiver Displayed #1923

Open

6 tasks

Kaz-ookid added 10 commits June 13, 2024 00:23

merged master + fmt

1fb3c9d

fixed a crash

d680f3e

fixed digitalcash issue crashing when selecting our own token

afd9068

updated RollCall QR, now showing username + pk hash

d1a979e

fixed tests failing after refactor

bc0ecbe

adding tests for username generation + DigitalCash coverage

1b1d316

adding tests for username generation + DigitalCash coverage

8da40c8

Merge remote-tracking branch 'origin/work-fe2-maxime-deterministic-us…

d073a48

…ername' into work-fe2-maxime-deterministic-username # Conflicts: # fe2-android/app/src/main/java/com/github/dedis/popstellar/utility/Constants.kt

tests for coins issuing elements

38eb0fc

Kaz-ookid marked this pull request as ready for review June 26, 2024 18:48

Kaz-ookid requested a review from a team as a code owner June 26, 2024 18:48

matteosz requested changes Jun 26, 2024

View reviewed changes

Kaz-ookid added 3 commits June 27, 2024 00:07

addressing comments :

9ef49f1

- changed getUsername to getLabel (toUsername to label) in PublicKey - refactored getPublicKeyFromUsername to avoid code duplication (now in PublicKey as static) - removed unnecessary comments - disabled serialization of label in PublicKey

addressing comments :

432a370

- changed getUsername to getLabel (toUsername to label) in PublicKey - refactored getPublicKeyFromUsername to avoid code duplication (now in PublicKey as static) - removed unnecessary comments - disabled serialization of label in PublicKey

changed username format (now capitalized first letter for words)

ed05d3a

matteosz approved these changes Jun 27, 2024

View reviewed changes

quadcopterman self-requested a review June 27, 2024 09:50

Kaz-ookid added this pull request to the merge queue Jun 27, 2024

Merged via the queue into master with commit d2a394e Jun 27, 2024
17 checks passed

Kaz-ookid deleted the work-fe2-maxime-deterministic-username branch June 27, 2024 11:07

quadcopterman reviewed Jun 27, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Displaying Deterministic Username for a given Token #1921

Displaying Deterministic Username for a given Token #1921

Kaz-ookid commented Jun 12, 2024 •

edited

Loading

matteosz left a comment

matteosz commented Jun 26, 2024

Kaz-ookid commented Jun 26, 2024 •

edited

Loading

sonarqubecloud bot commented Jun 27, 2024

sonarqubecloud bot commented Jun 27, 2024

sonarqubecloud bot commented Jun 27, 2024

sonarqubecloud bot commented Jun 27, 2024

quadcopterman left a comment

quadcopterman Jun 27, 2024

quadcopterman commented Jun 27, 2024

Displaying Deterministic Username for a given Token #1921

Displaying Deterministic Username for a given Token #1921

Conversation

Kaz-ookid commented Jun 12, 2024 • edited Loading

PR Description

Context

Summary of Changes

General Changes

Example:

Token

Social Media

Roll Call

Digital Cash

Bugs and Documentation

Screenshots

matteosz left a comment

Choose a reason for hiding this comment

matteosz commented Jun 26, 2024

Kaz-ookid commented Jun 26, 2024 • edited Loading

sonarqubecloud bot commented Jun 27, 2024

Quality Gate passed for 'PoP - PoPCHA-Web-Client'

sonarqubecloud bot commented Jun 27, 2024

Quality Gate passed for 'PoP - Be2-Scala'

sonarqubecloud bot commented Jun 27, 2024

Quality Gate passed for 'PoP - Be1-Go'

sonarqubecloud bot commented Jun 27, 2024

Quality Gate passed for 'PoP - Fe2-Android'

quadcopterman left a comment

Choose a reason for hiding this comment

quadcopterman Jun 27, 2024

Choose a reason for hiding this comment

quadcopterman commented Jun 27, 2024

Kaz-ookid commented Jun 12, 2024 •

edited

Loading

Kaz-ookid commented Jun 26, 2024 •

edited

Loading