feat: users namespace

docs/concepts/namespaces.md

@@ -4,13 +4,15 @@ id: namespaces
 
 # Namespaces
 
-Namespaces provide users with the exclusive capability to publish contracts under their designated namespaces, similar to GitHub's user and organization model.
+Namespaces provide users with the exclusive capability to publish contracts under their designated namespaces,
+similar to GitHub's user and organization model.
 
-This feature is currently a work in progress (WIP). To learn more about namespaces, please checkout https://github.com/gnolang/gno/issues/1107.
+:::warn This feature isn't enabled by default on the chain and is currently only on test4.gno.land.
 
 # Package Path
 
-A package path is a unique identifier for each package/realm. It specifies the location of the package source code which helps differentiate it from others. You can use a package path to:
+A package path is a unique identifier for each package/realm. It specifies the location of the package source
+code which helps differentiate it from others. You can use a package path to:
 
 - Call a specific function from a package/realm. (e.g using `gnokey maketx call`)
 - Import it in other packages/realms.
@@ -21,7 +23,9 @@ Here's a breakdown of the structure of a package path:
 - Type: Defines the type of package.
     - `p/`: [Package](packages.md)
     - `r/`: [Realm](realms.md)
-- Namespace: A namespace can be included after the type (e.g., user or organization name). Namespaces are a way to group related packages or realms, but currently ownership cannot be claimed. (see [Issue #1107](https://github.com/gnolang/gno/issues/1107) for more info)
+- Namespace: A namespace can be included after the type (e.g., user or organization name). Namespaces are a
+  way to group related packages or realms, but currently ownership cannot be claimed. (see 
+  [Issue#1107](https://github.com/gnolang/gno/issues/1107) for more info)
 - Remaining Path: The remaining part of the path.
     - Can only contain alphanumeric characters (letters and numbers) and underscores.
     - No special characters allowed (except underscore).
@@ -33,3 +37,47 @@ Examples:
 
 - `gno.land/p/demo/avl`: This signifies a package named `avl` within the `demo` namespace.
 - `gno.land/r/gnoland/home`: This signifies a realm named `home` within the `gnoland` namespace.
+
+## Registration Process
+
+The registration process is contract-based. The `AddPkg` command references
+`sys/users` for filtering, which in turn is based on `r/demo/users`.
+
+When `sys/users` is enabled, you need to register a name using `r/demo/users`. You can call the
+`r/demo/users.Register` function to register the name for the caller's address.
+
+> ex: `test1` user registering as `patrick`
+```bash
+$ gnokey maketx call -pkgpath gno.land/r/demo/users \
+    -func Register \
+    -gas-fee 1000000ugnot -gas-wanted 2000000 \
+    -broadcast \
+    -chainid=test4 \
+    -send=20000000ugnot \
+    -args '' \
+    -args 'patrick' \
+    -args 'My Profile Quote' test1
+```
+
+:::note Do not forget to update chain id
+
+
+After successful registration, you can add a package under the registered namespace.
+
+## Anonymous Namespace
+
+Gno.land offers the ability to add a package without having a registered namespace. 
+You can do this by using your own address as a namespace. This is formatted as `{p,r}/{std.Address}/**`. 
+
+> ex:  with `test1` user adding a package `microblog` using his own address as namespace
+```bash
+$ gnokey maketx addpkg \
+    --pkgpath "gno.land/r/g1jg8mtutu9khhfwc4nxmuhcpftf0pajdhfvsqf5/microblog" \
+    --pkgdir "examples/gno.land/p/demo/microblog" \
+    --deposit 100000000ugnot \
+    --gas-fee 1000000ugnot \
+    --gas-wanted 2000000 \
+    --broadcast \
+    --chainid test4 \
+    test1
+```

examples/gno.land/r/demo/boards/z_0_b_filetest.gno

@@ -1,7 +1,7 @@
 // PKGPATH: gno.land/r/demo/boards_test
 package boards_test
 
-// SEND: 199000000ugnot
+// SEND: 19900000ugnot
 
 import (
 	"gno.land/r/demo/boards"
@@ -20,4 +20,4 @@ func main() {
 }
 
 // Error:
-// payment must not be less than 200000000
+// payment must not be less than 20000000

examples/gno.land/r/demo/boards/z_0_filetest.gno

@@ -1,7 +1,7 @@
 // PKGPATH: gno.land/r/demo/boards_test
 package boards_test
 
-// SEND: 200000000ugnot
+// SEND: 20000000ugnot
 
 import (
 	"gno.land/r/demo/boards"

examples/gno.land/r/demo/boards/z_10_b_filetest.gno

@@ -1,7 +1,7 @@
 // PKGPATH: gno.land/r/demo/boards_test
 package boards_test
 
-// SEND: 2000000000ugnot
+// SEND: 200000000ugnot
 
 import (
 	"strconv"

examples/gno.land/r/demo/boards/z_11_a_filetest.gno

@@ -1,7 +1,7 @@
 // PKGPATH: gno.land/r/demo/boards_test
 package boards_test
 
-// SEND: 2000000000ugnot
+// SEND: 200000000ugnot
 
 import (
 	"strconv"

examples/gno.land/r/demo/boards/z_11_b_filetest.gno

@@ -1,7 +1,7 @@
 // PKGPATH: gno.land/r/demo/boards_test
 package boards_test
 
-// SEND: 2000000000ugnot
+// SEND: 200000000ugnot
 
 import (
 	"strconv"

examples/gno.land/r/demo/boards/z_11_c_filetest.gno

@@ -1,7 +1,7 @@
 // PKGPATH: gno.land/r/demo/boards_test
 package boards_test
 
-// SEND: 2000000000ugnot
+// SEND: 200000000ugnot
 
 import (
 	"strconv"

examples/gno.land/r/demo/boards/z_11_d_filetest.gno

@@ -1,7 +1,7 @@
 // PKGPATH: gno.land/r/demo/boards_test
 package boards_test
 
-// SEND: 2000000000ugnot
+// SEND: 200000000ugnot
 
 import (
 	"strconv"

examples/gno.land/r/demo/boards/z_11_filetest.gno

@@ -1,7 +1,7 @@
 // PKGPATH: gno.land/r/demo/boards_test
 package boards_test
 
-// SEND: 2000000000ugnot
+// SEND: 200000000ugnot
 
 import (
 	"strconv"

examples/gno.land/r/demo/boards/z_5_b_filetest.gno

@@ -1,6 +1,6 @@
 package main
 
-// SEND: 2000000000ugnot
+// SEND: 200000000ugnot
 
 import (
 	"std"

examples/gno.land/r/demo/boards/z_5_c_filetest.gno

@@ -1,6 +1,6 @@
 package main
 
-// SEND: 2000000000ugnot
+// SEND: 200000000ugnot
 
 import (
 	"std"

examples/gno.land/r/demo/boards/z_5_d_filetest.gno

@@ -1,6 +1,6 @@
 package main
 
-// SEND: 2000000000ugnot
+// SEND: 200000000ugnot
 
 import (
 	"std"

examples/gno.land/r/demo/boards/z_7_filetest.gno

@@ -1,7 +1,7 @@
 // PKGPATH: gno.land/r/demo/boards_test
 package boards_test
 
-// SEND: 2000000000ugnot
+// SEND: 200000000ugnot
 
 import (
 	"gno.land/r/demo/boards"

examples/gno.land/r/demo/boards/z_8_filetest.gno

@@ -1,7 +1,7 @@
 // PKGPATH: gno.land/r/demo/boards_test
 package boards_test
 
-// SEND: 2000000000ugnot
+// SEND: 200000000ugnot
 
 import (
 	"strconv"

examples/gno.land/r/demo/groups/z_0_b_filetest.gno

@@ -16,4 +16,4 @@ func main() {
 }
 
 // Error:
-// payment must not be less than 200000000
+// payment must not be less than 20000000

examples/gno.land/r/demo/groups/z_1_a_filetest.gno

@@ -13,7 +13,7 @@ import (
 
 var gid groups.GroupID
 
-const admin = std.Address("g1us8428u2a5satrlxzagqqa5m6vmuze025anjlj")
+const admin = std.Address("g1u7y667z64x2h7vc6fmpcprgey4ck233jaww9zq")
 
 func main() {
 	caller := std.GetOrigCaller() // main

examples/gno.land/r/demo/groups/z_2_a_filetest.gno

@@ -13,7 +13,7 @@ import (
 
 var gid groups.GroupID
 
-const admin = std.Address("g1us8428u2a5satrlxzagqqa5m6vmuze025anjlj")
+const admin = std.Address("g1u7y667z64x2h7vc6fmpcprgey4ck233jaww9zq")
 
 func main() {
 	caller := std.GetOrigCaller() // main

examples/gno.land/r/demo/users/preregister.gno

@@ -0,0 +1,66 @@
+package users
+
+import (
+	"std"
+
+	"gno.land/p/demo/users"
+)
+
+// pre-restricted names
+var preRestrictedNames = []string{
+	"bitcoin", "cosmos", "newtendermint", "ethereum",
+}
+
+// pre-registered users
+var preRegisteredUsers = []struct {
+	Name    string
+	Address std.Address
+}{
+	// system name
+	{"archives", "g1xlnyjrnf03ju82v0f98ruhpgnquk28knmjfe5k"}, // -> @r_archives
+	{"demo", "g13ek2zz9qurzynzvssyc4sthwppnruhnp0gdz8n"},     // -> @r_demo
+	{"gno", "g19602kd9tfxrfd60sgreadt9zvdyyuudcyxsz8a"},      // -> @r_gno
+	{"gnoland", "g1g3lsfxhvaqgdv4ccemwpnms4fv6t3aq3p5z6u7"},  // -> @r_gnoland
+	{"gnolang", "g1yjlnm3z2630gg5mryjd79907e0zx658wxs9hnd"},  // -> @r_gnolang
+	{"gov", "g1g73v2anukg4ej7axwqpthsatzrxjsh0wk797da"},      // -> @r_gov
+	{"nt", "g15ge0ae9077eh40erwrn2eq0xw6wupwqthpv34l"},       // -> @r_nt
+	{"sys", "g1r929wt2qplfawe4lvqv9zuwfdcz4vxdun7qh8l"},      // -> @r_sys
+	{"x", "g164sdpew3c2t3rvxj3kmfv7c7ujlvcw2punzzuz"},        // -> @r_x
+}
+
+func init() {
+	// add pre-registered users
+	for _, res := range preRegisteredUsers {
+		// assert not already registered.
+		_, ok := name2User.Get(res.Name)
+		if ok {
+			panic("name already registered")
+		}
+
+		_, ok = addr2User.Get(res.Address.String())
+		if ok {
+			panic("address already registered")
+		}
+
+		counter++
+		user := &users.User{
+			Address: res.Address,
+			Name:    res.Name,
+			Profile: "",
+			Number:  counter,
+			Invites: int(0),
+			Inviter: admin,
+		}
+		name2User.Set(res.Name, user)
+		addr2User.Set(res.Address.String(), user)
+	}
+
+	// add pre-restricted names
+	for _, name := range preRestrictedNames {
+		if _, ok := name2User.Get(name); ok {
+			panic("name already registered")
+		}
+
+		restricted.Set(name, true)
+	}
+}

examples/gno.land/r/demo/users/users.gno

@@ -14,13 +14,15 @@ import (
 // State
 
 var (
-	admin      std.Address = "g1us8428u2a5satrlxzagqqa5m6vmuze025anjlj"
-	name2User  avl.Tree                    // Name -> *users.User
-	addr2User  avl.Tree                    // std.Address -> *users.User
-	invites    avl.Tree                    // string(inviter+":"+invited) -> true
-	counter    int                         // user id counter
-	minFee     int64       = 200 * 1000000 // minimum gnot must be paid to register.
-	maxFeeMult int64       = 10            // maximum multiples of minFee accepted.
+	admin std.Address = "g1u7y667z64x2h7vc6fmpcprgey4ck233jaww9zq" // @moul
+
+	restricted avl.Tree                  // Name -> true - restricted name
+	name2User  avl.Tree                  // Name -> *users.User
+	addr2User  avl.Tree                  // std.Address -> *users.User
+	invites    avl.Tree                  // string(inviter+":"+invited) -> true
+	counter    int                       // user id counter
+	minFee     int64    = 20 * 1_000_000 // minimum gnot must be paid to register.
+	maxFeeMult int64    = 10             // maximum multiples of minFee accepted.
 )
 
 //----------------------------------------
@@ -34,8 +36,10 @@ func Register(inviter std.Address, name string, profile string) {
 	if caller != std.GetOrigCaller() {
 		panic("should not happen") // because std.AssertOrigCall().
 	}
+
 	sentCoins := std.GetOrigSend()
 	minCoin := std.NewCoin("ugnot", minFee)
+
 	if inviter == "" {
 		// banker := std.GetBanker(std.BankerTypeOrigSend)
 		if len(sentCoins) == 1 && sentCoins[0].IsGTE(minCoin) {
@@ -55,19 +59,35 @@ func Register(inviter std.Address, name string, profile string) {
 		}
 		invites.Remove(invitekey)
 	}
+
 	// assert not already registered.
 	_, ok := name2User.Get(name)
 	if ok {
-		panic("name already registered")
+		panic("name already registered: " + name)
 	}
 	_, ok = addr2User.Get(caller.String())
 	if ok {
-		panic("address already registered")
+		panic("address already registered: " + caller.String())
+	}
+
+	isInviterAdmin := inviter == admin
+
+	// check for restricted name
+	if _, isRestricted := restricted.Get(name); isRestricted {
+		// only address invite by the admin can register restricted name
+		if !isInviterAdmin {
+			panic("restricted name: " + name)
+		}
+
+		restricted.Remove(name)
 	}
+
 	// assert name is valid.
-	if !reName.MatchString(name) {
+	// admin inviter can bypass name restriction
+	if !isInviterAdmin && !reName.MatchString(name) {
 		panic("invalid name: " + name + " (must be at least 6 characters, lowercase alphanumeric with underscore)")
 	}
+
 	// remainder of fees go toward invites.
 	invites := int(0)
 	if len(sentCoins) == 1 {
@@ -240,10 +260,31 @@ func Resolve(input users.AddressOrName) std.Address {
 	if !isName {
 		return std.Address(input) // TODO check validity
 	}
+
 	user := GetUserByName(name)
 	return user.Address
 }
 
+// Add restricted name to the list
+func AdminAddRestrictedName(name string) {
+	// assert CallTx call.
+	std.AssertOriginCall()
+	// get caller
+	caller := std.GetOrigCaller()
+	// assert admin
+	if caller != admin {
+		panic("unauthorized")
+	}
+
+	if user := GetUserByName(name); user != nil {
+		panic("already registered name")
+	}
+
+	// register restricted name
+
+	restricted.Set(name, true)
+}
+
 //----------------------------------------
 // Constants