docs: ADR-071 Bank/v2 #20316
docs: ADR-071 Bank/v2 #20316
Conversation
Co-Authored-By: Julien Robert <29894366+julienrbrt@users.noreply.github.com>
|
Note Reviews PausedUse the following commands to manage reviews:
WalkthroughThe proposed changes in Changes
Possibly related 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: 6
Out of diff range and nitpick comments (3)
docs/architecture/adr-071-bank-v2.md (3)
13-13: Remove trailing space for cleaner formatting.
25-25: Remove trailing space for cleaner formatting.
92-92: Ensure the file ends with a single newline character.
Review Details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (1)
- docs/architecture/adr-071-bank-v2.md (1 hunks)
Additional Context Used
LanguageTool (6)
docs/architecture/adr-071-bank-v2.md (6)
Near line 17: Possible missing comma found.
Context: ...duplicates functionalities (with 4 send functions for instance). Additionally, the integ...
Near line 21: Opting for a less wordy alternative here can improve the clarity of your writing.
Context: ...in the core modules. This rewrite will not only reduce the complexity but also improve the efficiency and UX of the bank modul...
Near line 33: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...and does not exceed its intended scope. Currently the permissions allow all denoms, so th...
Near line 61: Consider a shorter alternative to avoid wordiness.
Context: ...ng a v2 needs to be thought thoroughly. In order to not force all dependencies to immediate...
Near line 63: A comma may be missing after the conjunctive/linking adverb ‘Instead’.
Context: ...a newcosmossdk.io/bank/v2go module. Instead the bank protos will be versioned from ...
Near line 81: The word “fallback” is a noun. The verb is spelled with a space.
Context: ...in (IBC-ed custom asset should possibly fallback to the default implementation) * Many a...
Path-based Instructions (1)
docs/architecture/adr-071-bank-v2.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
|
|
||
| In addition to the above, the bank module is currently too rigid and handles too many tasks, so this proposal aims to streamline the module by focusing on core functions `Send`, `Mint`, and `Burn`. | ||
|
|
||
| Currently, the module is split accross different keepers with scattered and duplicates functionalities (with 4 send functions for instance). |
There was a problem hiding this comment.
Consider adding a comma after "Additionally" for better readability.
- Additionally the integration of the token factory into the bank module allows for standardization, and better integration within the core modules.
+ Additionally, the integration of the token factory into the bank module allows for standardization, and better integration within the core modules.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.
| Currently, the module is split accross different keepers with scattered and duplicates functionalities (with 4 send functions for instance). | |
| Currently, the module is split accross different keepers with scattered and duplicates functionalities (with 4 send functions for instance). |
|
@coderabbitai pause |
Actions PerformedReviews paused. |
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Description
The main objective of bank is to condense and streamline the role of the bank module. Currently it handles a multitude of jobs such as handle sends, handle account restrictions, handle delegation counting, minting and burning of coins, we want to streamline this.
Within the ADR we cover ways to achieve this with pros and cons.
We would like to add more implementation details in the next coming days and more importantly obtain feedback
Reference: #17579
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
Documentation
New Features
Refactor
Send,Mint, andBurn.Chores