chore(demo): upgradable realm demo #3147

mconcat · 2024-11-18T12:04:56Z

Added upgradable realm demo.

admin: main entrypoint for users and controller contract for store and logic
store: persistent storage layer across migration steps
logic: switchable logic implementation

Contributors' checklist...

Added new tests, or not needed, or not feasible
Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
Updated the official documentation or not needed
No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
Added references to related issues and PRs
Provided any useful hints for running manual tests

dongwon8247 · 2024-11-18T12:13:35Z

It's our initial approach to tackle to the upgradable realm feature. Please have a look. @moul @zivkovicmilos @Kouteki

codecov · 2024-11-18T12:31:23Z

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

examples/gno.land/r/demo/upgradable/admin/entry.gno

ltzmaxwell

LGTM. will approve after this implementation integrated with other ones.

examples/gno.land/r/demo/upgradable/admin/logic.gno

mconcat · 2024-11-24T06:59:18Z

Moved to manfred_upgrade_patterns folder!

zivkovicmilos

Clever :)

We should definitely document these approaches in Efficient Gno, they are too valuable to be buried in our code READMEs (@Kouteki @moul)

zivkovicmilos · 2024-11-28T03:03:18Z

examples/gno.land/r/x/manfred_upgrade_patterns/upgrade_g/admin/gno.mod

