add comment for PreferredName

This commit is contained in:
frank 2024-03-07 19:37:22 +08:00
parent deb56c2c81
commit 327f171e13
1 changed files with 12 additions and 3 deletions

View File

@ -160,6 +160,15 @@ type Settings struct {
NotificationsEnabled bool `json:"notifications-enabled?,omitempty"`
PhotoPath string `json:"photo-path"`
PinnedMailserver *json.RawMessage `json:"pinned-mailservers,omitempty"`
// PreferredName represents the user's preferred Ethereum Name Service (ENS) name.
// If a user has multiple ENS names, they can select one as the PreferredName.
// When PreferredName is set, it takes precedence over the DisplayName for displaying the user's name.
// If PreferredName is empty or doesn't match any of the user's ENS names, the DisplayName is used instead.
//
// There is a race condition between updating DisplayName and PreferredName, where the account.Name field
// could be incorrectly updated based on the order in which the backup messages (BackedUpProfile/BackedUpSettings) arrive.
// To handle this race condition, the code checks the LastSynced clock value for both DisplayName and PreferredName,
// and updates account.Name with the value that has the latest clock
PreferredName *string `json:"preferred-name,omitempty"`
PreviewPrivacy bool `json:"preview-privacy?"`
PublicKey string `json:"public-key"`