feat(examples): hall of fame

examples/gno.land/p/demo/fqname/fqname.gno

@@ -63,10 +63,13 @@ func RenderLink(pkgPath, slug string) string {
 		if slug != "" {
 			return "[" + pkgPath + "](" + pkgLink + ")." + slug
 		}
+
 		return "[" + pkgPath + "](" + pkgLink + ")"
 	}
+
 	if slug != "" {
 		return pkgPath + "." + slug
 	}
+
 	return pkgPath
 }

examples/gno.land/r/gnoland/blog/gno.mod

@@ -5,4 +5,5 @@ require (
 	gno.land/p/demo/blog v0.0.0-latest
 	gno.land/p/demo/context v0.0.0-latest
 	gno.land/p/gov/proposal v0.0.0-latest
+	gno.land/r/gnoland/hof v0.0.0-latest
 )

examples/gno.land/r/gnoland/hof/errors.gno

@@ -0,0 +1,17 @@
+package hof
+
+import (
+	"errors"
+	"strconv"
+)
+
+var (
+	ErrNoSuchItem       = errors.New("hof: no such item exists")
+	ErrNoSuchExhibition = errors.New("hof: no such exhibition exists")
+	ErrInvalidTitle     = errors.New("hof: invalid title")
+	ErrDoubleUpvote     = errors.New("hof: cannot upvote twice")
+	ErrDoubleDownvote   = errors.New("hof: cannot downvote twice")
+	ErrMinWidgetSize    = errors.New("hof: widget size cannot be less than 1")
+	ErrMaxWidgetSize    = errors.New("hof: widget size cannot be more than " + strconv.Itoa(MaxWidgetSize))
+	ErrNonCodeCall      = errors.New("hof: non-code call")
+)

examples/gno.land/r/gnoland/hof/gno.mod

@@ -0,0 +1,8 @@
+module gno.land/r/gnoland/hof
+
+require (
+	gno.land/p/demo/avl v0.0.0-latest
+	gno.land/p/demo/fqname v0.0.0-latest
+	gno.land/p/demo/seqid v0.0.0-latest
+	gno.land/p/demo/ufmt v0.0.0-latest
+)

examples/gno.land/r/gnoland/hof/hof.gno

