modules/indexes-search/hyper-p2p-bloom-gossip/README.md

hyper-p2p-bloom-gossip

Probabilistic set membership filter with bloom-add gossip over Hyperswarm.

Category: indexes-search

Protocol: bloom-gossip/v1

When to use

Cheap “maybe seen” checks for peer IDs, hashes, or cache keys replicated across a swarm.

When not to use

When false positives are unacceptable without secondary verification, or when exact set membership is required locally only.

Quick start

const { HyperP2PBloomGossip } = require('hyper-p2p-bloom-gossip')
const mod = new HyperP2PBloomGossip({ topic: process.argv[2] })
await mod.ready()
mod.add('peer-abc')
console.log(mod.mightContain('peer-abc'), mod.exportBits())
await mod.close()

Docs

• docs/api.md
• docs/architecture.md
• ../../_shared/PRODUCTION.md

Test

npm install && npm test