Skip to content
This repository has been archived by the owner on Aug 1, 2024. It is now read-only.
/ cosmos-sdk Public archive
forked from cosmos/cosmos-sdk

Commit

Permalink
docs: add Q1 roadmap (cosmos#14898)
Browse files Browse the repository at this point in the history
## Description

Would love to hear feedback on if people are open to this format or would like to see another format. 

---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
  • Loading branch information
tac0turtle authored and tsenart committed Apr 12, 2023
1 parent d2345f8 commit 66321b2
Showing 1 changed file with 104 additions and 0 deletions.
104 changes: 104 additions & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# Roadmap 2023

Welcome to the Cosmos SDK's team roadmap.

> This document is meant to help the team get feedback on the proposed work and for others to follow where we stand in our process. This will be a living document updated on a regular basis. If you'd like to participate in any workscope or would like to suggest another feature please reach out to [Marko]([email protected]) or [Sam]([email protected]) and we will schedule a call to discuss the feature request.

## Q1

### Storage

* [Produce a spec for the new store design](https://github.com/cosmos/cosmos-sdk/issues/12986)
* Research a new design for store. This could entail writing some POC's in order to identify design patterns
* Store as its own go module
* Store module should be its own go.mod without a dependency on the Cosmos SDK
* Begin implementation of store v2
* Identify the migration path from store v1 -> store v2
* Parallel execution of state
* RFC/ADR is merged into the main on the sdk
* Optimistic execution
* RFC/ADR is merged into main on the sdk


### Client UX

* Release v1 of query support (auto-cli)
* A version of query support has been merged, documentation is missing
* Dynamic metadata support
* Dynamic support allows the Cosmos SDK to release a cmd line tool that could work with any chain.
* Add metadata support to latest version of Cosmos SDK and, if possible, backport to older versions
* Multi-chain command
* Release a cmd line tool that can be pointed a grpc endpoint which then can produce cmd lines to interact with the chain
* Auto-cli tx support
* Tx support for auto-cli/hubl
* This would fully remove the need for application developers to write cli commands for their modules


### Dev UX

* [Release collections v1](https://github.com/cosmos/cosmos-sdk/issues/14300)
* Collections is a new abstraction layer similar to the ORM. In the ADR phase it received support from many in the ecosystem.
* V1 release should allow modules to be migrated to collections.
* Migrate 3 modules to use collections api
* Migrating 3 modules to use collections would help in show users how to migrate users
* [Sign mode textual](https://github.com/cosmos/cosmos-sdk/issues/11970) (75%)
* Sign mode textual has been under construction for 2 quarters now, this quarter the goal is to move towards v1 and potentially line up a audit before final release.
* Core API
* [Merge ADR for Core API](https://github.com/cosmos/cosmos-sdk/blob/main/docs/architecture/adr-063-core-module-api.md)
* Migrate three modules to use core api
* Module Dependency
* Give three modules their own go.mods
* Cleanup dependency graph (dependent on integration testing framework)
* [Metamask signing directly into the sdk](https://github.com/cosmos/cosmos-sdk/discussions/13892)
* [ADR-033 (internal message routing)](https://github.com/cosmos/cosmos-sdk/blob/main/docs/architecture/adr-033-protobuf-inter-module-comm.md)
* Merge internal message router
* Add docs on how to use the router
* [ADR-54 (dependency management)](https://github.com/cosmos/cosmos-sdk/pull/11802)
* Come to consensus on module dependency graph for the future
* Begin socializing conventions
* [Remove global bech32](https://github.com/cosmos/cosmos-sdk/issues/13140)
* [Auth module](https://github.com/cosmos/cosmos-sdk/issues/14900)
* Produce a spec/ADR on a proposed new auth module.
* [Implement Amino Json encoder](https://github.com/cosmos/cosmos-sdk/issues/10993)

### Testing

* [integration testing framework](https://github.com/cosmos/cosmos-sdk/issues/14145)
* design and merge a integration testing framework.
* The goals of the framework would that a module only needs to depend on modules that it depends on outside of testing, not all modules in the sdk like today.


### ABCI 2.0

Issue: https://github.com/cosmos/cosmos-sdk/issues/12272

* [ADR ABCI 2.0](https://github.com/cosmos/cosmos-sdk/issues/14674)
* Write ADR for integration of vote extensions & finalize block

**Blocked**:

> once cometBFT has a release candidate of ABCI 2.0 (cmt 0.38)
* Integrate ABCI 2.0

### Security

* [Circuit breaker](https://github.com/cosmos/cosmos-sdk/issues/14226)
* Implement the circuit breaker module and prepare releases for Cosmos SDK versions 0.45, 0.46 and 0.47


### IAVL

* [ADR 001](https://github.com/cosmos/iavl/pull/608)
* Implementation has been completed, waiting on reviewers
* [Prepare the migration path](https://github.com/cosmos/iavl/issues/675)
* Migration path has not been finalized
* Test on mainnets
* If possible we would like to test the new IAVL design on mainnets to observer behavior changes.

Issue: https://github.com/cosmos/iavl/issues/548



This document will be updated at the end of the quarter on what was achieved and what was not. Shortly before the quarter concludes a new section will be added for the next quarter. We are working on updating the complete one year roadmap and will be posting it here as well.

0 comments on commit 66321b2

Please sign in to comment.