{
"repo": "hyperswarm-seeders",
"timestamp": "2026-01-16T23:39:52.972Z",
"entryPoint": "index.js",
"exports": {
"packageJson": {
"main": "index.js"
}
},
"api": {
"file": "index.js",
"exports": [
{
"type": "default",
"name": "class"
}
],
"classes": [
{
"name": "MutableRecord"
},
{
"name": "SeederSwarm"
}
],
"functions": [
{
"name": "pause"
},
{
"name": "retry"
}
]
},
"readme": {
"content": "# @hyperswarm/seeders\n\nA seeders only swarm, verified by a mutable record\n\n```\nnpm install @hyperswarm/seeders\n```\n\nNote that the list of seeds are stored in a verifiable record in the DHT,\nmeaning no one can spoof it, but other people can read it.\n\n## Usage\n\n``` js\nconst Seeders = require('@hyperswarm/seeders')\n\nconst swarm = new Seeders(firstSeedPublicKey, {\n dht, // optional dht new to use\n keyPair, // optional key pair to use, defaults to dht.defaultKeyPair\n maxClientConnections // how many connections to make to the seed, defaults to 2\n})\n\nswarm.on('connection', function (connection) {\n console.log('got connection...')\n})\n\n// if you are the first seed, add more seeds by passing a record\nif (swarm.owner) {\n await swarm.join({\n seeds: [\n publicKey1,\n publicKey2,\n ...\n ],\n // optionally add info about the hypercore being seeded\n core: {\n length: 42,\n fork: 0\n }\n })\n} else {\n await swarm.join()\n}\n```\n\n## License\n\nApache-2.0\n",
"sections": [
"intro",
"usage",
"license"
],
"hasApi": true,
"hasExamples": true,
"exampleCount": 1,
"examples": [
"npm install @hyperswarm/seeders"
]
},
"patterns": [
"append-only-log",
"peer-discovery",
"dht-discovery",
"binary-encoding"
]
}