Skip to content

Commit 7516b99

Browse files
committed
Update readme and license file
1 parent ca47736 commit 7516b99

File tree

5 files changed

+71
-40
lines changed

5 files changed

+71
-40
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Hamza Aid @ TokensHive
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 44 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,23 @@ Generate wallets whose public keys match an optional prefix and/or suffix, encry
1010
- Periodic progress stats per worker.
1111
- AES-256 OpenPGP symmetric encryption of the JSON output file.
1212
- Decryption command to recover the clear JSON.
13-
+
14-
+## Leet Similarity Mapping
15-
+
16-
+When using `-similar`, characters are considered equivalent to these visually similar substitutions:
17-
+| Character | Similar Characters |
18-
+|-----------|--------------------|
19-
+| a | 4 |
20-
+| b | 8, 6 |
21-
+| e | 3 |
22-
+| g | 6, 9 |
23-
+| i | 1, l |
24-
+| l | 1, i |
25-
+| o | 0 |
26-
+| s | 5, z |
27-
+| t | 7 |
28-
+| z | 2 |
13+
14+
## Leet Similarity Mapping
15+
16+
When using `-similar`, characters are considered equivalent to these visually similar substitutions:
17+
18+
| Character | Similar Characters |
19+
|-----------|--------------------|
20+
| a | 4 |
21+
| b | 8, 6 |
22+
| e | 3 |
23+
| g | 6, 9 |
24+
| i | 1, l |
25+
| l | 1, i |
26+
| o | 0 |
27+
| s | 5, z |
28+
| t | 7 |
29+
| z | 2 |
2930

3031
## Requirements
3132

@@ -69,6 +70,7 @@ Flags:
6970
- `-ignore-case` Ignore letter case when matching prefix/suffix
7071
- `-similar` Accept visually similar chars (leet substitutions)
7172
- `-timeout duration` Maximum search duration (e.g., `10s`, `1m`, `2h`); cancels search and saves any found wallets before exit
73+
- `-pass string` Passphrase (unsafe on CLI; prefer setting `HIVE_WALLET_PASSPHRASE` env var)
7274

7375
Examples:
7476

@@ -81,28 +83,33 @@ Examples:
8183

8284
# Generate wallets for up to 1 minute; saves any found wallets before timeout
8385
./hive-wallet new -prefix HIVE -timeout 1m
84-
+
85-
+# Advanced Examples
86-
+```bash
87-
+# Multi-prefix list, match any of the three prefixes:
88-
+./hive-wallet new -n 3 -prefix HIVE,ETH,SOL
89-
+
90-
+# Multi-suffix list, match any of the two suffixes:
91-
+./hive-wallet new -n 2 -suffix abc,xyz
92-
+
93-
+# Combine multiple prefixes and suffixes:
94-
+./hive-wallet new -n 1 -prefix HIVE,ETH -suffix AAA,BBB
95-
+
96-
+# Case-insensitive + leet similarity with lists:
97-
+./hive-wallet new -prefix h1v3,swap -ignore-case -similar
98-
+
99-
+# Generate for up to 30 seconds, saving any found wallets before timeout:
100-
+./hive-wallet new -prefix HIVE -timeout 30s
101-
+```
10286
```
10387

104-
You will be prompted to set and confirm a passphrase (min 8 characters).
105-
A status line prints every 5 seconds per worker, and each found wallet is logged immediately.
88+
<!-- Example: hive-wallet in action -->
89+
![Screenshot of hive-wallet running](docs/example.png)
90+
91+
```bash
92+
# Advanced Examples
93+
94+
# Multi-prefix list, match any of the three prefixes:
95+
./hive-wallet new -n 3 -prefix HIVE,ETH,SOL
96+
97+
# Multi-suffix list, match any of the two suffixes:
98+
./hive-wallet new -n 2 -suffix abc,xyz
99+
100+
# Combine multiple prefixes and suffixes:
101+
./hive-wallet new -n 1 -prefix HIVE,ETH -suffix AAA,BBB
102+
103+
# Case-insensitive + leet similarity with lists:
104+
./hive-wallet new -prefix h1v3,swap -ignore-case -similar
105+
106+
# Generate for up to 30 seconds, saving any found wallets before timeout:
107+
./hive-wallet new -prefix HIVE -timeout 30s
108+
```
109+
110+
A passphrase is required before writing the encrypted file.
111+
You may supply it non-interactively via `-pass` or the `HIVE_WALLET_PASSPHRASE` environment variable;
112+
otherwise you will be prompted to set and confirm one (min 8 characters).
106113

107114
### Decrypt file (`decrypt`)
108115

@@ -114,6 +121,7 @@ Flags:
114121

115122
- `-in string` Encrypted input file (default `wallets.json.gpg`)
116123
- `-out string` Decrypted JSON output file (stdout if omitted)
124+
- `-pass string` Passphrase (or set `HIVE_WALLET_PASSPHRASE` to avoid prompt)
117125

118126
Examples:
119127

docs/example.png

167 KB
Loading

go.mod

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ require (
1010
golang.org/x/term v0.29.0
1111
)
1212

13+
require github.com/stretchr/testify v1.10.0 // indirect
14+
1315
require (
1416
filippo.io/edwards25519 v1.0.0-rc.1 // indirect
1517
github.com/cloudflare/circl v1.6.0 // indirect

go.sum

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ github.com/mr-tron/base58 v1.2.0 h1:T/HDJBh4ZCPbU39/+c3rRvE0uKBQlU27+QI8LJ4t64o=
1414
github.com/mr-tron/base58 v1.2.0/go.mod h1:BinMc/sQntlIE1frQmRFPUoPA1Zkr8VRgBdjWI2mNwc=
1515
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
1616
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
17-
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
18-
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
17+
github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
18+
github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
1919
golang.org/x/crypto v0.33.0 h1:IOBPskki6Lysi0lo9qQvbxiQ+FvsCC/YWOecCHAixus=
2020
golang.org/x/crypto v0.33.0/go.mod h1:bVdXmD7IV/4GdElGPozy6U7lWdRXA4qyRVGJV57uQ5M=
2121
golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc=
2222
golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
2323
golang.org/x/term v0.29.0 h1:L6pJp37ocefwRRtYPKSWOWzOtWSxVajvz2ldH/xi3iU=
2424
golang.org/x/term v0.29.0/go.mod h1:6bl4lRlvVuDgSf3179VpIxBF0o10JUpXWOnI7nErv7s=
25-
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
26-
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
25+
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
26+
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

0 commit comments

Comments
 (0)