Class DandelionMesh<T>

DandelionMesh — a fault-tolerant P2P mesh network for browser applications.

Combines three layers:

Transport (default: PeerJS) — handles peer-to-peer WebRTC connections.
Crypto — RSA-OAEP + AES-256-GCM hybrid encryption for private messages.
Raft consensus — leader election and totally-ordered log replication.

All application messages (public broadcasts and encrypted private messages) flow through the Raft log, guaranteeing every peer sees the same events in the same order. Non-leader peers forward proposals to the current leader.

Events

Event	Payload	When
`ready`	`localPeerId: string`	Transport is open and Raft has started
`message`	`MeshMessage<T>, replay: boolean`	A committed log entry is delivered
`peersChanged`	`peers: string[]`	A peer connects or disconnects
`leaderChanged`	`leaderId: string \| null`	Raft leader changes
`error`	`Error`	Transport-level error

Example

const transport = new PeerJSTransport({ peerId: 'alice' });
const mesh = new DandelionMesh<GameAction>(transport, {
  bootstrapPeers: ['bob', 'charlie'],
});

mesh.on('ready', (id) => console.log('My ID:', id));
mesh.on('message', (msg) => {
  if (msg.type === 'public')  console.log(msg.sender, msg.data);
  if (msg.type === 'private') console.log('secret from', msg.sender);
});

await mesh.sendPublic({ action: 'bet', amount: 100 });
await mesh.sendPrivate('bob', { cards: ['Ah', 'Kd'] });

Example

Providing a pre-generated crypto key bundle

const bundle = await generateKeyBundle(2048);
const mesh = new DandelionMesh(transport, { cryptoKeyBundle: bundle });

Type Parameters

T = unknown

The application-level payload type for messages.

Hierarchy

DandelionMesh

Constructors

constructor

new DandelionMesh<T>(transport, options?): DandelionMesh<T>
Type Parameters
- T = unknown
Parameters
- transport: Transport
- Optional options: DandelionMeshOptions
Returns DandelionMesh<T>
- Defined in mesh/DandelionMesh.ts:122

Properties

`Private` `Readonly` bootstrapPeers

bootstrapPeers: string[]

`Private` cryptoBundle

cryptoBundle: CryptoKeyBundle = null

`Private` `Readonly` cryptoReady

cryptoReady: Promise<CryptoKeyBundle>

`Private` lastAppliedIndex

lastAppliedIndex: number = 0

`Private` `Readonly` listeners

listeners: ListenerMap<T> = ...

`Private` localPeerId

localPeerId: string

`Private` `Readonly` modulusLength

modulusLength: number

`Private` `Readonly` peerPublicKeys

peerPublicKeys: Map<string, Promise<CryptoKey>> = ...

`Private` `Readonly` pendingKeyWaiters

pendingKeyWaiters: Map<string, ((key) => void)[]> = ...

`Private` `Readonly` raftLog

raftLog: RaftLog<MeshLogCommand<T>>

`Private` raftNode

raftNode: RaftNode<MeshLogCommand<T>> = null

`Private` `Readonly` raftOptions

raftOptions: RaftNodeOptions

`Private` `Readonly` transport

transport: Transport

Accessors

isLeader

get isLeader(): boolean
Whether this node is the Raft leader

Returns boolean
- Defined in mesh/DandelionMesh.ts:216

leaderId

get leaderId(): string
Get the current Raft leader ID

Returns string
- Defined in mesh/DandelionMesh.ts:211

peerId

get peerId(): string
The local peer ID (available after 'ready')

Returns string
- Defined in mesh/DandelionMesh.ts:221

peers

get peers(): string[]
Get all connected peer IDs (including self)

Returns string[]
- Defined in mesh/DandelionMesh.ts:204

Methods

close

close(): void
Shut down the mesh: stop Raft, close transport

Returns void
- Defined in mesh/DandelionMesh.ts:242

`Private` emit

emit<E>(event, ...args): void
Type Parameters
- E extends keyof DandelionMeshEvents<T>
Parameters
- event: E
- Rest ...args: Parameters<DandelionMeshEvents<T>[E]>
Returns void
- Defined in mesh/DandelionMesh.ts:484

`Private` getOrAwaitPublicKey

getOrAwaitPublicKey(peerId): Promise<CryptoKey>
Parameters
- peerId: string
Returns Promise<CryptoKey>
- Defined in mesh/DandelionMesh.ts:460

`Private` handleControlMessage

handleControlMessage(msg): void
Parameters
- msg: MeshControlMessage<T>
Returns void
- Defined in mesh/DandelionMesh.ts:323

`Private` handleEncryptedCommit

handleEncryptedCommit(cmd, isReplay): Promise<void>
Parameters
- cmd: EncryptedPrivateMessage
- isReplay: boolean
Returns Promise<void>
- Defined in mesh/DandelionMesh.ts:383

off

