upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/src/readme.txt
diff options
context:
space:
mode:
authorbitflash-maintainer <noreply@bitflash.invalid>2026-09-06 01:53:03 +0000
committerbitflash-maintainer <noreply@bitflash.invalid>2026-09-06 01:53:03 +0000
commitef9f06d43fc6577c15df2256abbb25b20d4227b8 (patch)
tree7e9132aa871fdc01cb95268d2f5ea3bb11853ddf /src/readme.txt
parentbe63e83d79e7e00e6b8ca889a70e6a19886aa1d8 (diff)
parentceae3d076b5ad11ee84729ae43f14e9312896646 (diff)
Merge branch 'chore/main-catchup-2026-08-26' into 'main'HEADmain
Bring main onto the line this project actually ships (incl. the 1.2.23 compactblock port) Closes #6, #7, #8, #11, #35, #34, #29, #28, #27, and #16 See merge request !16
Diffstat (limited to 'src/readme.txt')
-rw-r--r--src/readme.txt28
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.
16Differences from the original Bitcoin 16Differences 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
42Command-line options (in addition to the original ones) 42Command-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
61Roadmap 85Roadmap