Skip to content

vanity move address #1229

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.

Sign up for GitHub

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

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

vanity move address #1229

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
7e445e8
vanity move address
Primata May 14, 2025
51575dd
specify flag issue
Primata May 14, 2025
efdf8ae
Update util/vanity/README.md
Primata May 14, 2025
7ae6945
workspace deps
Primata May 14, 2025
31a1cc2
fix: works in nix
Primata May 14, 2025
22584ae
Merge branch 'vanity-address' of https://github.com/movementlabsxyz/m…
Primata May 14, 2025
2785ce8
fix: tracing
Primata May 14, 2025
b5085df
revert tracing
Primata May 15, 2025
7066565
add cli tests
Primata May 19, 2025
dc4edb5
feat: vanity resource address
Primata May 21, 2025
76a8442
chore: cargo fmt
andygolay May 21, 2025
ca8b748
fix: refactor according to liam's desire
Primata May 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
300 changes: 149 additions & 151 deletions util/vanity/src/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,186 +1,184 @@
use std::{ops::Deref, str::FromStr};
use clap::{Parser, Subcommand};
use std::{ops::Deref, str::FromStr};

/// Pattern type for hex string filtering.
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Pattern(Box<str>);

impl Deref for Pattern {
type Target = str;
type Target = str;

fn deref(&self) -> &Self::Target {
&self.0
}
fn deref(&self) -> &Self::Target {
&self.0
}
}

impl Pattern {
/// Return the raw hex string without trying to decode it.
pub fn as_str(&self) -> &str {
&self.0
}
/// Return the raw hex string without trying to decode it.
pub fn as_str(&self) -> &str {
&self.0
}
}

/// Pattern parsing errors.
#[derive(Clone, Copy, Debug, PartialEq, Eq, thiserror::Error)]
pub enum PatternError {
#[error("the pattern's length exceeds 39 characters or the pattern is empty")]
InvalidPatternLength,
#[error("the pattern is not in hexadecimal format")]
NonHexPattern,
#[error("the pattern's length exceeds 39 characters or the pattern is empty")]
InvalidPatternLength,
#[error("the pattern is not in hexadecimal format")]
NonHexPattern,
}

impl FromStr for Pattern {
type Err = PatternError;

fn from_str(s: &str) -> Result<Self, Self::Err> {
if s.len() >= 40 || s.is_empty() {
return Err(PatternError::InvalidPatternLength);
}
if s.chars().any(|c| !c.is_ascii_hexdigit()) {
return Err(PatternError::NonHexPattern);
}
Ok(Self(s.into()))
}
type Err = PatternError;

fn from_str(s: &str) -> Result<Self, Self::Err> {
if s.len() >= 40 || s.is_empty() {
return Err(PatternError::InvalidPatternLength);
}
if s.chars().any(|c| !c.is_ascii_hexdigit()) {
return Err(PatternError::NonHexPattern);
}
Ok(Self(s.into()))
}
}

/// CLI definition for the `vanity` tool.
#[derive(Parser, Debug)]
#[command(name = "vanity", about = "Vanity is a fast vanity address miner.")]
pub struct Cli {
#[command(subcommand)]
pub command: Vanity,
#[command(subcommand)]
pub command: Vanity,
}

/// Supported CLI subcommands.
#[derive(Debug, Subcommand)]
pub enum Vanity {
Move {
#[clap(long)]
starts: Option<String>,
#[clap(long)]
ends: Option<String>,
},
Resource {
#[clap(long)]
address: Option<String>,
#[clap(long)]
starts: Option<String>,
#[clap(long)]
ends: Option<String>,
},
Move {
#[clap(long)]
starts: Option<String>,
Copy link
Contributor

Choose a reason for hiding this comment

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

You probably want to invalidate the case where both --starts and --ends are None. You can either do this in the implementation or use ArgGroup.

Copy link
Contributor

Choose a reason for hiding this comment

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

You're still not invalidating this case. Is there a reason you don't want to do this?

#[clap(long)]
ends: Option<String>,
},
Resource {
#[clap(long)]
address: Option<String>,
#[clap(long)]
starts: Option<String>,
#[clap(long)]
ends: Option<String>,
},
}

