docs: correct explanation on how to set custom signer via depinject #23654
Conversation
julienrbrt
added
backport/v0.50.x
📝 WalkthroughWalkthroughThe pull request renames the function Changes
Sequence Diagram(s)sequenceDiagram
participant App as Application Startup
participant Init as init()
participant Module as Module Registration
participant Signer as ProvideCustomMsgTransactionGetSigners
App->>Init: Start initialization
Init->>Module: Register custom signer
Module->>Signer: Invoke custom signer function
Signer-->>Module: Return CustomGetSigner (MsgType, Fn)
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (12)
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
|
![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 (1)
docs/build/building-modules/02-messages-and-queries.md (1)
57-72: Clarify the Custom Signer Example ImplementationThe new
ProvideCustomMsgTransactionGetSignersfunction clearly demonstrates how to wrap custom signer extraction logic and return a structuredsigning.CustomGetSigner. One suggestion is to ensure that the placeholder variables (TxandethTx) are either explained in accompanying documentation or replaced with more descriptive names so that readers do not confuse sample code with production code.
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/build/building-modules/02-messages-and-queries.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.md`: "Assess the documentation for misspellings, gramm...
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
docs/build/building-modules/02-messages-and-queries.md
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: build (arm64)
- GitHub Check: build (amd64)
- GitHub Check: markdown-link-check
- GitHub Check: Summary
🔇 Additional comments (1)
docs/build/building-modules/02-messages-and-queries.md (1)
77-83: Update Module Registration for Custom SignerThe update in the
init()function correctly shows the dependency injection change by addingProvideCustomMsgTransactionGetSignersalongsideProvideModulewhen callingappconfig.Provide. This change aligns with the PR’s objective for clearer documentation on setting a custom signer via depinject. It is advisable to verify that any related documentation narrative is also updated to explain this new registration approach.
* build(deps): Bump github.com/cosmos/cosmos-db from 1.1.0 to 1.1.1 (cosmos#23030) * build(deps): Bump github.com/cosmos/ledger-cosmos-go from 0.13.3 to 0.14.0 (cosmos#23029) Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * feat(x/tx): add an option to encode maps using amino json (backport cosmos#23539) (cosmos#23540) Co-authored-by: Julien Robert <julien@rbrt.fr> * feat(client/v2): add map support (backport cosmos#23544) (cosmos#23554) Co-authored-by: Julien Robert <julien@rbrt.fr> * docs(keyring): add keyctl docs (backport cosmos#23563) (cosmos#23566) Co-authored-by: Alessio Treglia <al@essio.dev> * docs: correct explanation on how to set custom signer via depinject (backport cosmos#23654) (cosmos#23663) Co-authored-by: Julien Robert <julien@rbrt.fr> * chore: remove unused orm module (backport cosmos#23633) (cosmos#23637) Co-authored-by: Zachary Becker <zrbecker@gmail.com> * Merge commit from fork * Prevent empty groups (cherry picked from commit 95090a0ec1f193104ba7d6d033a490d1515e54d8) * Handle inflight proposals (cherry picked from commit 855983471882068894ed7952b592ab3e61b464b9) * No empty group with simulations * Update changelog * Set release date * updates * Update RELEASE_NOTES.md * Update RELEASE_NOTES.md --------- Co-authored-by: Alex Peters <alpe@users.noreply.github.com> Co-authored-by: Julien Robert <julien@rbrt.fr> * Mark v0.50.12-pio-1 in the changelog. --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Julien Robert <julien@rbrt.fr> Co-authored-by: Alessio Treglia <al@essio.dev> Co-authored-by: Zachary Becker <zrbecker@gmail.com>
Description
documentation was unclear, causing confusion for users. This should fix it.
cc @johnletey
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
Refactor