@peerbit/pubsub 4.1.3-e38a67b → 4.1.4-000e3f1

package/README.md

@@ -1,28 +1,31 @@
-# Direct Sub
+# PubSub Transport
 
-Pubsub protocol built on top of [Direct Stream](./../stream/README.md)
+This package contains two related building blocks that both run on top of
+[`@peerbit/stream`](../stream/README.md):
 
-Features
-- Accurate
-	
-	```typescript
-	.getSubscribers(topic)
-	``` 
-	
-	method based on aggregated subscriber info, not only from immediate peers.
+## `TopicControlPlane` (`/peerbit/topic-control-plane/1.0.0`)
 
+A DirectStream-based topic membership and forwarding layer.
 
-- Efficient content routing through an approximate path finding algorithm
-	```typescript
-	.publish(data, { topics: ["a","b"]})
-	```
-	will try to find the subscribers of "a" and "b" and send messages with the shortest path in the network.
+This is useful for small to medium overlays and targeted messaging (explicit receiver
+lists) where you can tolerate subscription gossip and do not need the strict fanout
+economics of a tree.
 
-- Packet prioritization. Data packages can be sent with different priority. That allows some traffic to pass through the traffic faster than other. This is useful in case of congestion
-- Mode'd delivery. Packages can be sent with different delivery mode 'Acknowledge' (wait for acknowledgement from all known subscribers), 'Seek' (find new subscribers for a topic), 'Silent' (just deliver).
-- Redundancy in data delivery. Data packages can be sent with different redundancy. This means that you can choose to send some packages only in one path (the fastest) or send a package in the 'N' fastest paths (this gives you a redundancy degree of 'N'). This feature is useful when you want to adapt delivery for unstable networks or when you want to make sure that some messages are delivered with high probability (without waiting for Acknowledgemts and retry)
+## `FanoutTree` (`/peerbit/fanout-tree/0.5.0`)
 
+A scalable fanout tree for 1 writer to many subscribers (and tree-local unicast using
+route tokens).
 
-Protocol specification (TODO)
+This is the intended mechanism for very large audiences where you must cap per-node
+upload and avoid gossip-style explosion.
 
