refactor: use `ChainInfo` in `authority` to allow support chains dynamically #2380

lumtis · 2024-06-25T12:26:40Z

Description

Use the ChainList object to allow supporting chains where static info are added dynamically, without being hardcoded.

Mainly:

Modify the method in the chains package to support using a list of additional chains from ones hardcoded
Read the chain list directly from the authority keeper in the protocol when calling chains methods
Add the additional chains in core context and use it in ZetaClient

On the design choice, the main idea is to keep the purity of the functions in chains package and keep using these methods.

Closes: #2273

coderabbitai · 2024-06-25T12:26:45Z

Important

Review skipped

Review was skipped due to path filters

Files ignored due to path filters (139)

changelog.md is excluded by none and included by none
cmd/zetaclientd/debug.go is excluded by none and included by none
pkg/chains/chain.go is excluded by none and included by none
pkg/chains/chain_test.go is excluded by none and included by none
pkg/chains/chains.go is excluded by none and included by none
pkg/chains/chains_test.go is excluded by none and included by none
pkg/chains/conversion.go is excluded by none and included by none
pkg/chains/utils_test.go is excluded by none and included by none
pkg/crypto/pubkey.go is excluded by none and included by none
proto/zetachain/zetacore/observer/observer.proto is excluded by none and included by none
proto/zetachain/zetacore/observer/params.proto is excluded by none and included by none
proto/zetachain/zetacore/observer/query.proto is excluded by none and included by none
testutil/keeper/authority.go is excluded by none and included by none
testutil/keeper/crosschain.go is excluded by none and included by none
testutil/keeper/mocks/crosschain/authority.go is excluded by none and included by none
testutil/keeper/mocks/crosschain/observer.go is excluded by none and included by none
testutil/keeper/mocks/fungible/authority.go is excluded by none and included by none
testutil/keeper/mocks/fungible/observer.go is excluded by none and included by none
testutil/keeper/mocks/lightclient/authority.go is excluded by none and included by none
testutil/keeper/mocks/observer/authority.go is excluded by none and included by none
testutil/network/genesis_state.go is excluded by none and included by none
testutil/sample/authority.go is excluded by none and included by none
testutil/sample/crosschain.go is excluded by none and included by none
testutil/sample/observer.go is excluded by none and included by none
testutil/sample/sample.go is excluded by none and included by none
x/authority/keeper/chain_info.go is excluded by none and included by none
x/authority/keeper/chain_info_test.go is excluded by none and included by none
x/authority/keeper/grpc_query_chain_info.go is excluded by none and included by none
x/authority/keeper/grpc_query_chain_info_test.go is excluded by none and included by none
x/crosschain/keeper/abci.go is excluded by none and included by none
x/crosschain/keeper/abci_test.go is excluded by none and included by none
x/crosschain/keeper/cctx_gateway_observers.go is excluded by none and included by none
x/crosschain/keeper/cctx_orchestrator_validate_outbound.go is excluded by none and included by none
x/crosschain/keeper/cctx_orchestrator_validate_outbound_test.go is excluded by none and included by none
x/crosschain/keeper/cctx_utils.go is excluded by none and included by none
x/crosschain/keeper/cctx_utils_test.go is excluded by none and included by none
x/crosschain/keeper/events.go is excluded by none and included by none
x/crosschain/keeper/evm_deposit.go is excluded by none and included by none
x/crosschain/keeper/evm_hooks.go is excluded by none and included by none
x/crosschain/keeper/evm_hooks_test.go is excluded by none and included by none
x/crosschain/keeper/gas_payment.go is excluded by none and included by none
x/crosschain/keeper/grpc_query_cctx_rate_limit.go is excluded by none and included by none
x/crosschain/keeper/grpc_query_zeta_conversion_rate.go is excluded by none and included by none
x/crosschain/keeper/initiate_outbound.go is excluded by none and included by none
x/crosschain/keeper/initiate_outbound_test.go is excluded by none and included by none
x/crosschain/keeper/msg_server_add_inbound_tracker.go is excluded by none and included by none
x/crosschain/keeper/msg_server_add_inbound_tracker_test.go is excluded by none and included by none
x/crosschain/keeper/msg_server_add_outbound_tracker.go is excluded by none and included by none
x/crosschain/keeper/msg_server_add_outbound_tracker_test.go is excluded by none and included by none
x/crosschain/keeper/msg_server_migrate_tss_funds.go is excluded by none and included by none
x/crosschain/keeper/msg_server_migrate_tss_funds_test.go is excluded by none and included by none
x/crosschain/keeper/msg_server_refund_aborted_tx_test.go is excluded by none and included by none
x/crosschain/keeper/msg_server_vote_gas_price.go is excluded by none and included by none
x/crosschain/keeper/msg_server_vote_gas_price_test.go is excluded by none and included by none
x/crosschain/keeper/msg_server_vote_inbound_tx_test.go is excluded by none and included by none
x/crosschain/keeper/msg_server_vote_outbound_tx_test.go is excluded by none and included by none
x/crosschain/keeper/msg_server_whitelist_erc20.go is excluded by none and included by none
x/crosschain/keeper/refund.go is excluded by none and included by none
x/crosschain/keeper/utils_test.go is excluded by none and included by none
x/crosschain/migrations/v4/migrate.go is excluded by none and included by none
x/crosschain/migrations/v5/migrate.go is excluded by none and included by none
x/crosschain/migrations/v5/migrate_test.go is excluded by none and included by none
x/crosschain/types/cctx_test.go is excluded by none and included by none
x/crosschain/types/expected_keepers.go is excluded by none and included by none
x/crosschain/types/inbound_params.go is excluded by none and included by none
x/crosschain/types/inbound_params_test.go is excluded by none and included by none
x/crosschain/types/message_add_inbound_tracker.go is excluded by none and included by none
x/crosschain/types/message_add_inbound_tracker_test.go is excluded by none and included by none
x/crosschain/types/message_migrate_tss_funds.go is excluded by none and included by none
x/crosschain/types/message_migrate_tss_funds_test.go is excluded by none and included by none
x/crosschain/types/outbound_params.go is excluded by none and included by none
x/crosschain/types/outbound_params_test.go is excluded by none and included by none
x/crosschain/types/tx_body_verification.go is excluded by none and included by none
x/crosschain/types/validate.go is excluded by none and included by none
x/fungible/keeper/evm.go is excluded by none and included by none
x/fungible/keeper/gas_coin_and_pool.go is excluded by none and included by none
x/fungible/keeper/grpc_query_gas_stability_pool.go is excluded by none and included by none
x/fungible/keeper/grpc_query_gas_stability_pool_test.go is excluded by none and included by none
x/fungible/keeper/msg_server_deploy_fungible_coin_zrc20_test.go is excluded by none and included by none
x/fungible/keeper/msg_server_remove_foreign_coin_test.go is excluded by none and included by none
x/fungible/keeper/msg_server_update_contract_bytecode_test.go is excluded by none and included by none
x/fungible/keeper/msg_server_update_system_contract_test.go is excluded by none and included by none
x/fungible/keeper/msg_server_update_zrc20_withdraw_fee_test.go is excluded by none and included by none
x/fungible/types/expected_keepers.go is excluded by none and included by none
x/lightclient/keeper/grpc_query_prove.go is excluded by none and included by none
x/lightclient/keeper/proof.go is excluded by none and included by none
x/lightclient/types/expected_keepers.go is excluded by none and included by none
x/lightclient/types/message_disable_verification_flags.go is excluded by none and included by none
x/lightclient/types/message_disable_verification_flags_test.go is excluded by none and included by none
x/lightclient/types/message_enable_verification_flags.go is excluded by none and included by none
x/lightclient/types/message_enable_verification_flags_test.go is excluded by none and included by none
x/observer/keeper/chain_params.go is excluded by none and included by none
x/observer/keeper/chain_params_test.go is excluded by none and included by none
x/observer/keeper/grpc_query_supported_chain_test.go is excluded by none and included by none
x/observer/keeper/grpc_query_tss_funds_migrator_info.go is excluded by none and included by none
x/observer/keeper/msg_server_remove_chain_params_test.go is excluded by none and included by none
x/observer/keeper/msg_server_reset_chain_nonces.go is excluded by none and included by none
x/observer/keeper/msg_server_reset_chain_nonces_test.go is excluded by none and included by none
x/observer/keeper/msg_server_update_chain_params_test.go is excluded by none and included by none
x/observer/keeper/msg_server_vote_blame.go is excluded by none and included by none
x/observer/keeper/msg_server_vote_block_header.go is excluded by none and included by none
x/observer/keeper/msg_server_vote_block_header_test.go is excluded by none and included by none
x/observer/keeper/utils.go is excluded by none and included by none
x/observer/keeper/utils_test.go is excluded by none and included by none
x/observer/keeper/vote_inbound.go is excluded by none and included by none
x/observer/keeper/vote_inbound_test.go is excluded by none and included by none
x/observer/keeper/vote_outbound.go is excluded by none and included by none
x/observer/keeper/vote_outbound_test.go is excluded by none and included by none
x/observer/types/chain_params.go is excluded by none and included by none
x/observer/types/chain_params_test.go is excluded by none and included by none
x/observer/types/expected_keepers.go is excluded by none and included by none
x/observer/types/message_remove_chain_params.go is excluded by none and included by none
x/observer/types/message_remove_chain_params_test.go is excluded by none and included by none
x/observer/types/message_reset_chain_nonces.go is excluded by none and included by none
x/observer/types/message_reset_chain_nonces_test.go is excluded by none and included by none
x/observer/types/message_update_chain_params_test.go is excluded by none and included by none
x/observer/types/message_vote_blame.go is excluded by none and included by none
x/observer/types/message_vote_blame_test.go is excluded by none and included by none
x/observer/types/message_vote_block_header.go is excluded by none and included by none
x/observer/types/observer.pb.go is excluded by !**/*.pb.go and included by **/*.pb.go
x/observer/types/params.pb.go is excluded by !**/*.pb.go and included by **/*.pb.go
x/observer/types/query.pb.go is excluded by !**/*.pb.go and included by **/*.pb.go
zetaclient/chains/base/signer.go is excluded by none and included by none
zetaclient/chains/evm/observer/inbound.go is excluded by none and included by none
zetaclient/chains/evm/observer/observer_test.go is excluded by none and included by none
zetaclient/chains/evm/signer/outbound_data.go is excluded by none and included by none
zetaclient/chains/evm/signer/outbound_data_test.go is excluded by none and included by none
zetaclient/chains/evm/signer/signer.go is excluded by none and included by none
zetaclient/chains/evm/signer/signer_test.go is excluded by none and included by none
zetaclient/context/app.go is excluded by none and included by none
zetaclient/context/app_test.go is excluded by none and included by none
zetaclient/orchestrator/orchestrator.go is excluded by none and included by none
zetaclient/orchestrator/orchestrator_test.go is excluded by none and included by none
zetaclient/supplychecker/zeta_supply_checker.go is excluded by none and included by none
zetaclient/zetacore/client.go is excluded by none and included by none
zetaclient/zetacore/query.go is excluded by none and included by none
zetaclient/zetacore/query_test.go is excluded by none and included by none
zetaclient/zetacore/tx.go is excluded by none and included by none
zetaclient/zetacore/tx_test.go is excluded by none and included by none

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

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov · 2024-06-26T12:35:28Z

