vanity-miner 0.1.0

A blazing-fast, minimalistic vanity address miner for smart contract deployment, optimized for portability, perfect for client-side just-in-time (JIT) address mining.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# Vanity Miner

A blazing-fast, minimalistic vanity address miner for common smart contract deployment patterns. Written in Rust and optimized for portability, perfect for just-in-time (JIT) address mining directly on the client-side in environments like WebAssembly (WASM).

## Motivation

This project was born out of the need for a client-side JIT vanity address miner for contract deployments from a web app.

Instead of pre-mining salts and securing them behind APIs and captchas, **Vanity Miner** offers a simpler, more decentralized alternative: a miner optimized for the client-side which can run directly in the user's browser. One bonus point to this approach is that the mining process itself serves as a lightweight Proof-of-Work (POW), effectively acting as its own captcha while providing a seamless user experience.

## Supported Use-cases

The following use-cases are supported:

- **CREATE2**: Direct CREATE2 address with prefix/suffix/contains patterns
- **CREATE3**: CREATE3 address deployed via [CreateX](https://github.com/pcaversaccio/createx/)
- **Uniswap V4 Hooks**: Uniswap V4 hook address with permission flags
- **EulerSwap**: EulerSwap address with pool parameters

## Performance

Finding a 4-character hex prefix typically takes less than a second, even in a browser.

## Tradeoffs

Vanity Miner prioritizes **broad portability** and **ease of integration**, especially in WebAssembly environments. For this reason, it is CPU-based and written in pure Rust.

If your only goal is to find the absolute most complex vanity address with maximum efficiency, a GPU-accelerated tool like [**createXcrunch**](https://github.com/HrikB/createXcrunch/) may be a better fit.

## Installation

### As a Rust library

```toml
[dependencies]
vanity-miner = "0.1.0"
```

### For WebAssembly

```bash
# Install wasm-pack if you haven't already
curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh

# Build the WASM package
wasm-pack build --target web

# The generated `pkg/` directory contains the WASM module and JS bindings
```

## API Reference

### Mining Functions

All CreateX mining functions support three pattern matching modes:

- `mine_*_salt_with_prefix(config, prefix)` - Match addresses starting with the given prefix in a `u8` array
- `mine_*_salt_with_suffix(config, suffix)` - Match addresses ending with the given suffix in a `u8` array
- `mine_*_salt_with_contains(config, contains)` - Match addresses containing the given sequence in a `u8` array

Available for:

- CREATE2: `mine_create2_salt_*`
- CREATE3: `mine_create3_salt_*`

The Uniswap V4 hook mining function is a wrapper around the `mine_create2_salt_with_suffix` function, with the suffix defined by the permission flags.

The EulerSwap mining function is a wrapper around the Uniswap V4 hook mining function.

All public functions are also available in WASM as `wasm_mine_*`.

### Configuration Structures

- `Create2Config` - Configuration for CREATE2 mining
- `Create3Config` - Configuration for CREATE3 mining (via CreateX)
- `V4HookConfig` - Configuration for Uniswap V4 hook address mining
- `EulerSwapConfig` - Configuration for EulerSwap address mining

All configurations support:

- `max_iterations` - Maximum mining iterations before stopping
- `max_results` - Maximum number of matching results to find
- `seed` - Optional seed for deterministic mining

## Contributing

Contributions are welcome! Please feel free to open an issue or submit a pull request.

The project currently uses the `keccak256` implementation from [Alloy](https://crates.io/crates/alloy-primitives). A significant performance improvement could be achieved by implementing a custom version that supports partial hash computation for more efficient prefix matching.