-
Notifications
You must be signed in to change notification settings - Fork 68
chore: set package name to protocol-contracts-evm #596
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (1)
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 📝 WalkthroughWalkthroughUpdated the published package name to reflect EVM-specific targeting, expanded the foundry library configuration to include a dependencies directory, and removed three type declaration exports. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~5 minutes Pre-merge checks and finishing touches✅ Passed checks (3 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@fadeev Please install the latest stable version of forge and run forge fmt. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
lib/types.ts (1)
1-1: Consider reformatting this union type for better readability and maintainability.The 59 symbol literals are all on a single line, making this type definition difficult to read, review, and maintain. When adding or removing symbols, git diffs will show the entire line as changed rather than just the specific addition/removal.
Consider formatting with one literal per line:
-export type ParamSymbol = "USDC.ARB" | "USDC.BSC" | "USDT.ARB" | ... | "tBTC.BTC"; +export type ParamSymbol = + | "AVAX.AVAX" + | "AVAX.FUJI" + | "BNB.BSC" + | "BTC.BTC" + | "CBBTC.BASE" + | "CBBTC.ETH" + | "CBBTC.SOL" + | "DAI.ETH" + | "ETH.ARB" + | "ETH.ARBSEP" + | "ETH.BASE" + | "ETH.BASESEP" + | "ETH.ETH" + | "ETH.ETHSEP" + | "HanaKRW.FUJI" + | "KAIA.KAIROS" + | "KBKRW.KAIROS" + | "NPC.ETH" + | "PEPE.ETH" + | "POL.AMOY" + | "POL.POL" + | "sBTC.BTC" + | "SHIB.ETH" + | "SOL.SOL" + | "SUI.SUI" + | "tBTC.BTC" + | "TON.TON" + | "TSKRW.KAIROS" + | "ULTI.BSC" + | "ULTI.ETH" + | "UPKRW.ARBSEP" + | "USDC.AMOY" + | "USDC.ARB" + | "USDC.ARBSEP" + | "USDC.AVAX" + | "USDC.BASE" + | "USDC.BASESEP" + | "USDC.BSC" + | "USDC.ETH" + | "USDC.ETHSEP" + | "USDC.FUJI" + | "USDC.POL" + | "USDC.SOL" + | "USDC.SUI" + | "USDCT.ARBSEP" + | "USDCT.BASESEP" + | "USDCT.FUJI" + | "USDCT.SEPOLIA" + | "USDT.ARB" + | "USDT.AVAX" + | "USDT.BSC" + | "USDT.ETH" + | "USDT.POL" + | "USDT.SOL" + | "USDTT.ARBSEP" + | "USDTT.BASESEP" + | "USDTT.FUJI" + | "USDTT.SEPOLIA" + | "WBTC.ETH";Additionally, consider adding a JSDoc comment to explain the naming convention (e.g., what distinguishes USDCT from USDC, and USDTT from USDT).
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (57)
data/addresses.testnet.jsonis excluded by!data/**docs/index.mdis excluded by!docs/**pkg/coreregistry.sol/coreregistry.gois excluded by!pkg/**pkg/coreregistry.t.sol/coreregistrytest.gois excluded by!pkg/**pkg/coreregistry.t.sol/mockgatewayzevm.gois excluded by!pkg/**pkg/erc20custody.sol/erc20custody.gois excluded by!pkg/**pkg/erc20custody.t.sol/erc20custodytest.gois excluded by!pkg/**pkg/erc20custodyupgradetest.sol/erc20custodyupgradetest.gois excluded by!pkg/**pkg/gatewayevm.sol/gatewayevm.gois excluded by!pkg/**pkg/gatewayevm.t.sol/gatewayevminboundtest.gois excluded by!pkg/**pkg/gatewayevm.t.sol/gatewayevmtest.gois excluded by!pkg/**pkg/gatewayevmupgradetest.sol/gatewayevmupgradetest.gois excluded by!pkg/**pkg/gatewayevmzevm.t.sol/gatewayevmzevmtest.gois excluded by!pkg/**pkg/gatewayzevm.sol/gatewayzevm.gois excluded by!pkg/**pkg/gatewayzevm.t.sol/gatewayzevminboundtest.gois excluded by!pkg/**pkg/gatewayzevm.t.sol/gatewayzevmoutboundtest.gois excluded by!pkg/**pkg/gatewayzevmupgradetest.sol/gatewayzevmupgradetest.gois excluded by!pkg/**pkg/receiverevm.sol/receiverevm.gois excluded by!pkg/**pkg/registry.sol/registry.gois excluded by!pkg/**pkg/registry.t.sol/mockgatewayevm.gois excluded by!pkg/**pkg/registry.t.sol/registrytest.gois excluded by!pkg/**pkg/senderzevm.sol/senderzevm.gois excluded by!pkg/**pkg/systemcontract.sol/systemcontract.gois excluded by!pkg/**pkg/systemcontractmock.sol/systemcontractmock.gois excluded by!pkg/**pkg/testuniversalcontract.sol/testuniversalcontract.gois excluded by!pkg/**pkg/zetaconnector.base.sol/zetaconnectorbase.gois excluded by!pkg/**pkg/zetaconnector.eth.sol/zetaconnectoreth.gois excluded by!pkg/**pkg/zetaconnector.non-eth.sol/zetaconnectornoneth.gois excluded by!pkg/**pkg/zetaconnectornative.sol/zetaconnectornative.gois excluded by!pkg/**pkg/zetaconnectornative.t.sol/zetaconnectornativetest.gois excluded by!pkg/**pkg/zetaconnectornativeupgradetest.sol/zetaconnectornativeupgradetest.gois excluded by!pkg/**pkg/zetaconnectornonnative.sol/zetaconnectornonnative.gois excluded by!pkg/**pkg/zetaconnectornonnative.t.sol/zetaconnectornonnativetest.gois excluded by!pkg/**pkg/zetaconnectornonnativeupgradetest.sol/zetaconnectornonnativeupgradetest.gois excluded by!pkg/**pkg/zetaconnectorzevm.sol/zetaconnectorzevm.gois excluded by!pkg/**pkg/zrc20.t.sol/zrc20test.gois excluded by!pkg/**types/factories/CoreRegistry__factory.tsis excluded by!types/**types/factories/ERC20CustodyUpgradeTest__factory.tsis excluded by!types/**types/factories/ERC20Custody__factory.tsis excluded by!types/**types/factories/GatewayEVMUpgradeTest__factory.tsis excluded by!types/**types/factories/GatewayEVM__factory.tsis excluded by!types/**types/factories/GatewayZEVMUpgradeTest__factory.tsis excluded by!types/**types/factories/GatewayZEVM__factory.tsis excluded by!types/**types/factories/ReceiverEVM__factory.tsis excluded by!types/**types/factories/Registry__factory.tsis excluded by!types/**types/factories/SenderZEVM__factory.tsis excluded by!types/**types/factories/SystemContract.sol/SystemContract__factory.tsis excluded by!types/**types/factories/SystemContractMock.sol/SystemContractMock__factory.tsis excluded by!types/**types/factories/TestUniversalContract__factory.tsis excluded by!types/**types/factories/ZetaConnector.base.sol/ZetaConnectorBase__factory.tsis excluded by!types/**types/factories/ZetaConnector.eth.sol/ZetaConnectorEth__factory.tsis excluded by!types/**types/factories/ZetaConnector.non-eth.sol/ZetaConnectorNonEth__factory.tsis excluded by!types/**types/factories/ZetaConnectorNativeUpgradeTest__factory.tsis excluded by!types/**types/factories/ZetaConnectorNative__factory.tsis excluded by!types/**types/factories/ZetaConnectorNonNativeUpgradeTest__factory.tsis excluded by!types/**types/factories/ZetaConnectorNonNative__factory.tsis excluded by!types/**types/factories/ZetaConnectorZEVM.sol/ZetaConnectorZEVM__factory.tsis excluded by!types/**
📒 Files selected for processing (2)
foundry.toml(1 hunks)lib/types.ts(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- foundry.toml
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: test
- GitHub Check: slither
Currently, new versions are still being published to https://www.npmjs.com/package/@zetachain/protocol-contracts
We need to switch to
@zetachain/protocol-contracts-evmto keep naming consistent.Summary by CodeRabbit
Breaking Changes
Chores