Codecov Report

Attention: Patch coverage is 78.84615% with 66 lines in your changes missing coverage. Please review.

Project coverage is 69.04%. Comparing base (ba6bc6f) to head (bdc1b72).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2380      +/-   ##
===========================================
- Coverage    69.21%   69.04%   -0.17%     
===========================================
  Files          308      308              
  Lines        19217    19189      -28     
===========================================
- Hits         13301    13250      -51     
- Misses        5247     5264      +17     
- Partials       669      675       +6

Files	Coverage Δ
pkg/chains/chain.go	`94.38% <100.00%> (-2.20%)`	⬇️
pkg/chains/conversion.go	`100.00% <100.00%> (ø)`
x/authority/keeper/chain_info.go	`100.00% <100.00%> (ø)`
x/authority/keeper/grpc_query_chain_info.go	`100.00% <100.00%> (ø)`
x/crosschain/keeper/abci.go	`81.01% <100.00%> (+0.24%)`	⬆️
x/crosschain/keeper/cctx_gateway_observers.go	`100.00% <100.00%> (ø)`
...hain/keeper/cctx_orchestrator_validate_outbound.go	`94.89% <100.00%> (-0.04%)`	⬇️
x/crosschain/keeper/cctx_utils.go	`100.00% <100.00%> (ø)`
x/crosschain/keeper/evm_deposit.go	`91.25% <100.00%> (ø)`
x/crosschain/keeper/gas_payment.go	`79.03% <100.00%> (ø)`
... and 50 more

