feat: add r/grc20reg

examples/Makefile

@@ -45,7 +45,7 @@ test:
 
 .PHONY: lint
 lint:
-	go run ../gnovm/cmd/gno lint $(OFFICIAL_PACKAGES)
+	go run ../gnovm/cmd/gno lint -v $(OFFICIAL_PACKAGES)
 
 .PHONY: test.sync
 test.sync:

examples/gno.land/r/demo/bar20/bar20.gno

@@ -9,6 +9,7 @@ import (
 
 	"gno.land/p/demo/grc/grc20"
 	"gno.land/p/demo/ufmt"
+	"gno.land/r/demo/grc20reg"
 )
 
 var (
@@ -19,6 +20,7 @@ var (
 func init() {
 	banker = grc20.NewBanker("Bar", "BAR", 4)
 	Token = banker.Token()
+	grc20reg.Register(Token, "")
 }
 
 func Faucet() string {

examples/gno.land/r/demo/bar20/gno.mod

@@ -5,4 +5,5 @@ require (
 	gno.land/p/demo/testutils v0.0.0-latest
 	gno.land/p/demo/ufmt v0.0.0-latest
 	gno.land/p/demo/urequire v0.0.0-latest
+	gno.land/r/demo/grc20reg v0.0.0-latest
 )

examples/gno.land/r/demo/foo20/foo20.gno

@@ -10,6 +10,7 @@ import (
 	"gno.land/p/demo/ownable"
 	"gno.land/p/demo/ufmt"
 	pusers "gno.land/p/demo/users"
+	"gno.land/r/demo/grc20reg"
 	"gno.land/r/demo/users"
 )
 
@@ -24,6 +25,7 @@ func init() {
 	banker = grc20.NewBanker("Foo", "FOO", 4)
 	banker.Mint(admin.Owner(), 1000000*10000) // @administrator (1M)
 	token = banker.Token()
+	grc20reg.Register(token, "")
 }
 
 func TotalSupply() uint64 { return token.TotalSupply() }

examples/gno.land/r/demo/foo20/foo20_test.gno

@@ -71,10 +71,21 @@ func TestErrConditions(t *testing.T) {
 		fn   func()
 	}
 
-	std.TestSetOrigCaller(users.Resolve(admin))
+	banker.Mint(std.Address(admin), 10000)
 	{
 		tests := []test{
-			{"Transfer(admin, 1)", "cannot send transfer to self", func() { Transfer(admin, 1) }},
+			{"Transfer(admin, 1)", "cannot send transfer to self", func() {
+				// XXX: should replace with:
+				//    Transfer(admin, 1)
+				// but there is currently a limitation in
+				// manipulating the frame stack and simulate
+				// calling this package from an outside point of
+				// view.
+				adminAddr := std.Address(admin)
+				if err := banker.Transfer(adminAddr, adminAddr, 1); err != nil {
+					panic(err)
+				}
+			}},
 			{"Approve(empty, 1))", "invalid address", func() { Approve(empty, 1) }},
 		}
 		for _, tc := range tests {

examples/gno.land/r/demo/foo20/gno.mod

@@ -7,5 +7,6 @@ require (
 	gno.land/p/demo/uassert v0.0.0-latest
 	gno.land/p/demo/ufmt v0.0.0-latest
 	gno.land/p/demo/users v0.0.0-latest
+	gno.land/r/demo/grc20reg v0.0.0-latest
 	gno.land/r/demo/users v0.0.0-latest
 )

examples/gno.land/r/demo/grc20factory/gno.mod

@@ -6,4 +6,5 @@ require (
 	gno.land/p/demo/ownable v0.0.0-latest
 	gno.land/p/demo/uassert v0.0.0-latest
 	gno.land/p/demo/ufmt v0.0.0-latest
+	gno.land/r/demo/grc20reg v0.0.0-latest
 )

examples/gno.land/r/demo/grc20factory/grc20factory.gno

@@ -8,6 +8,7 @@ import (
 	"gno.land/p/demo/grc/grc20"
 	"gno.land/p/demo/ownable"
 	"gno.land/p/demo/ufmt"
+	"gno.land/r/demo/grc20reg"
 )
 
 var instances avl.Tree // symbol -> instance
@@ -33,8 +34,8 @@ func NewWithAdmin(name, symbol string, decimals uint, initialMint, faucet uint64
 		admin:  ownable.NewWithAddress(admin),
 		faucet: faucet,
 	}
-
 	instances.Set(symbol, &inst)
+	grc20reg.Register(banker.Token(), symbol)
 }
 
 type instance struct {

examples/gno.land/r/demo/grc20reg/gno.mod

@@ -0,0 +1,9 @@
+module gno.land/r/demo/grc20reg
+
+require (
+	gno.land/p/demo/avl v0.0.0-latest
+	gno.land/p/demo/fqname v0.0.0-latest
+	gno.land/p/demo/grc/grc20 v0.0.0-latest
+	gno.land/p/demo/ufmt v0.0.0-latest
+	gno.land/p/demo/urequire v0.0.0-latest
+)

examples/gno.land/r/demo/grc20reg/grc20reg.gno

@@ -0,0 +1,74 @@
+package grc20reg
+
+import (
+	"std"
+
+	"gno.land/p/demo/avl"
+	"gno.land/p/demo/fqname"
+	"gno.land/p/demo/grc/grc20"
+	"gno.land/p/demo/ufmt"
+)
+
+var registry = avl.NewTree() // rlmPath[.slug] -> Token
+
+func Register(token grc20.Token, slug string) {
+	rlmPath := std.PrevRealm().PkgPath()
+	key := fqname.Construct(rlmPath, slug)
+	registry.Set(key, token)
+	std.Emit(
+		registerEvent,
+		"pkgpath", rlmPath,
+		"slug", slug,
+	)
+}
+
+func Get(key string) grc20.Token {
+	token, ok := registry.Get(key)
+	if !ok {
+		return nil
+	}
+	return token.(grc20.Token)
+}
+
+func MustGet(key string) grc20.Token {
+	token := Get(key)
+	if token == nil {
+		panic("unknown token: " + key)
+	}
+	return token
+}
+
+func Render(path string) string {
+	switch {
+	case path == "": // home
+		// TODO: add pagination
+		s := ""
+		count := 0
+		registry.Iterate("", "", func(key string, tokenI interface{}) bool {
+			count++
+			token := tokenI.(grc20.Token)
+			rlmPath, slug := fqname.Parse(key)
+			rlmLink := fqname.RenderLink(rlmPath, slug)
+			infoLink := "/r/demo/grc20reg:" + key
+			s += ufmt.Sprintf("- **%s** - %s - [info](%s)\n", token.GetName(), rlmLink, infoLink)
+			return false
+		})
+		if count == 0 {
+			return "No registered token."
+		}
+		return s
+	default: // specific token
+		key := path
+		token := MustGet(key)
+		rlmPath, slug := fqname.Parse(key)
+		rlmLink := fqname.RenderLink(rlmPath, slug)
+		s := ufmt.Sprintf("# %s\n", token.GetName())
+		s += ufmt.Sprintf("- symbol: **%s**\n", token.GetSymbol())
+		s += ufmt.Sprintf("- realm: %s\n", rlmLink)
+		s += ufmt.Sprintf("- decimals: %d\n", token.GetDecimals())
+		s += ufmt.Sprintf("- total supply: %d\n", token.TotalSupply())
+		return s
+	}
+}
+
+const registerEvent = "register"

examples/gno.land/r/demo/grc20reg/grc20reg_test.gno

@@ -0,0 +1,74 @@
+package grc20reg
+
+import (
+	"std"
+	"testing"
+
+	"gno.land/p/demo/grc/grc20"
+	"gno.land/p/demo/urequire"
+)
+
+func TestRegistry(t *testing.T) {
+	std.TestSetRealm(std.NewCodeRealm("gno.land/r/demo/foo"))
+	realmAddr := std.CurrentRealm().PkgPath()
+	tokenImpl := &dummyImpl{}
+
+	// register
+	Register(tokenImpl, "")
+	regToken := Get(realmAddr)
+	urequire.True(t, regToken != nil, "expected to find a token") // fixme: use urequire.NotNil
+	urequire.Equal(t, regToken.GetSymbol(), "TST")
+
+	expected := `- **TestToken** - [gno.land/r/demo/foo](/r/demo/foo) - [info](/r/demo/grc20reg:gno.land/r/demo/foo)
+`
+	got := Render("")
+	urequire.Equal(t, expected, got)
+
+	// 404
+	invalidToken := Get("0xdeadbeef")
+	urequire.True(t, invalidToken == nil)
+
+	// register with a slug
+	Register(tokenImpl, "mySlug")
+	regToken = Get(realmAddr + ".mySlug")
+	urequire.True(t, regToken != nil, "expected to find a token") // fixme: use urequire.NotNil
+	urequire.Equal(t, regToken.GetSymbol(), "TST")
+
+	// override
+	Register(tokenImpl, "")
+	regToken = Get(realmAddr + "")
+	urequire.True(t, regToken != nil, "expected to find a token") // fixme: use urequire.NotNil
+	urequire.Equal(t, regToken.GetSymbol(), "TST")
+
+	expected = `- **TestToken** - [gno.land/r/demo/foo](/r/demo/foo) - [info](/r/demo/grc20reg:gno.land/r/demo/foo)
+- **TestToken** - [gno.land/r/demo/foo](/r/demo/foo).mySlug - [info](/r/demo/grc20reg:gno.land/r/demo/foo.mySlug)
+`
+	got = Render("")
+	urequire.Equal(t, expected, got)
+
+	expected = `# TestToken
+- symbol: **TST**
+- realm: [gno.land/r/demo/foo](/r/demo/foo).mySlug
+- decimals: 1337
+- total supply: 1234567
+`
+	got = Render("gno.land/r/demo/foo.mySlug")
+	urequire.Equal(t, expected, got)
+}
+
+type dummyImpl struct{}
+
+// FIXME: this should fail.
+var _ grc20.Token = (*dummyImpl)(nil)
+
+func (impl *dummyImpl) GetName() string                                  { return "TestToken" }
+func (impl *dummyImpl) GetSymbol() string                                { return "TST" }
+func (impl *dummyImpl) GetDecimals() uint                                { return 1337 }
+func (impl *dummyImpl) TotalSupply() uint64                              { return 1234567 }
+func (impl *dummyImpl) BalanceOf(account std.Address) uint64             { panic("not implemented") }
+func (impl *dummyImpl) Transfer(to std.Address, amount uint64) error     { panic("not implemented") }
+func (impl *dummyImpl) Allowance(owner, spender std.Address) uint64      { panic("not implemented") }
+func (impl *dummyImpl) Approve(spender std.Address, amount uint64) error { panic("not implemented") }
+func (impl *dummyImpl) TransferFrom(from, to std.Address, amount uint64) error {
+	panic("not implemented")
+}

examples/gno.land/r/demo/tests/crossrealm/crossrealm.gno

@@ -27,3 +27,13 @@ func Make1() *p_crossrealm.Container {
 		B: local,
 	}
 }
+
+type Fooer interface{ Foo() }
+
+var fooer Fooer
+
+func SetFooer(f Fooer) Fooer {
+	fooer = f
+	return fooer
+}
+func CallFoo() { fooer.Foo() }

examples/gno.land/r/demo/tests/tests.gno

@@ -50,6 +50,8 @@ type TestRealmObject struct {
 	Field string
 }
 
+var TestRealmObjectValue TestRealmObject
+
 func ModifyTestRealmObject(t *TestRealmObject) {
 	t.Field += "_modified"
 }

examples/gno.land/r/demo/wugnot/gno.mod

@@ -4,5 +4,6 @@ require (
 	gno.land/p/demo/grc/grc20 v0.0.0-latest
 	gno.land/p/demo/ufmt v0.0.0-latest
 	gno.land/p/demo/users v0.0.0-latest
+	gno.land/r/demo/grc20reg v0.0.0-latest
 	gno.land/r/demo/users v0.0.0-latest
 )

examples/gno.land/r/demo/wugnot/wugnot.gno

@@ -7,6 +7,7 @@ import (
 	"gno.land/p/demo/grc/grc20"
 	"gno.land/p/demo/ufmt"
 	pusers "gno.land/p/demo/users"
+	"gno.land/r/demo/grc20reg"
 	"gno.land/r/demo/users"
 )
 
@@ -20,6 +21,10 @@ const (
 	wugnotMinDeposit uint64 = 1
 )
 
+func init() {
+	grc20reg.Register(Token, "")
+}
+
 func Deposit() {
 	caller := std.PrevRealm().Addr()
 	sent := std.GetOrigSend()