docs: Update tx lifecycle in beginner/tx-lifecycle #20284
Conversation
|
Note Reviews pausedUse the following commands to manage reviews:
WalkthroughThe documentation update focuses on enhancing clarity and coherence in the transaction lifecycle sections, particularly emphasizing transaction processing and state management. The changes aim to provide a more structured and detailed explanation of transaction verification, processing, and post-transaction handling within the Cosmos SDK. Changes
Assessment against linked issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
Out of diff range and nitpick comments (9)
docs/learn/beginner/01-tx-lifecycle.md (9)
Line range hint
34-34: Consider a shorter alternative to avoid wordiness.The phrase "can be used to scale
gasup in order to avoid underestimating" could be shortened to "can scalegasup to avoid underestimation."
41-41: Consider shortening this phrase to just ‘whether’.The phrase "whether or not" can be simplified to "whether" to make the text more concise.
150-150: Do not mix variants of the same word.The word "finalized" should be consistent with the British English variant "finalised" if used elsewhere in the document. Please choose one variant and use it consistently throughout the document.
86-86: Trailing spaces.Please remove the trailing spaces at the end of this line to maintain clean code formatting.
103-103: Trailing spaces.Please remove the trailing spaces at the end of this line to maintain clean code formatting.
105-105: Trailing spaces.Please remove the trailing spaces at the end of this line to maintain clean code formatting.
123-123: Trailing spaces.Please remove the trailing spaces at the end of this line to maintain clean code formatting.
16-16: Multiple consecutive blank lines.Please reduce the multiple consecutive blank lines to a single blank line to maintain clean formatting.
108-108: Multiple consecutive blank lines.Please reduce the multiple consecutive blank lines to a single blank line to maintain clean formatting.
Review Details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- docs/learn/beginner/01-tx-lifecycle.md (3 hunks)
Additional Context Used
LanguageTool (6)
docs/learn/beginner/01-tx-lifecycle.md (6)
Near line 13: Unpaired symbol: ‘[’ seems to be missing
Context: ... * Anatomy of a Cosmos SDK Application ::: ## Transacti...
Near line 34: Consider a shorter alternative to avoid wordiness.
Context: ...optional) can be used to scalegasup in order to avoid underestimating. For example, use...
Near line 41: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...e of the two. Later, validators decide whether or not to include the transaction in their blo...
Near line 88: Possible missing comma found.
Context: ...ee of trasaction processing. Within the SDK we wrap theBaseAppwith a runtime la...
Near line 111: Two consecutive dots
Context: ...e state to reflect the transfer if valid.. ### Module Execution 1. The transacti...
Near line 150: Do not mix variants of the same word (‘finalize’ and ‘finalise’) within a single text.
Context: ...to the state during the transaction are finalized and written to the blockchain. This ste...
Path-based Instructions (1)
docs/learn/beginner/01-tx-lifecycle.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
There was a problem hiding this comment.
Actionable comments posted: 8
Out of diff range and nitpick comments (1)
docs/learn/beginner/01-tx-lifecycle.md (1)
Line range hint
34-34: Consider rephrasing to avoid wordiness.- can be used to scale `gas` up in order to avoid underestimating. + can be used to scale `gas` up to avoid underestimating.
Review Details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- docs/learn/beginner/01-tx-lifecycle.md (3 hunks)
Additional Context Used
LanguageTool (5)
docs/learn/beginner/01-tx-lifecycle.md (5)
Near line 13: Unpaired symbol: ‘[’ seems to be missing
Context: ... * Anatomy of a Cosmos SDK Application ::: ## Transacti...
Near line 34: Consider a shorter alternative to avoid wordiness.
Context: ...optional) can be used to scalegasup in order to avoid underestimating. For example, use...
Near line 41: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...e of the two. Later, validators decide whether or not to include the transaction in their blo...
Near line 88: Possible missing comma found.
Context: ...ee of trasaction processing. Within the SDK we wrap theBaseAppwith a runtime la...
Near line 150: Do not mix variants of the same word (‘finalize’ and ‘finalise’) within a single text.
Context: ...to the state during the transaction are finalized and written to the blockchain. This ste...
Path-based Instructions (1)
docs/learn/beginner/01-tx-lifecycle.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
Additional comments not posted (2)
docs/learn/beginner/01-tx-lifecycle.md (2)
13-13: Unpaired symbol: '[' seems to be missing.
88-88: Consider adding a comma after "SDK" for better readability: "Within the SDK, we wrap theBaseAppwith a runtime layer..."
|
|
||
| 3. Error Handling: If any errors occur during transaction execution, they are handled appropriately, which may include rolling back certain operations to maintain state consistency. | ||
|
|
||
| 4. State Commitment: Changes made to the state during the transaction are finalized and written to the blockchain. This step is crucial as it ensures that all state transitions are permanently recorded. |
There was a problem hiding this comment.
Ensure consistent use of American English spelling for "finalize".
- are finalized and written to the blockchain.
+ are finalized and written to the blockchain.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 4. State Commitment: Changes made to the state during the transaction are finalized and written to the blockchain. This step is crucial as it ensures that all state transitions are permanently recorded. | |
| 4. State Commitment: Changes made to the state during the transaction are finalized and written to the blockchain. This step is crucial as it ensures that all state transitions are permanently recorded. |
| @@ -13,9 +13,8 @@ | |||
| * [Anatomy of a Cosmos SDK Application](./00-app-anatomy.md) | |||
| ::: | |||
|
|
|||
| ## Creation | |||
|
|
|||
There was a problem hiding this comment.
Remove multiple consecutive blank lines.
-Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
|
|
||
| #### Guideline | ||
|
|
There was a problem hiding this comment.
Remove multiple consecutive blank lines.
-Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
There was a problem hiding this comment.
this seems to be removing lots of information without replacing it. I think there is a lot more information that can be added.
- Appside mempool
- finalisation
- block inclusion
- the ante handler starless vs stateful is still a concept
- validate basic is an optional setting users can do.
|
@tac0turtle a couple of q's
|
We should point to comets mempool if cometbft is being used, a link with a short description is useful. Keeping it high level enough for the user to go to comet to find out more
if this is beginner we should move the information somewhere else. I dont think removing information and not replacing it is a path we should take. There is still valuable information in what is being removed. |
But should we have a whole section on the mempool then in that case? Could have a one liner here saying
I wasnt going to remove it completely. Was planning on adding it into the |
|
can that be done in this pr? ideally we do these things in the same pr to avoid it being removed couple days pass and then its added again. This happens too often in my time in cosmos. |
|
Yep, thats completely fine. Ill target both of the issues (baseapp & txlifecycle). Do you have an answer on the comet/mempool part of my question?
|
There was a problem hiding this comment.
Actionable comments posted: 2
Out of diff range and nitpick comments (1)
docs/learn/beginner/01-tx-lifecycle.md (1)
Line range hint
34-34: Consider a shorter alternative to avoid wordiness.- can be used to scale `gas` up in order to avoid underestimating. + can be used to scale `gas` up to avoid underestimating.
Review Details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- docs/learn/beginner/01-tx-lifecycle.md (4 hunks)
Additional Context Used
LanguageTool (6)
docs/learn/beginner/01-tx-lifecycle.md (6)
Near line 13: Unpaired symbol: ‘[’ seems to be missing
Context: ... * Anatomy of a Cosmos SDK Application ::: ## Transacti...
Near line 34: Consider a shorter alternative to avoid wordiness.
Context: ...optional) can be used to scalegasup in order to avoid underestimating. For example, use...
Near line 41: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...e of the two. Later, validators decide whether or not to include the transaction in their blo...
Near line 41: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ....Txis rejected if itsgas-prices` is not high enough, so users are incentivi...
Near line 192: Do not mix variants of the same word (‘finalise’ and ‘finalize’) within a single text.
Context: ... Cosmos SDK, several steps are taken to finalise the process: 1. Event Emission: Module...
Near line 200: Do not mix variants of the same word (‘finalise’ and ‘finalize’) within a single text.
Context: ...to the state during the transaction are finalised and written to the blockchain. This ste...
Path-based Instructions (1)
docs/learn/beginner/01-tx-lifecycle.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
Additional comments not posted (1)
docs/learn/beginner/01-tx-lifecycle.md (1)
13-13: Unpaired symbol: '[' seems to be missing.
|
|
||
| :::warning |
There was a problem hiding this comment.
Now living in 00-baseapp.md
There was a problem hiding this comment.
Actionable comments posted: 8
Out of diff range and nitpick comments (6)
docs/learn/advanced/00-baseapp.md (6)
Line range hint
23-23: Ensure the link to "Service Routers" is correctly formatted.- * [Service Routers](#service-routers), to route messages an... + * [Service Routers](#service-routers), to route messages and...
Line range hint
69-69: Ensure the link to "Msg Service Router" is correctly formatted.- * [`Msg` Service Router](#msg-service-router): The `msgServiceRo... + * [`Msg` Service Router](#msg-service-router): The `msgServiceRouter`...
Line range hint
73-73: Ensure the link to "gRPC Query Router" is correctly formatted.- * [gRPC Query Router](#grpc-query-router): The `grpcQueryRout... + * [gRPC Query Router](#grpc-query-router): The `grpcQueryRouter`...
Line range hint
219-219: Ensure the link to "sdk.Msgs" is correctly formatted.- [`sdk.Msg`s](../../build/building-modules/02-message... + [`sdk.Msg`s](../../build/building-modules/02-messages-and-queries.md#messages)...
Line range hint
447-447: Ensure the link to "Consensus Parameters" is correctly formatted.- * [Consensus Parameters](https://docs.cometbft.com/v1.0/spec/abc... + * [Consensus Parameters](https://docs.cometbft.com/v1.0/spec/abci/abci++_app_requirements#consensus-parameters)...
Line range hint
448-448: Ensure the link to "checkState and finalizeBlockState" is correctly formatted.- * [`checkState` and `finalizeBlockState`](#state-updates) via `setState`. * The [... + * [`checkState` and `finalizeBlockState`](#state-updates) via `setState`. * The [`Block gas meter`](../beginner/04-gas-fees.md#block-gas-meter)...
Review Details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files ignored due to path filters (1)
docs/learn/advanced/blockprocessing.pngis excluded by!**/*.png
Files selected for processing (2)
- docs/learn/advanced/00-baseapp.md (6 hunks)
- docs/learn/beginner/01-tx-lifecycle.md (4 hunks)
Additional Context Used
LanguageTool (79)
docs/learn/advanced/00-baseapp.md (72)
Near line 23: Unpaired symbol: ‘[’ seems to be missing
Context: ...gine (e.g. CometBFT). * Service Routers, to route messages an...
Near line 63: Loose punctuation mark.
Context: ...iStore`](./04-store.md#commitmultistore): This is the main store of the applicati...
Near line 69: Unpaired symbol: ‘[’ seems to be missing
Context: ...ata persistence. *MsgService Router: The `msgServiceRo...
Near line 71: Consider a shorter alternative to avoid wordiness.
Context: ...at needs to be processed by a service in order to update the application state, and not t...
Near line 73: Unpaired symbol: ‘[’ seems to be missing
Context: ...g consensus engine. * gRPC Query Router: The `grpcQueryRout...
Near line 76: Loose punctuation mark.
Context: ...b.com/cosmos/cosmos-sdk/types#TxDecoder): It is used to decode raw transaction ...
Near line 78: Loose punctuation mark.
Context: ... engine. *AnteHandler: This handler is used to handle signatur...
Near line 81: Loose punctuation mark.
Context: .../beginner/00-app-anatomy.md#initchainer), [PreBlocker](../beginner/00-app-anato...
Near line 87: Loose punctuation mark.
Context: ...s) (i.e. cached states): *checkState: This state is updated during [CheckTx...
Near line 88: Loose punctuation mark.
Context: ...ommit](#commit). *finalizeBlockState: This state is updated during [Finalize...
Near line 90: Loose punctuation mark.
Context: ...FinalizeBlock. *processProposalState: This state is updated during [ProcessP...
Near line 91: Loose punctuation mark.
Context: ...cess-proposal). *prepareProposalState: This state is updated during [`PrepareP...
Near line 95: Loose punctuation mark.
Context: ...ore important parameters: *voteInfos: This parameter carries the list of vali...
Near line 99: Loose punctuation mark.
Context: ...hing absent validators. *minGasPrices: This parameter defines the minimum gas ...
Near line 106: Loose punctuation mark.
Context: ...n1uatomOR1photon). *appVersion: Version of the application. It is set i...
Near line 151: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...ckTx, thecheckState`, which is based off of the last committed state from the root ...
Near line 175: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...theprocessProposalStateis set based off of the last committed state from the root...
Near line 177: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...called and theAnteHandleris executed and the context used in this state is built...
Near line 187: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...lock. ThefinalizeBlockStateis based off of the last committed state from the root ...
Near line 215: Consider a shorter alternative to avoid wordiness.
Context: ...ust be routed to the appropriate module in order to be processed. Routing is done via `Base...
Near line 219: Unpaired symbol: ‘[’ seems to be missing
Context: .... ###MsgService Router [sdk.Msgs](../../build/building-modules/02-message...
Near line 219: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...holds amsgServiceRouterwhich maps fully-qualified service methods (string`, defined in e...
Near line 221: Possible missing comma found.
Context: ...nt to make use of more stateful routing mechanisms such as allowing governance to disable ...
Near line 227: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...grpcQueryRouter, which maps modules' fully-qualified service methods (string, defined in t...
Near line 259: Possible missing comma found.
Context: ....Msg`'s. This is done after stateless checks as stateful checks are more computati...
Near line 265: Possible missing comma found.
Context: ...osalcomplements theProcessProposal` method which is executed after this method. Th...
Near line 269: Loose punctuation mark.
Context: ...e response contains: *Txs ([][]byte): List of transactions which will form a ...
Near line 282: Possible missing comma found.
Context: ... that the coherence property is adhered to i.e. all honest validators must accept ...
Near line 283: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...cept a proposal by an honest proposer. It's important to note that `ProcessPropos...
Near line 288: Possible missing comma found.
Context: ...ectly coding these methods could affect liveness as CometBFT is unable to receive 2/3 va...
Near line 292: Loose punctuation mark.
Context: ...e contains: *Status (ProposalStatus): Status of the proposal processing wher...
Near line 314: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...edsGasWanted, the execution is halted and the changes made to the cached copy of ...
Near line 329: Consider a shorter alternative to avoid wordiness.
Context: ...t based on the raw transaction size, in order to avoid spam with transactions that provi...
Near line 342: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...y pay the fees until the transaction is actually included in a block, because `checkStat...
Near line 342: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...nsaction is actually included in a block, becausecheckStatenever gets committed to th...
Near line 343: The plural noun “blocks” cannot be used with the article “a”. Did you mean “a block” or “blocks”?
Context: ...atest state of the main state each time a blocks gets committed.CheckTxr...
Near line 348: Loose punctuation mark.
Context: ...he response contains: *Code (uint32): Response Code.0if successful. * `Da...
Near line 349: Loose punctuation mark.
Context: ...de.0if successful. *Data ([]byte): Result bytes, if any. *Log (string):...
Near line 350: To form a complete sentence, be sure to include a subject.
Context: ...The output of the application's logger. May be non-deterministic. * `Info (string):...
Near line 351: To form a complete sentence, be sure to include a subject.
Context: ...Info (string):Additional information. May be non-deterministic. *GasWanted (int...
Near line 352: Loose punctuation mark.
Context: ...non-deterministic. *GasWanted (int64): Amount of gas requested for transaction...
Near line 353: Loose punctuation mark.
Context: ...ate the transaction. *GasUsed (int64): Amount of gas consumed by transaction. ...
Near line 359: Loose punctuation mark.
Context: ...c.go#L102 ``` *Events ([]cmn.KVPair): Key-Value tags for filtering and indexi...
Near line 359: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...or filtering and indexing transactions (eg. by account). See [events](./08-events...
Near line 360: Loose punctuation mark.
Context: ...nts.md) for more. *Codespace (string): Namespace for the Code. #### RecheckTx...
Near line 425: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...e. First, it retrieves thesdk.Msg's fully-qualified type name, by checking thetype_urlo...
Near line 429: Consider a shorter alternative to avoid wordiness.
Context: ... receives theResultof theRunMsgsin order to enable this customizable behavior. Lik...
Near line 445: This phrase is redundant. Consider writing “started”.
Context: ...lying CometBFT engine when the chain is first started. It is mainly used to initialize pa...
Near line 447: Unpaired symbol: ‘[’ seems to be missing
Context: ...and state like: * [Consensus Parameters](https://docs.cometbft.com/v1.0/spec/abc...
Near line 448: Unpaired symbol: ‘[’ seems to be missing
Context: ...etConsensusParams. * [checkStateandfinalizeBlockState](#state-updates) viasetState`. * The [...
Near line 451: Consider a shorter alternative to avoid wordiness.
Context: ...tomy.md#initchainer) of the application in order to initialize the main state of the applic...
Near line 479: Did you mean to use ‘who’s’ here (the contracted form of ‘who’ and ‘is/has’)?
Context: ...pplication, i.e. the list of validators whose precommit for the previous block was ...
Near line 499: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...n withinFinalizeBlockperforms the exact same steps asCheckTx, with a little cav...
Near line 516: Loose punctuation mark.
Context: ...he response contains: *Code (uint32): Response Code.0if successful. * `Da...
Near line 517: Loose punctuation mark.
Context: ...de.0if successful. *Data ([]byte): Result bytes, if any. *Log (string):...
Near line 518: To form a complete sentence, be sure to include a subject.
Context: ...The output of the application's logger. May be non-deterministic. * `Info (string):...
Near line 519: To form a complete sentence, be sure to include a subject.
Context: ...Info (string):Additional information. May be non-deterministic. *GasWanted (int...
Near line 520: Loose punctuation mark.
Context: ...non-deterministic. *GasWanted (int64): Amount of gas requested for transaction...
Near line 521: Loose punctuation mark.
Context: ...ate the transaction. *GasUsed (int64): Amount of gas consumed by transaction. ...
Near line 522: Loose punctuation mark.
Context: ... store occurs. *Events ([]cmn.KVPair): Key-Value tags for filtering and indexi...
Near line 522: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...or filtering and indexing transactions (eg. by account). See [events](./08-events...
Near line 523: Loose punctuation mark.
Context: ...nts.md) for more. *Codespace (string): Namespace for the Code. #### EndBlock ...
Near line 535: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...nsus but listen for votes to understand whether or not they should commit the state changes. ...
Near line 539: Consider a shorter alternative to avoid wordiness.
Context: ...ndfinalizeBlockStateresets tonilin order to be consistent and reflect the changes. ...
Near line 541: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...cks have the same number of transactions and it is possible for consensus to result ...
Near line 541: ‘none at all’ might be wordy. Consider a shorter alternative.
Context: ... to result in anilblock or one with none at all. In a public blockchain network, it is ...
Near line 541: Possible missing comma found.
Context: ... censor aTxby excluding it from the block or a validator voting against the block...
Near line 543: Do not use a colon (:) before a series that is introduced by a preposition (‘over’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ... the transaction lifecycle of aTxis over: nodes have verified its validity, deliv...
Near line 553: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ... to query. If thepathmatches a gRPC fully-qualified service method, thenBaseAppwill def...
Near line 561: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...rocess does NOT have to be deterministic and the data returned can be unique to the ...
Near line 563: Possible missing comma found.
Context: ...o the validator process. In the Cosmos-SDK this is implemented as a NoOp: ``` go ...
Near line 573: Possible missing comma found.
Context: ...itted Application state. In the Cosmos-SDK this is implemented as a NoOp: ```go r...docs/learn/beginner/01-tx-lifecycle.md (7)
Near line 13: Unpaired symbol: ‘[’ seems to be missing
Context: ... * Anatomy of a Cosmos SDK Application ::: ## Transactio...
Near line 33: Consider a shorter alternative to avoid wordiness.
Context: ...optional) can be used to scalegasup in order to avoid underestimating. For example, use...
Near line 40: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...e of the two. Later, validators decide whether or not to include the transaction in their blo...
Near line 40: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ....Txis rejected if itsgas-prices` is not high enough, so users are incentivi...
Near line 149: Possible missing comma found.
Context: ...further consensus processes. The app-side mempool, serves the purpose of keepin...
Near line 211: Do not mix variants of the same word (‘finalise’ and ‘finalize’) within a single text.
Context: ... Cosmos SDK, several steps are taken to finalise the process: 1. Event Emission: Module...
Near line 219: Do not mix variants of the same word (‘finalise’ and ‘finalize’) within a single text.
Context: ...to the state during the transaction are finalised and written to the blockchain. This ste...
Path-based Instructions (2)
docs/learn/beginner/01-tx-lifecycle.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/learn/advanced/00-baseapp.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
Additional comments not posted (1)
docs/learn/beginner/01-tx-lifecycle.md (1)
16-16: Ensure the command-line example is accurate and up-to-date.
|
|
||
| Consensus, the process through which validator nodes come to agreement on which transactions to |
There was a problem hiding this comment.
this is all in baseapp with a new diagram
There was a problem hiding this comment.
Actionable comments posted: 10
Out of diff range and nitpick comments (13)
docs/learn/advanced/00-baseapp.md (13)
Line range hint
23-23: Ensure the markdown link is correctly formatted.- * [Service Routers](#service-routers), to route messages an... + * [Service Routers](#service-routers), to route messages and...
Line range hint
69-69: Ensure the markdown link is correctly formatted.- * [`Msg` Service Router](#msg-service-router): The `msgServiceRo... + * [`Msg` Service Router](#msg-service-router): The `msgServiceRouter`...
Line range hint
73-73: Ensure the markdown link is correctly formatted.- * [gRPC Query Router](#grpc-query-router): The `grpcQueryRout... + * [gRPC Query Router](#grpc-query-router): The `grpcQueryRouter`...
Line range hint
219-219: Ensure the markdown link is correctly formatted.- ### `Msg` Service Router [`sdk.Msg`s](../../build/building-modules/02-message... + ### `Msg` Service Router [`sdk.Msg`s](../../build/building-modules/02-messages-and-queries.md#messages)...
Line range hint
447-447: Ensure the markdown link is correctly formatted.- * [Consensus Parameters](https://docs.cometbft.com/v1.0/spec/abc... + * [Consensus Parameters](https://docs.cometbft.com/v1.0/spec/abci/abci++_app_requirements#consensus-parameters)...
Line range hint
448-448: Ensure the markdown link is correctly formatted.- * [`checkState` and `finalizeBlockState`](#state-updates) via `setState`. * The [... + * [`checkState` and `finalizeBlockState`](#state-updates) via `setState`. * The [`block gas meter`](../beginner/04-gas-fees.md#block-gas-meter),...
Line range hint
151-151: Consider rephrasing to avoid wordiness.- ...ckTx`, the `checkState`, which is based off of the last committed state from the root ... + ...ckTx`, the `checkState`, which is based on the last committed state from the root ...
Line range hint
175-175: Consider rephrasing to avoid wordiness.- ...the `processProposalState` is set based off of the last committed state from the root... + ...the `processProposalState` is set based on the last committed state from the root...
Line range hint
187-187: Consider rephrasing to avoid wordiness.- ...lock. The `finalizeBlockState` is based off of the last committed state from the root ... + ...lock. The `finalizeBlockState` is based on the last committed state from the root ...
Line range hint
215-215: Consider rephrasing to avoid wordiness.- ...ust be routed to the appropriate module in order to be processed. Routing is done via `Base... + ...ust be routed to the appropriate module for processing. Routing is done via `Base...
Line range hint
429-429: Consider rephrasing to avoid wordiness.- ... receives the `Result` of the `RunMsgs` in order to enable this customizable behavior. Lik... + ... receives the `Result` of the `RunMsgs` to enable this customizable behavior. Lik...
Line range hint
445-445: Consider rephrasing to avoid redundancy.- ...lying CometBFT engine when the chain is first started. It is mainly used to **initialize** pa... + ...lying CometBFT engine when the chain starts. It is mainly used to **initialize** pa...
Line range hint
451-451: Consider rephrasing to avoid wordiness.- ...tomy.md#initchainer) of the application in order to initialize the main state of the applic... + ...tomy.md#initchainer) of the application to initialize the main state of the applic...
Review Details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (2)
- docs/learn/advanced/00-baseapp.md (6 hunks)
- docs/learn/beginner/01-tx-lifecycle.md (4 hunks)
Additional Context Used
LanguageTool (78)
docs/learn/advanced/00-baseapp.md (71)
Near line 23: Unpaired symbol: ‘[’ seems to be missing
Context: ...gine (e.g. CometBFT). * Service Routers, to route messages an...
Near line 63: Loose punctuation mark.
Context: ...iStore`](./04-store.md#commitmultistore): This is the main store of the applicati...
Near line 69: Unpaired symbol: ‘[’ seems to be missing
Context: ...ata persistence. *MsgService Router: The `msgServiceRo...
Near line 71: Consider a shorter alternative to avoid wordiness.
Context: ...at needs to be processed by a service in order to update the application state, and not t...
Near line 73: Unpaired symbol: ‘[’ seems to be missing
Context: ...g consensus engine. * gRPC Query Router: The `grpcQueryRout...
Near line 76: Loose punctuation mark.
Context: ...b.com/cosmos/cosmos-sdk/types#TxDecoder): It is used to decode raw transaction ...
Near line 78: Loose punctuation mark.
Context: ... engine. *AnteHandler: This handler is used to handle signatur...
Near line 81: Loose punctuation mark.
Context: .../beginner/00-app-anatomy.md#initchainer), [PreBlocker](../beginner/00-app-anato...
Near line 87: Loose punctuation mark.
Context: ...s) (i.e. cached states): *checkState: This state is updated during [CheckTx...
Near line 88: Loose punctuation mark.
Context: ...ommit](#commit). *finalizeBlockState: This state is updated during [Finalize...
Near line 90: Loose punctuation mark.
Context: ...FinalizeBlock. *processProposalState: This state is updated during [ProcessP...
Near line 91: Loose punctuation mark.
Context: ...cess-proposal). *prepareProposalState: This state is updated during [`PrepareP...
Near line 95: Loose punctuation mark.
Context: ...ore important parameters: *voteInfos: This parameter carries the list of vali...
Near line 99: Loose punctuation mark.
Context: ...hing absent validators. *minGasPrices: This parameter defines the minimum gas ...
Near line 106: Loose punctuation mark.
Context: ...n1uatomOR1photon). *appVersion: Version of the application. It is set i...
Near line 151: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...ckTx, thecheckState`, which is based off of the last committed state from the root ...
Near line 152: Possible missing comma found.
Context: ...tore, is used for any reads and writes. Here we only execute theAnteHandlerand v...
Near line 175: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...theprocessProposalStateis set based off of the last committed state from the root...
Near line 177: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...called and theAnteHandleris executed and the context used in this state is built...
Near line 187: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...lock. ThefinalizeBlockStateis based off of the last committed state from the root ...
Near line 215: Consider a shorter alternative to avoid wordiness.
Context: ...ust be routed to the appropriate module in order to be processed. Routing is done via `Base...
Near line 219: Unpaired symbol: ‘[’ seems to be missing
Context: .... ###MsgService Router [sdk.Msgs](../../build/building-modules/02-message...
Near line 219: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...holds amsgServiceRouterwhich maps fully-qualified service methods (string`, defined in e...
Near line 221: Possible missing comma found.
Context: ...nt to make use of more stateful routing mechanisms such as allowing governance to disable ...
Near line 227: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...grpcQueryRouter, which maps modules' fully-qualified service methods (string, defined in t...
Near line 259: Possible missing comma found.
Context: ....Msg`'s. This is done after stateless checks as stateful checks are more computati...
Near line 265: Possible missing comma found.
Context: ...osalcomplements theProcessProposal` method which is executed after this method. Th...
Near line 269: Loose punctuation mark.
Context: ...e response contains: *Txs ([][]byte): List of transactions which will form a ...
Near line 283: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...cept a proposal by an honest proposer. It's important to note that `ProcessPropos...
Near line 288: Possible missing comma found.
Context: ...ectly coding these methods could affect liveness as CometBFT is unable to receive 2/3 va...
Near line 292: Loose punctuation mark.
Context: ...e contains: *Status (ProposalStatus): Status of the proposal processing wher...
Near line 314: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...edsGasWanted, the execution is halted and the changes made to the cached copy of ...
Near line 329: Consider a shorter alternative to avoid wordiness.
Context: ...t based on the raw transaction size, in order to avoid spam with transactions that provi...
Near line 342: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...y pay the fees until the transaction is actually included in a block, because `checkStat...
Near line 342: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...nsaction is actually included in a block, becausecheckStatenever gets committed to th...
Near line 343: The plural noun “blocks” cannot be used with the article “a”. Did you mean “a block” or “blocks”?
Context: ...atest state of the main state each time a blocks gets committed.CheckTxr...
Near line 348: Loose punctuation mark.
Context: ...he response contains: *Code (uint32): Response Code.0if successful. * `Da...
Near line 349: Loose punctuation mark.
Context: ...de.0if successful. *Data ([]byte): Result bytes, if any. *Log (string):...
Near line 350: To form a complete sentence, be sure to include a subject.
Context: ...The output of the application's logger. May be non-deterministic. * `Info (string):...
Near line 351: To form a complete sentence, be sure to include a subject.
Context: ...Info (string):Additional information. May be non-deterministic. *GasWanted (int...
Near line 352: Loose punctuation mark.
Context: ...non-deterministic. *GasWanted (int64): Amount of gas requested for transaction...
Near line 353: Loose punctuation mark.
Context: ...ate the transaction. *GasUsed (int64): Amount of gas consumed by transaction. ...
Near line 359: Loose punctuation mark.
Context: ...c.go#L102 ``` *Events ([]cmn.KVPair): Key-Value tags for filtering and indexi...
Near line 359: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...or filtering and indexing transactions (eg. by account). See [events](./08-events...
Near line 360: Loose punctuation mark.
Context: ...nts.md) for more. *Codespace (string): Namespace for the Code. #### RecheckTx...
Near line 425: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...e. First, it retrieves thesdk.Msg's fully-qualified type name, by checking thetype_urlo...
Near line 429: Consider a shorter alternative to avoid wordiness.
Context: ... receives theResultof theRunMsgsin order to enable this customizable behavior. Lik...
Near line 445: This phrase is redundant. Consider writing “started”.
Context: ...lying CometBFT engine when the chain is first started. It is mainly used to initialize pa...
Near line 447: Unpaired symbol: ‘[’ seems to be missing
Context: ...and state like: * [Consensus Parameters](https://docs.cometbft.com/v1.0/spec/abc...
Near line 448: Unpaired symbol: ‘[’ seems to be missing
Context: ...etConsensusParams. * [checkStateandfinalizeBlockState](#state-updates) viasetState`. * The [...
Near line 451: Consider a shorter alternative to avoid wordiness.
Context: ...tomy.md#initchainer) of the application in order to initialize the main state of the applic...
Near line 479: Did you mean to use ‘who’s’ here (the contracted form of ‘who’ and ‘is/has’)?
Context: ...pplication, i.e. the list of validators whose precommit for the previous block was ...
Near line 499: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ...n withinFinalizeBlockperforms the exact same steps asCheckTx, with a little cav...
Near line 516: Loose punctuation mark.
Context: ...he response contains: *Code (uint32): Response Code.0if successful. * `Da...
Near line 517: Loose punctuation mark.
Context: ...de.0if successful. *Data ([]byte): Result bytes, if any. *Log (string):...
Near line 518: To form a complete sentence, be sure to include a subject.
Context: ...The output of the application's logger. May be non-deterministic. * `Info (string):...
Near line 519: To form a complete sentence, be sure to include a subject.
Context: ...Info (string):Additional information. May be non-deterministic. *GasWanted (int...
Near line 520: Loose punctuation mark.
Context: ...non-deterministic. *GasWanted (int64): Amount of gas requested for transaction...
Near line 521: Loose punctuation mark.
Context: ...ate the transaction. *GasUsed (int64): Amount of gas consumed by transaction. ...
Near line 522: Loose punctuation mark.
Context: ... store occurs. *Events ([]cmn.KVPair): Key-Value tags for filtering and indexi...
Near line 522: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...or filtering and indexing transactions (eg. by account). See [events](./08-events...
Near line 523: Loose punctuation mark.
Context: ...nts.md) for more. *Codespace (string): Namespace for the Code. #### EndBlock ...
Near line 535: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...nsus but listen for votes to understand whether or not they should commit the state changes. ...
Near line 539: Consider a shorter alternative to avoid wordiness.
Context: ...ndfinalizeBlockStateresets tonilin order to be consistent and reflect the changes. ...
Near line 541: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...cks have the same number of transactions and it is possible for consensus to result ...
Near line 541: ‘none at all’ might be wordy. Consider a shorter alternative.
Context: ... to result in anilblock or one with none at all. In a public blockchain network, it is ...
Near line 541: Possible missing comma found.
Context: ... censor aTxby excluding it from the block or a validator voting against the block...
Near line 543: Do not use a colon (:) before a series that is introduced by a preposition (‘over’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ... the transaction lifecycle of aTxis over: nodes have verified its validity, deliv...
Near line 553: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ... to query. If thepathmatches a gRPC fully-qualified service method, thenBaseAppwill def...
Near line 561: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...rocess does NOT have to be deterministic and the data returned can be unique to the ...
Near line 573: Possible missing comma found.
Context: ...itted Application state. In the Cosmos-SDK this is implemented as a NoOp: ```go r...docs/learn/beginner/01-tx-lifecycle.md (7)
Near line 13: Unpaired symbol: ‘[’ seems to be missing
Context: ... * Anatomy of a Cosmos SDK Application ::: ## Transactio...
Near line 33: Consider a shorter alternative to avoid wordiness.
Context: ...optional) can be used to scalegasup in order to avoid underestimating. For example, use...
Near line 40: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...e of the two. Later, validators decide whether or not to include the transaction in their blo...
Near line 40: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ....Txis rejected if itsgas-prices` is not high enough, so users are incentivi...
Near line 149: Possible missing comma found.
Context: ...further consensus processes. The app-side mempool, serves the purpose of keepin...
Near line 211: Do not mix variants of the same word (‘finalise’ and ‘finalize’) within a single text.
Context: ... Cosmos SDK, several steps are taken to finalise the process: 1. Event Emission: Module...
Near line 219: Do not mix variants of the same word (‘finalise’ and ‘finalize’) within a single text.
Context: ...to the state during the transaction are finalised and written to the blockchain. This ste...
Path-based Instructions (2)
docs/learn/beginner/01-tx-lifecycle.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"docs/learn/advanced/00-baseapp.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
|
|
||
| `ValidateBasic` should not be used anymore. Message validation should be performed in the `Msg` service when [handling a message](../../build/building-modules/03-msg-services.md#validation) in a module Msg Server. | ||
| The **app-side mempool**, serves the purpose of keeping track of transactions seen by all full-nodes. Full-nodes maintain a **mempool cache** of the last `mempool.cache_size` transactions they have seen, serving as a first line of defense to prevent replay attacks. Ideally, `mempool.cache_size` should be large enough to encompass all transactions in the full mempool. If the mempool cache is too small to track all transactions, the initial transaction validation process is responsible for identifying and rejecting replayed transactions. |
There was a problem hiding this comment.
Add a missing comma for clarity.
- The **app-side mempool**, serves the purpose of keeping track of transactions seen by all full-nodes.
+ The **app-side mempool**, serves the purpose of keeping track of transactions seen by all full-nodes.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| The **app-side mempool**, serves the purpose of keeping track of transactions seen by all full-nodes. Full-nodes maintain a **mempool cache** of the last `mempool.cache_size` transactions they have seen, serving as a first line of defense to prevent replay attacks. Ideally, `mempool.cache_size` should be large enough to encompass all transactions in the full mempool. If the mempool cache is too small to track all transactions, the initial transaction validation process is responsible for identifying and rejecting replayed transactions. | |
| The **app-side mempool**, serves the purpose of keeping track of transactions seen by all full-nodes. Full-nodes maintain a **mempool cache** of the last `mempool.cache_size` transactions they have seen, serving as a first line of defense to prevent replay attacks. Ideally, `mempool.cache_size` should be large enough to encompass all transactions in the full mempool. If the mempool cache is too small to track all transactions, the initial transaction validation process is responsible for identifying and rejecting replayed transactions. |
|
|
||
| On the `BaseApp` end, the `Commit(res abci.CommitResponse)` function is implemented to commit all the valid state transitions that occurred during `FinalizeBlock` and to reset state for the next block. It syncs all the state transitions by writing the `finalizeBlockState.ms` into the application's internal state. `finalizeBlockState.ms` is a branched multistore of the main store `app.cms`. The `Commit` function calls the `Write()` function on `finalizeBlockState.ms`, effectively committing the state transitions. Then, the `Commit` function sets `checkState` to the latest header (obtained from `finalizeBlockState.ctx.BlockHeader`) and `finalizeBlockState` to `nil`. | ||
|
|
||
| Finally, `Commit` returns the hash of the commitment of `app.cms` back to the underlying consensus engine. This hash is used as a reference in the header of the next block. As soon as the state changes are committed, `checkState` starts afresh from the most recently committed state and `finalizeBlockState` resets to `nil` in order to be consistent and reflect the changes. |
There was a problem hiding this comment.
Consider rephrasing to avoid wordiness.
- ...nd `finalizeBlockState` resets to `nil` in order to be consistent and reflect the changes. ...
+ ...nd `finalizeBlockState` resets to `nil` to be consistent and reflect the changes. ...Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| Finally, `Commit` returns the hash of the commitment of `app.cms` back to the underlying consensus engine. This hash is used as a reference in the header of the next block. As soon as the state changes are committed, `checkState` starts afresh from the most recently committed state and `finalizeBlockState` resets to `nil` in order to be consistent and reflect the changes. | |
| Finally, `Commit` returns the hash of the commitment of `app.cms` back to the underlying consensus engine. This hash is used as a reference in the header of the next block. As soon as the state changes are committed, `checkState` starts afresh from the most recently committed state and `finalizeBlockState` resets to `nil` to be consistent and reflect the changes. |
There was a problem hiding this comment.
Actionable comments posted: 8
Review Details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- docs/learn/beginner/01-tx-lifecycle.md (4 hunks)
Additional Context Used
LanguageTool (5)
docs/learn/beginner/01-tx-lifecycle.md (5)
Near line 13: Unpaired symbol: ‘[’ seems to be missing
Context: ... * Anatomy of a Cosmos SDK Application ::: ## Transactio...
Near line 33: Consider a shorter alternative to avoid wordiness.
Context: ...optional) can be used to scalegasup in order to avoid underestimating. For example, use...
Near line 40: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...e of the two. Later, validators decide whether or not to include the transaction in their blo...
Near line 212: Do not mix variants of the same word (‘finalise’ and ‘finalize’) within a single text.
Context: ... Cosmos SDK, several steps are taken to finalise the process: 1. Event Emission: Module...
Near line 220: Do not mix variants of the same word (‘finalise’ and ‘finalize’) within a single text.
Context: ...to the state during the transaction are finalised and written to the blockchain. This ste...
Path-based Instructions (1)
docs/learn/beginner/01-tx-lifecycle.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
| During the module execution phase, each message that has been routed to the appropriate module is processed according to the module-specific business logic. For example, the `handleMsgSend` function in the bank module processes `MsgSend` messages by checking balances, transferring tokens, and emitting events: | ||
|
|
||
|
|
||
| ```go |
There was a problem hiding this comment.
Remove trailing spaces.
- func handleMsgSend(ctx sdk.Context, keeper BankKeeper, msg MsgSend) error {
+ func handleMsgSend(ctx sdk.Context, keeper BankKeeper, msg MsgSend) error {Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ```go | |
| ```go |
There was a problem hiding this comment.
Actionable comments posted: 7
Review Details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- docs/learn/beginner/01-tx-lifecycle.md (4 hunks)
Additional Context Used
LanguageTool (5)
docs/learn/beginner/01-tx-lifecycle.md (5)
Near line 13: Unpaired symbol: ‘[’ seems to be missing
Context: ... * Anatomy of a Cosmos SDK Application ::: ## Transactio...
Near line 33: Consider a shorter alternative to avoid wordiness.
Context: ...optional) can be used to scalegasup in order to avoid underestimating. For example, use...
Near line 40: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...e of the two. Later, validators decide whether or not to include the transaction in their blo...
Near line 209: Do not mix variants of the same word (‘finalise’ and ‘finalize’) within a single text.
Context: ... Cosmos SDK, several steps are taken to finalise the process: 1. Event Emission: Module...
Near line 217: Do not mix variants of the same word (‘finalise’ and ‘finalize’) within a single text.
Context: ...to the state during the transaction are finalised and written to the blockchain. This ste...
Path-based Instructions (1)
docs/learn/beginner/01-tx-lifecycle.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
| @@ -13,9 +13,7 @@ This document describes the lifecycle of a transaction from creation to committe | |||
| * [Anatomy of a Cosmos SDK Application](./00-app-anatomy.md) | |||
There was a problem hiding this comment.
Correct the Markdown link syntax.
- [Anatomy of a Cosmos SDK Application](./00-app-anatomy.md)
+ [Anatomy of a Cosmos SDK Application](./00-app-anatomy.md)Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * [Anatomy of a Cosmos SDK Application](./00-app-anatomy.md) | |
| * [Anatomy of a Cosmos SDK Application](./00-app-anatomy.md) |
| @@ -27,7 +25,7 @@ | |||
|
|
|||
| There are several required and optional flags for transaction creation. The `--from` flag specifies which [account](./03-accounts.md) the transaction is originating from. For example, if the transaction is sending coins, the funds are drawn from the specified `from` address. | |||
|
|
|||
| #### Gas and Fees | |||
| ### Gas and Fees | |||
There was a problem hiding this comment.
Consider simplifying the explanation of the --gas-adjustment flag.
- * `--gas-adjustment` (optional) can be used to scale `gas` up in order to avoid underestimating. For example, users can specify their gas adjustment as 1.5 to use 1.5 times the estimated gas.
+ * `--gas-adjustment` (optional) scales the estimated gas by a specified factor to prevent underestimation, e.g., 1.5 times.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ### Gas and Fees | |
| ### Gas and Fees | |
| * `--gas-adjustment` (optional) scales the estimated gas by a specified factor to prevent underestimation, e.g., 1.5 times. |
| @@ -41,53 +39,101 @@ | |||
|
|
|||
| Later, validators decide whether or not to include the transaction in their block by comparing the given or calculated `gas-prices` to their local `min-gas-prices`. `Tx` is rejected if its `gas-prices` is not high enough, so users are incentivized to pay more. | |||
There was a problem hiding this comment.
Correct grammatical error in the description of gas prices.
- `Tx` is rejected if its `gas-prices` is not high enough, so users are incentivized to pay more.
+ `Tx` is rejected if its `gas-prices` are not high enough, so users are incentivized to pay more.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| Later, validators decide whether or not to include the transaction in their block by comparing the given or calculated `gas-prices` to their local `min-gas-prices`. `Tx` is rejected if its `gas-prices` is not high enough, so users are incentivized to pay more. | |
| Later, validators decide whether or not to include the transaction in their block by comparing the given or calculated `gas-prices` to their local `min-gas-prices`. `Tx` is rejected if its `gas-prices` are not high enough, so users are incentivized to pay more. |
| In order to verify a `Tx`, full-nodes call `CheckTx`, which includes both _stateless_ and _stateful_ | ||
| checks. Further validation happens later in the [`DeliverTx`](../advanced/00-baseapp.md#delivertx) stage. `CheckTx` goes | ||
| through several steps, beginning with decoding `Tx`. | ||
| ## Transaction Processing |
There was a problem hiding this comment.
Remove trailing spaces.
- Within the SDK we wrap the `BaseApp` with a runtime layer defined in `runtime/app.go`.
+ Within the SDK we wrap the `BaseApp` with a runtime layer defined in `runtime/app.go`.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| ## Transaction Processing | |
| ## Transaction Processing |
| How Routing Works: | ||
| The transaction is routed to the appropriate module based on the message type. Each message type is associated with a specific module, which is responsible for processing the message. The core transaction processing layer uses a `MsgServiceRouter` to direct the transaction to the correct module. | ||
|
|
||
| 1. **Transaction Type Identification:** |
There was a problem hiding this comment.
Remove trailing spaces.
- The transaction is routed to the appropriate module based on the message type.
+ The transaction is routed to the appropriate module based on the message type.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 1. **Transaction Type Identification:** | |
| 1. **Transaction Type Identification:** |
|
|
||
| 1. **Transaction Type Identification:** | ||
| Each transaction contains one or more messages (`sdk.Msg`), and each message has a `Type()` method that identifies its type. This type is used to determine the appropriate module to handle the message. | ||
| 2. **Module Routing:** |
There was a problem hiding this comment.
Remove trailing spaces.
- Each transaction contains one or more messages (`sdk.Msg`), and each message has a `Type()` method that identifies its type.
+ Each transaction contains one or more messages (`sdk.Msg`), and each message has a `Type()` method that identifies its type.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 2. **Module Routing:** | |
| 2. **Module Routing:** |
| After a transaction is executed in the Cosmos SDK, several steps are taken to finalise the process: | ||
|
|
||
| 1. Event Emission: Modules emit events that can be used for logging, monitoring, or triggering other workflows. These events are collected during the transaction execution. | ||
|
|
||
| 2. Logging: Information about the transaction execution, such as success or failure, and any significant state changes, are logged for audit and diagnostic purposes. | ||
|
|
||
| 3. Error Handling: If any errors occur during transaction execution, they are handled appropriately, which may include rolling back certain operations to maintain state consistency. | ||
|
|
||
| 4. State Commitment: Changes made to the state during the transaction are finalised and written to the blockchain. This step is crucial as it ensures that all state transitions are permanently recorded. |
There was a problem hiding this comment.
Ensure consistent use of American English spelling for "finalize".
- finalise
+ finalizeCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| After a transaction is executed in the Cosmos SDK, several steps are taken to finalise the process: | |
| 1. Event Emission: Modules emit events that can be used for logging, monitoring, or triggering other workflows. These events are collected during the transaction execution. | |
| 2. Logging: Information about the transaction execution, such as success or failure, and any significant state changes, are logged for audit and diagnostic purposes. | |
| 3. Error Handling: If any errors occur during transaction execution, they are handled appropriately, which may include rolling back certain operations to maintain state consistency. | |
| 4. State Commitment: Changes made to the state during the transaction are finalised and written to the blockchain. This step is crucial as it ensures that all state transitions are permanently recorded. | |
| After a transaction is executed in the Cosmos SDK, several steps are taken to finalize the process: | |
| 1. Event Emission: Modules emit events that can be used for logging, monitoring, or triggering other workflows. These events are collected during the transaction execution. | |
| 2. Logging: Information about the transaction execution, such as success or failure, and any significant state changes, are logged for audit and diagnostic purposes. | |
| 3. Error Handling: If any errors occur during transaction execution, they are handled appropriately, which may include rolling back certain operations to maintain state consistency. | |
| 4. State Commitment: Changes made to the state during the transaction are finalized and written to the blockchain. This step is crucial as it ensures that all state transitions are permanently recorded. |
|
@coderabbitai pause |
Actions PerformedReviews paused. |
There was a problem hiding this comment.
this is super good!! nice job. We should add some mermaid diagrams on sections to help show. Trying to create more diagrams as its very informational. lmk if you want to pair on a few, I also need to learn how to use mermaidjs
(should add diagrams before merge)
docs/learn/advanced/00-baseapp.md
Outdated
| flowchart TD | ||
| A[Receive Block Proposal] --> B[FinalizeBlock] | ||
| B -->|BeginBlock| C{Execute Transactions} | ||
| C --> D[ExecuteTx(tx0)] | ||
| C --> E[ExecuteTx(tx1)] | ||
| C --> F[ExecuteTx(tx2)] | ||
| C --> G[ExecuteTx(tx3)] | ||
| C -->|EndBlock| H[Consensus] | ||
| H --> I[Commit] |
There was a problem hiding this comment.
the "(tx)" are giving trouble to the renderer, this should work:
| flowchart TD | |
| A[Receive Block Proposal] --> B[FinalizeBlock] | |
| B -->|BeginBlock| C{Execute Transactions} | |
| C --> D[ExecuteTx(tx0)] | |
| C --> E[ExecuteTx(tx1)] | |
| C --> F[ExecuteTx(tx2)] | |
| C --> G[ExecuteTx(tx3)] | |
| C -->|EndBlock| H[Consensus] | |
| H --> I[Commit] | |
| flowchart TD | |
| A[Receive Block Proposal] --> B[FinalizeBlock] | |
| B -->|BeginBlock| C{Execute Transactions} | |
| C --> D["ExecuteTx(tx0)"] | |
| C --> E["ExecuteTx(tx1)"] | |
| C --> F["ExecuteTx(tx2)"] | |
| C --> G["ExecuteTx(tx3)"] | |
| C -->|EndBlock| H[Consensus] | |
| H --> I[Commit] |
docs/learn/advanced/00-baseapp.md
Outdated
| Before the first transaction of a given block is processed, a [volatile state](#state-updates) called `finalizeBlockState` is initialized during FinalizeBlock. This state is updated each time a transaction is processed via `FinalizeBlock`, and committed to the [main state](#state-updates) when the block is [committed](#commit), after what it is set to `nil`. | ||
|
|
||
| The `FinalizeBlock` ABCI function defined in `BaseApp` and does the bulk of the state transitions: it is run for each transaction in the block in sequential order as committed to during consensus. Under the hood, transaction execution is almost identical to `CheckTx` but calls the [`runTx`](#runtx) function in deliver mode instead of check mode. |
There was a problem hiding this comment.
is the "and" in BaseApp and does unnecessary ?
docs/learn/advanced/00-baseapp.md
Outdated
| @@ -408,6 +418,10 @@ Click [here](../beginner/04-gas-fees.md#antehandler) for more on the `anteHandle | |||
|
|
|||
| `RunMsgs` is called from `RunTx` with `runTxModeCheck` as parameter to check the existence of a route for each message the transaction, and with `execModeFinalize` to actually process the `sdk.Msg`s. | |||
|
|
|||
| After `CheckTx` exits, `FinalizeBlock` continues to run [`runMsgs`](../advanced/00-baseapp.md#runtx-antehandler-runmsgs-posthandler) to fully execute each `Msg` within the transaction. Since the transaction may have messages from different modules, `BaseApp` needs to know which module to find the appropriate handler. This is achieved using `BaseApp`'s `MsgServiceRouter` so that it can be processed by the module's Protobuf [`Msg` service](../../build/building-modules/03-msg-services.md). | |||
There was a problem hiding this comment.
This is not accurate, CheckTx is ran when including the tx to the mempool, not before FinalizeBlock. These 2 are in different flows, maybe just mention that FinalizeBlock also calls runmsgs and remove the After CheckTx exits,
There was a problem hiding this comment.
Ugh this is actually something prexisting from the intro page and was pasted here :/ and missed this. I think a lot is outdated
Description
This updates the Tx lifecycle so it is more generic with server/v2 efforts. Removes all mention of cometbft other than as an example of a consensus engine that could be used.
Closes: #20173 and part of cosmos/cosmos-sdk-docs#144
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...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers 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...
Summary by CodeRabbit
Contextinitialization,AnteHandleroperations,RunMsgsexecution,FinalizeBlock, andCommitprocesses.