... and 1 file with indirect coverage changes

pkg/chains/chain.go

x/crosschain/types/inbound_params.go

x/lightclient/types/message_enable_verification_flags.go

x/observer/types/chain_params.go

x/observer/types/message_vote_block_header.go

ws4charlie

LGTM. left a few minor comments

Co-authored-by: Dmitry S <[email protected]>

Co-authored-by: Charlie Chen <[email protected]>

gitguardian · 2024-07-02T13:04:52Z

⚠️ GitGuardian has uncovered 12 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
11033143	Triggered	Generic High Entropy Secret	`ab4ccf4`	cmd/zetae2e/local/accounts.go	View secret
11033143	Triggered	Generic High Entropy Secret	`ab4ccf4`	cmd/zetae2e/config/local.yml	View secret
11033143	Triggered	Generic High Entropy Secret	`ab4ccf4`	cmd/zetae2e/config/localnet.yml	View secret
11033144	Triggered	Generic High Entropy Secret	`ab4ccf4`	cmd/zetae2e/config/localnet.yml	View secret
11033144	Triggered	Generic High Entropy Secret	`ab4ccf4`	cmd/zetae2e/local/accounts.go	View secret
11033145	Triggered	Generic High Entropy Secret	`ab4ccf4`	cmd/zetae2e/config/localnet.yml	View secret
11033145	Triggered	Generic High Entropy Secret	`ab4ccf4`	cmd/zetae2e/local/accounts.go	View secret
11033146	Triggered	Generic High Entropy Secret	`ab4ccf4`	cmd/zetae2e/config/localnet.yml	View secret
11033146	Triggered	Generic High Entropy Secret	`ab4ccf4`	cmd/zetae2e/local/accounts.go	View secret
11478175	Triggered	Generic High Entropy Secret	`ab4ccf4`	cmd/zetae2e/config/localnet.yml	View secret
11478176	Triggered	Generic High Entropy Secret	`ab4ccf4`	cmd/zetae2e/config/localnet.yml	View secret
11759679	Triggered	Generic High Entropy Secret	`ab4ccf4`	cmd/zetae2e/local/accounts.go	View secret