#[cfg(test)]
mod tests {
use super::{Cli, Pattern, Vanity};
use std::str::FromStr;
use clap::Parser;
use assert_cmd::Command;

#[test]
fn test_valid_pattern() {
let p = Pattern::from_str("abcd").unwrap();
assert_eq!(&*p, "abcd");
}

#[test]
fn test_cli_parsing_starts() {
let cli = Cli::parse_from([
"vanity",
"move",
"--starts",
"abcd",
]);
match cli.command {
Vanity::Move { starts, ends } => {
assert_eq!(starts, Some("abcd".to_string()));
assert_eq!(ends, None);
}
_ => panic!("Expected Move variant"),
}
}

#[test]
fn test_resource_parsing_starts() {
let cli = Cli::parse_from([
"vanity",
"resource",
"--address",
"0x5e04c2f5bf1a89d3431d2c047626acbba41c900a69b10e7c24e5b919802c531f",
"--starts",
"abcd",
]);
match cli.command {
Vanity::Resource { address, starts, ends } => {
assert_eq!(address, Some("0x5e04c2f5bf1a89d3431d2c047626acbba41c900a69b10e7c24e5b919802c531f".to_string()));
assert_eq!(starts, Some("abcd".to_string()));
assert_eq!(ends, None);
}
_ => panic!("Expected Resource variant"),
}
}

#[test]
fn test_cli_runs_with_starts() {
let mut cmd = Command::cargo_bin("vanity").unwrap();
let assert = cmd.args(&["move", "--starts", "de"]).assert().success();

let output = String::from_utf8(assert.get_output().stdout.clone()).unwrap();
let address_line = output.lines().find(|l| l.contains("Found Move address:")).unwrap();
let address = address_line.split(':').nth(1).unwrap().trim().trim_start_matches("0x");

assert!(address.starts_with("de"), "Address does not start with 'de': {}", address);
}

#[test]
fn test_cli_runs_with_ends() {
let mut cmd = Command::cargo_bin("vanity").unwrap();
let assert = cmd.args(&["move", "--ends", "f0"]).assert().success();

let output = String::from_utf8(assert.get_output().stdout.clone()).unwrap();
let address_line = output.lines().find(|l| l.contains("Found Move address:")).unwrap();
let address = address_line.split(':').nth(1).unwrap().trim().trim_start_matches("0x");

assert!(address.ends_with("f0"), "Address does not end with 'f0': {}", address);
}

#[test]
fn test_cli_runs_with_starts_and_ends() {
let mut cmd = Command::cargo_bin("vanity").unwrap();
let assert = cmd
.args(&["move", "--starts", "de", "--ends", "f0"])
.assert()
.success();

let output = String::from_utf8(assert.get_output().stdout.clone()).unwrap();
let address_line = output.lines().find(|l| l.contains("Found Move address:")).unwrap();
let address = address_line.split(':').nth(1).unwrap().trim().trim_start_matches("0x");

assert!(address.starts_with("de"), "Address does not start with 'de': {}", address);
assert!(address.ends_with("f0"), "Address does not end with 'f0': {}", address);
}

#[test]
fn test_resource_runs_with_starts_and_ends() {
let mut cmd = Command::cargo_bin("vanity").unwrap();
let assert = cmd
.args(&[
"resource",
"--address",
"0x5e04c2f5bf1a89d3431d2c047626acbba41c900a69b10e7c24e5b919802c531f",
"--starts",
"de",
"--ends",
"f0",
])
.assert()
.success();

let output = String::from_utf8(assert.get_output().stdout.clone()).unwrap();
let address_line = output.lines().find(|l| l.contains("Found Resource Address:")).unwrap();
let address = address_line.split(':').nth(1).unwrap().trim().trim_start_matches("0x");

assert!(address.starts_with("de"), "Address does not start with 'de': {}", address);
assert!(address.ends_with("f0"), "Address does not end with 'f0': {}", address);
}
use super::{Cli, Pattern, Vanity};
use assert_cmd::Command;
use clap::Parser;
use std::str::FromStr;

#[test]
fn test_valid_pattern() {
let p = Pattern::from_str("abcd").unwrap();
assert_eq!(&*p, "abcd");
}

#[test]
fn test_cli_parsing_starts() {
let cli = Cli::parse_from(["vanity", "move", "--starts", "abcd"]);
match cli.command {
Vanity::Move { starts, ends } => {
assert_eq!(starts, Some("abcd".to_string()));
assert_eq!(ends, None);
}
_ => panic!("Expected Move variant"),
}
}

#[test]
fn test_resource_parsing_starts() {
let cli = Cli::parse_from([
"vanity",
"resource",
"--address",
"0x5e04c2f5bf1a89d3431d2c047626acbba41c900a69b10e7c24e5b919802c531f",
"--starts",
"abcd",
]);
match cli.command {
Vanity::Resource { address, starts, ends } => {
assert_eq!(
address,
Some(
"0x5e04c2f5bf1a89d3431d2c047626acbba41c900a69b10e7c24e5b919802c531f"
.to_string()
)
);
assert_eq!(starts, Some("abcd".to_string()));
assert_eq!(ends, None);
}
_ => panic!("Expected Resource variant"),
}
}

#[test]
fn test_cli_runs_with_starts() {
let mut cmd = Command::cargo_bin("vanity").unwrap();
let assert = cmd.args(&["move", "--starts", "de"]).assert().success();

let output = String::from_utf8(assert.get_output().stdout.clone()).unwrap();
let address_line = output.lines().find(|l| l.contains("Found Move address:")).unwrap();
let address = address_line.split(':').nth(1).unwrap().trim().trim_start_matches("0x");

assert!(address.starts_with("de"), "Address does not start with 'de': {}", address);
}

#[test]
fn test_cli_runs_with_ends() {
let mut cmd = Command::cargo_bin("vanity").unwrap();
let assert = cmd.args(&["move", "--ends", "f0"]).assert().success();

let output = String::from_utf8(assert.get_output().stdout.clone()).unwrap();
let address_line = output.lines().find(|l| l.contains("Found Move address:")).unwrap();
let address = address_line.split(':').nth(1).unwrap().trim().trim_start_matches("0x");

assert!(address.ends_with("f0"), "Address does not end with 'f0': {}", address);
}

#[test]
fn test_cli_runs_with_starts_and_ends() {
let mut cmd = Command::cargo_bin("vanity").unwrap();
let assert = cmd.args(&["move", "--starts", "de", "--ends", "f0"]).assert().success();

let output = String::from_utf8(assert.get_output().stdout.clone()).unwrap();
let address_line = output.lines().find(|l| l.contains("Found Move address:")).unwrap();
let address = address_line.split(':').nth(1).unwrap().trim().trim_start_matches("0x");

assert!(address.starts_with("de"), "Address does not start with 'de': {}", address);
assert!(address.ends_with("f0"), "Address does not end with 'f0': {}", address);
}

#[test]
fn test_resource_runs_with_starts_and_ends() {
let mut cmd = Command::cargo_bin("vanity").unwrap();
let assert = cmd
.args(&[
"resource",
"--address",
"0x5e04c2f5bf1a89d3431d2c047626acbba41c900a69b10e7c24e5b919802c531f",
"--starts",
"de",
"--ends",
"f0",
])
.assert()
.success();

let output = String::from_utf8(assert.get_output().stdout.clone()).unwrap();
let address_line = output.lines().find(|l| l.contains("Found Resource Address:")).unwrap();
let address = address_line.split(':').nth(1).unwrap().trim().trim_start_matches("0x");

assert!(address.starts_with("de"), "Address does not start with 'de': {}", address);
assert!(address.ends_with("f0"), "Address does not end with 'f0': {}", address);
}
}
Loading
Loading