Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v2 Documentation #22531

Open
1 task done
julienrbrt opened this issue Nov 14, 2024 · 0 comments
Open
1 task done

v2 Documentation #22531

julienrbrt opened this issue Nov 14, 2024 · 0 comments
Labels
T:Docs Changes and features related to documentation.

Comments

@julienrbrt
Copy link
Member

julienrbrt commented Nov 14, 2024

Once #21429 is completed, we should focus on the documentation and upgrading documentation for docs.cosmos.network/v2 for Cosmos SDK (server) v2.

The removal of baseapp and change of all core concepts will require quite an overhaul.

Documentation

Core Concepts

  • STF
    • Branching
  • Server Components
  • Runtime/v2
  • Store/v2
    • Different database backend ss/sc
  • IAVL v2

App

  • Use runtime/v2 and simapp/v2

CometBFT server

  • CometBFT server
  • ABCI
  • Optimistic Execution on by default and cannot be disabled.

Modules

Module documentation changes are limited compared to #21429 thanks to core v1:

  • TxValidators
  • Handlers (Optional, gRPC services are still supported)
    • If you use handler, no gRPC service will be available for that module

Testing

  • integration tests framework v2
  • sims v2
  • systemtests

Upgrading Guide

  • Create a UPGRADING_V2.md

Modules

Server

  • Telemetry server is another port (1328)
  • New REST server for querying modules (8080) -> Use post and type_url (docs at server/v2/api/rest/README.md)
  • gRPC: new service to query the modules gRPC messages, without going via module services
  • gRPC: external gRPC services no more registered in the application router (e.g. nodeservice, cmtservice, authtx service)

App

  • Use runtime/v2 and simapp/v2 (no brainer)
@julienrbrt julienrbrt added the T:Docs Changes and features related to documentation. label Nov 14, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Cosmos-SDK Nov 14, 2024
@julienrbrt julienrbrt pinned this issue Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:Docs Changes and features related to documentation.
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant