diff options
Diffstat (limited to 'src/readme.txt')
| -rw-r--r-- | src/readme.txt | 28 |
1 files changed, 26 insertions, 2 deletions
diff --git a/src/readme.txt b/src/readme.txt index 6af1694..455884c 100644 --- a/src/readme.txt +++ b/src/readme.txt | |||
| @@ -16,7 +16,7 @@ This product includes software developed by the OpenSSL Project. | |||
| 16 | Differences from the original Bitcoin | 16 | Differences from the original Bitcoin |
| 17 | ------------------------------------- | 17 | ------------------------------------- |
| 18 | - Own genesis block (22/Jul/2026 headline, independent chain) | 18 | - Own genesis block (22/Jul/2026 headline, independent chain) |
| 19 | - Own magic bytes (0xbf 0x1a 0x5c 0xfd) and P2P port 8433 | 19 | - Own magic bytes (0xbf 0x20 0x5c 0xfd) and P2P port 8433 |
| 20 | - Addresses start with "B" (ADDRESSVERSION = 25) | 20 | - Addresses start with "B" (ADDRESSVERSION = 25) |
| 21 | - Consensus fixes applied: value overflow (CVE-2010-5139), duplicate inputs, | 21 | - Consensus fixes applied: value overflow (CVE-2010-5139), duplicate inputs, |
| 22 | money range checks (MoneyRange) | 22 | money range checks (MoneyRange) |
| @@ -41,21 +41,45 @@ The resulting executable is src/bitflash.exe. | |||
| 41 | 41 | ||
| 42 | Command-line options (in addition to the original ones) | 42 | Command-line options (in addition to the original ones) |
| 43 | ------------------------------------------------------- | 43 | ------------------------------------------------------- |
| 44 | /port=N listen on P2P port N (default 8433) | 44 | /testnet use isolated test network genesis, datadir, port 18433, and message magic |
| 45 | /port=N listen on P2P port N (default 8433; testnet default 18433) | ||
| 46 | /socks=HOST:PORT | ||
| 47 | route outbound Nostr, .btf rendezvous, and direct onion peer | ||
| 48 | dials through a SOCKS5 proxy, e.g. /socks=127.0.0.1:9050 for local Tor | ||
| 49 | or /socks=[::1]:9050 for an IPv6 loopback proxy | ||
| 50 | /tor[=HOST:PORT] | ||
| 51 | Tor mode for outbound Nostr, .btf rendezvous, and direct onion peer dials; | ||
| 52 | defaults to the local Tor SOCKS5 proxy at 127.0.0.1:9050 | ||
| 53 | /managedtor[=PATH] | ||
| 54 | start Tor, create a v3 hidden service for this node, route outbound | ||
| 55 | discovery through it, and advertise the generated onion endpoint | ||
| 56 | Windows release packages that include tor/tor.exe start this mode | ||
| 57 | automatically; use /nomanagedtor to force the legacy relay path | ||
| 45 | /solomine mine without requiring a connected peer (local testing) | 58 | /solomine mine without requiring a connected peer (local testing) |
| 46 | /operator operator mode (run pool server) | 59 | /operator operator mode (run pool server) |
| 47 | /participant=ADDR | 60 | /participant=ADDR |
| 48 | participant mode; mine to pool .btf address ADDR | 61 | participant mode; mine to pool .btf address ADDR |
| 62 | /stratumbridge=ADDR | ||
| 63 | listen on 127.0.0.1:3333 and bridge external Stratum miners | ||
| 64 | to pool .btf address ADDR | ||
| 65 | /stratumbridgeport=N | ||
| 66 | local Stratum bridge port (default 3333) | ||
| 49 | /poolname=NAME operator announcement pool name | 67 | /poolname=NAME operator announcement pool name |
| 50 | /poolfee=PCT operator announcement fee percent (example: 0.75) | 68 | /poolfee=PCT operator announcement fee percent (example: 0.75) |
| 51 | /pooldashboard=URL | 69 | /pooldashboard=URL |
| 52 | operator announcement dashboard URL | 70 | operator announcement dashboard URL |
| 71 | /poolstatusfile=PATH | ||
| 72 | write pool status JSON for dashboards | ||
| 73 | /poolroundsfile=PATH | ||
| 74 | write public pool round proofs JSON | ||
| 53 | /connectbtf=ADDR | 75 | /connectbtf=ADDR |
| 54 | keep an outbound .btf connection to ADDR | 76 | keep an outbound .btf connection to ADDR |
| 55 | /rvrelay=HOST:PORT | 77 | /rvrelay=HOST:PORT |
| 56 | override meeting relay list with one relay | 78 | override meeting relay list with one relay |
| 57 | /announcerelay=HOST:PORT | 79 | /announcerelay=HOST:PORT |
| 58 | announce this relay on Nostr for discovery | 80 | announce this relay on Nostr for discovery |
| 81 | /onionservice=HOST.onion:PORT | ||
| 82 | advertise this node's Tor hidden service in its signed .btf descriptor | ||
| 59 | 83 | ||
| 60 | 84 | ||
| 61 | Roadmap | 85 | Roadmap |