Go to file
Daira-Emma Hopwood 500d3912ec
Merge pull request #19 from zcash/nu6-protocol-version
Updates for NU6 mainnet activation
2024-11-23 11:45:40 +00:00
.github/workflows Create CI - release-docker-hub.yaml (#18) 2024-10-02 08:06:05 -06:00
.gitignore
CHANGELOG.md Add `CHANGELOG.md`. 2024-08-27 17:37:18 +01:00
Dockerfile ADD docker support (#17) 2024-09-24 19:34:21 -06:00
Makefile
README Update README 2023-04-05 10:41:08 -04:00
bitcoin.cpp Merge remote-tracking branch 'bitcoin/master' into upstream-changes 2021-06-24 00:18:33 +01:00
bitcoin.h
combine.pl
compat.h
db.cpp
db.h Bump required protocol version now that NU6 has activated on mainnet 2024-11-23 11:09:31 +00:00
dns.cpp
dns.h
entrypoint.sh ADD docker support (#17) 2024-09-24 19:34:21 -06:00
main.cpp Merge pull request #10 from zcash/upstream-changes 2021-10-01 17:36:59 -07:00
netbase.cpp
netbase.h
protocol.cpp Merge remote-tracking branch 'bitcoin/master' into upstream-changes 2021-06-24 00:18:33 +01:00
protocol.h Disable default filters for services Zcash doesn't (yet) have 2021-06-24 00:22:18 +01:00
serialize.h Bump protocol version for NU6 2024-11-23 10:44:30 +00:00
strlcpy.h
test.pl
uint256.h
util.cpp
util.h

README

zcash-seeder
==============

Zcash-seeder is a crawler for the Zcash network, which exposes a list
of reliable nodes via a built-in DNS server.

Features:
* regularly revisits known nodes to check their availability
* bans nodes after enough failures, or bad behaviour
* accepts nodes down to v0.3.19 to request new IP addresses from,
  but only reports good post-v0.3.24 nodes.
* keeps statistics over (exponential) windows of 2 hours, 8 hours,
  1 day and 1 week, to base decisions on.
* very low memory (a few tens of megabytes) and cpu requirements.
* crawlers run in parallel (by default 24 threads simultaneously).

REQUIREMENTS
------------

$ sudo apt-get install build-essential libboost-all-dev libssl-dev

USAGE
-----

Assuming you want to run a dns seed on dnsseed.example.com, you will
need an authorative NS record in example.com's domain record, pointing
to for example vps.example.com:

$ dig -t NS dnsseed.example.com

;; ANSWER SECTION
dnsseed.example.com.   86400    IN      NS     vps.example.com.

On the system vps.example.com, you can now run dnsseed:

./dnsseed -h dnsseed.example.com -n vps.example.com

If you want the DNS server to report SOA records, please provide an
e-mail address (with the @ part replaced by .) using -m.

COMPILING
---------
Compiling will require boost and ssl.  On debian systems, these are provided
by `libboost-dev` and `libssl-dev` respectively.

$ make

This will produce the `dnsseed` binary.


RUNNING AS NON-ROOT
-------------------

Typically, you'll need root privileges to listen to port 53 (name service).

One solution is using an iptables rule (Linux only) to redirect it to
a non-privileged port:

$ iptables -t nat -A PREROUTING -p udp --dport 53 -j REDIRECT --to-port 5353

If properly configured, this will allow you to run dnsseed in userspace, using
the -p 5353 option.

Another solution is allowing a binary to bind to ports < 1024 with setcap (IPv6 access-safe)

$ setcap 'cap_net_bind_service=+ep' /path/to/dnsseed