refactor: `r/demo/users` #3166

leohhhn · 2024-11-20T11:26:05Z

Description

Addresses: #2827

This PR refactors the current r/demo/users & r/sys/users system in accordance to the issue mentioned above. Below is the high-level overview of the new system.

It also makes a small change to the p/demo/releases lib.

`r/gnoland/users/v1`

Fully replaces r/demo/users
Is the main entry point for users looking to register a name, create an alias (rename themselves), or delete their username
Implements allowed username pattern checks as per the issue r/sys/users Mainnet v1 (mvp) & v2 #2827
Is pausable by GovDAO, contains no other administration functionality
Contains a nice UI/render for users (please suggest improvements) - see bottom
Uses r/demo/profile for displaying extra information about a user (to be moved to r/nt/profiles or r/gnoland/profiles)

`r/sys/users`

Namespace check moved to r/sys/names
Contains the address/name <> user stores, to which only whitelisted realms can write
Contains resolver functions & other useful getters
Is callable only by whitelisted realms, such as r/gnoland/users/v1, etc.
Whitelist is fully managed by GovDAO (after chore: remove govdao dependency in r/gov/dao/bridge #3523 was resolved)

`r/sys/names`

Namespace checking functionality moved here (from r/sys/users), added tests, as discussed with @moul
Verify function now only upgradeable with a GovDAO prop instead of previously being ownable
Verify functionality is now not pausable and on by default, as per discussions with @moul. This means Portal Loop will need to be patched upon merging this PR, as many txs will fail due to not having proper namespace permissions. The namespace verify functionality is off by default, but should be enabled in genesis via r/sys/names.Enable(). The Portal Loop will indeed need to be patched if we enable this functionality.

`Keeper` & genesis params

Updated the VM keeper to call r/sys/names for the namespace check instead of r/sys/users
Updated params to load r/sys/names, which the keeper will call

`r/gnoland/users/v1`

`r/gnoland/users`

Currently this is the "releases" page for the user registration systems (example data):

Contributors' checklist...

Added new tests, or not needed, or not feasible
Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
Updated the official documentation or not needed
No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
Added references to related issues and PRs
Provided any useful hints for running manual tests

codecov · 2024-11-21T05:45:57Z

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

# Conflicts: # examples/gno.land/r/demo/users/users.gno # examples/gno.land/r/demo/users/z_10_filetest.gno # examples/gno.land/r/demo/users/z_11_filetest.gno # examples/gno.land/r/demo/users/z_11b_filetest.gno # examples/gno.land/r/demo/users/z_2_filetest.gno # examples/gno.land/r/demo/users/z_3_filetest.gno # examples/gno.land/r/demo/users/z_4_filetest.gno # examples/gno.land/r/demo/users/z_5_filetest.gno # examples/gno.land/r/demo/users/z_6_filetest.gno # examples/gno.land/r/demo/users/z_7_filetest.gno # examples/gno.land/r/demo/users/z_7b_filetest.gno # examples/gno.land/r/demo/users/z_8_filetest.gno # examples/gno.land/r/demo/users/z_9_filetest.gno # examples/gno.land/r/sys/users/verify.gno

leohhhn · 2025-02-10T17:58:11Z

Considerations:

We should probably limit the # of times users can update their name - related comment
Should we allow users to go back to a previous name of theirs? Users still keep the permission to deploy their previous namespaces.

moul · 2025-02-12T03:08:14Z

examples/gno.land/r/gnoland/users/v1/errors.gno

+	ErrInvalidUsername = errors.New("r/gnoland/users: invalid username")
+	ErrPaused          = errors.New("r/gnoland/users: paused")


Keep it like this for now 👍 , but the need to prefix with "package realm" shows that we are not using gno errors as much as we should, yet.

examples/gno.land/r/gnoland/users/v1/render.gno

moul · 2025-02-12T03:27:22Z

examples/gno.land/r/gnoland/users/v1/users.gno

+
+// DeleteUser makes all names associated with the `PrevRealm()` address unresolvable.
+// WARN: After deletion, the same address WILL NOT be able to register a new name.
+func DeleteUser() error {


Same for now; make it a GovDAO feature until we determine the appropriate requirements.

moul · 2025-02-12T03:29:33Z

examples/gno.land/r/gov/dao/v2/render.gno

 			authorDisplayText := prop.Author().String()
 			if user != nil {
-				authorDisplayText = ufmt.Sprintf("[%s](/r/demo/users:%s)", user.Name, user.Name)
+				authorDisplayText = ufmt.Sprintf("[%s](/r/sys/users:%s)", user.Name(), user.Name())
 			}

 			out += ufmt.Sprintf("**Author: %s**\n\n", authorDisplayText)


this whole thing should be done like this:

user := users.GetUserByAddress(prop.Author()) out += ufmt.Sprintf("**Author: %s**\n\n", user.RenderLink())

moul · 2025-02-12T03:32:55Z

examples/gno.land/r/gov/dao/v2/render.gno

 			authorDisplayText := prop.Author().String()
 			if user != nil {
-				authorDisplayText = ufmt.Sprintf("[%s](/r/demo/users:%s)", user.Name, user.Name)
+				authorDisplayText = ufmt.Sprintf("[%s](/r/sys/users:%s)", user.Name(), user.Name())
 			}

 			out += ufmt.Sprintf("**Author: %s**\n\n", authorDisplayText)


this whole thing should be done like this, because a very common workflow:

user := users.GetUserByAddress(prop.Author()) out += ufmt.Sprintf("**Author: %s**\n\n", user.String())

moul · 2025-02-12T03:34:14Z

examples/gno.land/r/gov/dao/v2/render.gno

 	}

 	if authorUsername != "" {
-		out += ufmt.Sprintf("**Author: [%s](/r/demo/users:%s)**\n\n", authorUsername, authorUsername)
+		out += ufmt.Sprintf("**Author: [%s](/r/gnoland/users/v1:%s)**\n\n", authorUsername, authorUsername)
 	} else {
 		out += ufmt.Sprintf("**Author: %s**\n\n", p.Author().String())


same https://github.com/gnolang/gno/pull/3166/files#r1951927801

moul · 2025-02-12T03:35:37Z

examples/gno.land/r/sys/names/verifier.gno

+type verifierFunc func(address std.Address, name string) bool
+
+var (
+	Ownable = ownable.NewWithAddress("g1manfred47kzduec920z88wfr64ylksmdcedlf5") // @moul > dropped in genesis via Enable


govdao or #3700

ohhhhh, no sorry, it's for the enable fuse, that's ok.

would be better to be a random address, not mine. ideally one without a private key if this is a genesis msg without signature.

moul · 2025-02-12T03:37:30Z

examples/gno.land/r/sys/names/verifier.gno

+	enabled   = false           // set to true in genesis
+)
+
+const VerifyFuncUpdatedEvent = "VerifyFuncUpdated"


remove this

moul · 2025-02-12T03:39:29Z

examples/gno.land/r/sys/names/verifier.gno

+}
+
+// NewVerifyCallExecutor allows updating the verifier function via a GovDAO proposal
+func NewVerifyCallExecutor(newVerifyCall func(enabled bool, address std.Address, name string) bool) dao.Executor {


I think we should remove this and deploy a r/sys/names/v2 if we want to change the logic. It's very easy to modify using the params keeper, which simply points to an arbitrary realm address.

moul · 2025-02-12T07:05:20Z

examples/gno.land/r/sys/users/users.gno

+}
+
+func makeUserDataSafe(data interface{}) interface{} {
+	u := data.(*UserData)


Suggested change

u := data.(*UserData)

u := *(data.(*UserData))

moul · 2025-02-12T07:09:16Z

examples/gno.land/r/sys/users/admin.gno

+
+const gusersv1 = "gno.land/r/gnoland/users/v1" // preregistered with store write perms
+
+var callerWhitelist = addrset.Set{}


Suggested change

var callerWhitelist = addrset.Set{}

var controllers = addrset.Set{} // caller whitelist

moul · 2025-02-12T07:20:55Z

examples/gno.land/r/sys/users/admin.gno

+// IsOnWhitelist checks if the given address has
+// permission to write to the user store
+func IsOnWhitelist(addr std.Address) bool {
+	return callerWhitelist.Has(addr)
+}


remove this.

moul · 2025-02-12T07:21:59Z

examples/gno.land/r/sys/users/admin.gno

+}
+
+// NewAddWhitelistedAddrExecutor allows GovDAO to add a whitelisted caller
+func NewAddWhitelistedAddrExecutor(addr std.Address) dao.Executor {


Suggested change

func NewAddWhitelistedAddrExecutor(addr std.Address) dao.Executor {

func ProposeNewController(addr std.Address) dao.Executor {

examples/gno.land/r/sys/users/store.gno

moul · 2025-02-12T07:30:57Z

examples/gno.land/r/sys/users/store.gno

+
+// Validate validates username and address passed in
+func validateName(username string) error {
+	if strings.TrimSpace(username) == "" {


Space trimming shouldn't be for validation but for sanitization. Make validateName a helper function that also sanitizes, and use it for every function that could set a new name in the store.

update user rendering

38c2b9a

github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label Nov 20, 2024

github-actions bot assigned leohhhn Nov 20, 2024

leohhhn and others added 2 commits November 20, 2024 21:20

save

4970a59

Merge branch 'master' into refac/users

833576b

register

2c4f497

zivkovicmilos self-requested a review November 21, 2024 06:03

leohhhn and others added 8 commits November 21, 2024 17:54

Merge branch 'master' into refac/users

6f9b787

add gnoland/users, expand sys/users

74d6ae7

add resolving

487775b

pausable to sys/users

25c3fa1

update regex & add godoc

d06515e

update regex & add godoc

905bc10

save

970b3f0

save

0ad5292

leohhhn changed the title ~~refactor: r/demo/users~~ refactor: r/demo/users Nov 21, 2024

leohhhn and others added 7 commits November 22, 2024 00:51

fix err name

3d72544

Merge branch 'master' into refac/users

2f68087

Merge branch 'master' into refac/users

114de1b

add paginated fetch

a3ed4e6

add list by prefix

b7cc608

fix imports

3e58017

add admin tests

69cfe1c

github-actions bot added 📦 🤖 gnovm Issues or PRs gnovm related 📦 🌐 tendermint v2 Issues or PRs tm2 related 📦 ⛰️ gno.land Issues or PRs gno.land package related labels Nov 25, 2024

leohhhn force-pushed the refac/users branch from e70920e to 69cfe1c Compare November 26, 2024 11:04

leohhhn added 2 commits November 26, 2024 12:05

fix

46fcc93

leohhhn requested review from moul and n0izn0iz and removed request for n0izn0iz February 10, 2025 15:28

leohhhn and others added 6 commits February 10, 2025 16:28

Merge branch 'master' into refac/users

e4a3bef

update u/ rendering

e969c9b

update rendering :)

c7a78d7

update actions bar

be3c822

update docs

6dd5e99

decode > isvalid

246d7c5

leohhhn and others added 5 commits February 11, 2025 15:12

Merge branch 'master' into refac/users

78fb899

add govdao to make release changes

6710db2

add if cond

018afa0

add cmt

d548cdd

rm newline

1688699

moul reviewed Feb 12, 2025

View reviewed changes

examples/gno.land/r/gnoland/users/v1/render.gno Show resolved Hide resolved

moul reviewed Feb 12, 2025

View reviewed changes

examples/gno.land/r/sys/users/store.gno Show resolved Hide resolved

moul reviewed Feb 12, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: `r/demo/users` #3166

refactor: `r/demo/users` #3166

leohhhn commented Nov 20, 2024 •

edited

Loading

codecov bot commented Nov 21, 2024

leohhhn commented Feb 10, 2025 •

edited

Loading

moul Feb 12, 2025

moul Feb 12, 2025

moul Feb 12, 2025

moul Feb 12, 2025 •

edited

Loading

moul Feb 12, 2025

moul Feb 12, 2025

moul Feb 12, 2025

moul Feb 12, 2025

moul Feb 12, 2025

moul Feb 12, 2025

moul Feb 12, 2025

moul Feb 12, 2025

moul Feb 12, 2025

moul Feb 12, 2025

moul Feb 12, 2025

		ErrInvalidUsername = errors.New("r/gnoland/users: invalid username")
		ErrPaused = errors.New("r/gnoland/users: paused")


		const gusersv1 = "gno.land/r/gnoland/users/v1" // preregistered with store write perms

		var callerWhitelist = addrset.Set{}

	var callerWhitelist = addrset.Set{}
	var controllers = addrset.Set{} // caller whitelist

	func NewAddWhitelistedAddrExecutor(addr std.Address) dao.Executor {
	func ProposeNewController(addr std.Address) dao.Executor {

refactor: r/demo/users #3166

Are you sure you want to change the base?

refactor: r/demo/users #3166

Conversation

leohhhn commented Nov 20, 2024 • edited Loading

Description

r/gnoland/users/v1

r/sys/users

r/sys/names

Keeper & genesis params

r/gnoland/users/v1

r/gnoland/users

codecov bot commented Nov 21, 2024

Codecov Report

leohhhn commented Feb 10, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moul Feb 12, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

refactor: `r/demo/users` #3166

refactor: `r/demo/users` #3166

leohhhn commented Nov 20, 2024 •

edited

Loading

`r/gnoland/users/v1`

`r/sys/users`

`r/sys/names`

`Keeper` & genesis params

`r/gnoland/users/v1`

`r/gnoland/users`

leohhhn commented Feb 10, 2025 •

edited

Loading

moul Feb 12, 2025 •

edited

Loading