Skip to content

Conversation

@fadeev
Copy link
Member

@fadeev fadeev commented Oct 20, 2025

Currently, new versions are still being published to https://www.npmjs.com/package/@zetachain/protocol-contracts

We need to switch to @zetachain/protocol-contracts-evm to keep naming consistent.

Summary by CodeRabbit

  • Breaking Changes

    • Removed ParamSymbol, ParamChainName, and ParamType type exports
  • Chores

    • Updated package name to "@zetachain/protocol-contracts-evm"

@fadeev fadeev requested review from a team as code owners October 20, 2025 10:09
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 20, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • docs/index.md is excluded by !docs/**

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 the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

Updated 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

Cohort / File(s) Summary
Package metadata
package.json
Updated package name from "@zetachain/protocol-contracts" to "@zetachain/protocol-contracts-evm"
Build configuration
foundry.toml
Expanded libs configuration in [profile.default] from ["lib"] to ["lib", "dependencies"]
Type declarations
lib/types.ts
Removed three exported type declarations: ParamSymbol, ParamChainName, and ParamType

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~5 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The pull request title "chore: set package name to protocol-contracts-evm" directly aligns with the primary objective stated in the PR description, which is to change the package name from "@zetachain/protocol-contracts" to "@zetachain/protocol-contracts-evm" to maintain consistent naming. The title is concise, clear, and accurately summarizes the main change reflected in the package.json file. While the changeset includes additional modifications to foundry.toml and lib/types.ts, these appear to be supporting or secondary changes, and the PR's stated intent focuses on the package name update. The title does not contain vague language or misleading information.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions bot added the chore label Oct 20, 2025
@s2imonovic
Copy link
Collaborator

@fadeev Please install the latest stable version of forge and run forge fmt.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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.

📥 Commits

Reviewing files that changed from the base of the PR and between 9e01eae and 06ae1fa.

⛔ Files ignored due to path filters (57)
  • data/addresses.testnet.json is excluded by !data/**
  • docs/index.md is excluded by !docs/**
  • pkg/coreregistry.sol/coreregistry.go is excluded by !pkg/**
  • pkg/coreregistry.t.sol/coreregistrytest.go is excluded by !pkg/**
  • pkg/coreregistry.t.sol/mockgatewayzevm.go is excluded by !pkg/**
  • pkg/erc20custody.sol/erc20custody.go is excluded by !pkg/**
  • pkg/erc20custody.t.sol/erc20custodytest.go is excluded by !pkg/**
  • pkg/erc20custodyupgradetest.sol/erc20custodyupgradetest.go is excluded by !pkg/**
  • pkg/gatewayevm.sol/gatewayevm.go is excluded by !pkg/**
  • pkg/gatewayevm.t.sol/gatewayevminboundtest.go is excluded by !pkg/**
  • pkg/gatewayevm.t.sol/gatewayevmtest.go is excluded by !pkg/**
  • pkg/gatewayevmupgradetest.sol/gatewayevmupgradetest.go is excluded by !pkg/**
  • pkg/gatewayevmzevm.t.sol/gatewayevmzevmtest.go is excluded by !pkg/**
  • pkg/gatewayzevm.sol/gatewayzevm.go is excluded by !pkg/**
  • pkg/gatewayzevm.t.sol/gatewayzevminboundtest.go is excluded by !pkg/**
  • pkg/gatewayzevm.t.sol/gatewayzevmoutboundtest.go is excluded by !pkg/**
  • pkg/gatewayzevmupgradetest.sol/gatewayzevmupgradetest.go is excluded by !pkg/**
  • pkg/receiverevm.sol/receiverevm.go is excluded by !pkg/**
  • pkg/registry.sol/registry.go is excluded by !pkg/**
  • pkg/registry.t.sol/mockgatewayevm.go is excluded by !pkg/**
  • pkg/registry.t.sol/registrytest.go is excluded by !pkg/**
  • pkg/senderzevm.sol/senderzevm.go is excluded by !pkg/**
  • pkg/systemcontract.sol/systemcontract.go is excluded by !pkg/**
  • pkg/systemcontractmock.sol/systemcontractmock.go is excluded by !pkg/**
  • pkg/testuniversalcontract.sol/testuniversalcontract.go is excluded by !pkg/**
  • pkg/zetaconnector.base.sol/zetaconnectorbase.go is excluded by !pkg/**
  • pkg/zetaconnector.eth.sol/zetaconnectoreth.go is excluded by !pkg/**
  • pkg/zetaconnector.non-eth.sol/zetaconnectornoneth.go is excluded by !pkg/**
  • pkg/zetaconnectornative.sol/zetaconnectornative.go is excluded by !pkg/**
  • pkg/zetaconnectornative.t.sol/zetaconnectornativetest.go is excluded by !pkg/**
  • pkg/zetaconnectornativeupgradetest.sol/zetaconnectornativeupgradetest.go is excluded by !pkg/**
  • pkg/zetaconnectornonnative.sol/zetaconnectornonnative.go is excluded by !pkg/**
  • pkg/zetaconnectornonnative.t.sol/zetaconnectornonnativetest.go is excluded by !pkg/**
  • pkg/zetaconnectornonnativeupgradetest.sol/zetaconnectornonnativeupgradetest.go is excluded by !pkg/**
  • pkg/zetaconnectorzevm.sol/zetaconnectorzevm.go is excluded by !pkg/**
  • pkg/zrc20.t.sol/zrc20test.go is excluded by !pkg/**
  • types/factories/CoreRegistry__factory.ts is excluded by !types/**
  • types/factories/ERC20CustodyUpgradeTest__factory.ts is excluded by !types/**
  • types/factories/ERC20Custody__factory.ts is excluded by !types/**
  • types/factories/GatewayEVMUpgradeTest__factory.ts is excluded by !types/**
  • types/factories/GatewayEVM__factory.ts is excluded by !types/**
  • types/factories/GatewayZEVMUpgradeTest__factory.ts is excluded by !types/**
  • types/factories/GatewayZEVM__factory.ts is excluded by !types/**
  • types/factories/ReceiverEVM__factory.ts is excluded by !types/**
  • types/factories/Registry__factory.ts is excluded by !types/**
  • types/factories/SenderZEVM__factory.ts is excluded by !types/**
  • types/factories/SystemContract.sol/SystemContract__factory.ts is excluded by !types/**
  • types/factories/SystemContractMock.sol/SystemContractMock__factory.ts is excluded by !types/**
  • types/factories/TestUniversalContract__factory.ts is excluded by !types/**
  • types/factories/ZetaConnector.base.sol/ZetaConnectorBase__factory.ts is excluded by !types/**
  • types/factories/ZetaConnector.eth.sol/ZetaConnectorEth__factory.ts is excluded by !types/**
  • types/factories/ZetaConnector.non-eth.sol/ZetaConnectorNonEth__factory.ts is excluded by !types/**
  • types/factories/ZetaConnectorNativeUpgradeTest__factory.ts is excluded by !types/**
  • types/factories/ZetaConnectorNative__factory.ts is excluded by !types/**
  • types/factories/ZetaConnectorNonNativeUpgradeTest__factory.ts is excluded by !types/**
  • types/factories/ZetaConnectorNonNative__factory.ts is excluded by !types/**
  • types/factories/ZetaConnectorZEVM.sol/ZetaConnectorZEVM__factory.ts is 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

@lumtis lumtis merged commit 09ac0d6 into develop Oct 22, 2025
15 checks passed
@lumtis lumtis deleted the chore-protocol-contracts-evm-package-json branch October 22, 2025 13:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants