doc: Updates related to ServiceMsg, sdk.Msg and Msg service #9294
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
robert-zaremba
requested review from
clevinson,
blushi,
ryanchristo,
technicallyty and
atheeshp
ryanchristo
reviewed
May 11, 2021
Co-authored-by: Ryan Christoffersen <12519942+ryanchrypto@users.noreply.github.com>
|
Thank you @ryanchrypto for looking at the PRs and improving it. |
amaury1093
reviewed
May 12, 2021
docs/basics/app-anatomy.md
Outdated
| @@ -139,7 +139,9 @@ Modules must implement [interfaces](../building-modules/module-manager.md#applic | |||
|
|
|||
| ### `Msg` Services | |||
|
|
|||
| Each module defines two [Protobuf services](https://developers.google.com/protocol-buffers/docs/proto#services): one `Msg` service to handle messages, and one gRPC `Query` service to handle queries. If we consider the module as a state-machine, then a `Msg` is a state transition. A `Msg` service is a Protobuf service defining all possible `Msg`s a module exposes. Note that `Msg`s are bundled in [`transactions`](../core/transactions.md), and each transaction contains one or multiple `messages`. | |||
| Each module defines two [Protobuf services](https://developers.google.com/protocol-buffers/docs/proto#services): one `Msg` service to handle messages, and one gRPC `Query` service to handle queries. If we consider the module as a state-machine, then a `Msg` service is a set of state transition RPC methods. | |||
| Each Protobuf `Msg` service RPC is 1:1 related to a Protobuf request type, which must implement `sdk.Msg` interface. | |||
There was a problem hiding this comment.
So in the protobuf docs, a service == a RPC service, and that's where RPC is mentioned. What you call "service RPC" here is actually what protobuf calls a method.
My proposal would be to s/service RPC/service method/g (in all docs), what do you think?
There was a problem hiding this comment.
I was thinking about it, I thought that we use method because of Go, and in proto each endpoint is marked as RPC. But if in prodobuf docs they use method then let's use it here as well. I'm updating the docs.
amaury1093
added
the
A:automerge
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
In this PR I'm trying to distinguish sdk.Msg from Msg service as well as remove leftovers of ServiceMsg.
There are many places in documentation which were not very clear - I hope this will improve them.
closes: #9208
related to: baseapp audit
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.
docs/) or specification (x/<module>/spec/)godoccomments.Unreleasedsection inCHANGELOG.mdFiles changedin the Github PR explorerCodecov Reportin the comment section below once CI passes