Go to file
Sishir Giri b65f3fe070
feat: Move AppModule.BeginBlock and AppModule.EndBlock to extension interfaces (#12603)
## Description
Most modules right now have a no-op for AppModule.BeginBlock and AppModule.EndBlock. We should move these methods off the AppModule interface so we have less deadcode, and instead move them to extension interfaces. 

1. I added `BeginBlockAppModule` and `EndBlockAppModule` interface.
2. Remove the dead-code from modules that do no implement them
3. Add type casting in the the module code to use the new interface

Closes: #12462



---

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

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] 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-07-19 17:19:23 +00:00
.github chore: Fix legacy simapp compilation (#12531) 2022-07-12 06:37:49 +02:00
api fix: MsgMultiSend validation allows only a single sender (#12610) 2022-07-19 13:40:23 +02:00
baseapp refactor: remove dependency on simapp from baseapp tests (#12543) 2022-07-13 00:17:00 +02:00
client chore: check if pubkey is nil (#12623) 2022-07-18 21:41:04 -04:00
codec refactor: remove dependency on simapp from codec (#12530) 2022-07-11 21:41:50 +00:00
contrib chore: gogo/protobuf v1.3.2 (#12596) 2022-07-18 09:48:02 +00:00
core chore: routine gofumpt (#12571) 2022-07-16 18:22:05 +00:00
cosmovisor build(deps): Bump github.com/cosmos/cosmos-sdk in /cosmovisor (#12620) 2022-07-18 19:43:12 +02:00
crypto refactor(crypto): remove dependency on simapp from tests (#12614) 2022-07-18 14:45:09 +00:00
db build(deps): Bump github.com/stretchr/testify from 1.7.5 to 1.8.0 in /db (#12390) 2022-06-29 20:21:28 +01:00
depinject docs(depinject): clarify depinject API (#12214) 2022-07-19 16:00:15 +02:00
docs docs: update adr038 (#12629) 2022-07-19 09:29:42 -04:00
errors build(deps): Bump google.golang.org/grpc in /errors (#12562) 2022-07-13 19:54:21 +02:00
fuzz test: re-enable FuzzStoreInternalProofsCreateNonmembershipProof (#12176) 2022-06-08 18:44:51 +00:00
internal chore: Db linting (#12141) 2022-06-08 19:02:01 +02:00
math build(deps): Bump github.com/stretchr/testify in /math (#12514) 2022-07-11 19:27:33 +02:00
orm build(deps): Bump pgregory.net/rapid from 0.4.7 to 0.4.8 in /orm (#12599) 2022-07-15 19:15:03 +02:00
proto fix: MsgMultiSend validation allows only a single sender (#12610) 2022-07-19 13:40:23 +02:00
pruning chore: sdk.Int to math.Int (#12132) 2022-06-03 12:17:02 +00:00
runtime refactor: rename depinject imports to cosmossdk.io/depinject (#12479) 2022-07-09 17:46:07 +02:00
scripts refactor: use mocks for x/crisis keeper tests (#12558) 2022-07-13 16:32:11 +00:00
server fix: removed deprecated sdk.DBBackend variable (#12355) 2022-07-08 07:07:58 +00:00
simapp chore: routine gofumpt (#12571) 2022-07-16 18:22:05 +00:00
snapshots chore: sdk.Int to math.Int (#12132) 2022-06-03 12:17:02 +00:00
std fix: register evidence regression (#10595) 2021-12-14 14:25:31 +00:00
store chore: check if pubkey is nil (#12623) 2022-07-18 21:41:04 -04:00
telemetry refactor!: Keyring migration (#9695) 2021-09-20 12:02:15 +00:00
tests chore: Db linting (#12141) 2022-06-08 19:02:01 +02:00
testutil refactor(types): remove dependency on simapp in integration test (#12587) 2022-07-15 13:19:51 +00:00
third_party/proto feat: full api module building alongside gogo proto files with buf schema registry support (#10669) 2022-01-06 14:57:55 -05:00
tools chore: simplify and refactor linting (#12318) 2022-06-21 17:49:36 +00:00
types feat: Move AppModule.BeginBlock and AppModule.EndBlock to extension interfaces (#12603) 2022-07-19 17:19:23 +00:00
version refactor: Implementing sigs.k8s.io YAML to remove .proto yaml annotations (#9780) 2021-09-24 14:37:34 +00:00
x feat: Move AppModule.BeginBlock and AppModule.EndBlock to extension interfaces (#12603) 2022-07-19 17:19:23 +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 ci: fix gh docs action (#11547) 2022-04-05 15:04:15 +02:00
.golangci.yml chore: simplify and refactor linting (#12318) 2022-06-21 17:49:36 +00:00
.goreleaser.yml ci: automate release post tag push (#6230) 2020-05-25 20:02:08 +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 feat: full api module building alongside gogo proto files with buf schema registry support (#10669) 2022-01-06 14:57:55 -05:00
CHANGELOG.md feat: Move AppModule.BeginBlock and AppModule.EndBlock to extension interfaces (#12603) 2022-07-19 17:19:23 +00:00
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md (#7381) 2020-09-28 11:28:30 +02:00
CODING_GUIDELINES.md docs: Improve markdownlint configuration (#11104) 2022-02-10 12:07:01 +00:00
CONTRIBUTING.md docs: remove typos and IBC documentation (#11933) 2022-05-12 14:02:57 +02:00
docker-compose.yml build: add remote debugging with delve (#10587) 2021-12-01 12:44:54 +00:00
Dockerfile fix: pin go version Dockerfiles (#11711) 2022-04-20 14:33:56 -04:00
go.mod build(deps): Bump github.com/golangci/golangci-lint (#12635) 2022-07-19 18:27:06 +02:00
go.sum build(deps): Bump github.com/golangci/golangci-lint (#12635) 2022-07-19 18:27:06 +02:00
LICENSE chore: update license copyright (#12542) 2022-07-13 10:19:10 +00:00
Makefile chore: Fix legacy simapp compilation (#12531) 2022-07-12 06:37:49 +02:00
README.md docs(readme): update link to Ignite CLI (#12351) 2022-06-24 22:00:07 +02: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

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.18+

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.

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.