🛠 Guidelines to remediate hardcoded secrets

Understand the implications of revoking this secret by investigating where it is used in your code.
Replace and store your secret safely. Learn here the best practices.
Revoke and rotate this secret.
If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

following these best practices for managing and storing secrets including API keys and other credentials
install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}

ws4charlie

lgtm

x/authority/keeper/chain_info.go

lumtis added 16 commits June 24, 2024 14:04

add combine list function

640aa3e

remove unused functions and add combine default list method

d642c10

use test package for chain_test

0b852e8

use additional info parameter for methods

7881b53

rename additional chains

502261f

add GetChainList to authority interface

7f83544

iteration 1

52ced26

Merge branch 'develop' into feat/read-chain-info

a9af40d

crosschain refactoring

436bbe4

fungible refacotring

59f28fe

lightclient refactoring

384dd5f

observer refactoring

3dc2372

add additional chain list in context

ae4d0ff

zetaclient modification

ebd7ae7

fix build error

e1bec69

format

48ac8f8

github-actions bot added the breaking:cli label Jun 25, 2024

lumtis added 8 commits June 25, 2024 14:31

changelog

9c6b05b

Merge branch 'develop' into feat/read-chain-info

746d09a

conflicts

b3ebf57

fix lint

65f6cbe

test fixes 2

