feat(examples/hof): Title and description for realms #3674

Ursulovic · 2025-02-03T13:06:09Z

Title And Description for Hall of Fame realms

Goal

Add metadata support (title and description) to realms in the Hall of Fame while maintaining backward compatibility with existing registrations.

Description

This improvement allows users to provide additional metadata for their realms through optional title and description fields. The implementation uses variadic parameters in the Register function, ensuring that:

Existing registered realms continue to work without changes
New registrations can optionally include metadata
Clean and consistent display of metadata in the UI

Changes

Added Metadata struct with Title and Description fields
Instead of using raw Markdown in Render..Gno, @moul 's Mardkown package will be used
Extended Register function to accept optional metadata parameters
Updated rendering to display metadata when available
Added validation for metadata fields:
- Title: 1-30 characters
- Description: 1-100 characters

Gno2D2 · 2025-02-03T13:07:49Z

🛠 PR Checks Summary

🔴 Pending initial approval by a review team member, or review from tech-staff

Manual Checks (for Reviewers):

IGNORE the bot requirements for this PR (force green CI check)
The pull request description provides enough details

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)
🔴 Pending initial approval by a review team member, or review from tech-staff

☑️ Contributor Actions:

Fix any issues flagged by automated checks.
Follow the Contributor Checklist to ensure your PR is ready for review.
- Add new tests, or document why they are unnecessary.
- Provide clear examples/screenshots, if necessary.
- Update documentation, if required.
- Ensure no breaking changes, or include BREAKING CHANGE notes.
- Link related issues/PRs, where applicable.

☑️ Reviewer Actions:

Complete manual checks for the PR, including the guidelines and additional checks if applicable.

📚 Resources:

Debug

Automated Checks

Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 The pull request was created from a fork (head branch repo: Ursulovic/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

Pending initial approval by a review team member, or review from tech-staff

If

🟢 Condition met
└── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🔴 Requirement not satisfied
└── 🔴 If
    ├── 🔴 Condition
    │   └── 🔴 Or
    │       ├── 🔴 At least 1 user(s) of the organization reviewed the pull request (with state "APPROVED")
    │       ├── 🔴 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🔴 Else
        └── 🔴 And
            ├── 🟢 This label is applied to pull request: review/triage-pending
            └── 🔴 On no pull request

Manual Checks

**IGNORE** the bot requirements for this PR (force green CI check)
If
🟢 Condition met
└── 🟢 On every pull request
Can be checked by

Any user with comment edit permission
The pull request description provides enough details
If
🟢 Condition met
└── 🟢 And
    ├── 🟢 Not (🔴 Pull request author is a member of the team: core-contributors)
    └── 🟢 Not (🔴 Pull request author is user: dependabot[bot])
Can be checked by

team core-contributors

codecov · 2025-02-03T17:24:57Z

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

leohhhn · 2025-02-04T11:20:35Z

examples/gno.land/r/leon/hof/hof.gno

+func RegisterMetadata(params ...string) Metadata {
+	// Validate params length
+	if len(params) != 2 {
+		panic(ErrInvalidMetadata)
+	}


This is a bad approach, you're using variadic arguments but you know that you will have only two arguments.

Variadic arguments should be used only in specific cases, and this isn't one of them, as you could've done this in a very straighforward manner with two arguments.

leohhhn · 2025-02-04T11:21:57Z

examples/gno.land/r/leon/hof/hof.gno

 	exhibition.items.Set(pkgpath, i)
 	exhibition.itemsSorted.Set(id.String(), i)

 	std.Emit("Registration")
 }

+func RegisterMetadata(params ...string) Metadata {


Remove this whole function; Just add the title and description in the Register function directly. Keep the checks, but don't panic but just add an empty return, just like in the rest of the function

Imagine how your code will be used; if you need to use Register inside of another realm's code, if you panic, you will fully block execution of the realm that called Register. If you simply do a return, without an error, in Register, HOF will try to add the realm that called it, it may work, but if not, nothing will happen.

leohhhn · 2025-02-04T11:22:36Z

examples/gno.land/r/leon/hof/hof.gno

 		upvote   *avl.Tree // std.Addr > struct{}{}
 		downvote *avl.Tree // std.Addr > struct{}{}
 	}
+
+	Metadata struct {


I don't see a reason to have this, just add two strings to the Item type

leohhhn · 2025-02-04T11:26:35Z

examples/gno.land/r/leon/hof/render.gno

@@ -45,7 +46,7 @@ func (e Exhibition) Render(path string, dashboard bool) string {

 		out += "<div>\n\n"
 		id, _ := seqid.FromString(item.Key)
-		out += ufmt.Sprintf("### Submission #%d\n\n", int(id))
+		out += md.H3(ufmt.Sprintf("Submission #%d", int(id))) + "\n"


Is a \n needed here? I'm not sure, please double check

leohhhn · 2025-02-04T11:27:04Z

examples/gno.land/r/leon/hof/render.gno

+	out := ""
+
+	out += md.CodeBlock(i.pkgpath) + "\n"


Can you add a screenshot of how the new hall of fame page will look like?

leohhhn

You need to change the approach in your implementation; I've left comments.

Ivan Ursulovic added 3 commits February 3, 2025 13:01

Added metadata support for hof

2e43d11

added displaying description and title on redner

cb22225

Now using moul's md package for markdown, work still in progress

ef9ba24

github-actions bot assigned Ursulovic Feb 3, 2025

github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label Feb 3, 2025

Ursulovic changed the title ~~Improvement(Hall of Fame): Title and Description for Realms~~ feat(Hall of Fame): Title and Description for Realms Feb 3, 2025

Gno2D2 requested a review from a team February 3, 2025 13:07

Ran make fmt and make tidy

f4ca887

leohhhn changed the title ~~feat(Hall of Fame): Title and Description for Realms~~ feat(examples/hof): Title and description for realms Feb 3, 2025

Merge branch 'gnolang:master' into hof-imporvement-1

f0009f9

Ivan Ursulovic added 2 commits February 3, 2025 19:31

Further improved rendering

896715a

Ran make fmt and make tidy

cbd0724

Ursulovic marked this pull request as ready for review February 3, 2025 18:32

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

leohhhn reviewed Feb 4, 2025

View reviewed changes

leohhhn requested changes Feb 4, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(examples/hof): Title and description for realms #3674

feat(examples/hof): Title and description for realms #3674

Ursulovic commented Feb 3, 2025

Gno2D2 commented Feb 3, 2025 •

edited

Loading

✅ Automated Checks (for Contributors):

☑️ Contributor Actions:

☑️ Reviewer Actions:

📚 Resources:

If

Then

If

Then

If

Can be checked by

If

Can be checked by

codecov bot commented Feb 3, 2025

leohhhn Feb 4, 2025 •

edited

Loading

leohhhn Feb 4, 2025

leohhhn Feb 4, 2025

leohhhn Feb 4, 2025

leohhhn Feb 4, 2025

leohhhn Feb 4, 2025

leohhhn left a comment

feat(examples/hof): Title and description for realms #3674

Are you sure you want to change the base?

feat(examples/hof): Title and description for realms #3674

Conversation

Ursulovic commented Feb 3, 2025

Title And Description for Hall of Fame realms

Goal

Description

Changes

Gno2D2 commented Feb 3, 2025 • edited Loading

🛠 PR Checks Summary

Manual Checks (for Reviewers):

✅ Automated Checks (for Contributors):

☑️ Contributor Actions:

☑️ Reviewer Actions:

📚 Resources:

If

Then

If

Then

If

Can be checked by

If

Can be checked by

codecov bot commented Feb 3, 2025

Codecov Report

leohhhn Feb 4, 2025 • edited Loading

Choose a reason for hiding this comment

leohhhn Feb 4, 2025

Choose a reason for hiding this comment

leohhhn Feb 4, 2025

Choose a reason for hiding this comment

leohhhn Feb 4, 2025

Choose a reason for hiding this comment

leohhhn Feb 4, 2025

Choose a reason for hiding this comment

leohhhn Feb 4, 2025

Choose a reason for hiding this comment

leohhhn left a comment

Choose a reason for hiding this comment

Gno2D2 commented Feb 3, 2025 •

edited

Loading

leohhhn Feb 4, 2025 •

edited

Loading