9f543b1c3b
## Description
This small PR is trying to clarify the documentation that I found ambiguous when reading it.
Furthermore, it makes one error message more precise ("non-negative" --> "positive").
In particular:
- I clarified that the field `AcceptResponse.Accept` will be set to `true` when an authorization is accepted, but **will not** be set to `false` otherwise (instead, the function `Accept` will return an error).
- I clarified that the field `AcceptResponse.Updated` will not always be populated: it will be `nil` unless there are real changes to the authorization
- I changed the error message in the `send_authorization.go` function, when `IsAllPositive()` returns `false` from _spend limit cannot be negitive_ to _spend limit must be positive_. I emphasized the fact that spend limit must be positive in the documentation.
This is my first contribution to the Cosmos-SDK codebase so if I made some mistake the process (wrt the checklist), guide me patiently, pls.
---
### 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))
- [ ] provided a link to the relevant issue or specification: NOTE: does not apply, these are clarification changes
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules): NOTE: does not apply, these are clarification changes
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing): NOTE: does not apply, these are clarification changes
- [ ] added a changelog entry to `CHANGELOG.md`: NOTE: does not apply, these are clarification changes
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) NOTE: does not apply, these are clarification changes
- [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)
|
||
|---|---|---|
| .github | ||
| api | ||
| baseapp | ||
| client | ||
| codec | ||
| container | ||
| contrib | ||
| cosmovisor | ||
| crypto | ||
| db | ||
| docs | ||
| errors | ||
| internal | ||
| orm | ||
| proto | ||
| scripts | ||
| server | ||
| simapp | ||
| snapshots | ||
| std | ||
| store | ||
| telemetry | ||
| tests | ||
| testutil | ||
| third_party/proto | ||
| types | ||
| version | ||
| x | ||
| .build.sh | ||
| .clang-format | ||
| .codecov.yml | ||
| .deepsource.toml | ||
| .dockerignore | ||
| .gitattributes | ||
| .gitignore | ||
| .golangci.yml | ||
| .goreleaser.yml | ||
| .markdownlint.json | ||
| .markdownlintignore | ||
| .mergify.yml | ||
| buf.work.yaml | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| CODING_GUIDELINES.md | ||
| CONTRIBUTING.md | ||
| docker-compose.yml | ||
| Dockerfile | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| RELEASE_PROCESS.md | ||
| SECURITY.md | ||
Cosmos SDK
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.