feat(home-realm): add interactive home realm example #2918

stefann-01 · 2024-10-07T05:28:28Z

Description:

This PR finalizes the core functionality of my home realm project, focusing on a dynamic and interactive home realm experience, driven by GNOT donations. The following key features and enhancements are introduced in this PR:

Key Features:

Dynamic Background Change:
- Implemented sequential background changes triggered by GNOT donations. Each donation updates the city background in a fixed order, cycling through a predefined set of cities. The background change is seamless, offering a "traveling" experience for donors.
Sponsor Leaderboard:
- Added a sponsor leaderboard to showcase the top contributors based on their GNOT donations. The list displays the addresses of the top sponsors, formatted for readability (first and last characters with ellipses), and limits the displayed sponsors to the configurable maxSponsors setting.
Donation Validation:
- Introduced a strict GNOT validation check. The system now rejects any donation attempts that don't include GNOT, ensuring only valid contributions update the state of the realm.
Owner Withdrawal of Donations:
- Implemented a feature that allows the realm owner to withdraw accumulated GNOT donations, providing control over the funds contributed by supporters.
Home Realm Configurations:
- Cities: Cities can be dynamically updated to refresh the possible backgrounds.
- Maximum Sponsors: Admins can configure the number of sponsors shown on the leaderboard with the maxSponsors setting.
- Jar Link: Admins can update the link to the donation jar.

codecov · 2024-10-07T13:18:46Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.08%. Comparing base (b655cd2) to head (22f9526).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2918      +/-   ##
==========================================
+ Coverage   63.07%   63.08%   +0.01%     
==========================================
  Files         563      563              
  Lines       79254    79254              
==========================================
+ Hits        49986    49996      +10     
+ Misses      25904    25895       -9     
+ Partials     3364     3363       -1

