Skip to content
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

refactor(cli)!: break address tool out of cli #1803

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

SuperFluffy
Copy link
Member

@SuperFluffy SuperFluffy commented Nov 12, 2024

Summary

Moves the sequencer address subcommand out of the CLI into a new astria-address tool.

Background

Normal users should never have to deal with the raw hex-formatted address bytes derived from an ed25519 verification key. This functionality was (erroneously) added to astria-cli as a power user tool when migrating from the old Astria address format to the new bech32m based one.

Changes

  • Remove subcommand sequencer address from astria cli.
  • Provide a thin tools/astria-address binary with expanded functionality (also allowing to constract compat/bech32 non-m addresses).

Testing

Added integration tests for running astria-address with various options.

Added a github job to test the utility.

Changelogs

Changelogs updated.

Breaking Changelist

  • This is a breaking change for astria-cli for users relying on the sequencer address subcommand.

@SuperFluffy SuperFluffy force-pushed the superfluffy/break-out-bech32m branch from 5503c05 to 39d10c4 Compare November 12, 2024 10:41
@github-actions github-actions bot added the ci issues that are related to ci and github workflows label Nov 12, 2024
@SuperFluffy SuperFluffy added cli pertaining to the cli refactor code refactoring or maintainence blocked blocked on another PR, dependency, or missing feature labels Nov 12, 2024
@SuperFluffy
Copy link
Member Author

Currently gated on #1802 being merged into main.

@SuperFluffy SuperFluffy force-pushed the superfluffy/break-out-bech32m branch from e455742 to ee01a01 Compare November 12, 2024 13:00
@SuperFluffy SuperFluffy requested review from Fraser999 and noot and removed request for noot November 12, 2024 13:01
@SuperFluffy SuperFluffy marked this pull request as ready for review November 12, 2024 13:08
@SuperFluffy SuperFluffy requested review from a team, joroshiba and noot as code owners November 12, 2024 13:08
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we need a changelog if this is not a crate/binary which we expect to publish or to be consumed by third-parties.

@SuperFluffy SuperFluffy force-pushed the ENG-1003/address-to-crate branch from c1ce512 to 0b37986 Compare November 20, 2024 14:57
Base automatically changed from ENG-1003/address-to-crate to main November 20, 2024 17:14
@github-actions github-actions bot added the sequencer pertaining to the astria-sequencer crate label Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked blocked on another PR, dependency, or missing feature ci issues that are related to ci and github workflows cli pertaining to the cli refactor code refactoring or maintainence sequencer pertaining to the astria-sequencer crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants