Skip to content
CloudFlare-enabled DNS seeder for the Litecoin Cash network
Branch: master
Clone or download
Pull request Compare This branch is 15 commits ahead of sipa:master.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cf-uploader
.gitignore
Makefile
README
bitcoin.cpp
bitcoin.h
combine.pl Better combination formula Apr 18, 2012
compat.h
db.cpp Improve filter whitelist Jun 7, 2016
db.h Fixes for testnet Nov 23, 2018
dns.c Add support to filter nodes by node flags May 27, 2016
dns.h
main.cpp
netbase.cpp Merge pull request sipa#19 Jul 29, 2015
netbase.h Merge pull request sipa#19 Jul 29, 2015
protocol.cpp Ported for Litecoin Cash Feb 26, 2018
protocol.h
serialize.h Ported for Litecoin Cash Feb 26, 2018
strlcpy.h
test.pl IPv6/AAAA record support May 25, 2012
uint256.h
util.cpp
util.h fix logging May 25, 2012

README

Litecoin Cash Seeder
====================

litecoincash-seeder is a crawler for the Litecoin Cash network, which 
exposes a list of reliable nodes via a built-in DNS server, or instead
just generates that list to push to a remote CloudFlare server.

Features:
* CloudFlare DNS integration
* 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: LOCAL DNS SERVER MODE
----------------------------

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.


USAGE: CLOUDFLARE API MODE
--------------------------

Have the seeder above running all the time, but with no NS record.

Fill in CloudFlare API config and have the CloudFlare upload run on a
cron job.


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.
You can’t perform that action at this time.