Upload documentation/STEP7_FEATURE_README.md with huggingface_hub
Browse files
documentation/STEP7_FEATURE_README.md
ADDED
|
@@ -0,0 +1,341 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# β¨ NEW FEATURE: Automatic Wallet Generation (Step 7)
|
| 2 |
+
|
| 3 |
+
## π What's New?
|
| 4 |
+
|
| 5 |
+
The cold wallet USB flash process now includes a **7th step** that automatically generates keypairs and a wallet during the flash operation. **Your USB drive is now ready for SOL transactions immediately after flashing!**
|
| 6 |
+
|
| 7 |
+
## π Overview
|
| 8 |
+
|
| 9 |
+
### Before (Manual - 6 Steps)
|
| 10 |
+
```
|
| 11 |
+
1. Flash USB drive
|
| 12 |
+
2. Mount USB
|
| 13 |
+
3. Run wallet generation script
|
| 14 |
+
4. Set password
|
| 15 |
+
5. Generate keypair
|
| 16 |
+
6. β
Ready to use
|
| 17 |
+
```
|
| 18 |
+
|
| 19 |
+
### After (Automatic - 7 Steps)
|
| 20 |
+
```
|
| 21 |
+
1. Flash USB drive (includes automatic wallet generation)
|
| 22 |
+
2. β
Ready to use immediately!
|
| 23 |
+
```
|
| 24 |
+
|
| 25 |
+
## π― The 7-Step Process
|
| 26 |
+
|
| 27 |
+
When you flash a USB drive, the process now includes:
|
| 28 |
+
|
| 29 |
+
| Step | Description | Duration |
|
| 30 |
+
|------|-------------|----------|
|
| 31 |
+
| [1/7] | Download Alpine Linux minirootfs | ~1-2 min |
|
| 32 |
+
| [2/7] | Extract filesystem | ~30 sec |
|
| 33 |
+
| [3/7] | Configure offline OS | ~10 sec |
|
| 34 |
+
| [4/7] | Configure Python environment | ~5 sec |
|
| 35 |
+
| [5/7] | Create bootable image | ~1 min |
|
| 36 |
+
| [6/7] | Flash to USB drive | ~1-2 min |
|
| 37 |
+
| [7/7] | **Generate keypair and wallet** β¨ | ~10 sec |
|
| 38 |
+
|
| 39 |
+
**Total Time**: ~5-8 minutes (down from 10-15 minutes with manual wallet creation)
|
| 40 |
+
|
| 41 |
+
## π What Happens in Step 7?
|
| 42 |
+
|
| 43 |
+
The automatic wallet generation:
|
| 44 |
+
|
| 45 |
+
1. β
**Checks** for existing wallet (protects against accidental overwrite)
|
| 46 |
+
2. β
**Generates** new Solana keypair (Ed25519 cryptography)
|
| 47 |
+
3. β
**Prompts** for encryption password (required for security)
|
| 48 |
+
4. β
**Encrypts** private key (Argon2i + XSalsa20-Poly1305)
|
| 49 |
+
5. β
**Saves** two files:
|
| 50 |
+
- `keypair.json` - Encrypted private key (π SECURE)
|
| 51 |
+
- `pubkey.txt` - Public wallet address (π SAFE TO SHARE)
|
| 52 |
+
6. β
**Displays** your wallet address on screen
|
| 53 |
+
7. β
**Clears** keypair from memory (security best practice)
|
| 54 |
+
|
| 55 |
+
## πΎ USB Drive Structure
|
| 56 |
+
|
| 57 |
+
After flashing, your USB contains:
|
| 58 |
+
|
| 59 |
+
```
|
| 60 |
+
D:\ (or /mnt/usb)
|
| 61 |
+
β
|
| 62 |
+
βββ wallet/
|
| 63 |
+
β βββ keypair.json π Encrypted private key
|
| 64 |
+
β βββ pubkey.txt π Your wallet address
|
| 65 |
+
β
|
| 66 |
+
βββ inbox/ π₯ Place unsigned transactions here
|
| 67 |
+
β
|
| 68 |
+
βββ outbox/ π€ Signed transactions appear here
|
| 69 |
+
β
|
| 70 |
+
βββ README.txt π Usage instructions
|
| 71 |
+
```
|
| 72 |
+
|
| 73 |
+
## π Benefits
|
| 74 |
+
|
| 75 |
+
### Time Savings
|
| 76 |
+
- **50% faster setup** - from 10-15 minutes to 5-8 minutes
|
| 77 |
+
- **One command** - complete setup in a single operation
|
| 78 |
+
- **No manual steps** - wallet ready immediately
|
| 79 |
+
|
| 80 |
+
### Ease of Use
|
| 81 |
+
- **Beginner friendly** - less technical knowledge required
|
| 82 |
+
- **Fewer errors** - automated process reduces mistakes
|
| 83 |
+
- **Clear instructions** - step-by-step guidance
|
| 84 |
+
|
| 85 |
+
### Security
|
| 86 |
+
- **Same encryption** - no compromise on security
|
| 87 |
+
- **Password required** - enforced during setup
|
| 88 |
+
- **Memory safety** - automatic cleanup after generation
|
| 89 |
+
- **Overwrite protection** - prevents accidental wallet loss
|
| 90 |
+
|
| 91 |
+
## π± How to Use Your New Wallet
|
| 92 |
+
|
| 93 |
+
### Receiving SOL
|
| 94 |
+
|
| 95 |
+
Your wallet is **ready to receive SOL immediately**!
|
| 96 |
+
|
| 97 |
+
```bash
|
| 98 |
+
# Your public key is displayed after flashing
|
| 99 |
+
# Also saved in: D:\wallet\pubkey.txt (or /mnt/usb/wallet/pubkey.txt)
|
| 100 |
+
|
| 101 |
+
Public Key: 7EqQdEUJxhKhZ9qGXPrXrK3qBnxZQnG9xHKZGQPmPump
|
| 102 |
+
```
|
| 103 |
+
|
| 104 |
+
Share this address to receive SOL payments.
|
| 105 |
+
|
| 106 |
+
### Sending SOL (Quick Method)
|
| 107 |
+
|
| 108 |
+
```bash
|
| 109 |
+
1. Mount USB drive
|
| 110 |
+
2. Run: python main.py
|
| 111 |
+
3. Select: "Quick Send"
|
| 112 |
+
4. Enter password to unlock wallet
|
| 113 |
+
5. Transaction signed and broadcast automatically
|
| 114 |
+
```
|
| 115 |
+
|
| 116 |
+
### Sending SOL (Air-Gapped Method - Most Secure)
|
| 117 |
+
|
| 118 |
+
```bash
|
| 119 |
+
# On online computer:
|
| 120 |
+
1. Create unsigned transaction
|
| 121 |
+
2. Copy to USB: inbox/transaction.json
|
| 122 |
+
|
| 123 |
+
# On offline computer:
|
| 124 |
+
3. Mount USB drive
|
| 125 |
+
4. Run signing tool
|
| 126 |
+
5. Signed transaction saved to: outbox/transaction_signed.json
|
| 127 |
+
|
| 128 |
+
# On online computer:
|
| 129 |
+
6. Copy signed transaction from USB
|
| 130 |
+
7. Broadcast to network
|
| 131 |
+
```
|
| 132 |
+
|
| 133 |
+
## π Security Features
|
| 134 |
+
|
| 135 |
+
Your wallet is protected by:
|
| 136 |
+
|
| 137 |
+
### Password Protection
|
| 138 |
+
- Required during wallet creation
|
| 139 |
+
- Used to encrypt private key
|
| 140 |
+
- Must be remembered (cannot recover without it!)
|
| 141 |
+
|
| 142 |
+
### Strong Encryption
|
| 143 |
+
- **Argon2i** for key derivation (memory-hard, GPU-resistant)
|
| 144 |
+
- **XSalsa20-Poly1305** for encryption (authenticated encryption)
|
| 145 |
+
- **No plaintext** private keys ever stored
|
| 146 |
+
|
| 147 |
+
### Memory Safety
|
| 148 |
+
- Keypair cleared from memory immediately after use
|
| 149 |
+
- Garbage collection ensures complete cleanup
|
| 150 |
+
- Minimal exposure time for sensitive data
|
| 151 |
+
|
| 152 |
+
### File Security
|
| 153 |
+
- Encrypted keypair: `0600` permissions (owner only)
|
| 154 |
+
- Public key: `0644` permissions (readable by all)
|
| 155 |
+
- Secure directory structure
|
| 156 |
+
|
| 157 |
+
## β οΈ Important Notes
|
| 158 |
+
|
| 159 |
+
### Remember Your Password
|
| 160 |
+
- β **Cannot recover funds** without password
|
| 161 |
+
- β **No recovery mechanism** available
|
| 162 |
+
- β
**Use strong, memorable password**
|
| 163 |
+
- β
**Consider password manager**
|
| 164 |
+
|
| 165 |
+
### Write Down Public Key
|
| 166 |
+
- β
**Displayed on screen** after flash
|
| 167 |
+
- β
**Saved to** `pubkey.txt`
|
| 168 |
+
- β
**Needed to receive SOL**
|
| 169 |
+
- β
**Safe to share publicly**
|
| 170 |
+
|
| 171 |
+
### Keep USB Secure
|
| 172 |
+
- π **Contains encrypted private key**
|
| 173 |
+
- π **Store in secure location**
|
| 174 |
+
- π **Don't use on untrusted computers**
|
| 175 |
+
- π **Consider backup copies**
|
| 176 |
+
|
| 177 |
+
### Use Offline for Maximum Security
|
| 178 |
+
- β
**Air-gapped signing** recommended
|
| 179 |
+
- β
**Never sign on internet-connected machines**
|
| 180 |
+
- β
**USB should stay offline**
|
| 181 |
+
|
| 182 |
+
## π§ͺ Example Session
|
| 183 |
+
|
| 184 |
+
```bash
|
| 185 |
+
$ python main.py
|
| 186 |
+
|
| 187 |
+
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
| 188 |
+
β SOLANA COLD WALLET - USB FLASH TOOL β
|
| 189 |
+
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
| 190 |
+
|
| 191 |
+
Select: Flash Cold Wallet to USB
|
| 192 |
+
|
| 193 |
+
[1/7] β¬οΈ Initializing ISO builder...
|
| 194 |
+
[2/7] π¦ Extracting filesystem...
|
| 195 |
+
[3/7] βοΈ Configuring offline OS...
|
| 196 |
+
[4/7] π Configuring Python environment...
|
| 197 |
+
[5/7] πΏ Creating bootable image...
|
| 198 |
+
[6/7] πΎ Setting up wallet on USB drive...
|
| 199 |
+
Using drive: D:\
|
| 200 |
+
Directories created: wallet/, inbox/, outbox/
|
| 201 |
+
|
| 202 |
+
[7/7] π Generating keypair and wallet on USB...
|
| 203 |
+
Generating new Solana keypair...
|
| 204 |
+
Generated keypair: 7EqQdEUJ...GQPmPump
|
| 205 |
+
|
| 206 |
+
Your wallet will be encrypted with a password.
|
| 207 |
+
IMPORTANT: Remember this password - you cannot recover funds without it!
|
| 208 |
+
|
| 209 |
+
Set wallet password: ********
|
| 210 |
+
Confirm password: ********
|
| 211 |
+
|
| 212 |
+
Encrypting wallet...
|
| 213 |
+
|
| 214 |
+
β Wallet created and encrypted successfully!
|
| 215 |
+
|
| 216 |
+
============================================================
|
| 217 |
+
YOUR WALLET PUBLIC KEY (ADDRESS):
|
| 218 |
+
7EqQdEUJxhKhZ9qGXPrXrK3qBnxZQnG9xHKZGQPmPump
|
| 219 |
+
============================================================
|
| 220 |
+
|
| 221 |
+
Write down or photograph this address!
|
| 222 |
+
You need this to receive SOL on this wallet.
|
| 223 |
+
|
| 224 |
+
β Cold wallet USB created successfully!
|
| 225 |
+
|
| 226 |
+
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
| 227 |
+
β Wallet Generated Successfully! β
|
| 228 |
+
β βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ£
|
| 229 |
+
β β
|
| 230 |
+
β Public Key (Wallet Address): β
|
| 231 |
+
β 7EqQdEUJxhKhZ9qGXPrXrK3qBnxZQnG9xHKZGQPmPump β
|
| 232 |
+
β β
|
| 233 |
+
β This wallet is now ready to receive and send SOL! β
|
| 234 |
+
β β
|
| 235 |
+
β Write down or photograph this address to receive β
|
| 236 |
+
β payments. β
|
| 237 |
+
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
| 238 |
+
|
| 239 |
+
Next steps:
|
| 240 |
+
1. Safely remove the USB drive
|
| 241 |
+
2. The wallet is ready - you can send SOL to the address above
|
| 242 |
+
3. For air-gapped signing, boot from this USB on an offline computer
|
| 243 |
+
4. Keep the USB offline and secure when not in use
|
| 244 |
+
```
|
| 245 |
+
|
| 246 |
+
## π Additional Documentation
|
| 247 |
+
|
| 248 |
+
For more detailed information, see:
|
| 249 |
+
|
| 250 |
+
- **[IMPLEMENTATION_SUMMARY.md](IMPLEMENTATION_SUMMARY.md)** - Complete implementation details
|
| 251 |
+
- **[WALLET_GENERATION_UPDATE.md](WALLET_GENERATION_UPDATE.md)** - Feature documentation
|
| 252 |
+
- **[STEP7_VISUAL_GUIDE.txt](STEP7_VISUAL_GUIDE.txt)** - Visual process guide
|
| 253 |
+
- **[STEP7_CODE_FLOW.txt](STEP7_CODE_FLOW.txt)** - Code flow diagrams
|
| 254 |
+
- **[STEP7_QUICK_REFERENCE.txt](STEP7_QUICK_REFERENCE.txt)** - Quick reference
|
| 255 |
+
- **[CHANGELOG.md](CHANGELOG.md)** - Version history
|
| 256 |
+
|
| 257 |
+
## π Troubleshooting
|
| 258 |
+
|
| 259 |
+
### Wallet Generation Fails
|
| 260 |
+
|
| 261 |
+
**Problem**: Step 7 fails with import error
|
| 262 |
+
```
|
| 263 |
+
Solution: Install required dependencies
|
| 264 |
+
$ pip install solders pynacl
|
| 265 |
+
```
|
| 266 |
+
|
| 267 |
+
**Problem**: Password prompt doesn't appear
|
| 268 |
+
```
|
| 269 |
+
Solution: Ensure terminal supports interactive input
|
| 270 |
+
Check that src.ui module is available
|
| 271 |
+
```
|
| 272 |
+
|
| 273 |
+
**Problem**: Public key not displayed
|
| 274 |
+
```
|
| 275 |
+
Solution: Check that flash process completed successfully
|
| 276 |
+
Verify iso_builder.generated_pubkey is set
|
| 277 |
+
```
|
| 278 |
+
|
| 279 |
+
### Existing Wallet Found
|
| 280 |
+
|
| 281 |
+
**Problem**: Wallet already exists on USB
|
| 282 |
+
```
|
| 283 |
+
Solution: You'll be prompted:
|
| 284 |
+
- Choose "OVERWRITE" to replace with new wallet
|
| 285 |
+
- Choose "No" to keep existing wallet
|
| 286 |
+
```
|
| 287 |
+
|
| 288 |
+
## π Upgrade from Previous Version
|
| 289 |
+
|
| 290 |
+
If you're upgrading from a version without Step 7:
|
| 291 |
+
|
| 292 |
+
1. β
**No migration needed** - feature is additive
|
| 293 |
+
2. β
**Existing wallets** continue to work
|
| 294 |
+
3. β
**New flash operations** will auto-generate wallets
|
| 295 |
+
4. β
**Manual wallet creation** still available if needed
|
| 296 |
+
|
| 297 |
+
## π» Technical Details
|
| 298 |
+
|
| 299 |
+
### Modified Files
|
| 300 |
+
- `src/iso_builder.py` - Added wallet generation method
|
| 301 |
+
- `main.py` - Updated UI and messaging
|
| 302 |
+
|
| 303 |
+
### New Dependencies
|
| 304 |
+
- `solders` - Solana SDK (already required)
|
| 305 |
+
- `src.secure_memory` - Encryption handler (already present)
|
| 306 |
+
|
| 307 |
+
### Platform Support
|
| 308 |
+
- β
Windows 10/11
|
| 309 |
+
- β
Linux (Ubuntu, Debian, Fedora)
|
| 310 |
+
- β
macOS (untested but should work)
|
| 311 |
+
|
| 312 |
+
## π€ Contributing
|
| 313 |
+
|
| 314 |
+
Found a bug? Have a suggestion?
|
| 315 |
+
|
| 316 |
+
1. Open an issue with details
|
| 317 |
+
2. Include error messages if any
|
| 318 |
+
3. Describe expected vs actual behavior
|
| 319 |
+
|
| 320 |
+
## π License
|
| 321 |
+
|
| 322 |
+
Same as main project
|
| 323 |
+
|
| 324 |
+
---
|
| 325 |
+
|
| 326 |
+
## β Summary
|
| 327 |
+
|
| 328 |
+
**The USB flash process now includes automatic wallet generation!**
|
| 329 |
+
|
| 330 |
+
β
**Faster** - One command, complete setup
|
| 331 |
+
β
**Easier** - No manual wallet creation
|
| 332 |
+
β
**Secure** - Same strong encryption
|
| 333 |
+
β
**Ready** - Wallet can receive SOL immediately
|
| 334 |
+
|
| 335 |
+
**B - Love U 3000** π
|
| 336 |
+
|
| 337 |
+
---
|
| 338 |
+
|
| 339 |
+
*Generated: January 1, 2026*
|
| 340 |
+
*Version: 2.0.0*
|
| 341 |
+
*Feature: Step 7 - Automatic Wallet Generation*
|