@@ -0,0 +1,174 @@
+// Package hof is the gno.land hall of fame realm.
+// It contains a permanent exhibition of items in the hall of fame,
+// a possibility to host temporary ones created by its admins.
+package hof
+
+import (
+	"std"
+	"strings"
+	"time"
+
+	"gno.land/p/demo/avl"
+	"gno.land/p/demo/seqid"
+	"gno.land/p/demo/ufmt"
+)
+
+var (
+	exhibCounter seqid.ID
+	exhibitions  *avl.Tree // id > *Exhibition
+)
+
+type (
+	Exhibition struct {
+		id          seqid.ID // fixed per exhibition
+		itemCounter seqid.ID
+		title       string
+		description string
+		startTime   *time.Time // given in RFC3339
+		endTime     *time.Time // end time of the event, given in RFC3339
+		items       *avl.Tree  // Item id > Item
+	}
+
+	Item struct {
+		id       seqid.ID
+		exhibID  seqid.ID
+		pkgpath  string
+		deployer std.Address
+		blockNum int64
+		upvote   *avl.Tree // std.Addr > struct{}{}
+		downvote *avl.Tree // std.Addr > struct{}{}
+	}
+)
+
+func init() {
+	exhibitions = avl.NewTree()
+
+	exhibitions.Set(seqid.ID(0).String(),
+		&Exhibition{ // permanent exhibition, ID=0
+			id:    seqid.ID(0),
+			items: avl.NewTree(),
+			title: "Permanent Exhibition",
+		})
+}
+
+// CreateTemporaryExhibition creates a temporary exhibition to be displayed while it's active
+func CreateTemporaryExhibition(title, description string, start, end *time.Time) error {
+	// todo add admin checks
+
+	if strings.TrimSpace(title) == "" {
+		return ErrInvalidTitle
+	}
+
+	id := exhibCounter.Next()
+	e := &Exhibition{
+		id:          id,
+		title:       title,
+		description: description,
+		items:       avl.NewTree(),
+		startTime:   start,
+		endTime:     end,
+	}
+
+	exhibitions.Set(id.String(), e)
+
+	return nil
+}
+
+// Register registers to the permanent exhibition
+func Register() (string, error) {
+	return RegisterFor(seqid.ID(0))
+}
+
+// RegisterFor registers your realm for a specific exhibition
+func RegisterFor(exhibID seqid.ID) (string, error) {
+	submission := std.PrevRealm()
+	pkgpath := submission.PkgPath()
+
+	raw, ok := exhibitions.Get(exhibID.String())
+	if !ok {
+		return "", ErrNoSuchExhibition
+	}
+
+	e := raw.(*Exhibition)
+
+	// Must not already exist and must be called from code
+	if e.items.Has(pkgpath) || submission.IsUser() {
+		return "", ErrNonCodeCall
+	}
+
+	id := e.itemCounter.Next()
+	e.items.Set(
+		id.String(),
+		&Item{
+			id:       id,
+			exhibID:  e.id,
+			pkgpath:  pkgpath,
+			deployer: std.GetOrigCaller(),
+			blockNum: std.GetHeight(),
+			upvote:   avl.NewTree(),
+			downvote: avl.NewTree(),
+		})
+
+	return ufmt.Sprintf("Registered %s at ID %s for exhibition %s", pkgpath, id.String(), e.title), nil
+}
+
+func Upvote(exhibID, itemID seqid.ID) error {
+	raw, ok := exhibitions.Get(exhibID.String())
+	if !ok {
+		return ErrNoSuchExhibition
+	}
+
+	e := raw.(*Exhibition)
+
+	rawItem, ok := e.items.Get(itemID.String())
+	if !ok {
+		return ErrNoSuchItem
+	}
+
+	item := rawItem.(*Item)
+	caller := std.PrevRealm().Addr().String()
+
+	if item.upvote.Has(caller) {
+		return ErrDoubleUpvote
+	}
+
+	item.upvote.Set(caller, struct{}{})
+	return nil
+}
+
+func Downvote(exhibID, itemID seqid.ID) error {
+	raw, ok := exhibitions.Get(exhibID.String())
+	if !ok {
+		return ErrNoSuchExhibition
+	}
+
+	e := raw.(*Exhibition)
+
+	rawItem, ok := e.items.Get(itemID.String())
+	if !ok {
+		return ErrNoSuchItem
+	}
+
+	item := rawItem.(*Item)
+	caller := std.PrevRealm().Addr().String()
+
+	if item.downvote.Has(caller) {
+		return ErrDoubleDownvote
+	}
+
+	item.downvote.Set(caller, struct{}{})
+	return nil
+}
+
+func Delete(exhibID, itemID seqid.ID) error {
+	raw, ok := exhibitions.Get(exhibID.String())
+	if !ok {
+		return ErrNoSuchExhibition
+	}
+
+	if _, removed := raw.(*Exhibition).items.Remove(itemID.String()); !removed {
+		return ErrNoSuchItem
+	}
+
+	return nil
+}

examples/gno.land/r/gnoland/hof/rendering.gno

