Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robertDurst/stellar-vanity-address-generator
Generate Stellar Vanity Wallets
https://github.com/robertDurst/stellar-vanity-address-generator
blockchain rust stellar vanity-address
Last synced: 3 months ago
JSON representation
Generate Stellar Vanity Wallets
- Host: GitHub
- URL: https://github.com/robertDurst/stellar-vanity-address-generator
- Owner: robertDurst
- License: mit
- Created: 2018-03-21T08:31:56.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-11-23T05:50:56.000Z (almost 3 years ago)
- Last Synced: 2024-07-06T23:02:59.689Z (4 months ago)
- Topics: blockchain, rust, stellar, vanity-address
- Language: Rust
- Homepage: https://crates.io/crates/stellar_vanity
- Size: 40 KB
- Stars: 23
- Watchers: 2
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-stellar - Stellar Vanity Address Generator - A simple CLI tool to generate custom Stellar vanity addresses. (Developer Resources)
- awesome-stellar-cn - Stellar Vanity Address Generator - 一个简单的 CLI 工具，用于生成自定义 Stellar 虚荣地址。 (开发者资源)
README
# Stellar Vanity
A simple CLI tool to generate Stellar vanity addresses.
**Vanity Address:** similar to a vanity license plate, a vanity cryptocurrency address is an
address where either the beginning (prefix) or end (postfix) is a special or meaningful phrase.
Generating such an address requires work.
## Benchmarking
Benchmarking is performed by using [criterion.rs](https://github.com/bheisler/criterion.rs) via `cargo bench`, which executes the `benches/benchmark.rs` file.
## How can I Benchmark?
Ah, thanks so much! I have limited computing power (if you do too... do not attempt, will likely be long and costly)
1. `git clone https://github.com/robertDurst/stellar-vanity-address-generator.git`
2. `cd stellar-vanity-address-generator`
3. `cargo bench`
**Benchmark Configurations:**
* as many threads as possible (see note below)
* varied samples per method
* 1 - 3 prefixes
**Note:** this uses `num_cpus::get()` from [num_cpus](https://docs.rs/num_cpus/1.13.0/num_cpus/) to determine the maximum number of cores availible. If that is not desired, you'll have to dig in and set this number manually... or open a pr if you know how to pass CLI args to `cargo bench` :)
## How to use library:
```
use stellar_vanity::vanity_key::AddressGenerator, deserialize_public_key};;
let mut generator: AddressGenerator = Default::default();
let keypair = generator.find(|key| {
let public = deserialize_public_key(key);
// any conditions go here
public.as_str().ends_with("RUST") // e.g. find address with the "RUST" suffix
});
```
This will continuously loop until a key with the desired properties is found. Once the vanity address is found, a keypair will be returned, which may be deserialized with `deserialize_public_key` and `deserialize_private_key` respectively. Note, this is a synchronous function.
## How to use CLI:
```
cargo run -- [--postfix=] [--prefix=] [-c=]
Either `--postfix` or `--prefix` option is required, while thread count is optional.
```
As an example, the following looks for an address ending in pizza with 8 threads:
```
cargo run -- -c=8 --postfix=pizza
```
The `--prefix` and `--postfix` options will search using RegEx expressions. You may need to enclose the expression in quotes when running from the command-line.
The following looks for an address ending in joe with a number before it, using 8 threads:
```
cargo run -- -c=8 --postfix='[0-9]joe'
```