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.

`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

`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 managed by an ownable object
Is ownable+pausable until chore: remove govdao dependency in r/gov/dao/bridge #3523 is resolved so that GovDAO can be the sole owner of the realm, and can manage the whitelist & pausability

`r/sys/names`

Functionality moved here, added tests
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.

`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`

TODO:

fix docs and remove other appearances of r/demo/users.

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-01-19T02:10:38Z

I found an issue in how packages are loaded during txtar, that creates cyclic dependencies, specifically related to filetests:

in r/gov/dao/v2/example_filetest.gno, we import, say r/sys/validators
r/sys/validators imports r/gov/dao/bridge
r/gov/dao/bridge imports r/gov/dao/v2 package
which, because of the r/gov/dao/v2/example_filetest.gno file technically, even though filetests are seen as "outside" packages (ie not part of the one found in the same dir), imports r/sys/validators, creating a cyclic dependency error.

This simple txtar fails on master:

loadpkg gno.land/r/gov/dao/v2

gnoland start

Removing filetests makes the txtar above pass.

I could be wrong but I assume it's related to the fact that filetests are not properly ignored during package loading, at least during testing.

This is currently blocking adding GovDAO to manage the packages listed in the PR description.

EDIT: Fixed

fix(txtar): ignore filetests when loading packages #3550

leohhhn · 2025-01-20T09:56:23Z

gno.land/genesis/genesis_txs.jsonl

