cosmos-sdk/x/bank/types
Ivan Gavran 9f543b1c3b
refactor: Small clarifications to authz docs and one error description (#11506)
## 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)
2022-04-03 09:50:51 +00:00
..
authz.pb.go chore: Add "Since:" on proto doc comments (#10434) 2021-10-27 14:13:35 +00:00
balance.go refactoring balance.coin validation 2021-08-03 19:43:38 +02:00
balance_test.go revert: Revert "feat: staking config (#10988)" (#11446) 2022-03-24 12:26:25 +01:00
bank.pb.go chore: remove & add `since:` (#11094) 2022-02-02 20:36:47 +01:00
codec.go fix: RegisterLegacyAminoCodec should error if Msg name is >39 chars (#11349) 2022-03-16 13:21:00 +00:00
errors.go x/bank/types: fix AddressFromBalancesStore panics with invalid keys (#9061) 2021-04-07 16:20:38 +00:00
events.go [bank]: add balance tracking events (#8656) 2021-02-25 18:15:02 +00:00
expected_keepers.go perf!: Add HasAccount to the AuthKeeper to save protobuf decoding time (#10022) 2021-08-31 05:07:31 +00:00
genesis.go codec: Rename codec and marshaler interfaces (#9226) 2021-04-29 10:46:22 +00:00
genesis.pb.go refactor: Implementing sigs.k8s.io YAML to remove .proto yaml annotations (#9780) 2021-09-24 14:37:34 +00:00
genesis_test.go auth: allow 0 coin accounts in genesis (#8714) 2021-02-26 15:41:48 +00:00
key.go fix: x/bank/044 migrateDenomMetadata (#10239) 2021-09-29 01:40:18 +02:00
key_test.go fix: x/bank/044 migrateDenomMetadata (#10239) 2021-09-29 01:40:18 +02:00
metadata.go bank: name and symbol metadata fields (#8677) 2021-02-24 20:06:04 -03:00
metadata_test.go bank: name and symbol metadata fields (#8677) 2021-02-24 20:06:04 -03:00
msgs.go feat: replace all ModuleCdc instances with legacy.Cdc (#11240) 2022-02-23 14:13:36 +00:00
msgs_test.go refactor!: change GetSigners return type to []sdk.AccAddress (#9915) 2021-08-13 15:34:00 +00:00
params.go refactor: Implementing sigs.k8s.io YAML to remove .proto yaml annotations (#9780) 2021-09-24 14:37:34 +00:00
params_test.go refactor: Implementing sigs.k8s.io YAML to remove .proto yaml annotations (#9780) 2021-09-24 14:37:34 +00:00
querier.go feat: add support for spendable balances gRPC query (#11417) 2022-03-25 11:24:58 +01:00
query.pb.go feat: add support for spendable balances gRPC query (#11417) 2022-03-25 11:24:58 +01:00
query.pb.gw.go fix: Protobuf docker (#11472) 2022-03-26 23:38:32 +01:00
send_authorization.go refactor: Small clarifications to authz docs and one error description (#11506) 2022-04-03 09:50:51 +00:00
send_authorization_test.go refactor(test)!: refactor `simapp.Setup` function (#9938) 2021-08-17 00:52:06 +00:00
tx.pb.go feat: add message option extension to signal msg signers in a language agnostic way (#10977) 2022-01-28 17:01:56 +00:00
vesting.go refactor: remove x/auth vesting dependency in x/bank (#10967) 2022-01-18 16:10:56 -05:00