refactor: use soldeer instead of git submodules #337
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Important Review skippedReview was skipped due to path filters Files ignored due to path filters (90)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including You can disable this status message by setting the WalkthroughWalkthroughThe recent updates refine the GitHub Actions workflows by eliminating recursive submodule checkouts and improving dependency management through additional installation commands. These modifications simplify the build process while ensuring that necessary tools are current. Documentation enhancements provide clearer installation instructions and updated links, thereby facilitating a smoother onboarding experience for developers engaging with the new smart contract architecture. Changes
Possibly related PRs
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
|
skosito
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #337 +/- ##
=======================================
Coverage 97.37% 97.37%
=======================================
Files 7 7
Lines 305 305
Branches 98 98
=======================================
Hits 297 297
Misses 8 8 ☔ View full report in Codecov by Sentry. |
skosito
changed the title
skosito
requested review from
andresaiello,
brewmaster012,
lumtis,
CharlieMc0,
fadeev and
fbac
as code owners
![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
Outside diff range, codebase verification and nitpick comments (4)
v2/README.md (1)
10-11: Remove dollar signs from commands.Markdownlint warns about dollar signs used before commands without showing output. Consider removing them for consistency and clarity.
- $ yarn - $ forge soldeer update + yarn + forge soldeer updateTools
Markdownlint
10-10: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
11-11: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
v2/docs/src/README.md (1)
10-11: Remove dollar signs from commands.Markdownlint warns about dollar signs used before commands without showing output. Consider removing them for consistency and clarity.
- $ yarn - $ forge soldeer update + yarn + forge soldeer updateTools
Markdownlint
10-10: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
11-11: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
.github/workflows/generated-files_v2.yaml (1)
45-45: Reconsider the inclusion offorge soldeer updatein the workflow.The command
forge soldeer updateis mentioned only in documentation files and not in any scripts or workflow files, suggesting it may not be necessary for automated processes. Consider removing it or making its execution conditional based on specific needs.
- References found in:
v2/README.mdv2/docs/src/index.mdv2/docs/src/README.mdAnalysis chain
Ensure necessity of
forge soldeer updatefor generated files.The addition of
forge soldeer updateshould be verified for its necessity in the context of generating files. Consider conditional execution if it's only needed in specific scenarios.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the necessity of `forge soldeer update` in the file generation process. # Test: Search for `forge soldeer` usage in the codebase. Expect: Usage in generation scripts or documentation. rg --type shell --type markdown 'forge soldeer'Length of output: 79
Script:
#!/bin/bash # Description: Correctly verify the necessity of `forge soldeer update` in the file generation process. # Test: Search for `forge soldeer` usage in the codebase. Expect: Usage in YAML, shell scripts, or markdown documentation. rg 'forge soldeer' --type yaml --type sh --type mdLength of output: 177
v2/docs/src/index.md (1)
13-16: Remove dollar signs from shell commands.Markdownlint suggests removing dollar signs from shell commands unless showing output. This improves readability and consistency.
- $ yarn - $ forge soldeer update + yarn + forge soldeer updateTools
Markdownlint
14-14: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
15-15: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files ignored due to path filters (99)
v2/pkg/address.sol/address.gois excluded by!v2/pkg/**v2/pkg/beaconproxy.sol/beaconproxy.gois excluded by!v2/pkg/**v2/pkg/console.sol/console.gois excluded by!v2/pkg/**v2/pkg/core.sol/core.gois excluded by!v2/pkg/**v2/pkg/defender.sol/defender.gois excluded by!v2/pkg/**v2/pkg/defenderdeploy.sol/defenderdeploy.gois excluded by!v2/pkg/**v2/pkg/erc1967proxy.sol/erc1967proxy.gois excluded by!v2/pkg/**v2/pkg/erc1967utils.sol/erc1967utils.gois excluded by!v2/pkg/**v2/pkg/erc20custody.sol/erc20custody.gois excluded by!v2/pkg/**v2/pkg/erc20custody.t.sol/erc20custodytest.gois excluded by!v2/pkg/**v2/pkg/erc20custodyechidnatest.sol/erc20custodyechidnatest.gois excluded by!v2/pkg/**v2/pkg/gatewayevm.sol/gatewayevm.gois excluded by!v2/pkg/**v2/pkg/gatewayevm.t.sol/gatewayevminboundtest.gois excluded by!v2/pkg/**v2/pkg/gatewayevm.t.sol/gatewayevmtest.gois excluded by!v2/pkg/**v2/pkg/gatewayevmechidnatest.sol/gatewayevmechidnatest.gois excluded by!v2/pkg/**v2/pkg/gatewayevmupgrade.t.sol/gatewayevmuupsupgradetest.gois excluded by!v2/pkg/**v2/pkg/gatewayevmupgradetest.sol/gatewayevmupgradetest.gois excluded by!v2/pkg/**v2/pkg/gatewayevmzevm.t.sol/gatewayevmzevmtest.gois excluded by!v2/pkg/**v2/pkg/gatewayzevm.sol/gatewayzevm.gois excluded by!v2/pkg/**v2/pkg/gatewayzevm.t.sol/gatewayzevminboundtest.gois excluded by!v2/pkg/**v2/pkg/gatewayzevm.t.sol/gatewayzevmoutboundtest.gois excluded by!v2/pkg/**v2/pkg/math.sol/math.gois excluded by!v2/pkg/**v2/pkg/mockerc20.sol/mockerc20.gois excluded by!v2/pkg/**v2/pkg/mockerc721.sol/mockerc721.gois excluded by!v2/pkg/**v2/pkg/proxyadmin.sol/proxyadmin.gois excluded by!v2/pkg/**v2/pkg/receiverevm.sol/receiverevm.gois excluded by!v2/pkg/**v2/pkg/safeconsole.sol/safeconsole.gois excluded by!v2/pkg/**v2/pkg/safeerc20.sol/safeerc20.gois excluded by!v2/pkg/**v2/pkg/senderzevm.sol/senderzevm.gois excluded by!v2/pkg/**v2/pkg/signedmath.sol/signedmath.gois excluded by!v2/pkg/**v2/pkg/src/strings.sol/strings.gois excluded by!v2/pkg/**v2/pkg/stderror.sol/stderror.gois excluded by!v2/pkg/**v2/pkg/stdjson.sol/stdjson.gois excluded by!v2/pkg/**v2/pkg/stdmath.sol/stdmath.gois excluded by!v2/pkg/**v2/pkg/stdstorage.sol/stdstorage.gois excluded by!v2/pkg/**v2/pkg/stdstorage.sol/stdstoragesafe.gois excluded by!v2/pkg/**v2/pkg/stdstyle.sol/stdstyle.gois excluded by!v2/pkg/**v2/pkg/stdtoml.sol/stdtoml.gois excluded by!v2/pkg/**v2/pkg/storageslot.sol/storageslot.gois excluded by!v2/pkg/**v2/pkg/strings.sol/strings.gois excluded by!v2/pkg/**v2/pkg/systemcontract.sol/systemcontract.gois excluded by!v2/pkg/**v2/pkg/systemcontractmock.sol/systemcontractmock.gois excluded by!v2/pkg/**v2/pkg/testerc20.sol/testerc20.gois excluded by!v2/pkg/**v2/pkg/testuniversalcontract.sol/testuniversalcontract.gois excluded by!v2/pkg/**v2/pkg/transparentupgradeableproxy.sol/transparentupgradeableproxy.gois excluded by!v2/pkg/**v2/pkg/upgradeablebeacon.sol/upgradeablebeacon.gois excluded by!v2/pkg/**v2/pkg/upgrades.sol/unsafeupgrades.gois excluded by!v2/pkg/**v2/pkg/upgrades.sol/upgrades.gois excluded by!v2/pkg/**v2/pkg/utils.sol/utils.gois excluded by!v2/pkg/**v2/pkg/versions.sol/versions.gois excluded by!v2/pkg/**v2/pkg/vm.sol/vm.gois excluded by!v2/pkg/**v2/pkg/vm.sol/vmsafe.gois excluded by!v2/pkg/**v2/pkg/wzeta.sol/weth9.gois excluded by!v2/pkg/**v2/pkg/zeta.non-eth.sol/zetanoneth.gois excluded by!v2/pkg/**v2/pkg/zetaconnectornative.sol/zetaconnectornative.gois excluded by!v2/pkg/**v2/pkg/zetaconnectornative.t.sol/zetaconnectornativetest.gois excluded by!v2/pkg/**v2/pkg/zetaconnectornonnative.sol/zetaconnectornonnative.gois excluded by!v2/pkg/**v2/pkg/zetaconnectornonnative.t.sol/zetaconnectornonnativetest.gois excluded by!v2/pkg/**v2/pkg/zrc20.sol/zrc20.gois excluded by!v2/pkg/**v2/pkg/zrc20.t.sol/zrc20test.gois excluded by!v2/pkg/**v2/soldeer.lockis excluded by!**/*.lockv2/types/Strings.tsis excluded by!v2/types/**v2/types/Vm.sol/Vm.tsis excluded by!v2/types/**v2/types/Vm.sol/VmSafe.tsis excluded by!v2/types/**v2/types/factories/Address__factory.tsis excluded by!v2/types/**v2/types/factories/BeaconProxy__factory.tsis excluded by!v2/types/**v2/types/factories/ERC1967Proxy__factory.tsis excluded by!v2/types/**v2/types/factories/ERC1967Utils__factory.tsis excluded by!v2/types/**v2/types/factories/ERC20CustodyEchidnaTest__factory.tsis excluded by!v2/types/**v2/types/factories/ERC20Custody__factory.tsis excluded by!v2/types/**v2/types/factories/GatewayEVMEchidnaTest__factory.tsis excluded by!v2/types/**v2/types/factories/GatewayEVMUpgradeTest__factory.tsis excluded by!v2/types/**v2/types/factories/GatewayEVM__factory.tsis excluded by!v2/types/**v2/types/factories/GatewayZEVM__factory.tsis excluded by!v2/types/**v2/types/factories/Math__factory.tsis excluded by!v2/types/**v2/types/factories/MockERC20__factory.tsis excluded by!v2/types/**v2/types/factories/MockERC721__factory.tsis excluded by!v2/types/**v2/types/factories/ProxyAdmin__factory.tsis excluded by!v2/types/**v2/types/factories/ReceiverEVM__factory.tsis excluded by!v2/types/**v2/types/factories/SafeERC20__factory.tsis excluded by!v2/types/**v2/types/factories/SenderZEVM__factory.tsis excluded by!v2/types/**v2/types/factories/StdError.sol/StdError__factory.tsis excluded by!v2/types/**v2/types/factories/StdStorage.sol/StdStorageSafe__factory.tsis excluded by!v2/types/**v2/types/factories/Strings__factory.tsis excluded by!v2/types/**v2/types/factories/SystemContract.sol/SystemContract__factory.tsis excluded by!v2/types/**v2/types/factories/SystemContractMock.sol/SystemContractMock__factory.tsis excluded by!v2/types/**v2/types/factories/TestERC20__factory.tsis excluded by!v2/types/**v2/types/factories/TestUniversalContract__factory.tsis excluded by!v2/types/**v2/types/factories/TransparentUpgradeableProxy.sol/TransparentUpgradeableProxy__factory.tsis excluded by!v2/types/**v2/types/factories/UpgradeableBeacon__factory.tsis excluded by!v2/types/**v2/types/factories/Vm.sol/VmSafe__factory.tsis excluded by!v2/types/**v2/types/factories/Vm.sol/Vm__factory.tsis excluded by!v2/types/**v2/types/factories/WZETA.sol/WETH9__factory.tsis excluded by!v2/types/**v2/types/factories/ZRC20.sol/ZRC20__factory.tsis excluded by!v2/types/**v2/types/factories/Zeta.non-eth.sol/ZetaNonEth__factory.tsis excluded by!v2/types/**v2/types/factories/ZetaConnectorNative__factory.tsis excluded by!v2/types/**v2/types/factories/ZetaConnectorNonNative__factory.tsis excluded by!v2/types/**v2/types/factories/index.tsis excluded by!v2/types/**v2/types/index.tsis excluded by!v2/types/**
Files selected for processing (41)
- .github/workflows/generated-files_v2.yaml (2 hunks)
- .github/workflows/lint_v2.yaml (2 hunks)
- .github/workflows/publish-npm_v2.yaml (1 hunks)
- .github/workflows/slither_v2.yaml (2 hunks)
- .github/workflows/test_v2.yaml (2 hunks)
- .gitignore (1 hunks)
- v2/README.md (1 hunks)
- v2/docs/src/README.md (1 hunks)
- v2/docs/src/contracts/Revert.sol/interface.Revertable.md (1 hunks)
- v2/docs/src/contracts/Revert.sol/struct.RevertContext.md (1 hunks)
- v2/docs/src/contracts/Revert.sol/struct.RevertOptions.md (1 hunks)
- v2/docs/src/contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md (1 hunks)
- v2/docs/src/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md (1 hunks)
- v2/docs/src/contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md (1 hunks)
- v2/docs/src/contracts/evm/ZetaConnectorNative.sol/contract.ZetaConnectorNative.md (1 hunks)
- v2/docs/src/contracts/evm/ZetaConnectorNonNative.sol/contract.ZetaConnectorNonNative.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20Custody.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyErrors.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyEvents.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVM.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMErrors.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMEvents.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IZetaConnector.sol/interface.IZetaConnectorEvents.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IZetaNonEthNew.sol/interface.IZetaNonEthNew.md (1 hunks)
- v2/docs/src/contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md (1 hunks)
- v2/docs/src/contracts/zevm/ZRC20.sol/contract.ZRC20.md (1 hunks)
- v2/docs/src/contracts/zevm/ZRC20.sol/interface.ZRC20Errors.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVM.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMErrors.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMEvents.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/ISystem.sol/interface.ISystem.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IWZETA.sol/interface.IWETH9.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/enum.CoinType.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20Metadata.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.ZRC20Events.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/interface.UniversalContract.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/interface.zContract.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/struct.zContext.md (1 hunks)
- v2/docs/src/index.md (1 hunks)
- v2/foundry.toml (2 hunks)
Files skipped from review due to trivial changes (32)
- .gitignore
- v2/docs/src/contracts/Revert.sol/interface.Revertable.md
- v2/docs/src/contracts/Revert.sol/struct.RevertContext.md
- v2/docs/src/contracts/Revert.sol/struct.RevertOptions.md
- v2/docs/src/contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md
- v2/docs/src/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md
- v2/docs/src/contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md
- v2/docs/src/contracts/evm/ZetaConnectorNative.sol/contract.ZetaConnectorNative.md
- v2/docs/src/contracts/evm/ZetaConnectorNonNative.sol/contract.ZetaConnectorNonNative.md
- v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20Custody.md
- v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyErrors.md
- v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyEvents.md
- v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVM.md
- v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMErrors.md
- v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMEvents.md
- v2/docs/src/contracts/evm/interfaces/IZetaConnector.sol/interface.IZetaConnectorEvents.md
- v2/docs/src/contracts/evm/interfaces/IZetaNonEthNew.sol/interface.IZetaNonEthNew.md
- v2/docs/src/contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md
- v2/docs/src/contracts/zevm/ZRC20.sol/contract.ZRC20.md
- v2/docs/src/contracts/zevm/ZRC20.sol/interface.ZRC20Errors.md
- v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVM.md
- v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMErrors.md
- v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMEvents.md
- v2/docs/src/contracts/zevm/interfaces/ISystem.sol/interface.ISystem.md
- v2/docs/src/contracts/zevm/interfaces/IWZETA.sol/interface.IWETH9.md
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/enum.CoinType.md
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20.md
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20Metadata.md
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.ZRC20Events.md
- v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/interface.UniversalContract.md
- v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/interface.zContract.md
- v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/struct.zContext.md
Additional context used
Markdownlint
v2/README.md
10-10: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
11-11: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
v2/docs/src/README.md
10-10: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
11-11: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
v2/docs/src/index.md
14-14: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
15-15: null
Dollar signs used before commands without showing output(MD014, commands-show-output)
Additional comments not posted (6)
.github/workflows/lint_v2.yaml (1)
42-44: Verify the impact of removing submodules checkout.The removal of
submodules: recursivein theCheckout Repositorystep may affect projects that rely on submodules. Ensure that all necessary dependencies are correctly managed without submodules.Verification successful
No impact from removing submodules checkout.
The repository does not contain any configured submodules, so the removal of the
submodules: recursiveoption will not affect the build process.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify if any submodules are required for the build process. # Test: Search for submodule references in the repository. Expect: No essential submodules. git config --file .gitmodules --get-regexp pathLength of output: 49
.github/workflows/test_v2.yaml (1)
42-44: Verify the impact of removing submodules checkout.The removal of
submodules: recursivein theCheckout Repositorystep may affect projects that rely on submodules. Ensure that all necessary dependencies are correctly managed without submodules.Verification successful
No impact from the removal of submodules checkout.
The repository does not have any configured submodules or references to submodules. Therefore, removing
submodules: recursivefrom the workflow will not affect the build process or dependency management.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify if any submodules are required for the build process. # Test: Search for submodule references in the repository. Expect: No essential submodules. git config --file .gitmodules --get-regexp pathLength of output: 49
Script:
#!/bin/bash # Description: Search for any references to submodules in the repository files. # Test: Use ripgrep to search for the term 'submodule' across the repository. rg 'submodule' --ignore-caseLength of output: 28
v2/foundry.toml (1)
9-13: LGTM!The updates to remappings and the addition of the
[dependencies]section improve dependency management and ensure compatibility with the latest library versions.Also applies to: 39-41
.github/workflows/publish-npm_v2.yaml (1)
31-34: Ensureforge soldeer updateis necessary for all builds.The addition of
forge soldeer updatealigns with the transition to Soldeer. Ensure this command is required for all builds or consider conditional execution if it's only needed in specific scenarios..github/workflows/slither_v2.yaml (1)
44-46: Verify the impact of removing submodules.The removal of
submodules: recursivesimplifies the checkout process. Ensure that no submodules are required for this workflow, as their absence could affect the build.Verification successful
No active submodule dependencies found.
The
.gitmodulesfile exists but does not contain any configured submodule paths, and no references to submodules were found in the codebase. Therefore, removingsubmodules: recursivefrom the workflow should not impact the build process.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the absence of submodule dependencies in the workflow. # Test: Search for submodule usage in the codebase. Expect: No critical submodule dependencies. git config --file .gitmodules --get-regexp pathLength of output: 49
Script:
#!/bin/bash # Check if the .gitmodules file exists in the repository if [ -f .gitmodules ]; then echo ".gitmodules file exists." else echo ".gitmodules file does not exist." fi # Search for any submodule-related references in the codebase rg 'submodule' --glob '!.git' -A 3Length of output: 118
Script:
#!/bin/bash # List the contents of the .gitmodules file to identify configured submodules cat .gitmodules # Check for any references to the submodules listed in .gitmodules within the codebase submodule_paths=$(git config --file .gitmodules --get-regexp path | awk '{print $2}') for path in $submodule_paths; do echo "Searching for references to submodule path: $path" rg "$path" --glob '!.git' -A 3 doneLength of output: 107
v2/docs/src/index.md (1)
9-9: Improved link accessibility.The update to an absolute URL for the V2 Localnet guide enhances accessibility and clarity in the documentation.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files ignored due to path filters (89)
v2/pkg/address.sol/address.gois excluded by!v2/pkg/**v2/pkg/beaconproxy.sol/beaconproxy.gois excluded by!v2/pkg/**v2/pkg/console.sol/console.gois excluded by!v2/pkg/**v2/pkg/core.sol/core.gois excluded by!v2/pkg/**v2/pkg/defender.sol/defender.gois excluded by!v2/pkg/**v2/pkg/defenderdeploy.sol/defenderdeploy.gois excluded by!v2/pkg/**v2/pkg/erc1967proxy.sol/erc1967proxy.gois excluded by!v2/pkg/**v2/pkg/erc1967utils.sol/erc1967utils.gois excluded by!v2/pkg/**v2/pkg/erc20custody.sol/erc20custody.gois excluded by!v2/pkg/**v2/pkg/erc20custody.t.sol/erc20custodytest.gois excluded by!v2/pkg/**v2/pkg/erc20custodyechidnatest.sol/erc20custodyechidnatest.gois excluded by!v2/pkg/**v2/pkg/gatewayevm.sol/gatewayevm.gois excluded by!v2/pkg/**v2/pkg/gatewayevm.t.sol/gatewayevminboundtest.gois excluded by!v2/pkg/**v2/pkg/gatewayevm.t.sol/gatewayevmtest.gois excluded by!v2/pkg/**v2/pkg/gatewayevmechidnatest.sol/gatewayevmechidnatest.gois excluded by!v2/pkg/**v2/pkg/gatewayevmupgrade.t.sol/gatewayevmuupsupgradetest.gois excluded by!v2/pkg/**v2/pkg/gatewayevmupgradetest.sol/gatewayevmupgradetest.gois excluded by!v2/pkg/**v2/pkg/gatewayevmzevm.t.sol/gatewayevmzevmtest.gois excluded by!v2/pkg/**v2/pkg/gatewayzevm.sol/gatewayzevm.gois excluded by!v2/pkg/**v2/pkg/gatewayzevm.t.sol/gatewayzevminboundtest.gois excluded by!v2/pkg/**v2/pkg/gatewayzevm.t.sol/gatewayzevmoutboundtest.gois excluded by!v2/pkg/**v2/pkg/math.sol/math.gois excluded by!v2/pkg/**v2/pkg/mockerc20.sol/mockerc20.gois excluded by!v2/pkg/**v2/pkg/mockerc721.sol/mockerc721.gois excluded by!v2/pkg/**v2/pkg/proxyadmin.sol/proxyadmin.gois excluded by!v2/pkg/**v2/pkg/receiverevm.sol/receiverevm.gois excluded by!v2/pkg/**v2/pkg/safeconsole.sol/safeconsole.gois excluded by!v2/pkg/**v2/pkg/safeerc20.sol/safeerc20.gois excluded by!v2/pkg/**v2/pkg/senderzevm.sol/senderzevm.gois excluded by!v2/pkg/**v2/pkg/signedmath.sol/signedmath.gois excluded by!v2/pkg/**v2/pkg/src/strings.sol/strings.gois excluded by!v2/pkg/**v2/pkg/stderror.sol/stderror.gois excluded by!v2/pkg/**v2/pkg/stdjson.sol/stdjson.gois excluded by!v2/pkg/**v2/pkg/stdmath.sol/stdmath.gois excluded by!v2/pkg/**v2/pkg/stdstorage.sol/stdstorage.gois excluded by!v2/pkg/**v2/pkg/stdstorage.sol/stdstoragesafe.gois excluded by!v2/pkg/**v2/pkg/stdstyle.sol/stdstyle.gois excluded by!v2/pkg/**v2/pkg/stdtoml.sol/stdtoml.gois excluded by!v2/pkg/**v2/pkg/storageslot.sol/storageslot.gois excluded by!v2/pkg/**v2/pkg/strings.sol/strings.gois excluded by!v2/pkg/**v2/pkg/systemcontract.sol/systemcontract.gois excluded by!v2/pkg/**v2/pkg/systemcontractmock.sol/systemcontractmock.gois excluded by!v2/pkg/**v2/pkg/testerc20.sol/testerc20.gois excluded by!v2/pkg/**v2/pkg/testuniversalcontract.sol/testuniversalcontract.gois excluded by!v2/pkg/**v2/pkg/transparentupgradeableproxy.sol/transparentupgradeableproxy.gois excluded by!v2/pkg/**v2/pkg/upgradeablebeacon.sol/upgradeablebeacon.gois excluded by!v2/pkg/**v2/pkg/upgrades.sol/unsafeupgrades.gois excluded by!v2/pkg/**v2/pkg/upgrades.sol/upgrades.gois excluded by!v2/pkg/**v2/pkg/utils.sol/utils.gois excluded by!v2/pkg/**v2/pkg/versions.sol/versions.gois excluded by!v2/pkg/**v2/pkg/wzeta.sol/weth9.gois excluded by!v2/pkg/**v2/pkg/zeta.non-eth.sol/zetanoneth.gois excluded by!v2/pkg/**v2/pkg/zetaconnectornative.sol/zetaconnectornative.gois excluded by!v2/pkg/**v2/pkg/zetaconnectornative.t.sol/zetaconnectornativetest.gois excluded by!v2/pkg/**v2/pkg/zetaconnectornonnative.sol/zetaconnectornonnative.gois excluded by!v2/pkg/**v2/pkg/zetaconnectornonnative.t.sol/zetaconnectornonnativetest.gois excluded by!v2/pkg/**v2/pkg/zrc20.sol/zrc20.gois excluded by!v2/pkg/**v2/pkg/zrc20.t.sol/zrc20test.gois excluded by!v2/pkg/**v2/types/factories/Address__factory.tsis excluded by!v2/types/**v2/types/factories/BeaconProxy__factory.tsis excluded by!v2/types/**v2/types/factories/ERC1967Proxy__factory.tsis excluded by!v2/types/**v2/types/factories/ERC1967Utils__factory.tsis excluded by!v2/types/**v2/types/factories/ERC20CustodyEchidnaTest__factory.tsis excluded by!v2/types/**v2/types/factories/ERC20Custody__factory.tsis excluded by!v2/types/**v2/types/factories/GatewayEVMEchidnaTest__factory.tsis excluded by!v2/types/**v2/types/factories/GatewayEVMUpgradeTest__factory.tsis excluded by!v2/types/**v2/types/factories/GatewayEVM__factory.tsis excluded by!v2/types/**v2/types/factories/GatewayZEVM__factory.tsis excluded by!v2/types/**v2/types/factories/Math__factory.tsis excluded by!v2/types/**v2/types/factories/MockERC20__factory.tsis excluded by!v2/types/**v2/types/factories/MockERC721__factory.tsis excluded by!v2/types/**v2/types/factories/ProxyAdmin__factory.tsis excluded by!v2/types/**v2/types/factories/ReceiverEVM__factory.tsis excluded by!v2/types/**v2/types/factories/SafeERC20__factory.tsis excluded by!v2/types/**v2/types/factories/SenderZEVM__factory.tsis excluded by!v2/types/**v2/types/factories/StdError.sol/StdError__factory.tsis excluded by!v2/types/**v2/types/factories/StdStorage.sol/StdStorageSafe__factory.tsis excluded by!v2/types/**v2/types/factories/Strings__factory.tsis excluded by!v2/types/**v2/types/factories/SystemContract.sol/SystemContract__factory.tsis excluded by!v2/types/**v2/types/factories/SystemContractMock.sol/SystemContractMock__factory.tsis excluded by!v2/types/**v2/types/factories/TestERC20__factory.tsis excluded by!v2/types/**v2/types/factories/TestUniversalContract__factory.tsis excluded by!v2/types/**v2/types/factories/TransparentUpgradeableProxy.sol/TransparentUpgradeableProxy__factory.tsis excluded by!v2/types/**v2/types/factories/UpgradeableBeacon__factory.tsis excluded by!v2/types/**v2/types/factories/WZETA.sol/WETH9__factory.tsis excluded by!v2/types/**v2/types/factories/ZRC20.sol/ZRC20__factory.tsis excluded by!v2/types/**v2/types/factories/Zeta.non-eth.sol/ZetaNonEth__factory.tsis excluded by!v2/types/**v2/types/factories/ZetaConnectorNative__factory.tsis excluded by!v2/types/**v2/types/factories/ZetaConnectorNonNative__factory.tsis excluded by!v2/types/**
Files selected for processing (31)
- v2/docs/src/contracts/Revert.sol/interface.Revertable.md (1 hunks)
- v2/docs/src/contracts/Revert.sol/struct.RevertContext.md (1 hunks)
- v2/docs/src/contracts/Revert.sol/struct.RevertOptions.md (1 hunks)
- v2/docs/src/contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md (1 hunks)
- v2/docs/src/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md (1 hunks)
- v2/docs/src/contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md (1 hunks)
- v2/docs/src/contracts/evm/ZetaConnectorNative.sol/contract.ZetaConnectorNative.md (1 hunks)
- v2/docs/src/contracts/evm/ZetaConnectorNonNative.sol/contract.ZetaConnectorNonNative.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20Custody.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyErrors.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyEvents.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVM.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMErrors.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMEvents.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IZetaConnector.sol/interface.IZetaConnectorEvents.md (1 hunks)
- v2/docs/src/contracts/evm/interfaces/IZetaNonEthNew.sol/interface.IZetaNonEthNew.md (1 hunks)
- v2/docs/src/contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md (1 hunks)
- v2/docs/src/contracts/zevm/ZRC20.sol/contract.ZRC20.md (1 hunks)
- v2/docs/src/contracts/zevm/ZRC20.sol/interface.ZRC20Errors.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVM.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMErrors.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMEvents.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/ISystem.sol/interface.ISystem.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IWZETA.sol/interface.IWETH9.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/enum.CoinType.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20Metadata.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.ZRC20Events.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/interface.UniversalContract.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/interface.zContract.md (1 hunks)
- v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/struct.zContext.md (1 hunks)
Files skipped from review due to trivial changes (27)
- v2/docs/src/contracts/Revert.sol/struct.RevertContext.md
- v2/docs/src/contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md
- v2/docs/src/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md
- v2/docs/src/contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md
- v2/docs/src/contracts/evm/ZetaConnectorNative.sol/contract.ZetaConnectorNative.md
- v2/docs/src/contracts/evm/ZetaConnectorNonNative.sol/contract.ZetaConnectorNonNative.md
- v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20Custody.md
- v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyErrors.md
- v2/docs/src/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyEvents.md
- v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVM.md
- v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMEvents.md
- v2/docs/src/contracts/evm/interfaces/IZetaConnector.sol/interface.IZetaConnectorEvents.md
- v2/docs/src/contracts/evm/interfaces/IZetaNonEthNew.sol/interface.IZetaNonEthNew.md
- v2/docs/src/contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md
- v2/docs/src/contracts/zevm/ZRC20.sol/contract.ZRC20.md
- v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVM.md
- v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMErrors.md
- v2/docs/src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMEvents.md
- v2/docs/src/contracts/zevm/interfaces/ISystem.sol/interface.ISystem.md
- v2/docs/src/contracts/zevm/interfaces/IWZETA.sol/interface.IWETH9.md
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/enum.CoinType.md
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20.md
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20Metadata.md
- v2/docs/src/contracts/zevm/interfaces/IZRC20.sol/interface.ZRC20Events.md
- v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/interface.UniversalContract.md
- v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/interface.zContract.md
- v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/struct.zContext.md
Files skipped from review as they are similar to previous changes (4)
- v2/docs/src/contracts/Revert.sol/interface.Revertable.md
- v2/docs/src/contracts/Revert.sol/struct.RevertOptions.md
- v2/docs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMErrors.md
- v2/docs/src/contracts/zevm/ZRC20.sol/interface.ZRC20Errors.md
|
@fadeev do we need to run that are updated with every commit |
|
@skosito let's remove |
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Files selected for processing (1)
- v2/package.json (1 hunks)
Additional comments not posted (1)
v2/package.json (1)
16-16: Consider handling documentation generation separately.The removal of
&& yarn docsfrom the "generate" script indicates a shift in how documentation is managed. Ensure that documentation generation is handled appropriately elsewhere to maintain up-to-date documentation.
fbac
approved these changes
Sep 1, 2024
i was more referring to PR as a whole, if you could review it it would be great, to see if this is ok from package manager perspective, npm publishing and so on i will resolve conflicts |
|
@skosito I think this is good as long as we use Soldeer only for "development dependencies", so for scripts, tests, etc. (which I believe is what we're doing right now with |
|
Should we remove |
yes initially i removed it in first commit cb0d266#diff-397b1d5f636e2fc49d5a7c17abf7506455208f62a7415abd09fb7e5cff7ff22b but it is reverted back probably in merge commit, looking into it |
fadeev
approved these changes
Sep 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
New Features
yarnandforge soldeer update.abigenandsolcin the generate script.Bug Fixes
Documentation
Chores