-{"tx": {"msg":[{"@type":"/vm.m_call","caller":"g1us8428u2a5satrlxzagqqa5m6vmuze025anjlj","send":"","pkg_path":"gno.land/r/demo/boards","func":"CreateThread","args":["1","Simple echo example with coins","This is a simple test realm contract that demonstrates how to use the banker.\n\nSee [gno.land/r/demo/banktest/banktest.gno](/r/demo/banktest/banktest.gno) to see the original contract code.\n\nThis article will go through each line to explain how it works.\n\n```go\npackage banktest\n```\n\nThis package is locally named \"banktest\" (could be anything).\n\n```go\nimport (\n\t\"std\"\n)\n```\n\nThe \"std\" package is defined by the gno code in stdlibs/std/. \u003c/br\u003e\nSelf explanatory; and you'll see more usage from std later.\n\n```go\ntype activity struct {\n\tcaller   std.Address\n\tsent     std.Coins\n\treturned std.Coins\n\ttime     std.Time\n}\n\nfunc (act *activity) String() string {\n\treturn act.caller.String() + \" \" +\n\t\tact.sent.String() + \" sent, \" +\n\t\tact.returned.String() + \" returned, at \" +\n\t\tstd.FormatTimestamp(act.time, \"2006-01-02 3:04pm MST\")\n}\n\nvar latest [10]*activity\n```\n\nThis is just maintaining a list of recent activity to this contract.\nNotice that the \"latest\" variable is defined \"globally\" within\nthe context of the realm with path \"gno.land/r/demo/banktest\".\n\nThis means that calls to functions defined within this package\nare encapsulated within this \"data realm\", where the data is \nmutated based on transactions that can potentially cross many\nrealm and non-realm packge boundaries (in the call stack).\n\n```go\n// Deposit will take the coins (to the realm's pkgaddr) or return them to user.\nfunc Deposit(returnDenom string, returnAmount int64) string {\n\tstd.AssertOriginCall()\n\tcaller := std.GetOrigCaller()\n\tsend := std.Coins{{returnDenom, returnAmount}}\n```\n\nThis is the beginning of the definition of the contract function named\n\"Deposit\".  `std.AssertOriginCall() asserts that this function was called by a\ngno transactional Message. The caller is the user who signed off on this\ntransactional message. Send is the amount of deposit sent along with this\nmessage.\n\n```go\n\t// record activity\n\tact := \u0026activity{\n\t\tcaller:   caller,\n\t\tsent:     std.GetOrigSend(),\n\t\treturned: send,\n\t\ttime:     std.GetTimestamp(),\n\t}\n\tfor i := len(latest) - 2; i \u003e= 0; i-- {\n\t\tlatest[i+1] = latest[i] // shift by +1.\n\t}\n\tlatest[0] = act\n```\n\nUpdating the \"latest\" array for viewing at gno.land/r/demo/banktest: (w/ trailing colon).\n\n```go\n\t// return if any.\n\tif returnAmount \u003e 0 {\n```\n\nIf the user requested the return of coins...\n\n```go\n\t\tbanker := std.GetBanker(std.BankerTypeOrigSend)\n```\n\nuse a std.Banker instance to return any deposited coins to the original sender.\n\n```go\n\t\tpkgaddr := std.GetOrigPkgAddr()\n\t\t// TODO: use std.Coins constructors, this isn't generally safe.\n\t\tbanker.SendCoins(pkgaddr, caller, send)\n\t\treturn \"returned!\"\n```\n\nNotice that each realm package has an associated Cosmos address.\n\n\nFinally, the results are rendered via an ABCI query call when you visit [/r/demo/banktest:](/r/demo/banktest:).\n\n```go\nfunc Render(path string) string {\n\t// get realm coins.\n\tbanker := std.GetBanker(std.BankerTypeReadonly)\n\tcoins := banker.GetCoins(std.GetOrigPkgAddr())\n\n\t// render\n\tres := \"\"\n\tres += \"## recent activity\\n\"\n\tres += \"\\n\"\n\tfor _, act := range latest {\n\t\tif act == nil {\n\t\t\tbreak\n\t\t}\n\t\tres += \" * \" + act.String() + \"\\n\"\n\t}\n\tres += \"\\n\"\n\tres += \"## total deposits\\n\"\n\tres += coins.String()\n\treturn res\n}\n```\n\nYou can call this contract yourself, by vistiing [/r/demo/banktest](/r/demo/banktest) and the [quickstart guide](/r/demo/boards:testboard/4).\n"]}],"fee":{"gas_wanted":"2000000","gas_fee":"1000000ugnot"},"signatures":[{"pub_key":{"@type":"/tm.PubKeySecp256k1","value":"A+FhNtsXHjLfSJk1lB8FbiL4mGPjc50Kt81J7EKDnJ2y"},"signature":"iZX/llZlNTdZMLv1goCTgK2bWqzT8enlTq56wMTCpVxJGA0BTvuEM5Nnt9vrnlG6Taqj2GuTrmEnJBkDFTmt9g=="}],"memo":""}}
-{"tx": {"msg":[{"@type":"/vm.m_call","caller":"g1us8428u2a5satrlxzagqqa5m6vmuze025anjlj","send":"","pkg_path":"gno.land/r/demo/boards","func":"CreateThread","args":["1","TASK: Describe in your words","Describe in an essay (250+ words), on your favorite medium, why you are interested in gno.land and gnolang.\n\nReply here with a URL link to your written piece as a comment, for rewards.\n"]}],"fee":{"gas_wanted":"2000000","gas_fee":"1000000ugnot"},"signatures":[{"pub_key":{"@type":"/tm.PubKeySecp256k1","value":"AmG6kzznyo1uNqWPAYU6wDpsmzQKDaEOrVRaZ08vOyX0"},"signature":"4HBNtrta8HdeHj4JTN56PBTRK8GOe31NMRRXDiyYtjozuyRdWfOGEsGjGgHWcoBUJq6DepBgD4FetdqfhZ6TNQ=="}],"memo":""}}
-{"tx": {"msg":[{"@type":"/vm.m_call","caller":"g1manfred47kzduec920z88wfr64ylksmdcedlf5","send":"","pkg_path":"gno.land/r/demo/boards","func":"CreateThread","args":["1","Getting Started","This is a demo of Gno smart contract programming.  This document was\nconstructed by Gno onto a smart contract hosted on the data Realm\nname [\"gno.land/r/demo/boards\"](https://gno.land/r/demo/boards/)\n([github](https://github.com/gnolang/gno/tree/master/examples/gno.land/r/demo/boards)).\n\n\n\n## Build `gnokey`, create your account, and interact with Gno.\n\nNOTE: Where you see `--remote %%REMOTE%%` here, that flag can be replaced\nwith `--remote localhost:26657` for local testnets.\n\n### Build `gnokey`.\n\n```bash\ngit clone [email protected]:gnolang/gno.git\ncd ./gno\nmake\n```\n\n### Generate a seed/mnemonic code.\n\n```bash\n./build/gnokey generate\n```\n\nNOTE: You can generate 24 words with any good bip39 generator.\n\n### Create a new account using your mnemonic.\n\n```bash\n./build/gnokey add KEYNAME --recover\n```\n\nNOTE: `KEYNAME` is your key identifier, and should be changed.\n\n### Verify that you can see your account locally.\n\n```bash\n./build/gnokey list\n```\n\n## Interact with the blockchain:\n\n### Get your current balance, account number, and sequence number.\n\n```bash\n./build/gnokey query auth/accounts/ACCOUNT_ADDR --remote %%REMOTE%%\n```\n\nNOTE: you can retrieve your `ACCOUNT_ADDR` with `./build/gnokey list`.\n\n### Acquire testnet tokens using the official faucet.\n\nGo to https://gno.land/faucet\n\n### Create a board with a smart contract call.\n\nNOTE: `BOARDNAME` will be the slug of the board, and should be changed.\n\n```bash\n./build/gnokey maketx call KEYNAME --pkgpath \"gno.land/r/demo/boards\" --func \"CreateBoard\" --args \"BOARDNAME\" --gas-fee \"1000000ugnot\" --gas-wanted \"2000000\" --broadcast=true --chainid %%CHAINID%% --remote %%REMOTE%%\n```\n\nInteractive documentation: https://gno.land/r/demo/boards$help\u0026func=CreateBoard\n\nNext, query for the permanent board ID by querying (you need this to create a new post):\n\n```bash\n./build/gnokey query \"vm/qeval\" --data \"gno.land/r/demo/boards.GetBoardIDFromName(\\\"BOARDNAME\\\")\" --remote %%REMOTE%%\n```\n\n### Create a post of a board with a smart contract call.\n\nNOTE: If a board was created successfully, your SEQUENCE_NUMBER would have increased.\n\n```bash\n./build/gnokey maketx call KEYNAME --pkgpath \"gno.land/r/demo/boards\" --func \"CreateThread\" --args BOARD_ID --args \"Hello gno.land\" --args\\#file \"./examples/gno.land/r/demo/boards/example_post.md\" --gas-fee 1000000ugnot --gas-wanted 2000000 --broadcast=true --chainid %%CHAINID%% --remote %%REMOTE%%\n```\n\nInteractive documentation: https://gno.land/r/demo/boards$help\u0026func=CreateThread\n\n### Create a comment to a post.\n\n```bash\n./build/gnokey maketx call KEYNAME --pkgpath \"gno.land/r/demo/boards\" --func \"CreateReply\" --args \"BOARD_ID\" --args \"1\" --args \"1\" --args \"Nice to meet you too.\" --gas-fee 1000000ugnot --gas-wanted 2000000 --broadcast=true --chainid %%CHAINID%% --remote %%REMOTE%%\n```\n\nInteractive documentation: https://gno.land/r/demo/boards$help\u0026func=CreateReply\n\n```bash\n./build/gnokey query \"vm/qrender\" --data \"gno.land/r/demo/boards:BOARDNAME/1\" --remote %%REMOTE%%\n```\n\n### Render page with optional path expression.\n\nThe contents of `https://gno.land/r/demo/boards:` and `https://gno.land/r/demo/boards:gnolang` are rendered by calling\nthe `Render(path string)` function like so:\n\n```bash\n./build/gnokey query \"vm/qrender\" --data \"gno.land/r/demo/boards:gnolang\"\n```\n\n## Starting a local `gnoland` node:\n\n### Add test account.\n\n```bash\n./build/gnokey add test1 --recover\n```\n\nUse this mneonic:\n\u003e source bonus chronic canvas draft south burst lottery vacant surface solve popular case indicate oppose farm nothing bullet exhibit title speed wink action roast\n\n### Start `gnoland` node.\n\n```bash\n./build/gnoland\n```\n\nNOTE: This can be reset with `make reset`\n\n### Publish the \"gno.land/p/demo/avl\" package.\n\n```bash\n./build/gnokey maketx addpkg test1 --pkgpath \"gno.land/p/demo/avl\" --pkgdir \"examples/gno.land/p/demo/avl\" --deposit 100000000ugnot --gas-fee 1000000ugnot --gas-wanted 2000000 --broadcast=true --chainid %%CHAINID%% --remote localhost:26657\n```\n\n### Publish the \"gno.land/r/demo/boards\" realm package.\n\n```bash\n./build/gnokey maketx addpkg test1 --pkgpath \"gno.land/r/demo/boards\" --pkgdir \"examples/gno.land/r/demo/boards\" --deposit 100000000ugnot --gas-fee 1000000ugnot --gas-wanted 300000000 --broadcast=true --chainid %%CHAINID%% --remote localhost:26657\n```\n"]}],"fee":{"gas_wanted":"2000000","gas_fee":"1000000ugnot"},"signatures":[{"pub_key":{"@type":"/tm.PubKeySecp256k1","value":"AnK+a6mcFDjY6b/v6p7r8QFW1M1PgIoQxBgrwOoyY7v3"},"signature":"sHjOGXZEi9wt2FSXFHmkDDoVQyepvFHKRDDU0zgedHYnCYPx5/YndyihsDD5Y2Z7/RgNYBh4JlJwDMGFNStzBQ=="}],"memo":""}}
+{"tx": {"msg":[{"@type":"/vm.m_call","caller":"g1us8428u2a5satrlxzagqqa5m6vmuze025anjlj","pkg_path":"gno.land/r/gnoland/users/v1","func":"Register","args":["administrator123"]}],"fee":{"gas_wanted":"2000000","gas_fee":"1000000ugnot"},"signatures":[{"pub_key":{"@type":"/tm.PubKeySecp256k1","value":"AmG6kzznyo1uNqWPAYU6wDpsmzQKDaEOrVRaZ08vOyX0"},"signature":""}],"memo":""}}


