Go to file
Jim Larson c484a0dc0f
docs: Textual ADR minor fixes (#13608)
## Description

Refs: #11970

Minor fixups to architecture docs. No major semantic changes are intended.

---

### Author Checklist

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/main/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/main/docs/building-modules)
- [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing)
- [x] 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)
2022-10-23 00:52:06 +00:00
.github refactor: clean-up SDK tools (#13603) 2022-10-21 15:15:20 +00:00
api feat(cli): add module-account cli cmd and grpc get api (#13612) 2022-10-22 18:23:24 +00:00
baseapp feat: support alternative query multistore (#13529) 2022-10-17 23:40:28 +08:00
client build(deps): Bump google.golang.org/grpc from 1.50.0 to 1.50.1 in /api (#13573) 2022-10-17 20:31:47 +02:00
codec fix: add gRPC nil/zero check in query (#13352) 2022-09-29 01:20:03 +00:00
contrib refactor: clean-up SDK tools (#13603) 2022-10-21 15:15:20 +00:00
core build(deps): Bump cosmossdk.io/depinject from 1.0.0-alpha.2 to 1.0.0-alpha.3 in /tests (#13596) 2022-10-21 12:44:58 -04:00
crypto chore(crypto): update btcec to v2 (#13513) 2022-10-17 16:33:43 +02:00
depinject build(deps): Bump gotest.tools/v3 from 3.3.0 to 3.4.0 in /core (#13494) 2022-10-10 19:10:15 +02:00
docs docs: Textual ADR minor fixes (#13608) 2022-10-23 00:52:06 +00:00
errors build(deps): Bump google.golang.org/grpc from 1.50.0 to 1.50.1 in /api (#13573) 2022-10-17 20:31:47 +02:00
fuzz refactor: clean-up SDK tools (#13603) 2022-10-21 15:15:20 +00:00
internal chore: Db linting (#12141) 2022-06-08 19:02:01 +02:00
math refactor: Move FormatCoins to core (#13306) 2022-10-19 11:21:24 +00:00
orm build(deps): Bump google.golang.org/grpc from 1.50.0 to 1.50.1 in /api (#13573) 2022-10-17 20:31:47 +02:00
proto feat(cli): add module-account cli cmd and grpc get api (#13612) 2022-10-22 18:23:24 +00:00
pruning docs: improve documentation navigation and redirection (#13455) 2022-10-06 15:51:10 +02:00
runtime refactor!: require exported app wiring providers (#13292) 2022-10-10 20:27:44 +00:00
scripts refactor: simplify hooks implementation (#13396) 2022-09-27 20:37:26 +02:00
server feat: support alternative query multistore (#13529) 2022-10-17 23:40:28 +08:00
simapp build(deps): Bump tailwindcss from 3.1.8 to 3.2.0 in /docs (#13615) 2022-10-22 23:28:36 +02:00
snapshots fix: double close (#13400) 2022-09-27 18:16:13 +00:00
std fix: register evidence regression (#10595) 2021-12-14 14:25:31 +00:00
store refactor: clean-up SDK tools (#13603) 2022-10-21 15:15:20 +00:00
telemetry fix: all: fix resource leaks found by staticmajor (#13394) 2022-10-06 20:11:40 +00:00
tests build(deps): Bump tailwindcss from 3.1.8 to 3.2.0 in /docs (#13615) 2022-10-22 23:28:36 +02:00
testutil feat: gRPC query for operator and chain configuration (#13485) 2022-10-10 19:12:00 +00:00
third_party/proto docs: improve documentation navigation and redirection (#13455) 2022-10-06 15:51:10 +02:00
tools/cosmovisor refactor: clean-up SDK tools (#13603) 2022-10-21 15:15:20 +00:00
tx build(deps): Bump cosmossdk.io/depinject from 1.0.0-alpha.2 to 1.0.0-alpha.3 in /tests (#13596) 2022-10-21 12:44:58 -04:00
types feat: overwrite default denom in init cmd (#13535) 2022-10-13 18:24:28 +02:00
version chore: fix linting issues exposed by fixing golangci-lint (#12895) 2022-08-11 22:00:24 +02:00
x feat(cli): add module-account cli cmd and grpc get api (#13612) 2022-10-22 18:23:24 +00:00
.build.sh fix library file path (#8301) 2021-01-12 10:08:42 +00:00
.clang-format chore: improve proto formatting (#12656) 2022-07-21 10:56:31 +00:00
.codecov.yml CI: Fix codecov flag project config (#7994) 2020-11-20 09:13:25 -05:00
.deepsource.toml refactor: migrate to cosmos/gogoproto (#13070) 2022-09-08 17:27:48 +00:00
.dockerignore Add basic Dockerfile to build all binaries and export gaiad 2018-04-10 12:39:47 +02:00
.gitattributes Merge PR #6426: Migrate API Server 2020-06-15 13:39:09 -04:00
.gitignore build: add go.work in gitignore (#13100) 2022-08-30 21:08:04 +00:00
.gitpod.yml Create .gitpod.yml (#12662) 2022-08-15 15:18:30 +02:00
.golangci.yml build(deps): Bump github.com/golangci/golangci-lint from 1.48.0 to 1.49.0 (#13013) 2022-08-24 23:13:11 +02:00
.goreleaser.yml ci: fix release notes not populated by goreleaser 2022-08-13 20:41:27 +02:00
.markdownlint.json docs: Code blocks in SDK docs are broken (#11189) 2022-02-14 23:39:35 +01:00
.markdownlintignore docs: Improve markdownlint configuration (#11104) 2022-02-10 12:07:01 +00:00
.mergify.yml chore: master -> main (#11730) 2022-04-24 10:19:04 -04:00
buf.work.yaml refactor: migrate to cosmos/gogoproto (#13070) 2022-09-08 17:27:48 +00:00
CHANGELOG.md feat(cli): add module-account cli cmd and grpc get api (#13612) 2022-10-22 18:23:24 +00:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md (#7381) 2020-09-28 11:28:30 +02:00
CODING_GUIDELINES.md feat: migrate to docusaurus (#13471) 2022-10-10 14:01:53 +00:00
CONTRIBUTING.md docs: improve documentation navigation and redirection (#13455) 2022-10-06 15:51:10 +02:00
docker-compose.yml build: add remote debugging with delve (#10587) 2021-12-01 12:44:54 +00:00
Dockerfile build(deps): bump go minimum version to go 1.19 (#13397) 2022-09-27 21:02:02 +02:00
go.mod build(deps): Bump cosmossdk.io/depinject from 1.0.0-alpha.2 to 1.0.0-alpha.3 in /tests (#13596) 2022-10-21 12:44:58 -04:00
go.sum build(deps): Bump cosmossdk.io/depinject from 1.0.0-alpha.2 to 1.0.0-alpha.3 in /tests (#13596) 2022-10-21 12:44:58 -04:00
go.work.example refactor: clean-up SDK tools (#13603) 2022-10-21 15:15:20 +00:00
LICENSE chore: update license copyright (#12542) 2022-07-13 10:19:10 +00:00
Makefile refactor: clean-up SDK tools (#13603) 2022-10-21 15:15:20 +00:00
README.md feat: migrate to docusaurus (#13471) 2022-10-10 14:01:53 +00:00
RELEASE_PROCESS.md docs: updates outdated docs (#12014) 2022-05-31 08:59:38 -04:00
SECURITY.md docs: updates outdated docs (#12014) 2022-05-31 08:59:38 -04:00
UPGRADING.md refactor: automate EventTypeMessage inclusion in every message execution (#13532) 2022-10-16 19:00:34 -04:00

Cosmos SDK

banner

The Cosmos SDK is a framework for building blockchain applications. Tendermint Core (BFT Consensus) and the Cosmos SDK are written in the Go programming language. Cosmos SDK is used to build Gaia, the implementation of the Cosmos Hub.

WARNING: The Cosmos SDK has mostly stabilized, but we are still making some breaking changes.

Note: Requires Go 1.19+

Quick Start

To learn how the Cosmos SDK works from a high-level perspective, see the Cosmos SDK High-Level Intro.

If you want to get started quickly and learn how to build on top of Cosmos SDK, visit Cosmos SDK Tutorials. You can also fork the tutorial's repository to get started building your own Cosmos SDK application.

For more information, see the Cosmos SDK Documentation.

Contributing

See CONTRIBUTING.md for details on how to contribute and participate in our dev calls. If you want to follow the updates or learn more about the latest design then join our Discord.

Tools and Frameworks

The Cosmos ecosystem is vast. Awesome Cosmos is a community-curated list of notable frameworks, modules and tools.

Cosmos Hub Mainnet

The Cosmos Hub application, gaia, has its own cosmos/gaia repository. Go there to join the Cosmos Hub mainnet and more.

Inter-Blockchain Communication (IBC)

The IBC module for the Cosmos SDK has its own cosmos/ibc-go repository. Go there to build and integrate with the IBC module.

Ignite CLI

Ignite CLI is the all-in-one platform to build, launch, and maintain any crypto application on a sovereign and secured blockchain. If you are building a new app or a new module, use Ignite CLI to get started and speed up development.

Disambiguation

This Cosmos SDK project is not related to the React-Cosmos project (yet). Many thanks to Evan Coury and Ovidiu (@skidding) for this Github organization name. As per our agreement, this disambiguation notice will stay here.