An open API service indexing awesome lists of open source software.

https://github.com/decred/dcrseeder

Decred Seeder
https://github.com/decred/dcrseeder

bitcoin cryptocurrency decred dns seeder

Last synced: 3 months ago
JSON representation

Decred Seeder

Awesome Lists containing this project

README

          

# dcrseeder

[![Build Status](https://github.com/decred/dcrseeder/workflows/Build%20and%20Test/badge.svg)](https://github.com/decred/dcrseeder/actions)
[![ISC License](https://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)

## Overview

dcrseeder is a crawler for the Decred network, which exposes a list of reliable
nodes via a built-in HTTP server.

When dcrseeder is started for the first time, it will connect to the dcrd node
specified in config, send a `getaddrs` request, expecting an `addr`
message response. This message contains hostnames and IPs of peers known by the
node. dcrseeder will then connect to each of these peers, send a `getaddrs`
request, and will continue traversing the network in this fashion. dcrseeder
maintains a list of all known peers and periodically checks that they are
online and available. The list is stored on disk in a json file, so on
subsequent start ups the dcrd node specified in config does not need to be
online.

When dcrseeder is queried for node information, it responds with details of a
random selection of the reliable nodes it knows about.

## Requirements

[Go](https://golang.org) 1.20 or newer.

### Getting Started

To build and install from a checked-out repo, run `go install` in the repo's
root directory.

To start dcrseeder listening on localhost:8000 with an initial connection to working testnet node 192.168.0.1:

```no-highlight
$ ./dcrseeder --testnet.enabled --testnet.seeder 192.168.0.1 --testnet.listen=localhost:8000
```

You will then need to redirect HTTPS traffic on your public IP to localhost:8000

An [example configuration file](./sample-dcrseeder.conf) lists the full set of options available.

## Issue Tracker

The [integrated github issue tracker](https://github.com/decred/dcrseeder/issues)
is used for this project.

## License

dcrseeder is licensed under the [copyfree](http://copyfree.org) ISC License.