Update Building Modules documentation #7473

blushi · 2020-10-07T12:51:30Z

Description

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the module structure standards.
Wrote unit and integration tests
Updated relevant documentation (docs/) or specification (x/<module>/spec/)
Added relevant godoc comments.
Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
Re-reviewed Files changed in the Github PR explorer
Review Codecov Report in the comment section below once CI passes

codecov · 2020-10-08T12:28:35Z

Codecov Report

Merging #7473 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #7473   +/-   ##
=======================================
  Coverage   55.98%   55.98%           
=======================================
  Files         594      594           
  Lines       37281    37281           
=======================================
  Hits        20870    20870           
  Misses      14294    14294           
  Partials     2117     2117

Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>

docs/building-modules/module-manager.md

types/module/module.go

This reverts commit 1ea1ea8.

blushi · 2020-10-14T12:12:15Z

@fedekunze Thanks for the review! I believe I addressed all your comments, could you have a final look?

amaury1093

Gave another round of read through.

docs/basics/app-anatomy.md

docs/building-modules/intro.md

docs/building-modules/keeper.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

fedekunze

💯 👏

* Update module-manager.md * Update modules #messages doc * Fix typo * Update message implementation example link * Update messages-and-queries.md#queries doc * Update querier.md * Update handler.md * Update links in beginblock-endblock.md * Update keeper.md * Update invariants.md * Update genesis.md * Update module-interfaces.md#transaction-commands * Update module-interfaces.md#query-commands * Update module-interfaces.md#flags * Update module-interfaces.md#rest * Update structure.md * Update module-interfaces.md#grpc * Update errors.md * Update module-interfaces.md#grpc-gateway-rest * Add more info on swagger * Address comments * Fix go.sum * Fix app-anatomy.md * Update docs/building-modules/module-interfaces.md Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Update docs/building-modules/querier.md Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Update docs/building-modules/querier.md Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Update docs/building-modules/module-interfaces.md Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Update docs/building-modules/module-interfaces.md Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Address part of review comments * Update old ref of RegisterQueryService * Add example code for Manager * Update queriers.md to query-services.md and refs * Add new query-services.md * Revert "Update old ref of RegisterQueryService" This reverts commit 1ea1ea8. * Update keeper.md * Update handler.md * Update handler.md * Update messages-and-queries.md * Update docs/basics/app-anatomy.md Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com> * Update docs/building-modules/intro.md Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com> * Fix typo Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

@fedekunze

