btc-crawl/btc-crawl.go

// TODO: Namespace packages properly (outside of `main`)
// TODO: Apply peer-age filter to results?
package main

import (
	"encoding/json"
	"fmt"
	"io/ioutil"
	"os"
	"time"

	"github.com/alexcesaro/log"
	"github.com/alexcesaro/log/golog"
	"github.com/jessevdk/go-flags"
)

// Taken from: https://github.com/bitcoin/bitcoin/blob/89d72f3d9b6e7ef051ad1439f266b809f348229b/src/chainparams.cpp#L143
var defaultDnsSeeds = []string{
	"seed.bitcoin.sipa.be",
	"dnsseed.bluematt.me",
	"dnsseed.bitcoin.dashjr.org",
	"seed.bitcoinstats.com",
	"seed.bitnodes.io",
	"bitseed.xf2.org",
}

type Options struct {
	Verbose     []bool        `short:"v" long:"verbose" description:"Show verbose logging."`
	Output      string        `short:"o" long:"output" description:"File to write result to." default:"btc-crawl.json"`
	Seed        []string      `short:"s" long:"seed" description:"Override which seeds to use." default-mask:"<bitcoin-core DNS seeds>"`
	Concurrency int           `short:"c" long:"concurrency" description:"Maximum number of concurrent connections to open." default:"10"`
	UserAgent   string        `short:"A" long:"user-agent" description:"Client name to advertise while crawling. Should be in format of '/name:x.y.z/'." default:"/btc-crawl:0.1.1/"`
	PeerAge     time.Duration `long:"peer-age" description:"Ignore discovered peers older than this." default:"24h"`
	StopAfter   int           `long:"stop-after" description:"Stop crawling after this many results." default:"0"`
}

var logLevels = []log.Level{
	log.Warning,
	log.Info,
	log.Debug,
}

func main() {
	now := time.Now()
	options := Options{}
	parser := flags.NewParser(&options, flags.Default)

	p, err := parser.Parse()
	if err != nil {
		if p == nil {
			fmt.Print(err)
		}
		return
	}

	// Figure out the log level
	numVerbose := len(options.Verbose)
	if numVerbose > len(logLevels) { // lol math.Min, you floaty bugger.
		numVerbose = len(logLevels)
	}

	logLevel := logLevels[numVerbose]
	logger = golog.New(os.Stderr, logLevel)

	seedNodes := options.Seed
	if len(seedNodes) == 0 {
		seedNodes = GetSeedsFromDNS(defaultDnsSeeds)
	}

	client := NewClient(options.UserAgent)
	crawler := NewCrawler(client, seedNodes, options.PeerAge)
	results := crawler.Run(options.Concurrency, options.StopAfter)

	b, err := json.Marshal(results)
	if err != nil {
		logger.Errorf("Failed to export JSON: %v", err)
		return
	}

	if options.Output == "-" {
		os.Stdout.Write(b)
		return
	}

	err = ioutil.WriteFile(options.Output, b, 0644)
	if err != nil {
		logger.Errorf("Failed to write to %s: %v", options.Output, err)
		return
	}

	logger.Infof("Written %d results after %s: %s", len(*results), time.Now().Sub(now), options.Output)
}