docs: add a synopsis upgrade doc for 52 #23097
Conversation
📝 WalkthroughWalkthroughThis pull request introduces an upgrade guide for transitioning from Cosmos SDK version 0.50 to version 0.52. The document outlines significant changes, including the removal of the Changes
Possibly related PRs
Suggested Reviewers
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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
tac0turtle
force-pushed
the
marko/52_tut
branch
from
7c0f9ea to
1fa7f62
Compare
tac0turtle
force-pushed
the
marko/52_tut
branch
from
1fa7f62 to
78e7f3c
Compare
tac0turtle
added
T:Docs
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
docs/build/building-apps/upgrades/0.52.md (5)
171-172: Fix grammatical error in the instructionsThe sentence structure needs improvement.
-For the same instructions than for legacy app wiring to enable sign mode textual +For the same instructions as for legacy app wiring to enable sign mode textual🧰 Tools
🪛 LanguageTool
[grammar] ~171-~171: Comparison is written ‘the same … as’.
Context: ...ly the case). For the same instructions than for legacy app wiring to enable sign mo...(THE_SAME_AS)
135-136: Add missing comma for better readability-The embedding of gRPC-Web was removed. if you would like to continue using gRPC-Web you will need to use [Envoy](https://www.envoyproxy.io/) +The embedding of gRPC-Web was removed. If you would like to continue using gRPC-Web, you will need to use [Envoy](https://www.envoyproxy.io/)🧰 Tools
🪛 LanguageTool
[uncategorized] ~135-~135: Possible missing comma found.
Context: ...f you would like to continue using gRPC-Web you will need to use [Envoy](https://ww...(AI_HYDRA_LEO_MISSING_COMMA)
407-408: Clarify x/validate module requirementsThe instructions about x/validate module usage are ambiguous. Please specify when exactly this module is required and when it can be skipped.
-`x/validate` is a module for antehandlers. If you are using runtime/depinject or v2 this module is required. Skip this step or define your own custom ante/post handlers, see `x/validate` documentation for more details. +`x/validate` is a module for antehandlers. If you are using runtime/depinject or v2, this module is required. If you're not using these features, you can either skip this step or define your own custom ante/post handlers. See `x/validate` documentation for more details.🧰 Tools
🪛 LanguageTool
[uncategorized] ~407-~407: Possible missing comma found.
Context: ... If you are using runtime/depinject or v2 this module is required. Skip this step...(AI_HYDRA_LEO_MISSING_COMMA)
368-369: Fix typo in protocolpool description-This new module allows teams and the community to create funding opportunities fot the development team and the community. +This new module allows teams and the community to create funding opportunities for the development team and the community.
513-519: Enhance local testing instructionsConsider adding specific validation steps for critical features:
- Verify parameter migration from x/params to module-managed parameters
- Test unordered transactions if enabled
- Validate protocolpool functionality if x/distribution is used
- Verify account number migration if using x/accounts
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/build/building-apps/upgrades/0.52.md(1 hunks)docs/build/building-apps/upgrades/_category_.json(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/build/building-apps/upgrades/category.json
🧰 Additional context used
📓 Path-based instructions (1)
docs/build/building-apps/upgrades/0.52.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/build/building-apps/upgrades/0.52.md
[style] ~30-~30: This phrase is redundant (‘I’ stands for ‘Interfaces’). Use simply “APIInterfaces”.
Context: ...rts-to-cosmossdkiox) 11. Adopt Core API Interfaces 12. [Si...
(ACRONYM_TAUTOLOGY)
[uncategorized] ~135-~135: Possible missing comma found.
Context: ...f you would like to continue using gRPC-Web you will need to use [Envoy](https://ww...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~171-~171: Comparison is written ‘the same … as’.
Context: ...ly the case). For the same instructions than for legacy app wiring to enable sign mo...
(THE_SAME_AS)
[grammar] ~197-~197: Probably a preposition is missing after ‘corresponding’.
Context: ...ml configuration files by adjusting the corresponding opt option to Mgoogle/protobuf/any.proto=gi...
(ATD_VERBS_TO_COLLOCATION)
[style] ~227-~227: This phrase is redundant (‘I’ stands for ‘Interfaces’). Use simply “APIInterfaces”.
Context: ...sdk.io/x/gov/types" ``` ### Adopt Core API Interfaces Core API has been introduced for modul...
(ACRONYM_TAUTOLOGY)
[grammar] ~229-~229: The verb ‘recommend’ is used with the gerund form.
Context: ...deprecation of sdk.Context, we strongly recommend to use the cosmossdk.io/core/appmodule interfa...
(ADMIT_ENJOY_VB)
[style] ~309-~309: Consider a shorter alternative to avoid wordiness.
Context: ...emain, but you cannot create new ones. In order to create new vesting accounts you need to...
(IN_ORDER_TO_PREMIUM)
[typographical] ~310-~310: It seems that a comma is missing.
Context: ...w ones. In order to create new vesting accounts you need to add the accounts module to ...
(IN_ORDER_TO_VB_COMMA)
[style] ~331-~331: Consider a shorter alternative to avoid wordiness.
Context: ...` ### TX Decoder Setup for x/accounts In order to support x/accounts, you need to initial...
(IN_ORDER_TO_PREMIUM)
[grammar] ~356-~356: Did you mean “be removed”?
Context: ... module was removed entirely and should removed from your application. * Remove code...
(WILL_BASED_ON)
[uncategorized] ~407-~407: Possible missing comma found.
Context: ... If you are using runtime/depinject or v2 this module is required. Skip this step...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~411-~411: Consider a shorter alternative to avoid wordiness.
Context: ... appmodule is the single entry point. In order to make the necessary changes the appmodul...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~509-~509: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...g accounts, etc. If your chain is small or you do not rely on x/upgrade, you can d...
(COMMA_COMPOUND_SENTENCE)
🔇 Additional comments (1)
docs/build/building-apps/upgrades/0.52.md (1)
1-47: Well-structured documentation with clear navigation!
The document follows documentation best practices with proper markdown formatting, clear headings, and a comprehensive table of contents.
🧰 Tools
🪛 LanguageTool
[style] ~30-~30: This phrase is redundant (‘I’ stands for ‘Interfaces’). Use simply “APIInterfaces”.
Context: ...rts-to-cosmossdkiox) 11. Adopt Core API Interfaces 12. [Si...
(ACRONYM_TAUTOLOGY)
julienrbrt
changed the title
Co-authored-by: Alex | Skip <[email protected]>
Co-authored-by: Alex | Skip <[email protected]>
Co-authored-by: Alex | Skip <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (9)
docs/build/building-apps/upgrades/0.52.md (9)
30-30: Remove redundant word "Interfaces"The phrase "Core API Interfaces" is redundant since "API" already stands for "Application Programming Interface". Consider using just "Core API" instead.
Also applies to: 227-227
🧰 Tools
🪛 LanguageTool
[style] ~30-~30: This phrase is redundant (‘I’ stands for ‘Interfaces’). Use simply “APIInterfaces”.
Context: ...rts-to-cosmossdkiox) 11. Adopt Core API Interfaces 12. [Si...(ACRONYM_TAUTOLOGY)
171-171: Fix grammatical error in comparisonThe phrase "same instructions than" should be "same instructions as".
-For the same instructions than for legacy app wiring +For the same instructions as for legacy app wiring🧰 Tools
🪛 LanguageTool
[grammar] ~171-~171: Comparison is written ‘the same … as’.
Context: ...ly the case). For the same instructions than for legacy app wiring to enable sign mo...(THE_SAME_AS)
229-229: Fix verb usage with gerund formThe phrase "strongly recommend to use" should be "strongly recommend using".
-we strongly recommend to use +we strongly recommend using🧰 Tools
🪛 LanguageTool
[grammar] ~229-~229: The verb ‘recommend’ is used with the gerund form.
Context: ...precation ofsdk.Context, we strongly recommend to use the cosmossdk.io/core/appmodule interfa...(ADMIT_ENJOY_VB)
309-311: Improve sentence structure and fix commaThe phrases starting with "In order to" can be simplified, and a comma is missing after "accounts".
-In order to create new vesting accounts you need to +To create new vesting accounts, you need to🧰 Tools
🪛 LanguageTool
[style] ~309-~309: Consider a shorter alternative to avoid wordiness.
Context: ...emain, but you cannot create new ones. In order to create new vesting accounts you need to...(IN_ORDER_TO_PREMIUM)
[typographical] ~310-~310: It seems that a comma is missing.
Context: ...w ones. In order to create new vesting accounts you need to add the accounts module to ...(IN_ORDER_TO_VB_COMMA)
356-356: Fix missing word in sentenceThere's a missing word "be" in the sentence.
-should removed from your application +should be removed from your application🧰 Tools
🪛 LanguageTool
[grammar] ~356-~356: Did you mean “be removed”?
Context: ... module was removed entirely and should removed from your application. * Remove code...(WILL_BASED_ON)
368-368: Fix typo in wordThe word "fot" should be "for".
-fot the development team +for the development team🧰 Tools
🪛 GitHub Actions: Spell Check
[warning] 368-368: Spelling error: 'fot' should be 'for', 'fit', 'dot', 'rot', 'cot', 'got', 'tot', or 'fog'
291-293: Add code block formatting for better readabilityThe InitGenesis and ExportGenesis examples should be formatted as a diff block for better clarity. Also, consider mentioning common error types that developers might have been relying on.
-func (am AppModule) InitGenesis(ctx context.Context, data json.RawMessage) error { - // ... -} +func (am AppModule) InitGenesis(ctx context.Context, data json.RawMessage) error { + var genesisState types.GenesisState + if err := am.cdc.UnmarshalJSON(data, &genesisState); err != nil { + return fmt.Errorf("failed to unmarshal genesis state: %w", err) + } + return am.keeper.InitGenesis(ctx, genesisState) +} -func (am AppModule) ExportGenesis(ctx context.Context) (json.RawMessage, error) { - // ... -} +func (am AppModule) ExportGenesis(ctx context.Context) (json.RawMessage, error) { + genesisState := am.keeper.ExportGenesis(ctx) + return am.cdc.MarshalJSON(genesisState) +}Note: If you were previously using
sdk.ErrNotFoundortypes.ErrNotFound, these should now be replaced withcollections.ErrNotFound.Also applies to: 304-304
175-175: Add missing link to environment documentationThe sentence "Learn more about environment here" is missing the actual link to the documentation.
-Learn more about environment here +Learn more about environment [here](https://docs.cosmos.network/main/build/building-modules/module-manager#environment)
509-509: Add missing comma in compound sentenceAdd a comma before "or" as it connects two independent clauses.
-If your chain is small or you do not rely on x/upgrade +If your chain is small, or you do not rely on x/upgrade🧰 Tools
🪛 LanguageTool
[uncategorized] ~509-~509: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...g accounts, etc. If your chain is small or you do not rely on x/upgrade, you can d...(COMMA_COMPOUND_SENTENCE)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/build/building-apps/upgrades/0.52.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/build/building-apps/upgrades/0.52.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/build/building-apps/upgrades/0.52.md
[style] ~30-~30: This phrase is redundant (‘I’ stands for ‘Interfaces’). Use simply “APIInterfaces”.
Context: ...rts-to-cosmossdkiox) 11. Adopt Core API Interfaces 12. [Si...
(ACRONYM_TAUTOLOGY)
[grammar] ~171-~171: Comparison is written ‘the same … as’.
Context: ...ly the case). For the same instructions than for legacy app wiring to enable sign mo...
(THE_SAME_AS)
[grammar] ~197-~197: Probably a preposition is missing after ‘corresponding’.
Context: ...ml configuration files by adjusting the corresponding opt option to Mgoogle/protobuf/any.proto=gi...
(ATD_VERBS_TO_COLLOCATION)
[style] ~227-~227: This phrase is redundant (‘I’ stands for ‘Interfaces’). Use simply “APIInterfaces”.
Context: ...sdk.io/x/gov/types" ``` ### Adopt Core API Interfaces Core API has been introduced for modul...
(ACRONYM_TAUTOLOGY)
[grammar] ~229-~229: The verb ‘recommend’ is used with the gerund form.
Context: ...precation of sdk.Context, we strongly recommend to use the cosmossdk.io/core/appmodule interfa...
(ADMIT_ENJOY_VB)
[style] ~309-~309: Consider a shorter alternative to avoid wordiness.
Context: ...emain, but you cannot create new ones. In order to create new vesting accounts you need to...
(IN_ORDER_TO_PREMIUM)
[typographical] ~310-~310: It seems that a comma is missing.
Context: ...w ones. In order to create new vesting accounts you need to add the accounts module to ...
(IN_ORDER_TO_VB_COMMA)
[style] ~331-~331: Consider a shorter alternative to avoid wordiness.
Context: ...` ### TX Decoder Setup for x/accounts In order to support x/accounts, you need to initial...
(IN_ORDER_TO_PREMIUM)
[grammar] ~356-~356: Did you mean “be removed”?
Context: ... module was removed entirely and should removed from your application. * Remove code...
(WILL_BASED_ON)
[style] ~411-~411: Consider a shorter alternative to avoid wordiness.
Context: ... appmodule is the single entry point. In order to make the necessary changes the appmodul...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~509-~509: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...g accounts, etc. If your chain is small or you do not rely on x/upgrade, you can d...
(COMMA_COMPOUND_SENTENCE)
🪛 GitHub Actions: Spell Check
docs/build/building-apps/upgrades/0.52.md
[warning] 368-368: Spelling error: 'fot' should be 'for', 'fit', 'dot', 'rot', 'cot', 'got', 'tot', or 'fog'
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Summary
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
docs/build/building-apps/upgrades/0.52.md (2)
71-71: Minor grammatical improvement neededConsider rephrasing for better clarity:
- Genesis & ADR-070 – Constructors now take `context.Context` and do not pass around a codec. + Genesis & ADR-070 – Constructors now accept `context.Context` and no longer pass around a codec.🧰 Tools
🪛 GitHub Actions: Spell Check
[warning] 383: Spelling error: 'fot' should be 'for', 'fit', 'dot', 'rot', 'cot', 'got', 'tot', or 'fog'
528-534: Enhance local testing instructionsConsider adding specific validation steps for critical features:
- Verify parameter migration from x/params
- Test x/accounts functionality with both new and existing accounts
- Validate protocolpool operations if using x/distribution
🧰 Tools
🪛 GitHub Actions: Spell Check
[warning] 383: Spelling error: 'fot' should be 'for', 'fit', 'dot', 'rot', 'cot', 'got', 'tot', or 'fog'
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/build/building-apps/upgrades/0.52.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/build/building-apps/upgrades/0.52.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/build/building-apps/upgrades/0.52.md
[style] ~30-~30: This phrase is redundant (‘I’ stands for ‘Interfaces’). Use simply “APIInterfaces”.
Context: ...rts-to-cosmossdkiox) 11. Adopt Core API Interfaces 12. [Si...
(ACRONYM_TAUTOLOGY)
[uncategorized] ~119-~119: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...changed** • The “basic module manager” is removed. You should directly use module...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[uncategorized] ~119-~119: You might be missing the article “the” here.
Context: ...er” is removed. You should directly use module.Manager. Action • Remove referenc...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~171-~171: Comparison is written ‘the same … as’.
Context: ...ly the case). For the same instructions than for legacy app wiring to enable sign mo...
(THE_SAME_AS)
[uncategorized] ~175-~175: You might be missing the article “the” here.
Context: ...nment for all modules. Learn more about environment here . Given the fields of environment,...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~197-~197: Probably a preposition is missing after ‘corresponding’.
Context: ...ml configuration files by adjusting the corresponding opt option to Mgoogle/protobuf/any.proto=gi...
(ATD_VERBS_TO_COLLOCATION)
[style] ~227-~227: This phrase is redundant (‘I’ stands for ‘Interfaces’). Use simply “APIInterfaces”.
Context: ...sdk.io/x/gov/types" ``` ### Adopt Core API Interfaces Core API has been introduced for modul...
(ACRONYM_TAUTOLOGY)
[uncategorized] ~228-~228: You might be missing the article “the” here.
Context: ...es" ``` ### Adopt Core API Interfaces Core API has been introduced for modules sin...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~229-~229: The verb ‘recommend’ is used with the gerund form.
Context: ...precation of sdk.Context, we strongly recommend to use the cosmossdk.io/core/appmodule interfa...
(ADMIT_ENJOY_VB)
[uncategorized] ~273-~273: A comma might be missing here.
Context: ... Invoke, Provide, Register → appconfig Previously cosmossdk.io/core/appconfig held functi...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~305-~305: Future tense may not be necessary in this context (after ‘when’).
Context: ...th no error. When migrating collections will return collections.ErrNotFound. Checking fo...
(WHEN_I_WILL)
[style] ~324-~324: Consider a shorter alternative to avoid wordiness.
Context: ...emain, but you cannot create new ones. In order to create new vesting accounts you need to...
(IN_ORDER_TO_PREMIUM)
[typographical] ~325-~325: It seems that a comma is missing.
Context: ...w ones. In order to create new vesting accounts you need to add the accounts module to ...
(IN_ORDER_TO_VB_COMMA)
[style] ~346-~346: Consider a shorter alternative to avoid wordiness.
Context: ...` ### TX Decoder Setup for x/accounts In order to support x/accounts, you need to initial...
(IN_ORDER_TO_PREMIUM)
[grammar] ~371-~371: Did you mean “be removed”?
Context: ... module was removed entirely and should removed from your application. * Remove code...
(WILL_BASED_ON)
[style] ~426-~426: Consider a shorter alternative to avoid wordiness.
Context: ... appmodule is the single entry point. In order to make the necessary changes the appmodul...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~426-~426: A comma might be missing here.
Context: ...y point. In order to make the necessary changes the appmodulebasic struct in the module...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~524-~524: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...g accounts, etc. If your chain is small or you do not rely on x/upgrade, you can d...
(COMMA_COMPOUND_SENTENCE)
🪛 GitHub Actions: Spell Check
docs/build/building-apps/upgrades/0.52.md
[warning] 383: Spelling error: 'fot' should be 'for', 'fit', 'dot', 'rot', 'cot', 'got', 'tot', or 'fog'
⏰ Context from checks skipped due to timeout of 90000ms (20)
- GitHub Check: tests (03)
- GitHub Check: tests (02)
- GitHub Check: tests (01)
- GitHub Check: tests (00)
- GitHub Check: test-x-mint
- GitHub Check: test-x-epochs
- GitHub Check: test-x-consensus
- GitHub Check: test-tools-benchmark
- GitHub Check: test-x-staking
- GitHub Check: test-x-authz
- GitHub Check: test-x-bank
- GitHub Check: test-x-slashing
- GitHub Check: test-x-group
- GitHub Check: test-x-upgrade
- GitHub Check: test-x-protocolpool
- GitHub Check: build (arm64)
- GitHub Check: build (amd64)
- GitHub Check: markdown-link-check
- GitHub Check: dependency-review
- GitHub Check: Summary
🔇 Additional comments (1)
docs/build/building-apps/upgrades/0.52.md (1)
1-47: Well-structured documentation layout!The document has a clear hierarchy with a comprehensive table of contents that makes it easy to navigate through the upgrade process.
🧰 Tools
🪛 LanguageTool
[style] ~30-~30: This phrase is redundant (‘I’ stands for ‘Interfaces’). Use simply “APIInterfaces”.
Context: ...rts-to-cosmossdkiox) 11. Adopt Core API Interfaces 12. [Si...(ACRONYM_TAUTOLOGY)
🪛 GitHub Actions: Spell Check
[warning] 383: Spelling error: 'fot' should be 'for', 'fit', 'dot', 'rot', 'cot', 'got', 'tot', or 'fog'
|
|
||
| ### Update Depinject app_config.go / app.yml if Applicable | ||
|
|
||
| With the introduction of environment in modules, depinject automatically creates the environment for all modules. Learn more about environment here . Given the fields of environment, this means runtime creates a kv store service for all modules by default. It can happen that some modules do not have a store necessary (such as x/auth/tx for instance). In this case, the store creation should be skipped in app_config.go: |
There was a problem hiding this comment.
Add missing link to environment documentation
The line "Learn more about environment here" is missing its hyperlink.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~175-~175: You might be missing the article “the” here.
Context: ...nment for all modules. Learn more about environment here . Given the fields of environment,...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 GitHub Actions: Spell Check
[warning] 383: Spelling error: 'fot' should be 'for', 'fit', 'dot', 'rot', 'cot', 'got', 'tot', or 'fog'
|
|
||
| ### Add x/protocolpool if Using x/distribution | ||
|
|
||
| The community pool was moved from distribution to a new module called protocolpool. This new module allows teams and the community to create funding opportunities fot the development team and the community. |
There was a problem hiding this comment.
Fix typo in protocol pool description
- This new module allows teams and the community to create funding opportunities fot the development team and the community.
+ This new module allows teams and the community to create funding opportunities for the development team and the community.📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The community pool was moved from distribution to a new module called protocolpool. This new module allows teams and the community to create funding opportunities fot the development team and the community. | |
| The community pool was moved from distribution to a new module called protocolpool. This new module allows teams and the community to create funding opportunities for the development team and the community. |
🧰 Tools
🪛 GitHub Actions: Spell Check
[warning] 383: Spelling error: 'fot' should be 'for', 'fit', 'dot', 'rot', 'cot', 'got', 'tot', or 'fog'
|
|
||
| ### Handle Sign Mode Textual | ||
|
|
||
| With the split of x/auth/tx/config in two (`x/auth/tx/config` as depinject module for txconfig and tx options) and `x/validate`, sign mode textual is no more automatically configured when using runtime (it was previously the case). For the same instructions than for legacy app wiring to enable sign mode textual (see in v0.50 UPGRADING documentation). |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve clarity of sign mode textual instructions
- For the same instructions than for legacy app wiring to enable sign mode textual (see in v0.50 UPGRADING documentation).
+ Follow the same instructions as for legacy app wiring to enable sign mode textual (see the v0.50 UPGRADING documentation).📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
| With the split of x/auth/tx/config in two (`x/auth/tx/config` as depinject module for txconfig and tx options) and `x/validate`, sign mode textual is no more automatically configured when using runtime (it was previously the case). For the same instructions than for legacy app wiring to enable sign mode textual (see in v0.50 UPGRADING documentation). | |
| With the split of x/auth/tx/config in two (`x/auth/tx/config` as depinject module for txconfig and tx options) and `x/validate`, sign mode textual is no more automatically configured when using runtime (it was previously the case). Follow the same instructions as for legacy app wiring to enable sign mode textual (see the v0.50 UPGRADING documentation). |
🧰 Tools
🪛 LanguageTool
[grammar] ~171-~171: Comparison is written ‘the same … as’.
Context: ...ly the case). For the same instructions than for legacy app wiring to enable sign mo...
(THE_SAME_AS)
🪛 GitHub Actions: Spell Check
[warning] 383: Spelling error: 'fot' should be 'for', 'fit', 'dot', 'rot', 'cot', 'got', 'tot', or 'fog'
|
Looks like we have some markdown link fails in unrelated files https://github.com/cosmos/cosmos-sdk/actions/runs/12634159334/job/35201313253?pr=23097#step:5:500 |
|
markdown links some times appear broken but after running the
fixed |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/learn/advanced/00-baseapp.md (1)
312-312: Consider adding a comma for better readability.Add a comma before "and" to improve the flow of this compound sentence.
-The [`Core pkg`](../advanced/02-core.md), which includes a `GasService` that tracks how much gas is used during the execution of `Tx`, is initialized at the beginning of `CheckTx`. The user-provided amount of gas for `Tx` is referred to as `GasWanted`. If `GasConsumed`, the amount of gas used during execution, exceeds `GasWanted`, the execution is halted and the changes made to the cached copy of the state are not committed. +The [`Core pkg`](../advanced/02-core.md), which includes a `GasService` that tracks how much gas is used during the execution of `Tx`, is initialized at the beginning of `CheckTx`. The user-provided amount of gas for `Tx` is referred to as `GasWanted`. If `GasConsumed`, the amount of gas used during execution, exceeds `GasWanted`, the execution is halted, and the changes made to the cached copy of the state are not committed.🧰 Tools
🪛 LanguageTool
[uncategorized] ~312-~312: 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 ...(COMMA_COMPOUND_SENTENCE_2)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
docs/architecture/adr-040-storage-and-smt-state-commitments.md(0 hunks)docs/build/build.md(1 hunks)docs/build/building-apps/00-runtime.md(1 hunks)docs/build/building-modules/16-testing.md(1 hunks)docs/learn/advanced/00-baseapp.md(1 hunks)docs/learn/advanced/04-store.md(0 hunks)docs/user/run-node/06-run-production.md(1 hunks)
💤 Files with no reviewable changes (2)
- docs/learn/advanced/04-store.md
- docs/architecture/adr-040-storage-and-smt-state-commitments.md
✅ Files skipped from review due to trivial changes (4)
- docs/user/run-node/06-run-production.md
- docs/build/build.md
- docs/build/building-apps/00-runtime.md
- docs/build/building-modules/16-testing.md
🧰 Additional context used
📓 Path-based instructions (1)
docs/learn/advanced/00-baseapp.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/learn/advanced/00-baseapp.md
[uncategorized] ~312-~312: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ...eds GasWanted, the execution is halted and the changes made to the cached copy of ...
(COMMA_COMPOUND_SENTENCE_2)
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: test-x-consensus
- GitHub Check: test-tools-benchmark
- GitHub Check: test-x-slashing
- GitHub Check: build (arm64)
- GitHub Check: build (amd64)
- GitHub Check: dependency-review
- GitHub Check: markdown-link-check
- GitHub Check: Summary
🔇 Additional comments (1)
docs/learn/advanced/00-baseapp.md (1)
312-312: LGTM! Accurate update of gas tracking implementation.The change correctly reflects that gas tracking is now handled by the
GasServicein theCore pkgrather than directly in theContext.🧰 Tools
🪛 LanguageTool
[uncategorized] ~312-~312: 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 ...(COMMA_COMPOUND_SENTENCE_2)
|
@Mergifyio backport release/v0.52.x |
✅ Backports have been created
|
Co-authored-by: Alex | Skip <[email protected]> (cherry picked from commit 9afe2f7) # Conflicts: # docs/build/build.md
Co-authored-by: Marko <[email protected]> Co-authored-by: Julien Robert <[email protected]>
Description
This pr adds a short step by step upgrade doc to the documentation. its smaller than the upgrading with some slight other information .
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.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit
New Features
Documentation
Environmentstruct within the context ofkeepers to specify "kvstore services".