docs: Update "Basics" section #7416

amaury1093 · 2020-09-30T11:26:17Z

Description

Main changes:

Be clear on Amino vs Protobuf in MakeCodecs
Replace legacy KeyBase with new Keyring
Update code snippets to latest version, and use simapp instead of gaia
appcli -> appd

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-09-30T11:31:05Z

Codecov Report

Merging #7416 into master will not change coverage.
The diff coverage is 80.00%.

@@           Coverage Diff           @@
##           master    #7416   +/-   ##
=======================================
  Coverage   56.01%   56.01%           
=======================================
  Files         592      592           
  Lines       37244    37244           
=======================================
  Hits        20864    20864           
  Misses      14262    14262           
  Partials     2118     2118

amaury1093

my main concern for merging this right now is that we reference gaia's code as an example, but it hasn't been updated to use protobuf yet.

I can add a note in #6953 to update these snippets once gaia is ready.

amaury1093 · 2020-09-30T11:31:10Z

docs/basics/accounts.md

-`lazyKeybase` is simple wrapper around `dbKeybase` which locks the database only when operations are to be performed and unlocks it immediately after. With the `lazyKeybase`, it is possible for the [command-line interface](../interfaces/cli.md) to create a new account while the [rest server](../interfaces/rest.md) is running. It is also possible to pipe multiple CLI commands. 
+- `Sign(uid string, msg []byte) ([]byte, tmcrypto.PubKey, error)` strictly deals with the signature of the `message` bytes. Some preliminary work should be done beforehand to prepare and encode the `message` into a canonical `[]byte` form. See an example of `message` preparation from the `x/bank` module. Note that signature verification is not implemented in the SDK by default. It is deferred to the [`anteHandler`](#antehandler).
+  +++ https://github.com/cosmos/cosmos-sdk/blob/d9175200920e96bfa4182b5c8bc46d91b17a28a1/x/bank/types/msgs.go#L51-L54
+- `NewAccount(uid, mnemonic, bip39Passwd, hdPath string, algo SignatureAlgo) (Info, error)` creates a new account based on the [`bip44 path`](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) and persists it on disk (note that the `PrivKey` is [encrypted with a passphrase before being persisted](https://github.com/cosmos/cosmos-sdk/blob/d9175200920e96bfa4182b5c8bc46d91b17a28a1/crypto/keys/mintkey/mintkey.go), it is **never stored unencrypted**). In the context of this method, the `account` and `address` parameters refer to the segment of the BIP44 derivation path (e.g. `0`, `1`, `2`, ...) used to derive the `PrivKey` and `PubKey` from the mnemonic (note that given the same mnemonic and `account`, the same `PrivKey` will be generated, and given the same `account` and `address`, the same `PubKey` and `Address` will be generated). Finally, note that the `NewAccount` method derives keys and addresses using `secp256k1` as implemented in the [SDK's `crypto/keys/secp256k1` package](https://github.com/cosmos/cosmos-sdk/blob/d9175200920e96bfa4182b5c8bc46d91b17a28a1/crypto/keys/secp256k1/secp256k1.go). As a result, it only works for creating account keys and addresses, not consensus keys. See [`Addresses`](#addresses) for more.


Now that we switched to use 99designs/keyring, does anyone know if this section is still relevant?

I think it makes sense, adding a note on how to export private keys would be valuable imho, i.e key -> armored privkey -> raw priv key

docs/basics/accounts.md

docs/basics/app-anatomy.md

…953-basic

blushi

Pre-approving, just some small nits/questions.
Also not sure re: #7416 (comment)

docs/basics/accounts.md

docs/basics/app-anatomy.md

Co-authored-by: Marie Gauthier <[email protected]>

…to am-6953-basic

docs/basics/app-anatomy.md

Co-authored-by: Marie Gauthier <[email protected]>

docs/basics/accounts.md

fedekunze · 2020-10-09T15:27:42Z

docs/basics/accounts.md

-`lazyKeybase` is simple wrapper around `dbKeybase` which locks the database only when operations are to be performed and unlocks it immediately after. With the `lazyKeybase`, it is possible for the [command-line interface](../interfaces/cli.md) to create a new account while the [rest server](../interfaces/rest.md) is running. It is also possible to pipe multiple CLI commands. 
+- `Sign(uid string, msg []byte) ([]byte, tmcrypto.PubKey, error)` strictly deals with the signature of the `message` bytes. Some preliminary work should be done beforehand to prepare and encode the `message` into a canonical `[]byte` form. See an example of `message` preparation from the `x/bank` module. Note that signature verification is not implemented in the SDK by default. It is deferred to the [`anteHandler`](#antehandler).
+  +++ https://github.com/cosmos/cosmos-sdk/blob/d9175200920e96bfa4182b5c8bc46d91b17a28a1/x/bank/types/msgs.go#L51-L54
+- `NewAccount(uid, mnemonic, bip39Passwd, hdPath string, algo SignatureAlgo) (Info, error)` creates a new account based on the [`bip44 path`](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) and persists it on disk (note that the `PrivKey` is [encrypted with a passphrase before being persisted](https://github.com/cosmos/cosmos-sdk/blob/d9175200920e96bfa4182b5c8bc46d91b17a28a1/crypto/keys/mintkey/mintkey.go), it is **never stored unencrypted**). In the context of this method, the `account` and `address` parameters refer to the segment of the BIP44 derivation path (e.g. `0`, `1`, `2`, ...) used to derive the `PrivKey` and `PubKey` from the mnemonic (note that given the same mnemonic and `account`, the same `PrivKey` will be generated, and given the same `account` and `address`, the same `PubKey` and `Address` will be generated). Finally, note that the `NewAccount` method derives keys and addresses using `secp256k1` as implemented in the [SDK's `crypto/keys/secp256k1` package](https://github.com/cosmos/cosmos-sdk/blob/d9175200920e96bfa4182b5c8bc46d91b17a28a1/crypto/keys/secp256k1/secp256k1.go). As a result, it only works for creating account keys and addresses, not consensus keys. See [`Addresses`](#addresses) for more.


I think it makes sense, adding a note on how to export private keys would be valuable imho, i.e key -> armored privkey -> raw priv key

docs/basics/accounts.md

docs/basics/app-anatomy.md

docs/basics/tx-lifecycle.md

…953-basic

Co-authored-by: Federico Kunze <[email protected]>

…to am-6953-basic

…953-basic

amaury1093 · 2020-10-12T13:43:56Z

Thanks @fedekunze, your review was very helpful. I believe I addressed all your comments.

fedekunze

LGTM, thanks!

docs/basics/accounts.md

* 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 <[email protected]> * Add section about gRPC query services * Optional LegacyQuerierHandler * Clearer docs * Update docs/basics/app-anatomy.md Co-authored-by: Marie Gauthier <[email protected]> * Update docs/basics/app-anatomy.md Co-authored-by: Federico Kunze <[email protected]> * Address comments * Address comments * Update docs/basics/accounts.md Co-authored-by: Marie Gauthier <[email protected]> Co-authored-by: Federico Kunze <[email protected]>

@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 <[email protected]> * Add section about gRPC query services * Optional LegacyQuerierHandler * Clearer docs * Update docs/basics/app-anatomy.md Co-authored-by: Marie Gauthier <[email protected]> * Update docs/basics/app-anatomy.md Co-authored-by: Federico Kunze <[email protected]> * Address comments * Address comments * Update docs/basics/accounts.md Co-authored-by: Marie Gauthier <[email protected]> Co-authored-by: Federico Kunze <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * 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] <[email protected]> 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 <[email protected]> * Update docs/building-modules/querier.md Co-authored-by: Federico Kunze <[email protected]> * Update docs/building-modules/querier.md Co-authored-by: Federico Kunze <[email protected]> * Update docs/building-modules/module-interfaces.md Co-authored-by: Federico Kunze <[email protected]> * Update docs/building-modules/module-interfaces.md Co-authored-by: Federico Kunze <[email protected]> * 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 <[email protected]> * Update docs/building-modules/intro.md Co-authored-by: Amaury Martiny <[email protected]> * Fix typo Co-authored-by: Federico Kunze <[email protected]> Co-authored-by: Amaury Martiny <[email protected]> * 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 <[email protected]> * Update x/auth/client/cli/tx_sign.go Co-authored-by: Alessio Treglia <[email protected]> * Apply suggestions from code review Co-authored-by: Alessio Treglia <[email protected]> * Fix go format Co-authored-by: Federico Kunze <[email protected]> Co-authored-by: Alessio Treglia <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * ibc: update solo machine client command (#7579) Co-authored-by: Federico Kunze <[email protected]> * 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 <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * remove id in localhost (#7577) Co-authored-by: Federico Kunze <[email protected]> Co-authored-by: Christopher Goes <[email protected]> * update changelog * Update CHANGELOG.md Co-authored-by: Aleksandr Bezobchuk <[email protected]> * Fix solomachine cmds (#7581) * fix solo machine cli cmds * polish Co-authored-by: Federico Kunze <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> * simapp: use tmjson on InitChainer (#7514) Co-authored-by: Alessio Treglia <[email protected]> * [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 <[email protected]> * golangci-lint fix Co-authored-by: Amaury Martiny <[email protected]> Co-authored-by: Aaron Craelius <[email protected]> Co-authored-by: Cory Levinson <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Marie Gauthier <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Amaury Martiny <[email protected]> Co-authored-by: Federico Kunze <[email protected]> Co-authored-by: colin axnér <[email protected]> Co-authored-by: Neeraj Murarka <[email protected]> Co-authored-by: Riccardo Montagnin <[email protected]> Co-authored-by: Marko <[email protected]> Co-authored-by: Aleksandr Bezobchuk <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Zaki Manian <[email protected]> Co-authored-by: Alessio Treglia <[email protected]> Co-authored-by: Christopher Goes <[email protected]> Co-authored-by: Aaron Craelius <[email protected]>

* 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 <[email protected]> * Add section about gRPC query services * Optional LegacyQuerierHandler * Clearer docs * Update docs/basics/app-anatomy.md Co-authored-by: Marie Gauthier <[email protected]> * Update docs/basics/app-anatomy.md Co-authored-by: Federico Kunze <[email protected]> * Address comments * Address comments * Update docs/basics/accounts.md Co-authored-by: Marie Gauthier <[email protected]> Co-authored-by: Federico Kunze <[email protected]>

amaury1093 added 3 commits September 30, 2020 11:51

Prettier

2a44adf

docs: Update "Basics" section

9dd18e9

appcli -> appd

fb27d5d

amaury1093 commented Sep 30, 2020

View reviewed changes

amaury1093 marked this pull request as ready for review September 30, 2020 11:41

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

Better wording

a0479ae

amaury1093 commented Sep 30, 2020

View reviewed changes

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

Fix to appCodec

b06ca72

amaury1093 mentioned this pull request Sep 30, 2020

Update documentation for Stargate #6953

Closed

amaury1093 marked this pull request as draft September 30, 2020 16:10

amaury1093 added 2 commits October 1, 2020 12:34

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

004a87a

…953-basic

Add gRPC mention

f7513f0

amaury1093 marked this pull request as ready for review October 1, 2020 11:26

amaury1093 added 3 commits October 1, 2020 13:37

Add grpc

abe3433

Reference simapp code

291f969

Merge branch 'master' into am-6953-basic

ec03152

amaury1093 requested review from anilcse, blushi and clevinson October 1, 2020 15:04

amaury1093 assigned atheeshp Oct 1, 2020

amaury1093 requested a review from robert-zaremba October 1, 2020 15:05

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

amaury1093 unassigned atheeshp Oct 5, 2020

amaury1093 requested a review from atheeshp October 5, 2020 08:42

Merge branch 'master' into am-6953-basic

9a39807

Merge branch 'master' into am-6953-basic

c00ef48

blushi approved these changes Oct 7, 2020

View reviewed changes

docs/basics/accounts.md Outdated Show resolved Hide resolved

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

amaury1093 and others added 5 commits October 7, 2020 15:51

Update docs/basics/accounts.md

5779cda

Co-authored-by: Marie Gauthier <[email protected]>

Add section about gRPC query services

6a0192d

Merge branch 'am-6953-basic' of ssh://github.com/cosmos/cosmos-sdk in…

9b29d10

…to am-6953-basic

Optional LegacyQuerierHandler

97035de

Clearer docs

8083ebd

blushi reviewed Oct 8, 2020

View reviewed changes

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

Update docs/basics/app-anatomy.md

0038246

Co-authored-by: Marie Gauthier <[email protected]>

fedekunze reviewed Oct 9, 2020

View reviewed changes

amaury1093 and others added 6 commits October 12, 2020 12:41

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

69b4c87

…953-basic

Update docs/basics/app-anatomy.md

66cf3ce

Co-authored-by: Federico Kunze <[email protected]>

Address comments

048a28d

Merge branch 'am-6953-basic' of ssh://github.com/cosmos/cosmos-sdk in…

da83743

…to am-6953-basic

Address comments

4873551

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

933ca8d

…953-basic

fedekunze approved these changes Oct 12, 2020

View reviewed changes

docs/basics/accounts.md Outdated Show resolved Hide resolved

fedekunze added 2 commits October 12, 2020 17:13

Update docs/basics/accounts.md

8362324

Merge branch 'master' into am-6953-basic

da629d0

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

mergify bot merged commit 647ad0d into master Oct 12, 2020

mergify bot deleted the am-6953-basic branch October 12, 2020 15:31

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: Update "Basics" section #7416

docs: Update "Basics" section #7416

amaury1093 commented Sep 30, 2020 •

edited

Loading

codecov bot commented Sep 30, 2020 •

edited

Loading

amaury1093 left a comment

amaury1093 Sep 30, 2020

fedekunze Oct 9, 2020

blushi left a comment •

edited

Loading

fedekunze Oct 9, 2020

amaury1093 commented Oct 12, 2020

fedekunze left a comment

docs: Update "Basics" section #7416

docs: Update "Basics" section #7416

Conversation

amaury1093 commented Sep 30, 2020 • edited Loading

Description

codecov bot commented Sep 30, 2020 • edited Loading

Codecov Report

amaury1093 left a comment

Choose a reason for hiding this comment

amaury1093 Sep 30, 2020

Choose a reason for hiding this comment

fedekunze Oct 9, 2020

Choose a reason for hiding this comment

blushi left a comment • edited Loading

Choose a reason for hiding this comment

fedekunze Oct 9, 2020

Choose a reason for hiding this comment

amaury1093 commented Oct 12, 2020

fedekunze left a comment

Choose a reason for hiding this comment

amaury1093 commented Sep 30, 2020 •

edited

Loading

codecov bot commented Sep 30, 2020 •

edited

Loading

blushi left a comment •

edited

Loading