docs: Revert SPEC-SPEC and update x/{auth,bank,evidence,slashing} #7407

amaury1093 · 2020-09-29T10:23:30Z

Description

For x/{auth,bank,evidence,slashing} :

read through the docs to make sure they're still up to date
replace deprecated go interfaces/structs with their newer versions
use protobuf message instead of go structs, where possible
use a single README.md instead of separate spec files.

rendered:

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

x/slashing/spec/README.md

amaury1093 · 2020-09-29T10:55:57Z

x/auth/spec/README.md

+all fields of all accounts, and to iterate over all stored accounts.
+
+```go
+type AccountKeeper interface {


This interface doesn't seem to exist anymore in x/auth.

2 notes:

there is a type AccountKeeper interface in most modules, I think the one in x/auth just got deleted?

godoc mentions a sdk.AccountKeeper

cosmos-sdk/x/auth/keeper/account.go

Lines 8 to 9 in bf8809e

// NewAccountWithAddress implements sdk.AccountKeeper.

func (ak AccountKeeper) NewAccountWithAddress(ctx sdk.Context, addr sdk.AccAddress) types.AccountI {

but I can't find that either.

I am going to add back a type AccountKeeper interface in x/auth. But if anyone has any other idea, please let me know.

Edit: done in b146fe0

codecov · 2020-09-29T11:29:00Z

Codecov Report

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

@@           Coverage Diff           @@
##           master    #7407   +/-   ##
=======================================
  Coverage   54.77%   54.77%           
=======================================
  Files         601      601           
  Lines       38142    38142           
=======================================
  Hits        20891    20891           
  Misses      15126    15126           
  Partials     2125     2125

tac0turtle · 2020-09-29T11:31:17Z

Could you also check for broken links? This may break countless links

amaury1093 · 2020-09-29T14:29:54Z

x/auth/spec/README.md

+   - [Handlers](03_messages.md#handlers)
+4. **[Keepers](04_keepers.md)**
+   - [Account Keeper](04_keepers.md#account-keeper)
+5. **[Vesting](05_vesting.md)**


this section does not adhere to the SPEC-SPEC, but I believe it's important enough to deserve its own section.

clevinson

Thank you @amaurymartiny!! Just left a few comments with some minor improvements to be made.

clevinson · 2020-10-08T01:05:34Z

x/auth/spec/03_types.md

-order: 4
-->
-
-# Types


Are the corresponding new proto types documented elsewhere or will they be covered in a separate PR ?

There's a "new page for Tx Signing" in #6953, I believe it suits more over there? It also echoes to Robert's refactor attempt to move tx stuff outside of x/auth.

x/auth/spec/README.md

clevinson · 2020-10-08T01:19:55Z

x/evidence/spec/06_begin_block.md

+
+### Equivocation
+
+Currently, the evidence module only handles evidence of type `Equivocation` which is derived from


@amaurymartiny I think we should add some mention of the new light client evidence handling here as well. cc @robert-zaremba @marbar3778 who may have more info on how that should look.

yes this needs updating

Updated, lmk if there are mistakes in my understanding of evidence handling

…953-slashing

clevinson

lgtm!

fedekunze · 2020-10-16T12:19:59Z

docs/spec/SPEC-SPEC.md

+- `XX_begin_block.md` - specify any begin-block operations
+- `XX_end_block.md` - specify any end-block operations
+- `XX_hooks.md` - describe available hooks to be called by/from this module
+- `XX_events.md` - list and describe event tags used


Suggested change

- `XX_events.md` - list and describe event tags used

- `XX_events.md` - list and describe event tags used

- `XX_metrics.md` - list and describe module specific metrics exposed for telemetry

) * 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>

@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>

amaury1093 mentioned this pull request Sep 29, 2020

Update SPEC-SPEC & documentation for x/{bank,evidence} #7404

Merged

9 tasks

tac0turtle reviewed Sep 29, 2020

View reviewed changes

x/slashing/spec/README.md Outdated Show resolved Hide resolved

amaury1093 commented Sep 29, 2020

View reviewed changes

amaury1093 marked this pull request as ready for review September 29, 2020 11:24

amaury1093 requested review from aaronc, alessio and alexanderbez as code owners September 29, 2020 11:24

amaury1093 added the T:Docs Changes and features related to documentation. label Sep 29, 2020

amaury1093 mentioned this pull request Sep 29, 2020

Update documentation for Stargate #6953

Closed

amaury1093 requested a review from clevinson September 29, 2020 11:28

amaury1093 marked this pull request as draft September 29, 2020 13:57

amaury1093 added 2 commits September 29, 2020 16:22

Revert some changes from #7404

136cd16

Update x/slashing

de781ff

amaury1093 force-pushed the am-6953-slashing branch from c8dcea8 to de781ff Compare September 29, 2020 14:25

amaury1093 changed the title ~~docs: Update x/{auth,slashing}~~ docs: Revert SPEC-SPEC and update x/{auth,bank,evidence,slashing} Sep 29, 2020

amaury1093 commented Sep 29, 2020

View reviewed changes

amaury1093 marked this pull request as ready for review September 29, 2020 14:30

amaury1093 added 2 commits October 1, 2020 12:13

Merge branch 'master' into am-6953-slashing

a867974

Merge branch 'master' into am-6953-slashing

4c533b5

amaury1093 requested review from anilcse, atheeshp, blushi and robert-zaremba October 1, 2020 15:05

Merge branch 'master' into am-6953-slashing

50f4af1

amaury1093 added the A:automerge Automatically merge PR once all prerequisites pass. label Oct 2, 2020

amaury1093 added 2 commits October 5, 2020 16:39

Merge branch 'master' into am-6953-slashing

b1a6ca0

Merge branch 'master' into am-6953-slashing

146704a

clevinson requested changes Oct 8, 2020

View reviewed changes

amaury1093 added 5 commits October 8, 2020 16:02

Merge branch 'master' of ssh://github.com/cosmos/cosmos-sdk into am-6…

77fef98

…953-slashing

Address review comments

86fda6c

Small tweak

bad3498

Merge branch 'master' of ssh://github.com/cosmos/cosmos-sdk into am-6…

680f9b3

…953-slashing

Merge branch 'master' into am-6953-slashing

8014441

amaury1093 added the backport/0.40.x (Stargate) label Oct 12, 2020

clevinson approved these changes Oct 13, 2020

View reviewed changes

amaury1093 added A:automerge Automatically merge PR once all prerequisites pass. and removed A:automerge Automatically merge PR once all prerequisites pass. labels Oct 14, 2020

amaury1093 and others added 2 commits October 14, 2020 11:16

Merge branch 'master' into am-6953-slashing

fe98c92

Merge branch 'master' into am-6953-slashing

95f6c74

fedekunze approved these changes Oct 16, 2020

View reviewed changes

Merge branch 'master' into am-6953-slashing

c41456d

mergify bot merged commit 69e2b7d into master Oct 16, 2020

mergify bot deleted the am-6953-slashing branch October 16, 2020 12:42

clevinson mentioned this pull request Oct 19, 2020

[backports] v0.40.0-rc1 #7590

Merged

31 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Revert SPEC-SPEC and update x/{auth,bank,evidence,slashing} #7407

docs: Revert SPEC-SPEC and update x/{auth,bank,evidence,slashing} #7407

amaury1093 commented Sep 29, 2020 •

edited

amaury1093 Sep 29, 2020 •

edited

codecov bot commented Sep 29, 2020 •

edited

tac0turtle commented Sep 29, 2020

amaury1093 Sep 29, 2020

clevinson left a comment

clevinson Oct 8, 2020

amaury1093 Oct 8, 2020

clevinson Oct 8, 2020

tac0turtle Oct 8, 2020 •

edited

amaury1093 Oct 8, 2020

clevinson left a comment

fedekunze Oct 16, 2020

	// NewAccountWithAddress implements sdk.AccountKeeper.
	func (ak AccountKeeper) NewAccountWithAddress(ctx sdk.Context, addr sdk.AccAddress) types.AccountI {


		### Equivocation

		Currently, the evidence module only handles evidence of type `Equivocation` which is derived from

	- `XX_events.md` - list and describe event tags used
	- `XX_events.md` - list and describe event tags used
	- `XX_metrics.md` - list and describe module specific metrics exposed for telemetry

docs: Revert SPEC-SPEC and update x/{auth,bank,evidence,slashing} #7407

docs: Revert SPEC-SPEC and update x/{auth,bank,evidence,slashing} #7407

Conversation

amaury1093 commented Sep 29, 2020 • edited

Description

amaury1093 Sep 29, 2020 • edited

Choose a reason for hiding this comment

codecov bot commented Sep 29, 2020 • edited

Codecov Report

tac0turtle commented Sep 29, 2020

amaury1093 Sep 29, 2020

Choose a reason for hiding this comment

clevinson left a comment

Choose a reason for hiding this comment

clevinson Oct 8, 2020

Choose a reason for hiding this comment

amaury1093 Oct 8, 2020

Choose a reason for hiding this comment

clevinson Oct 8, 2020

Choose a reason for hiding this comment

tac0turtle Oct 8, 2020 • edited

Choose a reason for hiding this comment

amaury1093 Oct 8, 2020

Choose a reason for hiding this comment

clevinson left a comment

Choose a reason for hiding this comment

fedekunze Oct 16, 2020

Choose a reason for hiding this comment

amaury1093 commented Sep 29, 2020 •

edited

amaury1093 Sep 29, 2020 •

edited

codecov bot commented Sep 29, 2020 •

edited

tac0turtle Oct 8, 2020 •

edited