coderabbitai[bot]
commented
3 months ago [!IMPORTANT]
Review skipped
Review was skipped due to path filters
Files ignored due to path filters (90)
* `v2/pkg/address.sol/address.go` is excluded by `!v2/pkg/**` * `v2/pkg/beaconproxy.sol/beaconproxy.go` is excluded by `!v2/pkg/**` * `v2/pkg/console.sol/console.go` is excluded by `!v2/pkg/**` * `v2/pkg/core.sol/core.go` is excluded by `!v2/pkg/**` * `v2/pkg/defender.sol/defender.go` is excluded by `!v2/pkg/**` * `v2/pkg/defenderdeploy.sol/defenderdeploy.go` is excluded by `!v2/pkg/**` * `v2/pkg/erc1967proxy.sol/erc1967proxy.go` is excluded by `!v2/pkg/**` * `v2/pkg/erc1967utils.sol/erc1967utils.go` is excluded by `!v2/pkg/**` * `v2/pkg/erc20custody.sol/erc20custody.go` is excluded by `!v2/pkg/**` * `v2/pkg/erc20custody.t.sol/erc20custodytest.go` is excluded by `!v2/pkg/**` * `v2/pkg/erc20custodyechidnatest.sol/erc20custodyechidnatest.go` is excluded by `!v2/pkg/**` * `v2/pkg/gatewayevm.sol/gatewayevm.go` is excluded by `!v2/pkg/**` * `v2/pkg/gatewayevm.t.sol/gatewayevminboundtest.go` is excluded by `!v2/pkg/**` * `v2/pkg/gatewayevm.t.sol/gatewayevmtest.go` is excluded by `!v2/pkg/**` * `v2/pkg/gatewayevmechidnatest.sol/gatewayevmechidnatest.go` is excluded by `!v2/pkg/**` * `v2/pkg/gatewayevmupgrade.t.sol/gatewayevmuupsupgradetest.go` is excluded by `!v2/pkg/**` * `v2/pkg/gatewayevmupgradetest.sol/gatewayevmupgradetest.go` is excluded by `!v2/pkg/**` * `v2/pkg/gatewayevmzevm.t.sol/gatewayevmzevmtest.go` is excluded by `!v2/pkg/**` * `v2/pkg/gatewayzevm.sol/gatewayzevm.go` is excluded by `!v2/pkg/**` * `v2/pkg/gatewayzevm.t.sol/gatewayzevminboundtest.go` is excluded by `!v2/pkg/**` * `v2/pkg/gatewayzevm.t.sol/gatewayzevmoutboundtest.go` is excluded by `!v2/pkg/**` * `v2/pkg/math.sol/math.go` is excluded by `!v2/pkg/**` * `v2/pkg/mockerc20.sol/mockerc20.go` is excluded by `!v2/pkg/**` * `v2/pkg/mockerc721.sol/mockerc721.go` is excluded by `!v2/pkg/**` * `v2/pkg/proxyadmin.sol/proxyadmin.go` is excluded by `!v2/pkg/**` * `v2/pkg/receiverevm.sol/receiverevm.go` is excluded by `!v2/pkg/**` * `v2/pkg/safeconsole.sol/safeconsole.go` is excluded by `!v2/pkg/**` * `v2/pkg/safeerc20.sol/safeerc20.go` is excluded by `!v2/pkg/**` * `v2/pkg/senderzevm.sol/senderzevm.go` is excluded by `!v2/pkg/**` * `v2/pkg/signedmath.sol/signedmath.go` is excluded by `!v2/pkg/**` * `v2/pkg/src/strings.sol/strings.go` is excluded by `!v2/pkg/**` * `v2/pkg/stderror.sol/stderror.go` is excluded by `!v2/pkg/**` * `v2/pkg/stdjson.sol/stdjson.go` is excluded by `!v2/pkg/**` * `v2/pkg/stdmath.sol/stdmath.go` is excluded by `!v2/pkg/**` * `v2/pkg/stdstorage.sol/stdstorage.go` is excluded by `!v2/pkg/**` * `v2/pkg/stdstorage.sol/stdstoragesafe.go` is excluded by `!v2/pkg/**` * `v2/pkg/stdstyle.sol/stdstyle.go` is excluded by `!v2/pkg/**` * `v2/pkg/stdtoml.sol/stdtoml.go` is excluded by `!v2/pkg/**` * `v2/pkg/storageslot.sol/storageslot.go` is excluded by `!v2/pkg/**` * `v2/pkg/strings.sol/strings.go` is excluded by `!v2/pkg/**` * `v2/pkg/systemcontract.sol/systemcontract.go` is excluded by `!v2/pkg/**` * `v2/pkg/systemcontractmock.sol/systemcontractmock.go` is excluded by `!v2/pkg/**` * `v2/pkg/testerc20.sol/testerc20.go` is excluded by `!v2/pkg/**` * `v2/pkg/testuniversalcontract.sol/testuniversalcontract.go` is excluded by `!v2/pkg/**` * `v2/pkg/transparentupgradeableproxy.sol/transparentupgradeableproxy.go` is excluded by `!v2/pkg/**` * `v2/pkg/upgradeablebeacon.sol/upgradeablebeacon.go` is excluded by `!v2/pkg/**` * `v2/pkg/upgrades.sol/unsafeupgrades.go` is excluded by `!v2/pkg/**` * `v2/pkg/upgrades.sol/upgrades.go` is excluded by `!v2/pkg/**` * `v2/pkg/utils.sol/utils.go` is excluded by `!v2/pkg/**` * `v2/pkg/versions.sol/versions.go` is excluded by `!v2/pkg/**` * `v2/pkg/wzeta.sol/weth9.go` is excluded by `!v2/pkg/**` * `v2/pkg/zeta.non-eth.sol/zetanoneth.go` is excluded by `!v2/pkg/**` * `v2/pkg/zetaconnectornative.sol/zetaconnectornative.go` is excluded by `!v2/pkg/**` * `v2/pkg/zetaconnectornative.t.sol/zetaconnectornativetest.go` is excluded by `!v2/pkg/**` * `v2/pkg/zetaconnectornonnative.sol/zetaconnectornonnative.go` is excluded by `!v2/pkg/**` * `v2/pkg/zetaconnectornonnative.t.sol/zetaconnectornonnativetest.go` is excluded by `!v2/pkg/**` * `v2/pkg/zrc20.sol/zrc20.go` is excluded by `!v2/pkg/**` * `v2/pkg/zrc20.t.sol/zrc20test.go` is excluded by `!v2/pkg/**` * `v2/soldeer.lock` is excluded by `!**/*.lock` * `v2/types/factories/Address__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/BeaconProxy__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/ERC1967Proxy__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/ERC1967Utils__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/ERC20CustodyEchidnaTest__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/ERC20Custody__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/GatewayEVMEchidnaTest__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/GatewayEVMUpgradeTest__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/GatewayEVM__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/GatewayZEVM__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/Math__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/MockERC20__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/MockERC721__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/ProxyAdmin__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/ReceiverEVM__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/SafeERC20__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/SenderZEVM__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/StdError.sol/StdError__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/StdStorage.sol/StdStorageSafe__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/Strings__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/SystemContract.sol/SystemContract__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/SystemContractMock.sol/SystemContractMock__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/TestERC20__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/TestUniversalContract__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/TransparentUpgradeableProxy.sol/TransparentUpgradeableProxy__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/UpgradeableBeacon__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/WZETA.sol/WETH9__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/ZRC20.sol/ZRC20__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/Zeta.non-eth.sol/ZetaNonEth__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/ZetaConnectorNative__factory.ts` is excluded by `!v2/types/**` * `v2/types/factories/ZetaConnectorNonNative__factory.ts` is excluded by `!v2/types/**`CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including
**/dist/**will override the default block on thedistdirectory.You can disable this status message by setting the
reviews.review_statustofalsein the CodeRabbit configuration file.
Walkthrough
## Walkthrough The 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 | Files | Change Summary | |-----------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `.github/workflows/generated-files_v2.yaml`, `.github/workflows/lint_v2.yaml`, `.github/workflows/slither_v2.yaml`, `.github/workflows/test_v2.yaml` | Removed recursive submodule checkout from workflow configurations; enhanced dependency installation with `forge soldeer update` after `yarn install`. | | `.github/workflows/publish-npm_v2.yaml` | Updated dependency installation to include `forge soldeer update` following `yarn install`. | | `.gitignore` | Added `dependencies/` to the ignore list and provided comments on ignored files for better clarity. | | `v2/README.md`, `v2/docs/src/README.md` | Updated documentation to include installation instructions for dependencies using `yarn` and `forge soldeer update`, and modified links for improved accessibility. | | `v2/docs/.../*.md` (multiple files) | Updated Git source links to point to new commits for clarity, without affecting functionality or structure. | | `v2/package.json` | Modified "generate" script to remove automatic documentation generation step, indicating a shift in build process. | | `v2/scripts/generate_go.sh` | Added commands to output versions of `abigen` and `solc` tools within the `process_file` function for enhanced environment verification. | ## Possibly related PRs - #338: The changes in this PR involve the removal of a check in the ZRC20 constructor, which aligns with the main PR's focus on simplifying processes in the GitHub Actions workflow, particularly regarding the handling of submodules and naming conventions.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?
codecov-commenter
skosito
fadeev
Summary by CodeRabbit
New Features
yarnandforge soldeer update.abigenandsolcin the generate script.Bug Fixes
Documentation
Chores