Go to file
Ryan Christoffersen 5e98404654
docs: bank client spec (#10147)
## Description

Ref: #9707

<!-- Add a description of the changes that this PR introduces and the files that
are the most critical to review. -->

Add `client.md` page to `bank` module spec.

---

### 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 `docs:` prefix in the PR title
- [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 [documentation writing guidelines](https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOC_WRITING_GUIDELINES.md)
- [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 `docs:` prefix in the PR title
- [ ] confirmed all author checklist items have been addressed 
- [ ] confirmed that this PR only changes documentation
- [ ] reviewed content for consistency
- [ ] reviewed content for thoroughness
- [ ] reviewed content for spelling and grammar
- [ ] tested instructions (if applicable)
2021-09-16 11:08:28 +00:00
.github build(deps): bump codecov/codecov-action from 2.0.3 to 2.1.0 (#10131) 2021-09-14 10:14:38 -04:00
baseapp refactor!: BaseApp {Check,Deliver}Tx with middleware design (#9920) 2021-08-25 14:40:33 +00:00
client feat: add sign mode direct aux handler (#9944) 2021-09-14 09:42:42 +00:00
codec test: bring back Marshalling/unmarshalling of a wrapped tx test (#10044) 2021-09-01 13:55:16 +00:00
container feat: add low-level dependency injection container API (#9658) 2021-08-12 09:07:15 -04:00
contrib refactor: Cleanup rosetta-ci docker code (#10002) 2021-09-13 12:50:49 +00:00
cosmovisor feat: change default value of DAEMON_RESTART_AFTER_UPGRADE to true (#10128) 2021-09-14 12:52:29 +00:00
crypto fix: unmarshalling issue with multisig keys in master (#10061) 2021-09-10 15:32:40 -04:00
db feat: ADR-040: Implement BadgerDB backend (#9848) 2021-09-15 02:58:10 +00:00
docs docs(adr): ADR-045: BaseApp `{Check,Deliver}Tx` as Middlewares (#9996) 2021-09-15 17:12:12 +00:00
internal/conv internal/conv: fix wrong string to bytes implementation (#9141) 2021-04-19 14:51:05 +01:00
proto/cosmos docs: Fix GetNodeInfoResponse comment (#10052) 2021-09-02 08:23:30 +00:00
scripts chore: Add script to validate gentxs (#9486) 2021-07-27 09:37:29 +00:00
server fix: rosetta server boot and add burn event type to pass check:data (#10150) 2021-09-16 10:14:03 +00:00
simapp feat(tests): add simapp setup helpers (#10020) 2021-09-15 17:18:01 -04:00
snapshots snapshots: document use of ioutil.TempDir() (#8508) 2021-02-04 09:54:01 +00:00
std Add ADR 031 BaseApp and codec infrastructure (#7519) 2020-10-15 13:07:59 +00:00
store perf: Make CacheKV store interleaved iterator and insertion not O(n^2) (#10026) 2021-09-10 15:42:56 -04:00
telemetry v043 audit changes for telemetry/ (#9297) 2021-05-11 12:28:47 +00:00
tests test: fix mockgen version (#9127) 2021-05-25 09:18:59 +00:00
testutil feat(tests): add simapp setup helpers (#10020) 2021-09-15 17:18:01 -04:00
third_party/proto Any: update and test String method (#8854) 2021-03-12 12:24:07 +00:00
types chore: change the inconsistent error message in DecCoin.ParseDecCoin func (#9831) 2021-09-14 14:43:12 +00:00
version feat: add cosmos-sdk Version (#9429) 2021-06-18 12:56:55 +00:00
x docs: bank client spec (#10147) 2021-09-16 11:08:28 +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 fix(CI): add golangci-lint to dependencies (#10112) 2021-09-14 11:05:30 +02: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: update mergify for v0.44 backports (#10146) 2021-09-15 12:43:59 +02:00
CHANGELOG.md feat: ADR-040: Implement BadgerDB backend (#9848) 2021-09-15 02:58:10 +00:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md (#7381) 2020-09-28 11:28:30 +02:00
CONTRIBUTING.md docs: Fix typo in CONTRIBUTING.md (#10143) 2021-09-14 10:59:09 -04:00
Dockerfile build: Update Dockerfile (#9839) 2021-08-03 09:46:16 -04:00
LICENSE Add README.md to Basecoin; Update licenses 2018-01-28 18:17:19 -08:00
Makefile fix(CI): add golangci-lint to dependencies (#10112) 2021-09-14 11:05:30 +02:00
README.md chore: add markdownlint to lint commands (#9353) 2021-05-27 15:31:04 +00:00
SECURITY.md chore: add markdownlint to lint commands (#9353) 2021-05-27 15:31:04 +00:00
STABLE_RELEASES.md chore: Update STABLE_RELEASES for 0.43 (#9931) 2021-08-16 09:10:50 -04:00
buf.yaml refactor: Bring back deprecated proto fields to `v1beta1` (#9534) 2021-06-23 13:03:33 +00:00
docker-compose.yml perf: Change localnet CIDR from /16 (65k addresses) to /25 (128 addresses) to reduce docker network conflicts (#9667) 2021-07-12 08:51:36 +00:00
go.mod chore: bump IAVL version (#10040) 2021-09-15 15:49:58 +02:00
go.sum chore: bump IAVL version (#10040) 2021-09-15 15:49:58 +02:00

README.md

Cosmos SDK

banner

The Cosmos-SDK is a framework for building blockchain applications in Golang. It is being used to build Gaia, the first implementation of the Cosmos Hub.

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

Note: Requires Go 1.15+

Quick Start

To learn how the SDK works from a high-level perspective, go to the SDK Intro.

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

For more, please go to the Cosmos SDK Docs.

Cosmos Hub Mainnet

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

Interblockchain Communication (IBC)

The IBC module for the SDK has moved to its own repository. Go there to build and integrate with the IBC module.

Starport

If you are starting a new app or a new module you can use Starport to help you get started and speed up development. If you have any questions or find a bug, feel free to open an issue in the repo.

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.