Refactor x/rollup module to adhere to Cosmos SDK suggested standards #124
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThe recent changes introduce significant refactoring across the codebase, enhancing modularity and clarity. Key updates include transitioning from specific package dependencies to a more generalized structure, improving transaction handling, and streamlining error management. New script automation for protocol buffer generation and updated configuration files further enhance the system's integration with Go. The overall focus has been on consolidating functionality and improving maintainability, paving the way for better extensibility and usability within the project. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Layer2
participant Layer1
participant Monomer
User->>Layer2: Initiate Withdrawal Request
Layer2->>Monomer: Process Withdrawal
Monomer->>Layer1: Send State Commitment
Layer1-->>User: Confirm Withdrawal
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 Configuration 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: 2
Outside diff range, codebase verification and nitpick comments (1)
x/rollup/keeper/msg_server.go (1)
24-24:msgServerdoes not implementtypes.MsgServiceServermethods.The
msgServerstruct is defined but does not implement the methods required by thetypes.MsgServiceServerinterface (ApplyL1TxsandInitiateWithdrawal). This needs to be addressed to ensure the correct functionality.
msgServerstruct is defined inx/rollup/keeper/msg_server.go.types.MsgServiceServerinterface requires methodsApplyL1TxsandInitiateWithdrawalas defined inx/rollup/types/tx.pb.go.Analysis chain
Ensure correct implementation of
NewMsgServerImpl.The function now returns
types.MsgServiceServer. Verify that thetypes.MsgServiceServerinterface is correctly implemented bymsgServer.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the implementation of `types.MsgServiceServer` by `msgServer`. # Test: Search for the implementation of `MsgServiceServer` methods in `msgServer`. Expect: Correct implementation. ast-grep --lang go --pattern 'func ($_ msgServer) $_($_) ($_ error) { $$$ }'Length of output: 78
Script:
#!/bin/bash # Find the definition of `msgServer` to understand its structure. ast-grep --lang go --pattern 'type msgServer struct { $$$ }' # List all methods implemented by `msgServer`. ast-grep --lang go --pattern 'func ($_ msgServer) $_($_) ($_ error) { $$$ }' # Find the definition of `types.MsgServiceServer` to list required methods. ast-grep --lang go --pattern 'type MsgServiceServer interface { $$$ }'Length of output: 676
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (5)
gen/rollup/module/v1/module.pb.gois excluded by!**/*.pb.gogen/testapp/module/v1/module.pb.gois excluded by!**/*.pb.gogen/testapp/v1/get.pb.gois excluded by!**/*.pb.gogen/testapp/v1/set.pb.gois excluded by!**/*.pb.gox/rollup/types/tx.pb.gois excluded by!**/*.pb.go
Files selected for processing (21)
- Makefile (1 hunks)
- adapters.go (4 hunks)
- buf.gen.yaml (1 hunks)
- builder/builder.go (3 hunks)
- engine/engine.go (3 hunks)
- monomer.go (2 hunks)
- proto/rollup/module/v1/module.proto (1 hunks)
- proto/rollup/v1/tx.proto (2 hunks)
- scripts/gen-proto.sh (1 hunks)
- testapp/proto/testapp/module/v1/module.proto (1 hunks)
- testapp/proto/testapp/v1/get.proto (1 hunks)
- testapp/proto/testapp/v1/set.proto (1 hunks)
- testutils/utils.go (3 hunks)
- x/rollup/README.md (1 hunks)
- x/rollup/keeper/msg_server.go (7 hunks)
- x/rollup/module.go (3 hunks)
- x/rollup/types/codec.go (1 hunks)
- x/rollup/types/errors.go (1 hunks)
- x/rollup/types/events.go (2 hunks)
- x/rollup/types/msgs.go (1 hunks)
- x/rollup/types/msgs_test.go (2 hunks)
Files skipped from review due to trivial changes (2)
- testapp/proto/testapp/module/v1/module.proto
- testapp/proto/testapp/v1/get.proto
Additional context used
LanguageTool
x/rollup/README.md
[uncategorized] ~15-~15: Possible missing comma found.
Context: ...2 state commitment to L1 through the OP Stack and the user will be able to prove and ...(AI_HYDRA_LEO_MISSING_COMMA)
Additional comments not posted (39)
buf.gen.yaml (1)
5-9: Improved configuration readability and functionality.The transition to a multi-line list format for the
optfield enhances readability. The addition of the new optionMcosmos/app/v1alpha1/module.proto=cosmossdk.io/api/cosmos/app/v1alpha1extends the configuration to support additional functionality with the Cosmos SDK.x/rollup/types/codec.go (1)
1-10: Correct implementation of interface registration.The
RegisterInterfacesfunction is correctly implemented, adhering to Cosmos SDK standards for registering message service descriptions.proto/rollup/module/v1/module.proto (1)
7-7: Enhanced Go package specification.The addition of the
go_packageoption improves clarity and integration with Go projects by explicitly defining the package structure for generated code.testapp/proto/testapp/v1/set.proto (1)
7-8: Addition ofgo_packageoption is appropriate.The inclusion of the
go_packageoption aligns with Go conventions and improves the integration of generated code.scripts/gen-proto.sh (1)
1-16: Script structure is well-organized.The script uses standard shell scripting practices and is structured clearly.
x/rollup/types/events.go (1)
15-15: Removal of unused constants is appropriate.The removal of these constants helps streamline the code. Ensure they are not used elsewhere in the codebase.
Verification successful
Removal of unused constants is confirmed.
The removed constants are not used elsewhere in the codebase, confirming their removal is appropriate. This helps streamline the code and reduce complexity.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that removed constants are not used elsewhere in the codebase. # Test: Search for the removed constants. Expect: No occurrences. rg --type go 'AttributeKeyBridgedTokenType|AttributeKeyFromEvmAddress|AttributeKeyToEvmAddress|L1SystemDepositTxType'Length of output: 119
Script:
#!/bin/bash # Re-run the search for the removed constants to confirm they are not used elsewhere in the codebase. rg --type go 'AttributeKeyBridgedTokenType|AttributeKeyFromEvmAddress|AttributeKeyToEvmAddress|L1SystemDepositTxType'Length of output: 119
x/rollup/README.md (1)
5-7: Clarify the deposits section.The description of the deposits section is clear and effectively distinguishes it from other cosmos-sdk modules. No issues found.
x/rollup/types/errors.go (1)
18-19: Addition of new error codes looks good.The new error codes
ErrProcessL1UserDepositTxsandErrProcessL1SystemDepositTxare correctly registered, enhancing the granularity of error handling.x/rollup/types/msgs.go (5)
23-28: ValidateBasic method for ApplyL1TxsRequest is well-implemented.The
ValidateBasicmethod checks for the presence of transaction bytes, usingWrapErrorfor error handling. This aligns with best practices.
30-36: Type and Route methods for ApplyL1TxsRequest are correctly defined.The
TypeandRoutemethods provide the expected string identifiers for the message type.
38-52: ValidateBasic method for InitiateWithdrawalRequest is comprehensive.The method includes checks for a valid Ethereum address and gas limit, ensuring robustness.
54-60: Type and Route methods for InitiateWithdrawalRequest are correctly defined.These methods follow the standard pattern for defining message type and route.
17-21: Implement GetSigners method for ApplyL1TxsRequest.The
GetSignersmethod currently returnsnil, which might be intentional if no signers are required. Ensure this is the intended behavior.Verification successful
No Signers Required for ApplyL1TxsRequest
The
GetSignersmethod inApplyL1TxsRequestreturningnilis intentional. The usage context indicates that this message type does not require signers, aligning with its role in processing L1 transactions. No changes are needed.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify if the GetSigners method for ApplyL1TxsRequest is correctly implemented. # Test: Search for the ApplyL1TxsRequest usage. Expect: Contextual usage indicating if signers are needed. rg --type go -A 5 $'ApplyL1TxsRequest'Length of output: 9761
proto/rollup/v1/tx.proto (2)
10-10: Addgo_packageoption for better Go integration.The addition of the
go_packageoption is a good practice for ensuring that the generated Go code is placed in the correct package, improving maintainability and usability.
11-11: Verify removal of validation comment.The removal of the comment regarding validations related to the target address and gas limit might imply a change in validation strategy. Ensure that these validations are implemented elsewhere if still required.
x/rollup/types/msgs_test.go (3)
1-1: Transition totypes_testpackage.The transition from
keeper_testtotypes_testaligns the tests with the refactored package structure, enhancing modularity.
12-12: Refactor test to focus onInitiateWithdrawalRequest.Renaming the test function to
TestInitiateWithdrawalRequestValidateBasicand focusing onInitiateWithdrawalRequestimproves specificity and clarity in testing.
Line range hint
64-72: Encapsulate validation logic within request structure.Encapsulating the validation logic within the
InitiateWithdrawalRequeststructure promotes object-oriented principles and enhances code maintainability.Makefile (1)
35-35: Use script forgen-prototarget.Replacing the direct
bufcommand with a script (gen-proto.sh) allows for more flexibility and potential enhancements in the protocol buffer generation process. Ensure the script is well-documented and handles all necessary steps.Verification successful
Script
gen-proto.shis present and executable.The
gen-proto.shscript is correctly located in thescriptsdirectory and has executable permissions. This satisfies the requirement to use the script for thegen-prototarget in the Makefile. No further action is needed.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the contents and functionality of `gen-proto.sh`. # Test: Check if `gen-proto.sh` exists and is executable. Expect: The script should be present and executable. if [ -x "${SCRIPTS_PATH}/gen-proto.sh" ]; then echo "gen-proto.sh exists and is executable." else echo "gen-proto.sh is missing or not executable." fiLength of output: 121
Script:
#!/bin/bash # Search for the `gen-proto.sh` script in the repository. fd -e sh -e bash -e zsh -e ksh -e fish -e csh -e tcsh -e dash -e ash -e sh -e bash -e zsh -e ksh -e fish -e csh -e tcsh -e dash -e ash -e sh gen-proto.sh # Check if the found script is executable. if [ -f "gen-proto.sh" ]; then if [ -x "gen-proto.sh" ]; then echo "gen-proto.sh is executable." else echo "gen-proto.sh is not executable." fi fiLength of output: 202
Script:
#!/bin/bash # Check if the `scripts/gen-proto.sh` script is executable. if [ -x "scripts/gen-proto.sh" ]; then echo "scripts/gen-proto.sh is executable." else echo "scripts/gen-proto.sh is not executable." fiLength of output: 114
adapters.go (2)
91-94: Verify the correctness ofrolluptypes.ApplyL1TxsRequest.Ensure that the
ApplyL1TxsRequesttype fromrolluptypesis correctly used and compatible with the transaction adaptation logic.
45-48: Verify the correctness ofrolluptypes.ApplyL1TxsRequest.Ensure that the
ApplyL1TxsRequesttype fromrolluptypesis correctly used and compatible with the transaction adaptation logic.Verification successful
The
ApplyL1TxsRequesttype is correctly used.The
ApplyL1TxsRequeststruct fromrolluptypesis properly defined with a fieldTxBytesthat aligns with its usage in adapting Ethereum transactions to Cosmos transactions. No issues were found with the transaction adaptation logic.
- The
TxBytesfield is a slice of byte slices, suitable for handling Ethereum transaction bytes.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the definition and usage of `ApplyL1TxsRequest` in `rolluptypes`. # Test: Search for the definition of `ApplyL1TxsRequest`. Expect: Correct structure and fields. ast-grep --lang go --pattern 'type ApplyL1TxsRequest struct { $$$ }'Length of output: 506
testutils/utils.go (2)
100-100: Verify the function call tomonomer.AdaptPayloadTxsToCosmosTxs.Ensure that the function
AdaptPayloadTxsToCosmosTxsfrom themonomerpackage is correctly used and that the block generation logic remains consistent.
82-82: Verify the function call tomonomer.AdaptNonDepositCosmosTxToEthTx.Ensure that the function
AdaptNonDepositCosmosTxToEthTxfrom themonomerpackage is correctly used and that the transaction generation logic remains consistent.x/rollup/module.go (2)
153-153: Verify the service registration withtypes.RegisterMsgServiceServer.Ensure that the
RegisterMsgServiceServerfunction from thetypespackage correctly registers all necessary services for the module.
83-83: Verify the interface registration withtypes.RegisterInterfaces.Ensure that the
RegisterInterfacesfunction from thetypespackage correctly registers all necessary interfaces for the module.monomer.go (1)
125-125: EnsureAdaptCosmosTxsToEthTxsis correctly scoped.The function
AdaptCosmosTxsToEthTxsis now called directly. Verify that this function is accessible in the current scope without therolluptypesprefix, and ensure there are no naming conflicts.Verification successful
AdaptCosmosTxsToEthTxsis correctly scoped and accessible. The function is defined without a prefix in the package scope, and no naming conflicts were found in the codebase.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the scope and definition of `AdaptCosmosTxsToEthTxs`. # Test: Search for the definition of `AdaptCosmosTxsToEthTxs`. Expect: Correct definition without `rolluptypes` prefix. ast-grep --lang go --pattern 'func AdaptCosmosTxsToEthTxs($_) $_'Length of output: 2077
Script:
#!/bin/bash # Check for any other definitions or imports of `AdaptCosmosTxsToEthTxs` in the codebase. rg 'AdaptCosmosTxsToEthTxs' -g '!*.go'Length of output: 38
builder/builder.go (2)
287-287: Verify the integration ofrolluptypes.InitiateWithdrawalRequest.The type of
withdrawalMsghas been changed torolluptypes.InitiateWithdrawalRequest. Ensure that this type is correctly defined and used throughout the codebase.
257-257: Verify the integration ofrolluptypes.InitiateWithdrawalRequest.The type of
withdrawalMsghas been changed torolluptypes.InitiateWithdrawalRequest. Ensure that this type is correctly defined and used throughout the codebase.Verification successful
Integration of
rolluptypes.InitiateWithdrawalRequestis verified.The
InitiateWithdrawalRequesttype is properly defined and used throughout the codebase, including in message handling, validation, and testing. This confirms its correct integration.
- Definition: Located in
x/rollup/types/tx.pb.go.- Usage: Found in
msg_server.go,msgs.go,builder.go.- Testing: Verified in
msgs_test.go.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the definition and usage of `rolluptypes.InitiateWithdrawalRequest`. # Test: Search for the definition of `InitiateWithdrawalRequest` in `rolluptypes`. Expect: Correct definition. ast-grep --lang go --pattern 'type InitiateWithdrawalRequest struct { $$$ }'Length of output: 1208
Script:
#!/bin/bash # Description: Find all usages of `InitiateWithdrawalRequest` in the codebase. rg 'InitiateWithdrawalRequest' -A 3Length of output: 10360
x/rollup/keeper/msg_server.go (9)
31-65: Refactor ofApplyL1Txsfor clarity and modularity.The
ApplyL1Txsmethod has been refactored to use helper methods for processing transactions. This improves readability and maintainability. Ensure that the helper methods are correctly implemented and integrated.
Line range hint
70-102:
Refactor ofInitiateWithdrawalfor improved error handling.The
InitiateWithdrawalmethod now usestypes.WrapErrorfor more descriptive error messages. This enhances clarity and debugging. Ensure that error handling is consistent across the module.
105-106: Adherence to Go naming conventions for unexported methods.The method
mintETHis now unexported, aligning with Go's naming conventions. Ensure that this change does not affect its usage in other parts of the codebase.
129-130: Adherence to Go naming conventions for unexported methods.The method
burnETHis now unexported, aligning with Go's naming conventions. Ensure that this change does not affect its usage in other parts of the codebase.
163-163: Ensure correct implementation ofsetL1BlockInfo.The method
setL1BlockInfois now unexported. Verify that this change does not affect its usage in other parts of the codebase.
175-175: Ensure correct implementation ofsetL1BlockHistory.The method
setL1BlockHistoryis now unexported. Verify that this change does not affect its usage in other parts of the codebase.
187-203: Refactor ofprocessL1SystemDepositTxfor improved error handling.The method now uses
types.WrapErrorfor more descriptive error messages. This enhances clarity and debugging. Ensure that error handling is consistent across the module.
206-237: Refactor ofprocessL1UserDepositTxsfor improved error handling.The method now uses
types.WrapErrorfor more descriptive error messages. This enhances clarity and debugging. Ensure that error handling is consistent across the module.
242-244: Ensure correct conversion inevmToCosmos.The function converts an EVM address to a Cosmos address. Ensure that this conversion is correctly implemented and used.
engine/engine.go (2)
263-263: Verify the correctness of transaction adaptation.The function
monomer.AdaptCosmosTxsToEthTxsis now used for adapting transactions. Ensure that this function correctly handles the transaction adaptation process and that all necessary validations are in place.
176-176: Verify the correctness of transaction adaptation.The function
monomer.AdaptPayloadTxsToCosmosTxsis now used for adapting transactions. Ensure that this function correctly handles the transaction adaptation process and that all necessary validations are in place.Verification successful
Verified: Transaction adaptation function is correctly implemented.
The function
AdaptPayloadTxsToCosmosTxsis implemented inadapters.go. It checks for empty input and returns an appropriate response, indicating correct initial handling of transactions. Further verification of its full logic would require additional context, but the initial setup is correct.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the implementation of `AdaptPayloadTxsToCosmosTxs` in the `monomer` package. # Test: Search for the function implementation. Expect: Correct handling of transaction adaptation. ast-grep --lang go --pattern $'func AdaptPayloadTxsToCosmosTxs(transactions []$_) ($_, error) { $$$ }'Length of output: 105
Script:
#!/bin/bash # Description: Search for the function `AdaptPayloadTxsToCosmosTxs` in the codebase to verify its existence and implementation. # Use ripgrep to search for the function definition across the codebase. rg 'func\s+AdaptPayloadTxsToCosmosTxs' --type go -A 5Length of output: 296
There was a problem hiding this comment.
Is there a case for splitting this file into deposits and withdrawals?
Fairly independent workflows, each somewhat logically dense, etc.
There was a problem hiding this comment.
Yeah I thought about that but didn't end up moving it for the initial PR. Your extra nudge convinced me though :) I'll split msg_server up into deposits.go and withdrawals.go
There was a problem hiding this comment.
Ended up leaving the high level MsgServer funcs (ApplyL1Txs, InitiateWithdrawal) in msg_server.go and split the helpers out into separate deposits and withdrawals files. Lmk if you think I should move the high level funcs into the separate files as well
natebeauregard
force-pushed
the
nkb-refactor-rollup-module
branch
from
3976d85 to
a456239
Compare
|
@NiloCK @joshklop I still have a good bit of commit cleaning before this is ready for merge but I just added my CR changes starting with the |
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range, codebase verification and nitpick comments (1)
x/rollup/README.md (1)
14-16: Enhance clarity in the withdrawals section.The new withdrawals section is informative and provides a clear understanding of the process. Consider adding a comma for better readability.
- through the OP Stack and the user will be able to prove and finalize their withdrawal. + through the OP Stack, and the user will be able to prove and finalize their withdrawal.Tools
LanguageTool
[uncategorized] ~15-~15: Possible missing comma found.
Context: ...2 state commitment to L1 through the OP Stack and the user will be able to prove and ...(AI_HYDRA_LEO_MISSING_COMMA)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (5)
gen/rollup/module/v1/module.pb.gois excluded by!**/*.pb.gogen/testapp/module/v1/module.pb.gois excluded by!**/*.pb.gogen/testapp/v1/get.pb.gois excluded by!**/*.pb.gogen/testapp/v1/set.pb.gois excluded by!**/*.pb.gox/rollup/types/tx.pb.gois excluded by!**/*.pb.go
Files selected for processing (23)
- Makefile (1 hunks)
- adapters.go (4 hunks)
- buf.gen.yaml (1 hunks)
- builder/builder.go (3 hunks)
- engine/engine.go (3 hunks)
- monomer.go (2 hunks)
- proto/rollup/module/v1/module.proto (1 hunks)
- proto/rollup/v1/tx.proto (2 hunks)
- scripts/gen-proto.sh (1 hunks)
- testapp/proto/testapp/module/v1/module.proto (1 hunks)
- testapp/proto/testapp/v1/get.proto (1 hunks)
- testapp/proto/testapp/v1/set.proto (1 hunks)
- testutils/utils.go (3 hunks)
- x/rollup/README.md (1 hunks)
- x/rollup/keeper/deposits.go (1 hunks)
- x/rollup/keeper/msg_server.go (3 hunks)
- x/rollup/keeper/withdrawals.go (1 hunks)
- x/rollup/module.go (3 hunks)
- x/rollup/types/codec.go (1 hunks)
- x/rollup/types/errors.go (1 hunks)
- x/rollup/types/events.go (2 hunks)
- x/rollup/types/msgs.go (1 hunks)
- x/rollup/types/msgs_test.go (2 hunks)
Files skipped from review due to trivial changes (1)
- scripts/gen-proto.sh
Files skipped from review as they are similar to previous changes (17)
- Makefile
- adapters.go
- buf.gen.yaml
- builder/builder.go
- engine/engine.go
- monomer.go
- proto/rollup/module/v1/module.proto
- proto/rollup/v1/tx.proto
- testapp/proto/testapp/module/v1/module.proto
- testapp/proto/testapp/v1/get.proto
- testapp/proto/testapp/v1/set.proto
- testutils/utils.go
- x/rollup/keeper/msg_server.go
- x/rollup/types/codec.go
- x/rollup/types/errors.go
- x/rollup/types/events.go
- x/rollup/types/msgs.go
Additional context used
LanguageTool
x/rollup/README.md
[uncategorized] ~15-~15: Possible missing comma found.
Context: ...2 state commitment to L1 through the OP Stack and the user will be able to prove and ...(AI_HYDRA_LEO_MISSING_COMMA)
Additional comments not posted (8)
x/rollup/module.go (2)
83-83: Change totypes.RegisterInterfacesis appropriate.The switch from
rollupv1.RegisterInterfacestotypes.RegisterInterfacesaligns with the refactoring goals and maintains functionality.
153-153: Change totypes.RegisterMsgServiceServeris appropriate.The switch from
rollupv1.RegisterMsgServiceServertotypes.RegisterMsgServiceServeraligns with the refactoring goals and maintains functionality.x/rollup/keeper/deposits.go (6)
22-31:setL1BlockInfofunction is well-implemented.The function correctly marshals the L1 block info and sets it in the store with appropriate error handling.
34-43:setL1BlockHistoryfunction is well-implemented.The function correctly marshals the L1 block info and sets it in the store using the block hash as the key, with appropriate error handling.
46-62:processL1SystemDepositTxfunction is well-implemented.The function correctly unmarshals the transaction, checks its type, and derives the L1 block info with appropriate error handling and logging.
65-97:processL1UserDepositTxsfunction is well-implemented.The function correctly processes each transaction, checks its type, and mints ETH to the user's Cosmos address with appropriate error handling and logging.
101-121:mintETHfunction is well-implemented.The function correctly mints coins and sends them to the user's account, with appropriate error handling and event emission.
125-126:evmToCosmosfunction is well-implemented.The function correctly converts an EVM address to a Cosmos SDK address.
- Rename msg.proto to be tx.proto - Generate tx.pb.go inside of x/rollup/types - Extract helpers.go funcs into msgs.go and codec.go - Split deposit/withdrawal logic in msg_server.go into helper files - Remove unused event keys from x/rollup - Move adapters.go out of x/rollup/types into the top level package - Update x/rollup README
natebeauregard
force-pushed
the
nkb-refactor-rollup-module
branch
from
a456239 to
f1d35a2
Compare
Closes: #105
Refactors the
x/rollupmodule with the following updates to follow Cosmos SDK suggested practices:msg.prototo betx.prototx.pb.goinside ofx/rollup/typesinstead of thegendirectorygen/rollup/v1/helpers.gointox/rollup/types/codec.go(RegisterInterfaces) andx/rollup/types/msgs.go(ValidateBasic,GetSigners,Type,Route, etc)msg_server.gointo helper funcs for readabilityx/rollupadapters.goout ofx/rollup/typesand into the top levelmonomerpackageSummary by CodeRabbit
Summary by CodeRabbit
New Features
Bug Fixes
Refactor
Documentation
Tests