Go to file
Robert Zaremba 32c960a342
docs: adr-43 update and nft proto comments (#10615)
## Description

During the NFT working group we found that more clarification is needed. 

I've updated comments in NFT proto and regenerated all proto files. 

---

### 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)
- [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
- [ ] 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)
2021-11-29 08:53:04 +00:00
.github build(deps): Bump actions/cache from 2.1.6 to 2.1.7 (#10597) 2021-11-24 11:25:28 +01:00
api feat(orm): add ormfield.Codec (#10601) 2021-11-24 13:10:26 -05:00
baseapp feat: add configurable iavl cache size (#10561) 2021-11-20 09:32:30 +00:00
client fix: AuxTxBuilder check all AuxSignerData match (#10547) 2021-11-16 21:48:52 +01:00
codec refactor: move from io/ioutil to io and os package (#10341) 2021-10-13 07:38:22 +00:00
container refactor(container)!: move logging and visualization options to DebugOption (#10302) 2021-10-14 16:49:50 +00:00
contrib build: upgrade buf and contrib/devtools/dockerfile protoc-gen-go version (#10599) 2021-11-23 12:47:45 -05:00
cosmovisor doc: Update cosmosvisor README (#10584) 2021-11-20 10:21:37 +01:00
crypto chore: bump TM to v0.35.0 release candidate (#10210) 2021-11-16 11:24:38 -08:00
db chore: bump db dependencies (#10542) 2021-11-15 14:13:18 +00:00
docs docs: adr-43 update and nft proto comments (#10615) 2021-11-29 08:53:04 +00:00
internal feat: ADR-040: Implement KV Store with decoupled storage and SMT (#9892) 2021-10-19 11:58:06 +00:00
orm feat(orm): add ormfield.Codec (#10601) 2021-11-24 13:10:26 -05:00
proto docs: adr-43 update and nft proto comments (#10615) 2021-11-29 08:53:04 +00:00
scripts feat(orm): add ormfield.Codec (#10601) 2021-11-24 13:10:26 -05:00
server feat: add configurable iavl cache size (#10561) 2021-11-20 09:32:30 +00:00
simapp chore: bump TM to v0.35.0 release candidate (#10210) 2021-11-16 11:24:38 -08:00
snapshots style: lint go and markdown (#10060) 2021-10-30 13:43:04 +00:00
std Add ADR 031 BaseApp and codec infrastructure (#7519) 2020-10-15 13:07:59 +00:00
store feat: add configurable iavl cache size (#10561) 2021-11-20 09:32:30 +00:00
telemetry refactor!: Keyring migration (#9695) 2021-09-20 12:02:15 +00:00
tests test: fix mockgen version (#9127) 2021-05-25 09:18:59 +00:00
testutil chore: bump TM to v0.35.0 release candidate (#10210) 2021-11-16 11:24:38 -08:00
third_party/proto build: upgrade buf and contrib/devtools/dockerfile protoc-gen-go version (#10599) 2021-11-23 12:47:45 -05:00
types fix: AuxTxBuilder check all AuxSignerData match (#10547) 2021-11-16 21:48:52 +01:00
version refactor: Implementing sigs.k8s.io YAML to remove .proto yaml annotations (#9780) 2021-09-24 14:37:34 +00:00
x docs: adr-43 update and nft proto comments (#10615) 2021-11-29 08:53:04 +00:00
.build.sh fix library file path (#8301) 2021-01-12 10:08:42 +00:00
.clang-format Fix clang-format to specific version (#7350) 2020-10-27 10:04:34 +00:00
.codecov.yml CI: Fix codecov flag project config (#7994) 2020-11-20 09:13:25 -05:00
.deepsource.toml chore: refactor code quality issues (#8932) 2021-03-22 09:30:27 +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 docs: fix cosmovisor quickstart (#9730) 2021-07-26 07:51:36 +00:00
.golangci.yml chore: bump TM to v0.35.0 release candidate (#10210) 2021-11-16 11:24:38 -08:00
.goreleaser.yml ci: automate release post tag push (#6230) 2020-05-25 20:02:08 +02:00
.markdownlint.json chore: add markdownlint to lint commands (#9353) 2021-05-27 15:31:04 +00:00
.markdownlintignore chore: add markdownlint to lint commands (#9353) 2021-05-27 15:31:04 +00:00
.mergify.yml chore: Mergify update (#10525) 2021-11-11 15:21:56 +01:00
CHANGELOG.md feat: add configurable iavl cache size (#10561) 2021-11-20 09:32:30 +00:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md (#7381) 2020-09-28 11:28:30 +02:00
CODING_GUIDELINES.md style: lint go and markdown (#10060) 2021-10-30 13:43:04 +00:00
CONTRIBUTING.md style: lint go and markdown (#10060) 2021-10-30 13:43:04 +00:00
Dockerfile build: Update Dockerfile (#9839) 2021-08-03 09:46:16 -04:00
LICENSE docs: 10180 Fix SDK (#10237) 2021-09-28 19:33:58 +02:00
Makefile build: upgrade buf and contrib/devtools/dockerfile protoc-gen-go version (#10599) 2021-11-23 12:47:45 -05:00
README.md chore: add meeting list and working groups to contributing doc (#10315) 2021-10-13 13:01:29 +00:00
RELEASE_PROCESS.md style: lint go and markdown (#10060) 2021-10-30 13:43:04 +00:00
SECURITY.md docs: update contributing guidelines (#10223) 2021-10-01 11:36:22 +00:00
buf.work.yaml feat(orm): add ormfield.Codec (#10601) 2021-11-24 13:10:26 -05:00
docker-compose.yml build: fix build environment for the liveness test (#10551) 2021-11-15 11:02:31 -08:00
go.mod build: upgrade buf and contrib/devtools/dockerfile protoc-gen-go version (#10599) 2021-11-23 12:47:45 -05:00
go.sum build: upgrade buf and contrib/devtools/dockerfile protoc-gen-go version (#10599) 2021-11-23 12:47:45 -05:00

README.md

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 Golang programming language. Cosmos SDK is used to build Gaia, the first implementation of the Cosmos Hub.

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

Note: Requires Go 1.17+

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 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. We will only make a few notable mentions here.

  • Tools: notable frameworks and modules.
  • CosmJS: the Swiss Army knife to power JavaScript based client solutions.

Cosmos Hub Mainnet

The Cosmos Hub application, gaia, has moved to 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 moved to its own cosmos/ibc-go repository. Go there to build and integrate with the IBC module.

Starport

Starport 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 Starport 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.