# @caldera-network/dns-seeder

> Scans a network for active full nodes and stores their IP's in Cloudflare DNS

Latest version **1.0.2** (published 2021-08-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @caldera-network/dns-seeder
pnpm add @caldera-network/dns-seeder
yarn add @caldera-network/dns-seeder
bun add @caldera-network/dns-seeder
```

Provides the command `dns-seeder`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2021-08-23 |
| First published | 2021-08-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 26 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Caldera Network |
| Maintainers | deafwave |
| Keywords | caldera, chia, cryptocurrency, blockchain, dns, seeder |

## Links

- npm: https://www.npmjs.com/package/@caldera-network/dns-seeder
- Repository: https://github.com/caldera-network/dns-seeder
- Homepage: https://github.com/caldera-network/dns-seeder#readme
- Issues: https://github.com/caldera-network/dns-seeder/issues
- npm.io page: https://npm.io/package/@caldera-network/dns-seeder

## Dependencies (8)

- [conf](https://npm.io/package/conf.md) ^10.0.2
- [axios](https://npm.io/package/axios.md) ^0.21.1
- [is-ip](https://npm.io/package/is-ip.md) ^3.1.0
- [commander](https://npm.io/package/commander.md) ^8.1.0
- [configstore](https://npm.io/package/configstore.md) ^6.0.0
- [node-schedule](https://npm.io/package/node-schedule.md) ^2.0.0
- [update-notifier](https://npm.io/package/update-notifier.md) ^5.1.0
- [@caldera-network/chia-network-scanner](https://npm.io/package/@caldera-network/chia-network-scanner.md) ^6.0.4

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2021-08-23
- 1.0.1 — 2021-08-23
- 1.0.0 — 2021-08-09

## README

# DNS Seeder

Routlinely scans a Chia Blockchain Algorithm Network and stores data in Cloudflare, allowing Chia forks to increase stability and futureproof their blockchains by utilizing DNS Seeders.

## Donate

[Coinbase](https://commerce.coinbase.com/checkout/5ed151a5-4d24-4dd9-9d1e-8f31648dd271)

XCH: `xch1jhp9n6h30qmqjknmldd3y4948325npfkfs6f7jn8v3u8cgw5ykks9zlvae`

## Usage

### Install

1. `npm i -g @caldera-network/dns-seeder`

### Commands
| Name              | Description |
|:---               | :---        |
| `dns-seeder start` | Executes The Scan & Upload |
| `dns-seeder setup` | Displays Config FilePath |


## Configuration

### Cloudflare API Token & Zone ID (Pick One)

1. Config File
    - `apiToken`
    - `zoneId`
1. Environment Variables
    - `CLOUDFLARE_TOKEN`
    - `CLOUDFLARE_ZONE`
1. `dns-seeder start --apiToken <API Token> --zoneId <Zone ID>`

- API Token
    - Create a token on your profile (https://dash.cloudflare.com/profile/api-tokens)
    - Permissions of `Edit zone DNS` with at least one Zone Resource
- Zone ID
    - Must be included in your API Token's Zone Resources
    - Can be found at the bottom right of your websites' cloudflare dashboard (`https://dash.cloudflare.com/\<Account ID\>/\<Domain\>`)

### [Network Scanner](https://github.com/Caldera-Network/chia-network-scanner#usage)

| Key              | Description |
|:---               | :---        |
| `networkId` | e.g. `mainnet` or `testnet7` |
| `startNodes` | Array of reliable nodes to start from |
| `connectionTimeout` | Used to timeout on various operations such as handshake |
| `concurrency` | Number of peers to scan concurrently. Bigger is faster but uses more sockets and memory |
| `keyPath` | Full node public key |
| `certPath` | Full node public cert |

---

### Default Config
```
{
    schedule: '*/30 * * * *',
    cloudflare: {
        apiToken: '',
        zoneId: '',
    },
    startNodes: [
        { hostname: '1.1.1.1', port: 8620 },
        { hostname: '2.2.2.2', port: 8620 },
        { hostname: '3.3.3.3', port: 8620 },
    ],
    network: {
        networkId: 'mainnet',
        protocolVersion: '0.0.0',
        softwareVersion: '0.0.0',
    },
    peer: {
        nodeType: 1,
    },
    connectionTimeout: 2500,
    concurrency: 50,
    certPath: '/root/.caldera/mainnet/config/ssl/ca/caldera_ca.crt',
    keyPath: '/root/.caldera/mainnet/config/ssl/ca/caldera_ca.key',
}
```

---
_Source: https://npm.io/package/@caldera-network/dns-seeder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._