Flag	Coverage Δ
contribs/gnodev	`60.62% <ø> (+0.62%)`	⬆️
contribs/gnofaucet	`14.82% <ø> (ø)`
gno.land	`67.56% <ø> (ø)`
gnovm	`67.25% <ø> (ø)`
misc/genstd	`79.72% <ø> (ø)`
misc/logos	`19.95% <ø> (+0.50%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

- Add profile picture, background image, and about section rendering - Implement dynamic background and tip jar rendering - Add functions to update cities and tip jar link - Integrate sponsor leaderboard - Home realm is still a work in progress

- Ensure city index increments with each donation, resetting after the last city - Implement full GNOT validation to enforce valid donations - Complete sponsor leaderboard functionality with maxSponsors limit - Refine sponsor list display logic to prevent visual issues - Fully integrate tip jar mechanics with donation tracking - Fix AssertAuth issue in config

examples/gno.land/r/stefann/config/config.gno

examples/gno.land/r/stefann/home/home.gno

examples/gno.land/r/stefann/config/config.gno

examples/gno.land/r/stefann/home/home.gno

- Remove ownership management logic from `config` and rename it to `registar`. - Integrate `Ownable` for ownership management in the home package. - Add a comment to clarify the purpose of `jarLink` and its expected update process. - Remove the unused `caption` parameter in the `UpdatePFP` function. - Replace `OrigPkgAddr()` with `CurrentRealm()` in `CollectDonations`.

- Run `gno mod tidy` to clean up dependencies. - Run `gno fmt -C ./examples` to format code. - Clean up by fixing the undefined `owner` reference and other minor bugs.

stefann-01 · 2024-10-11T12:54:02Z

I’ve resolved some issues with the latest commits and will be addressing the remaining problems soon. Thank you for your comprehensive suggestions!

- Refactor the `currentCityIndex` update using modulo (`%`) to prevent manual resetting and ensure correct rendering. - Merge sponsor and donation logic into a single structure, simplifying data handling. - Replace sponsor list iteration with a map for direct access, enhancing performance. - Remove `CollectDonations` function; `Donate` now directly sends funds to the owner, simplifying fund management. - Move sponsor sorting from the donation step to the render step, reducing gas fees for donors. - Generalize the `UpdateAboutMe` method to support dynamic content updates without column restrictions. - Group related variables (e.g., `pfp`, `cities`, `aboutMe`, `jarLink`) into common objects for improved organization. - Apply minor optimizations and clean up code for better readability and maintainability.

- Re-add UpdateMaxSponsors function, accidentally removed earlier. - Replace DonationStats with DonationsCount field. - Update logic to derive total donations directly from the sponsors map by summing "ugnot" coins.

examples/gno.land/r/stefann/home/home.gno

zivkovicmilos · 2024-10-15T10:20:48Z

examples/gno.land/r/stefann/home/home.gno

+	if len(sponsorship.sponsors) == 0 {
+		out += `<p style="text-align: center;">No sponsors yet. Be the first to tip the jar!</p>` + "\n"
+	} else {


Suggested change

if len(sponsorship.sponsors) == 0 {

out += `<p style="text-align: center;">No sponsors yet. Be the first to tip the jar!</p>` + "\n"

} else {

if len(sponsorship.sponsors) == 0 {

return out + `<p style="text-align: center;">No sponsors yet. Be the first to tip the jar!</p>` + "\n"

}

// ...

Fixed! 22531c7

You can drop the else, since you return in the if

zivkovicmilos

Thank you for applying the suggestions 🙏

zivkovicmilos · 2024-10-15T10:25:31Z

@stefann-01
You gotta run gno mod tidy in the registry package folder to make the CI pass 🙏

zivkovicmilos · 2024-10-16T16:24:07Z

@stefann-01 Can you check the leftover comments, so we can merge? 🙏

stefann-01 · 2024-10-16T16:27:02Z

Yes, I will fix them all tonight. Thanks! @zivkovicmilos

- Add AddCities function to append one or more cities to the travel list without replacing the existing entries. - Add AddAboutMeRows function to append one or more rows to the aboutMe section. - Implemented unit tests for home realm.

zivkovicmilos

Looking good 😎

zivkovicmilos · 2024-10-18T19:29:39Z

examples/gno.land/r/stefann/home/home_test.gno

+)
+
+func TestUpdatePFP(t *testing.T) {
+	std.TestSetOrigCaller(std.Address("g1sd5ezmxt4rwpy52u6wl3l3y085n8x0p6nllxm8"))


Nitpick: you should use testutils.TestAddress(...) to create an std.Address in tests

stefann-01 requested review from a team as code owners October 7, 2024 05:28

stefann-01 requested review from jaekwon and petar-dambovaliev and removed request for a team October 7, 2024 05:28

github-actions bot assigned stefann-01 Oct 7, 2024

github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label Oct 7, 2024

stefann-01 changed the title ~~feat(home-realm): introduce interactive donation-based home realm with background change and sponsor leaderboard~~ feat(home-realm): interactive home realm with background change and sponsor leaderboard Oct 7, 2024

stefann-01 changed the title ~~feat(home-realm): interactive home realm with background change and sponsor leaderboard~~ feat(home-realm): add interactive home realm example Oct 7, 2024

stefann-01 mentioned this pull request Oct 7, 2024

Stefann's Builder Journey gnolang/hackerspace#94

Open

stefann-01 added 3 commits October 7, 2024 19:09

Run make fmt -C ./examples

47c0b81

stefann-01 force-pushed the master branch from 076646a to 47c0b81 Compare October 7, 2024 17:11

moul reviewed Oct 8, 2024

View reviewed changes

examples/gno.land/r/stefann/config/config.gno Outdated Show resolved Hide resolved

moul reviewed Oct 8, 2024

View reviewed changes

examples/gno.land/r/stefann/home/home.gno Outdated Show resolved Hide resolved

Merge branch 'master' into master

f05370c

zivkovicmilos marked this pull request as draft October 8, 2024 14:51

zivkovicmilos reviewed Oct 8, 2024

View reviewed changes

stefann-01 added 3 commits October 10, 2024 22:15

Merge branch 'master' into master

dbda3cf

Run gno mod tidy, fmt, and clean up bugs

b79ba55

- Run `gno mod tidy` to clean up dependencies. - Run `gno fmt -C ./examples` to format code. - Clean up by fixing the undefined `owner` reference and other minor bugs.

stefann-01 added 4 commits October 11, 2024 14:57

Simplify totalDonated addition logic

b0ae489

Rename Registar to Registry

d5c2fe4

Re-add UpdateMaxSponsors and refactor donations logic

139c8d3

- Re-add UpdateMaxSponsors function, accidentally removed earlier. - Replace DonationStats with DonationsCount field. - Update logic to derive total donations directly from the sponsors map by summing "ugnot" coins.

matijamarjanovic mentioned this pull request Oct 14, 2024

feat: add Matija's Homepage realm to examples #2916

Open

stefann-01 mentioned this pull request Oct 14, 2024

update docs (and examples) regarding PrevRealm and OrigCaller #2923

Open

zivkovicmilos marked this pull request as ready for review October 15, 2024 10:06

zivkovicmilos reviewed Oct 15, 2024

View reviewed changes

examples/gno.land/r/stefann/home/home.gno Outdated Show resolved Hide resolved

zivkovicmilos reviewed Oct 15, 2024

View reviewed changes

zivkovicmilos approved these changes Oct 15, 2024

View reviewed changes

stefann-01 added 4 commits October 15, 2024 21:23

Merge remote-tracking branch 'upstream/master'

1514a95

Do gno mod tidy in registry

2fa6e14

Merge branch 'master' into master

724f0e2

Merge branch 'master' into master

2ed45e3

stefann-01 added 6 commits October 17, 2024 00:02

Simplify sponsor rendering logic for empty sponsor list

22531c7

Replace sponsors map with AVL tree for efficiency

6cb50b7

Merge branch 'master' into master

32da9d1

Merge branch 'master' into master

9beaa83

Merge branch 'master' into master

22f9526

stefann-01 requested a review from zivkovicmilos October 18, 2024 18:57

zivkovicmilos approved these changes Oct 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(home-realm): add interactive home realm example #2918

feat(home-realm): add interactive home realm example #2918

stefann-01 commented Oct 7, 2024 •

edited

Loading

codecov bot commented Oct 7, 2024 •

edited

Loading

stefann-01 commented Oct 11, 2024 •

edited

Loading

zivkovicmilos Oct 15, 2024

stefann-01 Oct 17, 2024

zivkovicmilos Oct 18, 2024

zivkovicmilos left a comment

zivkovicmilos commented Oct 15, 2024

zivkovicmilos commented Oct 16, 2024

stefann-01 commented Oct 16, 2024 •

edited

Loading

zivkovicmilos left a comment

zivkovicmilos Oct 18, 2024

feat(home-realm): add interactive home realm example #2918

Are you sure you want to change the base?

feat(home-realm): add interactive home realm example #2918

Conversation

stefann-01 commented Oct 7, 2024 • edited Loading

Description:

Key Features:

codecov bot commented Oct 7, 2024 • edited Loading

Codecov Report

stefann-01 commented Oct 11, 2024 • edited Loading

zivkovicmilos Oct 15, 2024

Choose a reason for hiding this comment

stefann-01 Oct 17, 2024

Choose a reason for hiding this comment

zivkovicmilos Oct 18, 2024

Choose a reason for hiding this comment

zivkovicmilos left a comment

Choose a reason for hiding this comment

zivkovicmilos commented Oct 15, 2024

zivkovicmilos commented Oct 16, 2024

stefann-01 commented Oct 16, 2024 • edited Loading

zivkovicmilos left a comment

Choose a reason for hiding this comment

zivkovicmilos Oct 18, 2024

Choose a reason for hiding this comment

stefann-01 commented Oct 7, 2024 •

edited

Loading

codecov bot commented Oct 7, 2024 •

edited

Loading

stefann-01 commented Oct 11, 2024 •

edited

Loading

stefann-01 commented Oct 16, 2024 •

edited

Loading