672da05

observer test fix

b373d17

zetaclient tests

4560118

fix test 2

0a6f256

add more tests

994020a

lumtis commented Jun 26, 2024

View reviewed changes

pkg/chains/chain.go Show resolved Hide resolved

x/crosschain/types/inbound_params.go Show resolved Hide resolved

rename getChainList

54dd10c

ws4charlie reviewed Jun 27, 2024

View reviewed changes

x/lightclient/types/message_enable_verification_flags.go Outdated Show resolved Hide resolved

ws4charlie reviewed Jun 27, 2024

View reviewed changes

x/observer/types/chain_params.go Show resolved Hide resolved

ws4charlie reviewed Jun 27, 2024

View reviewed changes

x/observer/types/message_vote_block_header.go Show resolved Hide resolved

ws4charlie reviewed Jun 27, 2024

View reviewed changes

lumtis and others added 8 commits June 28, 2024 10:45

Update pkg/chains/chains.go

f842aa0

Co-authored-by: Dmitry S <[email protected]>

Update pkg/chains/chains.go

6e6b781

Co-authored-by: Dmitry S <[email protected]>

add TODO

6adf45b

Update x/authority/keeper/chain_info.go

1b07d96

Co-authored-by: Dmitry S <[email protected]>

Update cmd/zetaclientd/debug.go

adfd208

Co-authored-by: Charlie Chen <[email protected]>

remove pointers in chains

e935a3f

complete chain remove pointer

54d6135

fix tests

66e2b77

github-actions bot added the breaking:proto label Jun 28, 2024

lumtis added 2 commits June 28, 2024 15:33

dmitry comments

a7af5d8

update comment

52d5650

lumtis requested a review from fbac as a code owner July 1, 2024 17:36

lumtis linked an issue Jul 2, 2024 that may be closed by this pull request

zetacored : Remove pointers from functions returning a list of chains #2080

Closed

lumtis added 2 commits July 2, 2024 14:41

conflicts

ab4ccf4

fix merge error

c09b769

comments

d066959

lumtis requested review from swift1337, ws4charlie and skosito July 2, 2024 13:52

skosito approved these changes Jul 2, 2024

View reviewed changes

ws4charlie approved these changes Jul 2, 2024

View reviewed changes

swift1337 approved these changes Jul 2, 2024

View reviewed changes

x/authority/keeper/chain_info.go Outdated Show resolved Hide resolved

use nil

bdc1b72

lumtis merged commit 8982129 into develop Jul 2, 2024
19 checks passed

lumtis deleted the feat/read-chain-info branch July 2, 2024 15:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: use `ChainInfo` in `authority` to allow support chains dynamically #2380

refactor: use `ChainInfo` in `authority` to allow support chains dynamically #2380

lumtis commented Jun 25, 2024 •

edited

Loading

coderabbitai bot commented Jun 25, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

codecov bot commented Jun 26, 2024 •

edited

Loading

ws4charlie left a comment

gitguardian bot commented Jul 2, 2024 •

edited

Loading

ws4charlie left a comment

refactor: use ChainInfo in authority to allow support chains dynamically #2380

refactor: use ChainInfo in authority to allow support chains dynamically #2380

Conversation

lumtis commented Jun 25, 2024 • edited Loading

Description

coderabbitai bot commented Jun 25, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

codecov bot commented Jun 26, 2024 • edited Loading

Codecov Report

ws4charlie left a comment

Choose a reason for hiding this comment

gitguardian bot commented Jul 2, 2024 • edited Loading

⚠️ GitGuardian has uncovered 12 secrets following the scan of your pull request.

ws4charlie left a comment

Choose a reason for hiding this comment

refactor: use `ChainInfo` in `authority` to allow support chains dynamically #2380

refactor: use `ChainInfo` in `authority` to allow support chains dynamically #2380

lumtis commented Jun 25, 2024 •

edited

Loading

coderabbitai bot commented Jun 25, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

codecov bot commented Jun 26, 2024 •

edited

Loading

gitguardian bot commented Jul 2, 2024 •

edited

Loading