Closed
Description
openedon Aug 5, 2024
The time for stable module api is coming! With v0.52 almost (internally) audited and ready for alpha, we need to make sure cosmossdk.io/core v1 has good APIs.
From our call (1/2) we should change a few things before the alpha:
- store:
- Add documentation that
TransientStoreService
isn't supported for store/v2 (refactor(core): core review (1/n) #21193) - Use core/store.StoreUpgrade in x/upgrade (@tac0turtle refactor: use corestore.StoreUpgrades #21259)
- Remove NonConsensusStore until implemented (refactor(core): core review (1/n) #21193)
- Check if
Changeset
/KVPairs
should remain in core/store (@tac0turtle) - Move some interfaces from core/store to core/server (@julienrbrt): not moved, but added docs
- Add documentation that
- router
- Remove
InvokeTyped
from router.Service and renameInvokeUntyped
to invoke. Update the usage in module code (@julienrbrt) (refactor(core,stf,x)!: remove InvokeTyped from router #21224)
- Remove
- app
- Change type requirement
BlockRequest
(https://github.com/cosmos/cosmos-sdk/blob/main/core/app/app.go#L29-L30) - Check if
ConsensusMessages
still needed there (@tac0turtle) (refactor: remove consensus messages #21248) - Determine if events should be improved ([Feature]: Consider using schema/appdata event model in core/app #21312)
- Determine if
core/app
should be moved back to server/v2 (not as its core modules but directly next to their implementation), if not moved, possibly rename it instead (@tac0turtle) (chore: cleanup core/app #21368) - Add
doc.go
(chore: cleanup core/app #21368)
- Change type requirement
- legacy
- Rename legacy package to something more obvious. Additionally, think of putting all legacy interfaces in one package. (refactor(core): move amino registrar and drop legacy package #21531)
- attempt at 0 dependency for core (remove gogoproto) (ref refactor: zerodep core #21239)
- Refactor handlers to not require
gogoproto.MessageName
- router should get the name (@julienrbrt) (refactor(core): re-add handlers #21575)
- Refactor handlers to not require
- documentation
- Add function and package documentation on every public function of core (@julienrbrt, @kocubinski, @tac0turtle) (docs(core): add core documentation and principles #21511)
- Add core principles in README.md (docs(core): add core documentation and principles #21511)
In our next meeting (2/2), we'll finish reviewing core/store, core/testing and core/transaction. DONE.
Upon closing this issue, we can tag cosmossdk.io/core
v1-alpha.1
(final v1
after 0.52 audit)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Metadata
Assignees
Labels
Type
Projects
Status
🥳 Done