@@ -0,0 +1,121 @@
+package hof
+
+import (
+	"gno.land/p/demo/fqname"
+	"gno.land/p/demo/seqid"
+	"gno.land/p/demo/ufmt"
+)
+
+const (
+	MaxWidgetSize = 5
+	likesBar      = "#### [%d 👍](/r/gnoland/hof?help&__func=Upvote&exhibID=%s&itemID=%s) - [%d 👎](/r/gnoland/hof?help&__func=Downvote&exhibID=%s&itemID=%s)\n\n"
+	delBar        = "[Delete](/r/gnoland/hof?help&__func=Delete&exhibID=%s&itemID=%s)\n\n"
+)
+
+func Render(path string) string {
+	out := "# Hall of Fame\n\n"
+
+	// Render permanent exhib
+	permanent, _ := exhibitions.Get(seqid.ID(0).String())
+	out += permanent.(*Exhibition).Render(path == "dashboard")
+
+	if exhibitions.Size() > 1 {
+		out += "---\n\n"
+	}
+
+	exhibitions.Iterate(seqid.ID(1).String(), "", func(key string, value interface{}) bool {
+		e := value.(*Exhibition)
+		out += e.Render(path == "dashboard")
+
+		out += "---\n\n"
+		return false
+	})
+
+	return out
+}
+
+func (e Exhibition) Render(dashboard bool) string {
+	out := ufmt.Sprintf("## %s\n\n", e.title)
+	out += ufmt.Sprintf("%s\n\n", e.description)
+	out += ufmt.Sprintf("Exhibition ID: %s\n\n", e.id.String())
+
+	if e.items.Size() == 0 {
+		out += "No items in this exhibition currently.\n\n"
+		return out
+	}
+
+	out += "<div class='columns-2'>\n\n"
+
+	e.items.ReverseIterate("", "", func(key string, value interface{}) bool {
+		out += "<div>\n\n"
+		id, _ := seqid.FromString(key)
+		out += ufmt.Sprintf("### Submission #%d\n\n", int(id))
+		out += value.(*Item).Render(dashboard)
+		out += "</div>"
+
+		return false
+	})
+
+	out += "</div><!-- /columns-2 -->\n\n"
+
+	return out
+}
+
+func (i Item) Render(dashboard bool) string {
+	out := ufmt.Sprintf("\n```\n%s\n```\n\n", i.pkgpath)
+	out += ufmt.Sprintf("by %s\n\n", i.deployer.String())
+	out += ufmt.Sprintf("Published at Block #%d\n\n", i.blockNum)
+	out += ufmt.Sprintf(
+		likesBar,
+		i.upvote.Size(),
+		i.exhibID.String(),
+		i.id.String(),
+		i.downvote.Size(),
+		i.exhibID.String(),
+		i.id.String(),
+	)
+
+	if dashboard {
+		out += ufmt.Sprintf(
+			delBar,
+			i.exhibID.String(),
+			i.id.String(),
+		)
+	}
+
+	return out
+}
+
+func RenderExhibWidget(exhibID seqid.ID, itemsToRender int) (string, error) {
+	if itemsToRender > MaxWidgetSize {
+		return "", ErrMaxWidgetSize
+	}
+
+	if itemsToRender < 1 {
+		return "", ErrMinWidgetSize
+	}
+
+	e, ok := exhibitions.Get(exhibID.String())
+	if !ok {
+		return "", ErrNoSuchExhibition
+	}
+
+	exhib := e.(*Exhibition)
+	if exhib.items.Size() == 0 {
+		return "No items in this exhibition.", nil
+	}
+
+	out := ""
+	i := 0
+
+	exhib.items.Iterate("", "", func(key string, value interface{}) bool {
+		item := value.(*Item)
+
+		out += ufmt.Sprintf("- %s\n", fqname.RenderLink(item.pkgpath, ""))
+
+		i++
+		return i >= itemsToRender
+	})
+
+	return out, nil
+}

examples/gno.land/r/gnoland/home/gno.mod

@@ -2,8 +2,10 @@ module gno.land/r/gnoland/home
 
 require (
 	gno.land/p/demo/ownable v0.0.0-latest
+	gno.land/p/demo/seqid v0.0.0-latest
 	gno.land/p/demo/ufmt v0.0.0-latest
 	gno.land/p/demo/ui v0.0.0-latest
 	gno.land/r/gnoland/blog v0.0.0-latest
 	gno.land/r/gnoland/events v0.0.0-latest
+	gno.land/r/gnoland/hof v0.0.0-latest
 )

examples/gno.land/r/gnoland/home/home.gno

@@ -4,10 +4,12 @@ import (
 	"std"
 
 	"gno.land/p/demo/ownable"
+	"gno.land/p/demo/seqid"
 	"gno.land/p/demo/ufmt"
 	"gno.land/p/demo/ui"
 	blog "gno.land/r/gnoland/blog"
 	events "gno.land/r/gnoland/events"
+	"gno.land/r/gnoland/hof"
 )
 
 // XXX: p/demo/ui API is crappy, we need to make it more idiomatic
@@ -37,7 +39,7 @@ func Render(_ string) string {
 		ui.Columns{3, []ui.Element{
 			lastBlogposts(4),
 			upcomingEvents(),
-			lastContributions(4),
+			latestHOFItems(5),
 		}},
 	)
 
@@ -90,6 +92,15 @@ func upcomingEvents() ui.Element {
 	}
 }
 
+func latestHOFItems(num int) ui.Element {
+	submissions, _ := hof.RenderExhibWidget(seqid.ID(0), num)
+
+	return ui.Element{
+		ui.H3("[Hall of Fame](/r/gnoland/hof)"),
+		ui.Text(submissions),
+	}
+}
+
 func introSection() ui.Element {
 	return ui.Element{
 		ui.H3("We’re building gno.land, set to become the leading open-source smart contract platform, using Gno, an interpreted and fully deterministic variation of the Go programming language for succinct and composable smart contracts."),

examples/gno.land/r/leon/home/gno.mod

@@ -4,5 +4,6 @@ require (
 	gno.land/p/demo/ufmt v0.0.0-latest
 	gno.land/r/demo/art/gnoface v0.0.0-latest
 	gno.land/r/demo/art/millipede v0.0.0-latest
+	gno.land/r/gnoland/hof v0.0.0-latest
 	gno.land/r/leon/config v0.0.0-latest
 )