chore(demo): upgradable realm demo #3147
Conversation
github-actions
bot
added
the
🧾 package/realm
|
It's our initial approach to tackle to the upgradable realm feature. Please have a look. @moul @zivkovicmilos @Kouteki |
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
|
Moved to manfred_upgrade_patterns folder! |
| @@ -0,0 +1,5 @@ | |||
| module gno.land/r/x/manfred_upgrade_patterns/upgrade_g/admin | |||
|
|
|||
| require ( | |||
|
|
||
| var store admin.Store = nil | ||
|
|
||
| func Init() { |
There was a problem hiding this comment.
Is this uppercase on purpose?
There was a problem hiding this comment.
It needs to be lowercase if this is supposed to be a realm constructor
There was a problem hiding this comment.
Not a constructor, meant to be called by the testing code as an emulated deployment
| "gno.land/r/x/manfred_upgrade_patterns/upgrade_g/admin" | ||
| ) | ||
|
|
||
| var store admin.Store = nil |
There was a problem hiding this comment.
Why does store need to be the global, and not an instance of logic?
There was a problem hiding this comment.
The main question is why doesn't this store instance live in the logic instance?
There was a problem hiding this comment.
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.
|
|
||
| var store admin.Store = nil | ||
|
|
||
| func Init() { |
There was a problem hiding this comment.
Same question, why uppercase?
|
|
||
| func (s *store) GetCounter() uint64 { | ||
| if s != currentStore { | ||
| panic("Revoked store") |
There was a problem hiding this comment.
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.
| return currentStore | ||
| } | ||
|
|
||
| func Init() { |
| std.TestSetRealm(std.NewUserRealm(alice)) | ||
| std.TestSetOrigCaller(alice) // XXX: should not need this | ||
|
|
||
| store.Init() |
There was a problem hiding this comment.
I understand now, you want to manually trigger the init :)
| store.Init() | ||
|
|
||
| v1.Init() | ||
| urequire.Equal(t, admin.ReadCounter(), uint64(0)) |
There was a problem hiding this comment.
Nitpick, but the order of urequire.Equal is expected, then actual (swap the last 2 values)
| - 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) |
There was a problem hiding this comment.
Nitpick: this is an =, not a -
|
Run go mod tidy, fix README.md, fix testing, replied to comments |
|
The Also, please check why the CI is failing. |
Added upgradable realm demo.
Contributors' checklist...
BREAKING CHANGE: xxxmessage was included in the description