off<E>(event, listener): void
Remove an event listener
Type Parameters
- E extends keyof DandelionMeshEvents<T>
Parameters
- event: E
- listener: DandelionMeshEvents<T>[E]
Returns void
- Defined in mesh/DandelionMesh.ts:234

on

on<E>(event, listener): void
Register an event listener
Type Parameters
- E extends keyof DandelionMeshEvents<T>
Parameters
- event: E
- listener: DandelionMeshEvents<T>[E]
Returns void
- Defined in mesh/DandelionMesh.ts:226

`Private` onPeerConnected

onPeerConnected(_remotePeerId): void
Parameters
- _remotePeerId: string
Returns void
- Defined in mesh/DandelionMesh.ts:292

`Private` onPeerDisconnected

onPeerDisconnected(_remotePeerId): void
Parameters
- _remotePeerId: string
Returns void
- Defined in mesh/DandelionMesh.ts:298

`Private` onRaftCommitted

onRaftCommitted(entry, index): void
Parameters
- entry: LogEntry<MeshLogCommand<T>>
- index: number
Returns void
- Defined in mesh/DandelionMesh.ts:337

`Private` onTransportError

onTransportError(error): void
Parameters
- error: Error
Returns void
- Defined in mesh/DandelionMesh.ts:317

`Private` onTransportMessage

onTransportMessage(fromPeerId, data): void
Parameters
- fromPeerId: string
- data: unknown
Returns void
- Defined in mesh/DandelionMesh.ts:303

`Private` onTransportOpen

onTransportOpen(peerId): void
Parameters
- peerId: string
Returns void
- Defined in mesh/DandelionMesh.ts:254

`Private` proposePublicKey

proposePublicKey(): Promise<void>
Returns Promise<void>
- Defined in mesh/DandelionMesh.ts:418

sendPrivate

sendPrivate(recipientPeerId, data): Promise<boolean>
Send an encrypted private message through the Raft cluster
Parameters
- recipientPeerId: string
- data: T
Returns Promise<boolean>
- Defined in mesh/DandelionMesh.ts:176

sendPublic

sendPublic(data): Promise<boolean>
Send a public (broadcast) message through the Raft cluster
Parameters
- data: T
Returns Promise<boolean>
- Defined in mesh/DandelionMesh.ts:153

`Private` wireMessage

wireMessage(channel, payload): WireMessage
Parameters
- channel: "raft" | "control"
- payload: unknown
Returns WireMessage
- Defined in mesh/DandelionMesh.ts:477

Class DandelionMesh<T>

Events

Example

Example

Type Parameters

T = unknown

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T = unknown

Parameters

transport: Transport

Optional options: DandelionMeshOptions

Returns DandelionMesh<T>

Properties

Private Readonly bootstrapPeers

Private cryptoBundle

Private Readonly cryptoReady

Private lastAppliedIndex

Private Readonly listeners

Private localPeerId

Private Readonly modulusLength

Private Readonly peerPublicKeys

Private Readonly pendingKeyWaiters

Private Readonly raftLog

Private raftNode

Private Readonly raftOptions

Private Readonly transport

Accessors

isLeader

Returns boolean

leaderId

Returns string

peerId

Returns string

peers

Returns string[]

Methods

close

Returns void

Private emit

Type Parameters

E extends keyof DandelionMeshEvents<T>

Parameters

event: E

Rest ...args: Parameters<DandelionMeshEvents<T>[E]>

Returns void

Private getOrAwaitPublicKey

Parameters

peerId: string

Returns Promise<CryptoKey>

Private handleControlMessage

Parameters

msg: MeshControlMessage<T>

Returns void

Private handleEncryptedCommit

Parameters

cmd: EncryptedPrivateMessage

isReplay: boolean

Returns Promise<void>

off

Type Parameters

E extends keyof DandelionMeshEvents<T>

Parameters

event: E

listener: DandelionMeshEvents<T>[E]

Returns void

on

Type Parameters

E extends keyof DandelionMeshEvents<T>

Parameters

event: E

listener: DandelionMeshEvents<T>[E]

Returns void

`Optional` options: DandelionMeshOptions

`Private` `Readonly` bootstrapPeers

`Private` cryptoBundle

`Private` `Readonly` cryptoReady

`Private` lastAppliedIndex

`Private` `Readonly` listeners

`Private` localPeerId

`Private` `Readonly` modulusLength

`Private` `Readonly` peerPublicKeys

`Private` `Readonly` pendingKeyWaiters

`Private` `Readonly` raftLog

`Private` raftNode

`Private` `Readonly` raftOptions

`Private` `Readonly` transport

`Private` emit

`Rest` ...args: Parameters<DandelionMeshEvents<T>[E]>

`Private` getOrAwaitPublicKey

`Private` handleControlMessage

`Private` handleEncryptedCommit

`Private` onPeerConnected

`Private` onPeerDisconnected

`Private` onRaftCommitted

`Private` onTransportError

`Private` onTransportMessage

`Private` onTransportOpen

`Private` proposePublicKey

`Private` wireMessage