Rm'd Invite txs as this doesn't exist anymore
Rm'd signatures from these transactions as they are not validated, and this makes it clear that's the case

thehowl · 2025-01-21T15:00:49Z

@leohhhn I see there's still some CI failures.

I don't think I have enough context on all the changes required and discussed, so I'm prioritizing my time elsewhere, but happy to provide a second review after a first one has been done.

leohhhn · 2025-01-21T15:29:47Z

@thehowl

Lint is failing due to the issue we discussed, and master is failing since I merged master yesterday. Didn't see it happen, I'll fix in a sec.

EDIT: Fixed

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 and others added 4 commits January 17, 2025 18:42

switch actions

cf74724

update btns

76f0e9e

Merge branch 'master' into refac/users

3c83640

update genesis params

56ead47

leohhhn mentioned this pull request Jan 19, 2025

Cyclic dependency with filetests #3546

Closed

leohhhn and others added 9 commits January 19, 2025 03:23

fix namespace txtar, add comment executor funcs, modify genesis_params

8940f9c

fix 2 txtars

4bb226d

add verifier tests

7be3dc0

update namespace test

b2940bb

Merge branch 'master' into refac/users

97f5ca7

add executors

bf81aa1

typo

877ccbc

embed users & boards source code into txtar

6efcb30