@@ -0,0 +1,5 @@
+module gno.land/r/x/manfred_upgrade_patterns/upgrade_g/admin
+
+require (


gno mod tidy

zivkovicmilos · 2024-11-28T03:06:42Z

examples/gno.land/r/x/manfred_upgrade_patterns/upgrade_g/logic/v1/counter.gno

+
+var store admin.Store = nil
+
+func Init() {


Is this uppercase on purpose?

It needs to be lowercase if this is supposed to be a realm constructor

Not a constructor, meant to be called by the testing code as an emulated deployment

zivkovicmilos · 2024-11-28T03:09:28Z

examples/gno.land/r/x/manfred_upgrade_patterns/upgrade_g/logic/v1/counter.gno

+	"gno.land/r/x/manfred_upgrade_patterns/upgrade_g/admin"
+)
+
+var store admin.Store = nil


Why does store need to be the global, and not an instance of logic?

The main question is why doesn't this store instance live in the logic instance?

The logic is simply a set of functions to be registered to the admin. It is a workaround with interfaces as they are not able to cross the realm boundary. Store, in this case, needs to be accessed by any functions in the realm, entrypoint or not. By having store as a top level variable it could have the similar coding style with having state variables.

zivkovicmilos · 2024-11-28T03:14:19Z

examples/gno.land/r/x/manfred_upgrade_patterns/upgrade_g/logic/v2/counter.gno

+
+var store admin.Store = nil
+
+func Init() {


Same question, why uppercase?

zivkovicmilos · 2024-11-28T03:16:31Z

examples/gno.land/r/x/manfred_upgrade_patterns/upgrade_g/store/store.gno

+
+func (s *store) GetCounter() uint64 {
+	if s != currentStore {
+		panic("Revoked store")


When is this possible?

The user tries to call the public function in a old version logics without going through the admin interface. In this case, any outer-world call would fail because the prevRealm will return the logic's address, not the admin's. However, the old logics still holds the store reference, thus need to be deprecated when a new store struct is instantiated.

zivkovicmilos · 2024-11-28T03:17:14Z

examples/gno.land/r/x/manfred_upgrade_patterns/upgrade_g/store/store.gno

+	return currentStore
+}
+
+func Init() {


zivkovicmilos · 2024-11-28T03:20:17Z

examples/gno.land/r/x/manfred_upgrade_patterns/upgrade_g/upgradable_testing/upgradable_test.gno

+	std.TestSetRealm(std.NewUserRealm(alice))
+	std.TestSetOrigCaller(alice) // XXX: should not need this
+
+	store.Init()


I understand now, you want to manually trigger the init :)

zivkovicmilos · 2024-11-28T03:21:05Z

examples/gno.land/r/x/manfred_upgrade_patterns/upgrade_g/upgradable_testing/upgradable_test.gno

+	store.Init()
+
+	v1.Init()
+	urequire.Equal(t, admin.ReadCounter(), uint64(0))


Nitpick, but the order of urequire.Equal is expected, then actual (swap the last 2 values)

zivkovicmilos · 2024-11-28T03:33:11Z

examples/gno.land/r/x/manfred_upgrade_patterns/README.md

+- Diamond pattern of admin <-> (multiple version of logics) <-> store
+- The admin provides persistent interface for the interaction for the other contracts and users
+- The store acts as the persistent storage independent from the migration
+= Logics could be replaced, registering the entrypoint functions as function variables to the admin and taking the store access(while revoking the previous one)


Nitpick: this is an =, not a -

mconcat · 2024-11-28T08:17:23Z

Run go mod tidy, fix README.md, fix testing, replied to comments

leohhhn · 2024-11-28T13:57:24Z

The x/ folder is for experimentation; you can create your own namespace, or an onbloc namespace in it; no need to keep it under "manfred_upgrade_patterns" :)

Also, please check why the CI is failing.

thehowl · 2025-01-16T14:57:12Z

@mconcat, can you address the latest comment?

Gno2D2 · 2025-01-16T14:58:15Z

🛠 PR Checks Summary

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

Manual Checks (for Reviewers):

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

✅ 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
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 The pull request was created from a fork (head branch repo: gnoswap-labs/gno)

Then

🔴 Requirement not satisfied
└── 🔴 Maintainer can modify this pull request

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

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🟢 Requirement 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
    └── 🟢 Then
        └── 🟢 Not (🔴 This label is applied to pull request: review/triage-pending)

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

thehowl · 2025-02-11T16:28:55Z

@mconcat, please re-create this PR from your personal account, so we can merge in master when needed.

Also, please make sure the PR passes the CI. I think in general it's looking good, so if you re-create it and fix it up, it should be merged rather quickly

add upgradable realm demo

31dbc62

github-actions bot assigned mconcat Nov 18, 2024

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

mconcat changed the title ~~Upgradable realm demo~~ chore(demo): upgradable realm demo Nov 18, 2024

moul reviewed Nov 18, 2024

View reviewed changes

examples/gno.land/r/demo/upgradable/admin/entry.gno Outdated Show resolved Hide resolved

ltzmaxwell reviewed Nov 22, 2024

View reviewed changes

examples/gno.land/r/demo/upgradable/admin/logic.gno Outdated Show resolved Hide resolved

mconcat added 2 commits November 24, 2024 15:56

move to canonical folder

33ac66f

Merge branch 'master' into mconcat/upgradable-realm-demo

3929646

Kouteki requested review from ltzmaxwell and moul November 24, 2024 10:29

ltzmaxwell approved these changes Nov 24, 2024

View reviewed changes

dongwon8247 mentioned this pull request Nov 27, 2024

Onbloc's Builder Journey gnolang/hackerspace#29

Open

Merge branch 'master' into mconcat/upgradable-realm-demo

0da5ee7

zivkovicmilos approved these changes Nov 28, 2024

View reviewed changes

apply reviews

4ed558c

Merge branch 'master' into mconcat/upgradable-realm-demo

e0c2424

dongwon8247 mentioned this pull request Jan 20, 2025

Remaining tasks of the GnoSwap realms before launching gnoswap-labs/gnoswap#470

Open

r3v4s mentioned this pull request Jan 20, 2025

[RFC] Apply Upgradable Realm Pattern gnoswap-labs/gnoswap#471

Open

thehowl closed this Feb 11, 2025

		@@ -0,0 +1,5 @@
		module gno.land/r/x/manfred_upgrade_patterns/upgrade_g/admin

		require (

chore(demo): upgradable realm demo #3147

chore(demo): upgradable realm demo #3147

Conversation

mconcat commented Nov 18, 2024

dongwon8247 commented Nov 18, 2024

codecov bot commented Nov 18, 2024 • edited Loading

Codecov Report

ltzmaxwell left a comment

Choose a reason for hiding this comment

mconcat commented Nov 24, 2024

zivkovicmilos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mconcat commented Nov 28, 2024

leohhhn commented Nov 28, 2024

thehowl commented Jan 16, 2025

Gno2D2 commented Jan 16, 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

thehowl commented Feb 11, 2025

codecov bot commented Nov 18, 2024 •

edited

Loading

Gno2D2 commented Jan 16, 2025 •

edited

Loading