402148a39e
<!-- The default pull request template is for types feat, fix, or refactor. For other templates, add one of the following parameters to the url: - template=docs.md - template=other.md --> ## Description ref: https://github.com/cosmos/cosmos-sdk/issues/7633 <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> Following up on https://github.com/cosmos/cosmos-sdk/pull/9089, this PR is the first step towards the migration of [x/group](https://github.com/regen-network/regen-ledger/tree/master/x/group) into the SDK. It introduces the group module proto definitions (types, tx, query) and other types. The rest of the code (module, server, client, genesis...) is dependent on various other discussions (https://github.com/cosmos/cosmos-sdk/issues/9238, https://github.com/cosmos/cosmos-sdk/discussions/9182, https://github.com/cosmos/cosmos-sdk/issues/9237, https://github.com/cosmos/cosmos-sdk/issues/7773) and will be added in follow-up PRs incrementally. --- ### 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... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [x] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [x] included comments for [documenting Go code](https://blog.golang.org/godoc) - [x] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [x] 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) |
||
|---|---|---|
| .. | ||
| .vuepress | ||
| architecture | ||
| basics | ||
| building-modules | ||
| core | ||
| ibc | ||
| intro | ||
| ko | ||
| migrations | ||
| ru | ||
| run-node | ||
| spec | ||
| uml | ||
| using-the-sdk | ||
| zh | ||
| DOCS_README.md | ||
| DOC_WRITING_GUIDELINES.md | ||
| README.md | ||
| cosmos-sdk-image.jpg | ||
| package-lock.json | ||
| package.json | ||
| post.sh | ||
| pre.sh | ||
| protodoc-markdown.tmpl | ||
| versions | ||
README.md
Cosmos SDK Documentation
Get Started
- SDK Intro: High-level overview of the Cosmos SDK.
- Starport: A developer-friendly interface to the Cosmos SDK to scaffold a standard Cosmos SDK blockchain app.
- SDK Tutorials: Tutorials that showcase how to build Cosmos SDK-based blockchains from scratch and explain the basic principles of the SDK in the process.
Reference
- Basics: Documentation on the basic concepts of the Cosmos SDK, like the standard anatomy of an application, the transaction lifecycle, and accounts management.
- Core: Documentation on the core concepts of the Cosmos SDK, like
baseapp, thestore, or theserver. - Building Modules: Important concepts for module developers like
message,keeper, andquerier. - IBC: Documentation for the IBC protocol integration and concepts.
- Running a Node, API, CLI: Documentation on how to run a node and interact with the node using the CLI and the API.
- Migrations: Migration guides for updating to newer versions of the SDK.
Other Resources
- Module Directory: Cosmos SDK module implementations and their respective documentation.
- Specifications: Specifications of modules and other parts of the Cosmos SDK.
- SDK API Reference: Godocs of the Cosmos SDK.
- REST and RPC Endpoints: List of endpoints to interact with a
gaiafull-node.
Cosmos Hub
The Cosmos Hub (gaia) docs have moved to github.com/cosmos/gaia.
Languages
The Cosmos SDK is written in Golang, though the framework could be implemented similarly in other languages. Contact us for information about funding an implementation in another language.
Contribute
See the DOCS_README.md for details of the build process and considerations when making changes.