* Update Encoding Doc for 0.40 (#7430) * Remove deprecated docs and add first guidelines to protobuf migration * Add conventions * Reorder and add more FAQ doc * Update guidelines for pb msg definitions * Use commit hash in github links Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * docs: Update "Basics" section (#7416) * Prettier * docs: Update "Basics" section * appcli -> appd * Better wording * Fix to appCodec * Add gRPC mention * Add grpc * Reference simapp code * Update docs/basics/accounts.md Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> * Add section about gRPC query services * Optional LegacyQuerierHandler * Clearer docs * Update docs/basics/app-anatomy.md Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> * Update docs/basics/app-anatomy.md Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Address comments * Address comments * Update docs/basics/accounts.md Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Fix misbehaviour handling for solo machine (#7515) * add timestamp to SignatureAndData Add timestamp field to signature and data. Add ValidateBasic check for timestamp. Add ValidateBasic test. Update misbehaviour handler to use supplied timestamp. * fix typo * add timestamp check * fix lint Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * update solo machine specs (#7512) * update solo machine specs * update concepts * self review fixes * Apply suggestions from code review * add note on upgarding solo machines Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Corrected 'unsafe-reset-all' help text (#7504) * Merge PR #7415: Return empty store tree on non-existing version * tendermint: update sdk to rc5 (#7527) * update sdk to rc5 * Update baseapp/params.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Bump github.com/spf13/cobra from 1.0.0 to 1.1.0 (#7553) Bumps [github.com/spf13/cobra](https://github.com/spf13/cobra) from 1.0.0 to 1.1.0. - [Release notes](https://github.com/spf13/cobra/releases) - [Changelog](https://github.com/spf13/cobra/blob/master/CHANGELOG.md) - [Commits](spf13/cobra@v1.0.0...v1.1.0) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * remove test_utils.go in tm client (#7522) * remove test_utils from tm client * fix build * fix lint? * fix lint? * apply @fedekunze review suggestion * add tests as per @alessio suggestion * fix typo * ibc: cleanup channel types test (#7521) * Update Building Modules documentation (#7473) * Update module-manager.md * Update modules #messages doc * Fix typo * Update message implementation example link * Update messages-and-queries.md#queries doc * Update querier.md * Update handler.md * Update links in beginblock-endblock.md * Update keeper.md * Update invariants.md * Update genesis.md * Update module-interfaces.md#transaction-commands * Update module-interfaces.md#query-commands * Update module-interfaces.md#flags * Update module-interfaces.md#rest * Update structure.md * Update module-interfaces.md#grpc * Update errors.md * Update module-interfaces.md#grpc-gateway-rest * Add more info on swagger * Address comments * Fix go.sum * Fix app-anatomy.md * Update docs/building-modules/module-interfaces.md Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Update docs/building-modules/querier.md Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Update docs/building-modules/querier.md Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Update docs/building-modules/module-interfaces.md Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Update docs/building-modules/module-interfaces.md Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Address part of review comments * Update old ref of RegisterQueryService * Add example code for Manager * Update queriers.md to query-services.md and refs * Add new query-services.md * Revert "Update old ref of RegisterQueryService" This reverts commit 1ea1ea8. * Update keeper.md * Update handler.md * Update handler.md * Update messages-and-queries.md * Update docs/basics/app-anatomy.md Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com> * Update docs/building-modules/intro.md Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com> * Fix typo Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com> * client: add GetAccount and GetAccountWithHeight to AccountRetriever (#7558) * client: add GetAccount and GetAccountWithHeight to AccountRetriever * update ADR * address comments from review * Add the option of emitting amino encoded json from the CLI (#7221) * Add the option of emitting amino encoded json * Update AMINO JSON serialization with ConvertTxToStdTx * Make the Amino flag more self documenting by serializing the BroadcastRequest type instead of StdTx * Handle amino encoding error * Update x/auth/client/cli/tx_multisign.go Co-authored-by: Alessio Treglia <alessio@tendermint.com> * Update x/auth/client/cli/tx_sign.go Co-authored-by: Alessio Treglia <alessio@tendermint.com> * Apply suggestions from code review Co-authored-by: Alessio Treglia <alessio@tendermint.com> * Fix go format Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> Co-authored-by: Alessio Treglia <alessio@tendermint.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * ibc: update solo machine client command (#7579) Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * docs: Revert SPEC-SPEC and update x/{auth,bank,evidence,slashing} (#7407) * Revert some changes from #7404 * Update x/slashing * Address review comments * Small tweak Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * remove id in localhost (#7577) Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> Co-authored-by: Christopher Goes <cwgoes@pluranimity.org> * update changelog * Update CHANGELOG.md Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Fix solomachine cmds (#7581) * fix solo machine cli cmds * polish Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * simapp: use tmjson on InitChainer (#7514) Co-authored-by: Alessio Treglia <alessio@tendermint.com> * [IAVL]: Bump to v0.15.0-rc4 (#7549) * iavl 0.15.0-rc4 version bump * update comments on error modes for store.LoadStore * update CONFIO_URL in makefile Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * Handle nil *Any in UnpackAny and add panic handler for tx decoding (#7594) * Handle nil any in UnpackAny * Add test * Add flag back * Update runTx signature * Update Simulate signature * Update calls to Simulate * Add txEncoder in baseapp * Fix TestTxWithoutPublicKey * Wrap errors * Use amino in baseapp tests * Add txEncoder arg to Check & Deliver * Fix gas in test * Fix remaining base app tests * Rename to amionTxEncoder * Update codec/types/interface_registry.go Co-authored-by: Aaron Craelius <aaron@regen.network> * golangci-lint fix Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com> Co-authored-by: Aaron Craelius <aaron@regen.network> Co-authored-by: Cory Levinson <cjlevinson@gmail.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Marie Gauthier <marie.gauthier63@gmail.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com> Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> Co-authored-by: Neeraj Murarka <njmurarka@users.noreply.github.com> Co-authored-by: Riccardo Montagnin <riccardo.montagnin@gmail.com> Co-authored-by: Marko <marbar3778@yahoo.com> Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Zaki Manian <zaki@manian.org> Co-authored-by: Alessio Treglia <alessio@tendermint.com> Co-authored-by: Christopher Goes <cwgoes@pluranimity.org> Co-authored-by: Aaron Craelius <aaron@regen.network>

blushi added 2 commits October 7, 2020 14:49

Update module-manager.md

cb87c4f

Merge branch 'master' of github.com:cosmos/cosmos-sdk

49bdfa0

blushi mentioned this pull request Oct 7, 2020

Update documentation for Stargate #6953

Closed

blushi added 6 commits October 7, 2020 15:23

Update modules #messages doc

0bc40be

Fix typo

916a80b

Update message implementation example link

340babe

Update messages-and-queries.md#queries doc

844401d

Update querier.md

0a8fa86

Update handler.md

25bc998

blushi added 15 commits October 8, 2020 14:32

Update links in beginblock-endblock.md

2c7010b

Update keeper.md

201d442

Update invariants.md

546aefc

Update genesis.md

3918392

Update module-interfaces.md#transaction-commands

d0bac01

Update module-interfaces.md#query-commands

0686e5e

Merge branch 'master' into marie/6953-building-modules

e76bdaf

Update module-interfaces.md#flags

6dac9b2

Update module-interfaces.md#rest

fadd8c1

Update structure.md

8b58c43

Merge branch 'master' into marie/6953-building-modules

bcb17dd

Update module-interfaces.md#grpc

2fed130

Update errors.md

289e10e

Update module-interfaces.md#grpc-gateway-rest

d0d4b34

Merge branch 'master' into marie/6953-building-modules

757b711

blushi marked this pull request as ready for review October 9, 2020 15:21

blushi requested review from aaronc, alessio and alexanderbez as code owners October 9, 2020 15:21

blushi requested a review from anilcse October 9, 2020 15:21

blushi and others added 5 commits October 13, 2020 16:59

Update docs/building-modules/module-interfaces.md

0635919

Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com>

Address part of review comments

b19c8e1

Update old ref of RegisterQueryService

1ea1ea8

Add example code for Manager

56f9e10

Update queriers.md to query-services.md and refs

bbd52c1

fedekunze reviewed Oct 14, 2020

View reviewed changes

docs/building-modules/module-manager.md Outdated Show resolved Hide resolved

fedekunze reviewed Oct 14, 2020

View reviewed changes

types/module/module.go Outdated Show resolved Hide resolved

blushi added 6 commits October 14, 2020 11:35

Add new query-services.md

447ebb7

Revert "Update old ref of RegisterQueryService"

03e4c56

This reverts commit 1ea1ea8.

Update keeper.md

5ad70f4

Update handler.md

9201a1a

Update handler.md

9d156fa

Update messages-and-queries.md

e8d6858

amaury1093 approved these changes Oct 14, 2020

View reviewed changes

docs/basics/app-anatomy.md Outdated Show resolved Hide resolved

docs/building-modules/intro.md Outdated Show resolved Hide resolved

docs/building-modules/keeper.md Outdated Show resolved Hide resolved

blushi and others added 3 commits October 14, 2020 14:28

Update docs/basics/app-anatomy.md

6ef1db3

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

Update docs/building-modules/intro.md

bd20a72

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

Fix typo

1d02539

fedekunze approved these changes Oct 14, 2020

View reviewed changes

Merge branch 'master' into marie/6953-building-modules

4288915

fedekunze added A:automerge Automatically merge PR once all prerequisites pass. T:Docs Changes and features related to documentation. labels Oct 14, 2020

mergify bot merged commit 589835d into master Oct 14, 2020

mergify bot deleted the marie/6953-building-modules branch October 14, 2020 12:38

blushi added the backport/0.40.x (Stargate) label Oct 15, 2020

clevinson mentioned this pull request Oct 19, 2020

[backports] v0.40.0-rc1 #7590

Merged

31 tasks

clevinson mentioned this pull request Oct 23, 2020

[docs]: update building modules section to reflect ADR31 #7660

Closed

blushi mentioned this pull request Oct 29, 2020

[docs]: update building modules section to reflect ADR31 #7702

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Building Modules documentation #7473

Update Building Modules documentation #7473

blushi commented Oct 7, 2020 •

edited

Loading

codecov bot commented Oct 8, 2020 •

edited

Loading

blushi commented Oct 14, 2020

amaury1093 left a comment

fedekunze left a comment

Update Building Modules documentation #7473

Update Building Modules documentation #7473

Conversation

blushi commented Oct 7, 2020 • edited Loading

Description

codecov bot commented Oct 8, 2020 • edited Loading

Codecov Report

blushi commented Oct 14, 2020

amaury1093 left a comment

Choose a reason for hiding this comment

fedekunze left a comment

Choose a reason for hiding this comment

blushi commented Oct 7, 2020 •

edited

Loading

codecov bot commented Oct 8, 2020 •

edited

Loading