-Currently the protocol itself is not specificed more than as in this implementation with messages types found [here](https://github.com/dao-xyz/peerbit/blob/master/packages/transport/stream-interface/src/messages.ts) and [here](https://github.com/dao-xyz/peerbit/blob/master/packages/transport/pubsub-interface/src/messages.ts). Message handling logic can be found [here](https://github.com/dao-xyz/peerbit/blob/aa577a5e5b2b4920662de5e0efb92fb97a5dc63c/packages/transport/pubsub/src/index.ts#L502) and [here](https://github.com/dao-xyz/peerbit/blob/aa577a5e5b2b4920662de5e0efb92fb97a5dc63c/packages/transport/stream/src/index.ts#L1057).
+`FanoutChannel` is a small convenience wrapper around `FanoutTree` for channel-scoped
+usage.
+
+## `TopicRootControlPlane`
+
+A small helper to resolve a topic root from:
+
+- An explicit mapping (topic -> root)
+- A set of default candidates (deterministic choice per topic)
+- Optional trackers (if configured by the application)

package/dist/benchmark/fanout-tree-sim-lib.d.ts

@@ -0,0 +1,201 @@
+import { InMemoryNetwork } from "@peerbit/libp2p-test-utils/inmemory-libp2p.js";
+export type FanoutTreeSimParams = {
+    nodes: number;
+    rootIndex: number;
+    bootstraps: number;
+    bootstrapMaxPeers: number;
+    subscribers: number;
+    relayFraction: number;
+    messages: number;
+    msgRate: number;
+    msgSize: number;
+    intervalMs: number;
+    settleMs: number;
+    deadlineMs: number;
+    maxDataAgeMs: number;
+    timeoutMs: number;
+    seed: number;
+    topic: string;
+    rootUploadLimitBps: number;
+    rootMaxChildren: number;
+    relayUploadLimitBps: number;
+    relayMaxChildren: number;
+    allowKick: boolean;
+    bidPerByte: number;
+    bidPerByteRelay: number;
+    bidPerByteLeaf: number;
+    repair: boolean;
+    repairWindowMessages: number;
+    repairMaxBackfillMessages: number;
+    repairIntervalMs: number;
+    repairMaxPerReq: number;
+    neighborRepair: boolean;
+    neighborRepairPeers: number;
+    neighborMeshPeers: number;
+    neighborAnnounceIntervalMs: number;
+    neighborMeshRefreshIntervalMs: number;
+    neighborHaveTtlMs: number;
+    neighborRepairBudgetBps: number;
+    neighborRepairBurstMs: number;
+    streamRxDelayMs: number;
+    streamHighWaterMarkBytes: number;
+    dialDelayMs: number;
+    joinConcurrency: number;
+    joinReqTimeoutMs: number;
+    candidateShuffleTopK: number;
+    candidateScoringMode: "ranked-shuffle" | "ranked-strict" | "weighted";
+    bootstrapEnsureIntervalMs: number;
+    trackerQueryIntervalMs: number;
+    joinAttemptsPerRound: number;
+    candidateCooldownMs: number;
+    joinPhases: boolean;
+    joinPhaseSettleMs: number;
+    maxLatencySamples: number;
+    profile: boolean;
+    progress: boolean;
+    progressEveryMs: number;
+    dropDataFrameRate: number;
+    churnEveryMs: number;
+    churnDownMs: number;
+    churnFraction: number;
+    assertMinJoinedPct: number;
+    assertMinDeliveryPct: number;
+    assertMinDeadlineDeliveryPct: number;
+    assertMaxUploadFracPct: number;
+    assertMaxOverheadFactor: number;
+    assertMaxControlBpp: number;
+    assertMaxTrackerBpp: number;
+    assertMaxRepairBpp: number;
+    assertAttachP95Ms: number;
+    assertMaxTreeLevelP95: number;
+    assertMaxFormationScore: number;
+    assertMaxOrphans: number;
+    assertRecoveryP95Ms: number;
+    assertMaxReparentsPerMin: number;
+    assertMaxOrphanArea: number;
+};
+export type FanoutTreeSimResult = {
+    params: FanoutTreeSimParams;
+    bootstrapCount: number;
+    subscriberCount: number;
+    relayCount: number;
+    joinedCount: number;
+    joinedPct: number;
+    joinMs: number;
+    attachSamples: number;
+    attachP50: number;
+    attachP95: number;
+    attachP99: number;
+    attachMax: number;
+    formationTreeMaxLevel: number;
+    formationTreeLevelP95: number;
+    formationTreeLevelAvg: number;
+    formationTreeOrphans: number;
+    formationTreeChildrenP95: number;
+    formationTreeChildrenMax: number;
+    formationTreeRootChildren: number;
+    formationUnderlayEdges: number;
+    formationUnderlayDistP95: number;
+    formationUnderlayDistMax: number;
+    formationStretchP95: number;
+    formationStretchMax: number;
+    formationScore: number;
+    publishMs: number;
+    expected: number;
+    delivered: number;
+    deliveredPct: number;
+    deliveredWithinDeadline: number;
+    deliveredWithinDeadlinePct: number;
+    duplicates: number;
+    latencySamples: number;
+    latencyP50: number;
+    latencyP95: number;
+    latencyP99: number;
+    latencyMax: number;
+    droppedForwardsTotal: number;
+    droppedForwardsMax: number;
+    droppedForwardsMaxNode?: string;
+    staleForwardsDroppedTotal: number;
+    staleForwardsDroppedMax: number;
+    staleForwardsDroppedMaxNode?: string;
+    dataWriteDropsTotal: number;
+    dataWriteDropsMax: number;
+    dataWriteDropsMaxNode?: string;
+    reparentDisconnectTotal: number;
+    reparentStaleTotal: number;
+    reparentKickedTotal: number;
+    treeMaxLevel: number;
+    treeLevelP95: number;
+    treeLevelAvg: number;
+    treeOrphans: number;
+    treeChildrenP95: number;
+    treeChildrenMax: number;
+    treeRootChildren: number;
+    maxUploadBps: number;
+    maxUploadFracPct: number;
+    maxUploadNode?: string;
+    streamQueuedBytesTotal: number;
+    streamQueuedBytesMax: number;
+    streamQueuedBytesP95: number;
+    streamQueuedBytesMaxNode?: string;
+    streamQueuedBytesByLane: number[];
+    churnEvents: number;
+    churnedPeersTotal: number;
+    maintDurationMs: number;
+    maintSamples: number;
+    maintMaxOrphans: number;
+    maintOrphanArea: number;
+    maintRecoveryCount: number;
+    maintRecoveryP50Ms: number;
+    maintRecoveryP95Ms: number;
+    maintReparentsPerMin: number;
+    maintMaxReparentsPerPeer: number;
+    maintLevelP95DriftMax: number;
+    maintChildrenP95DriftMax: number;
+    overheadFactorData: number;
+    controlBpp: number;
+    trackerBpp: number;
+    repairBpp: number;
+    earningsTotal: number;
+    earningsRelayCount: number;
+    earningsRelayP50: number;
+    earningsRelayP95: number;
+    earningsRelayMax: number;
+    protocolControlSends: number;
+    protocolControlBytesSent: number;
+    protocolControlBytesSentJoin: number;
+    protocolControlBytesSentRepair: number;
+    protocolControlBytesSentTracker: number;
+    protocolControlReceives: number;
+    protocolControlBytesReceived: number;
+    protocolDataSends: number;
+    protocolDataPayloadBytesSent: number;
+    protocolDataReceives: number;
+    protocolDataPayloadBytesReceived: number;
+    protocolRepairReqSent: number;
+    protocolFetchReqSent: number;
+    protocolIHaveSent: number;
+    protocolTrackerFeedbackSent: number;
+    protocolCacheHitsServed: number;
+    protocolHoleFillsFromNeighbor: number;
+    protocolRouteCacheHits: number;
+    protocolRouteCacheMisses: number;
+    protocolRouteCacheExpirations: number;
+    protocolRouteCacheEvictions: number;
+    protocolRouteProxyQueries: number;
+    protocolRouteProxyTimeouts: number;
+    protocolRouteProxyFanout: number;
+    network: InMemoryNetwork["metrics"];
+    profile?: {
+        cpuUserMs: number;
+        cpuSystemMs: number;
+        rssMb: number;
+        heapUsedMb: number;
+        eventLoopDelayP95Ms: number;
+        eventLoopDelayMaxMs: number;
+    };
+};
+export declare const resolveFanoutTreeSimParams: (input: Partial<FanoutTreeSimParams>) => FanoutTreeSimParams;
+export declare const formatFanoutTreeSimResult: (r: FanoutTreeSimResult) => string;
+export declare const runFanoutTreeSim: (input: Partial<FanoutTreeSimParams>) => Promise<FanoutTreeSimResult>;
+//# sourceMappingURL=fanout-tree-sim-lib.d.ts.map

package/dist/benchmark/fanout-tree-sim-lib.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fanout-tree-sim-lib.d.ts","sourceRoot":"","sources":["../../benchmark/fanout-tree-sim-lib.ts"],"names":[],"mappings":"AAKA,OAAO,EACN,eAAe,EAEf,MAAM,+CAA+C,CAAC;AA0BvD,MAAM,MAAM,mBAAmB,GAAG;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IAEtB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IAErB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IAEd,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IAEvB,MAAM,EAAE,OAAO,CAAC;IAChB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,yBAAyB,EAAE,MAAM,CAAC;IAClC,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,OAAO,CAAC;IACxB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,0BAA0B,EAAE,MAAM,CAAC;IACnC,6BAA6B,EAAE,MAAM,CAAC;IACtC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,uBAAuB,EAAE,MAAM,CAAC;IAChC,qBAAqB,EAAE,MAAM,CAAC;IAE9B,eAAe,EAAE,MAAM,CAAC;IACxB,wBAAwB,EAAE,MAAM,CAAC;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,oBAAoB,EAAE,gBAAgB,GAAG,eAAe,GAAG,UAAU,CAAC;IACtE,yBAAyB,EAAE,MAAM,CAAC;IAClC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,UAAU,EAAE,OAAO,CAAC;IACpB,iBAAiB,EAAE,MAAM,CAAC;IAE1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IAExB,iBAAiB,EAAE,MAAM,CAAC;IAE1B,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IAEtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,4BAA4B,EAAE,MAAM,CAAC;IACrC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,uBAAuB,EAAE,MAAM,CAAC;IAChC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,uBAAuB,EAAE,MAAM,CAAC;IAChC,gBAAgB,EAAE,MAAM,CAAC;IACzB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,wBAAwB,EAAE,MAAM,CAAC;IACjC,mBAAmB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IACjC,MAAM,EAAE,mBAAmB,CAAC;IAE5B,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAElB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,wBAAwB,EAAE,MAAM,CAAC;IACjC,wBAAwB,EAAE,MAAM,CAAC;IACjC,yBAAyB,EAAE,MAAM,CAAC;IAClC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,wBAAwB,EAAE,MAAM,CAAC;IACjC,wBAAwB,EAAE,MAAM,CAAC;IACjC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,cAAc,EAAE,MAAM,CAAC;IAEvB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,uBAAuB,EAAE,MAAM,CAAC;IAChC,0BAA0B,EAAE,MAAM,CAAC;IACnC,UAAU,EAAE,MAAM,CAAC;IAEnB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IAEnB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,yBAAyB,EAAE,MAAM,CAAC;IAClC,uBAAuB,EAAE,MAAM,CAAC;IAChC,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,uBAAuB,EAAE,MAAM,CAAC;IAChC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,EAAE,MAAM,CAAC;IAE5B,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IAEzB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,uBAAuB,EAAE,MAAM,EAAE,CAAC;IAElC,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,EAAE,MAAM,CAAC;IAE1B,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,wBAAwB,EAAE,MAAM,CAAC;IACjC,qBAAqB,EAAE,MAAM,CAAC;IAC9B,wBAAwB,EAAE,MAAM,CAAC;IAEjC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,gBAAgB,EAAE,MAAM,CAAC;IACzB,gBAAgB,EAAE,MAAM,CAAC;IACzB,gBAAgB,EAAE,MAAM,CAAC;IAEzB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,wBAAwB,EAAE,MAAM,CAAC;IACjC,4BAA4B,EAAE,MAAM,CAAC;IACrC,8BAA8B,EAAE,MAAM,CAAC;IACvC,+BAA+B,EAAE,MAAM,CAAC;IACxC,uBAAuB,EAAE,MAAM,CAAC;IAChC,4BAA4B,EAAE,MAAM,CAAC;IACrC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,4BAA4B,EAAE,MAAM,CAAC;IACrC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,gCAAgC,EAAE,MAAM,CAAC;IACzC,qBAAqB,EAAE,MAAM,CAAC;IAC9B,oBAAoB,EAAE,MAAM,CAAC;IAC7B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,2BAA2B,EAAE,MAAM,CAAC;IACpC,uBAAuB,EAAE,MAAM,CAAC;IAChC,6BAA6B,EAAE,MAAM,CAAC;IACtC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,wBAAwB,EAAE,MAAM,CAAC;IACjC,6BAA6B,EAAE,MAAM,CAAC;IACtC,2BAA2B,EAAE,MAAM,CAAC;IACpC,yBAAyB,EAAE,MAAM,CAAC;IAClC,0BAA0B,EAAE,MAAM,CAAC;IACnC,wBAAwB,EAAE,MAAM,CAAC;IAEjC,OAAO,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC;IACpC,OAAO,CAAC,EAAE;QACT,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,EAAE,MAAM,CAAC;QACd,UAAU,EAAE,MAAM,CAAC;QACnB,mBAAmB,EAAE,MAAM,CAAC;QAC5B,mBAAmB,EAAE,MAAM,CAAC;KAC5B,CAAC;CACF,CAAC;AA0BF,eAAO,MAAM,0BAA0B,GACtC,OAAO,OAAO,CAAC,mBAAmB,CAAC,KACjC,mBAuGF,CAAC;AAEF,eAAO,MAAM,yBAAyB,GAAI,GAAG,mBAAmB,WAqC9D,CAAC;AAEH,eAAO,MAAM,gBAAgB,GAC5B,OAAO,OAAO,CAAC,mBAAmB,CAAC,KACjC,OAAO,CAAC,mBAAmB,CAqoC7B,CAAC"}