rm genesis txs, update readme, update docs-partially

2f2f085

Gno2D2 requested review from a team January 20, 2025 00:06

Kouteki added the in focus Core team is prioritizing this work label Jan 20, 2025

add registration & boards to genesis_txs, rm signatures

00cbbb5

leohhhn commented Jan 20, 2025

View reviewed changes

leohhhn and others added 3 commits January 20, 2025 10:56

rm leftover file

c6c5613

Merge branch 'master' into refac/users

ee6758f

Merge branch 'master' into refac/users

69ac851

Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Jan 21, 2025

fix broken test

b899731

leohhhn mentioned this pull request Jan 22, 2025

refactor(examples): use std.Address based behaviour #3580

Merged

rm leftover

1dc09e9

Gno2D2 removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Jan 24, 2025

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 Jan 19, 2025 •

edited

Loading

leohhhn Jan 20, 2025 •

edited

Loading

thehowl commented Jan 21, 2025

leohhhn commented Jan 21, 2025 •

edited

Loading

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

codecov bot commented Nov 21, 2024

Codecov Report

leohhhn commented Jan 19, 2025 • edited Loading

EDIT: Fixed

leohhhn Jan 20, 2025 • edited Loading

Choose a reason for hiding this comment

thehowl commented Jan 21, 2025

leohhhn commented Jan 21, 2025 • edited Loading

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`

leohhhn commented Jan 19, 2025 •

edited

Loading

leohhhn Jan 20, 2025 •

edited

Loading

leohhhn commented Jan 21, 2025 •

edited

Loading