Skip to content

refactor(voyager): rename consensus modules to finality modules #4597

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

marvelshan
Copy link
Contributor

@marvelshan marvelshan commented May 23, 2025

Which issue does this PR close?

closes #4374

Overview

This PR renames the voyager/modules/consensus directory to finality and updates all related package names and references to better reflect their actual functionality.

Why

As identified in issue #4374, the current "consensus" naming is a legacy artifact from an earlier design. These modules now only provide information about finality rather than handling the full consensus process. This renaming improves code clarity and removes potential confusion for developers.

Implementation Details

  • Renamed directory: voyager/modules/consensus → finality
  • Updated package names in all module Cargo.toml files:
    • voyager-consensus-module-Xvoyager-finality-module-X
  • Updated all references to these modules throughout the codebase
  • Updated trait names and related implementations where applicable

Modules Affected

  • arbitrum
  • berachain
  • bob
  • cometbls
  • ethereum
  • movement
  • tendermint
  • trusted-evm

@marvelshan marvelshan requested a review from benluelo as a code owner May 23, 2025 09:33
Copy link

vercel bot commented May 23, 2025

@marvelshan is attempting to deploy a commit to the unionbuild Team on Vercel.

A member of the Team first needs to authorize it.

@cor
Copy link
Contributor

cor commented May 23, 2025

Hey @marvelshan , can you please ensure ci passes?

@marvelshan
Copy link
Contributor Author

Sure! I'll take a look and make sure CI passes. Thanks for the heads-up!

@benluelo
Copy link
Contributor

you'll need to run cargo check to update the Cargo.lock. also please rename the traits as we discussed in the issue

@marvelshan marvelshan changed the title refactor: rename voyager/modules/consensus to voyager/modules/finality refactor(voyager): rename consensus modules to finality modules May 23, 2025
@marvelshan marvelshan marked this pull request as draft May 23, 2025 15:24
@marvelshan marvelshan force-pushed the rename-voyager-consensus-to-finality-modules branch 3 times, most recently from 4edee78 to b4247ed Compare May 23, 2025 18:13
@marvelshan
Copy link
Contributor Author

Hi @benluelo , I encountered a problem during the test execution in the development environment. The test consistently times out, and I noticed some recurring errors in the logs. Here are the key points:

  1. Test Timeout

    The test terminates with the message:

    timeout reached; test terminating...
    

    It seems the test is unable to complete within the expected time.

  2. DNS Resolution Errors

    I also observed multiple DNS resolution errors in the logs, such as:

    [resolver] failed to query external DNS server
    error="read udp 172.18.0.10:59231->10.0.2.3:53: i/o timeout"
    

    This suggests that the environment is unable to resolve certain domain names (e.g., redis-db).

  3. Virtual Machine Termination

    The virtual machine running the tests is being terminated with the following message:

    kill machine (pid 9)
    qemu-kvm: terminating on signal 15
    

Do you have any suggestions on where I should start looking to resolve this issue? I'm especially wondering whether this could be related to the network configuration, the DNS resolver setup, or something in the test environment that causes the VM to be killed prematurely.

Thanks in advance for your guidance!

@benluelo
Copy link
Contributor

don't worry about the CI issues for now, the timeouts etc are unrelated to this PR. you will, however, need to reword your latest commit.

@marvelshan marvelshan force-pushed the rename-voyager-consensus-to-finality-modules branch 5 times, most recently from 5dc2f71 to 86fea16 Compare May 24, 2025 11:51
@marvelshan
Copy link
Contributor Author

@benluelo Thanks so much for your help and patience. I spent some time setting up the development environment due to compatibility issues between macOS and Nix. Since I’m not very familiar with Nix, I followed the project documentation and ended up using OrbStack to create a NixOS VM. There were some hiccups during the setup—like missing dependencies and OpenSSL build errors—but I managed to resolve them eventually. I really appreciate your guidance throughout this process. I’ve learned a lot from working on this PR, and I’m truly sorry for the repeated force-pushes that kept triggering CI.

@marvelshan marvelshan marked this pull request as ready for review May 24, 2025 12:05
@benluelo
Copy link
Contributor

you need to sign all of your commits, and reword all commit messages to follow conventional commits as per our contributing guide

@marvelshan marvelshan force-pushed the rename-voyager-consensus-to-finality-modules branch from 86fea16 to 9ec15ab Compare May 24, 2025 13:08
@marvelshan
Copy link
Contributor Author

I have signed all commits and updated the commit messages.

Copy link
Contributor

@benluelo benluelo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@benluelo benluelo merged commit 90a5a1c into unionlabs:main May 24, 2025
110 of 111 checks passed
@marvelshan
Copy link
Contributor Author

marvelshan commented May 25, 2025

@benluelo Hi, I’ve just completed this issue and the related PR. I’m interested in learning more about the Union project and would love to continue contributing. I noticed there are some issues tagged as Easy and also saw the current issue @unionlabs/union/issues/4360. Do you have any recommendations on which issues I should work on next, or is it fine to pick any that interest me? If there are any issues you think would be especially suitable for someone new to the project, I’d appreciate your suggestions. Thank you!

@benluelo
Copy link
Contributor

4360 is a good simple one if you're interested. i'll write more of an explanation in the issue

@marvelshan
Copy link
Contributor Author

Thanks. Appreciate it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

rename voyager consensus modules to finality modules
3 participants