Dhi sets the upper bound on the number of peers we keep in a Gossipsub topic mesh.
Dlazy affects how many peers we will emit gossip to at each heartbeat.
Dlo sets the lower bound on the number of peers we keep in a Gossipsub topic mesh.
Dout sets the quota for the number of outbound connections to maintain in a topic mesh.
Dscore affects how peers are selected when pruning a mesh due to over subscription.
Do not throw InsufficientPeers
error if publishing to zero peers
Optional
allowedIf provided, only allow topics in this list
If true will not forward messages to mesh peers until reportMessageValidationResult() is called. Messages will be cached in mcache for some time after which they are evicted. Calling reportMessageValidationResult() after the message is dropped from mcache won't forward the message.
For a single stream, await processing each RPC before processing the next
For a single RPC, await processing each message before processing the next
Optional
canif can relay messages not subscribed
Optional
dataOptional
debugPrefix tag for debug logs
Optional
decodeLimits to bound protobuf decoding
Optional
directpeers with which we will maintain direct connections
whether PX is enabled; this should be enabled in bootstrappers and other well connected/trusted nodes.
Optional
emitif publish should emit to self, if subscribed
Optional
enabledif dial should fallback to floodsub
fanoutTTL controls how long we keep track of the fanout state. If it's been fanoutTTL milliseconds since we've published to a topic that we're not subscribed to, we'll delete the fanout map for that topic.
fast message id function
if self-published messages should be sent to all peers
Optional
globaldefines how signatures should be handled
customize GossipsubIWantFollowupTime in order not to apply IWANT penalties
Optional
graftheartbeatInterval is the time between heartbeats in milliseconds
Optional
maxSpecify max size to skip decoding messages whose data section exceeds this size.
Optional
maxSpecify the maximum number of inbound gossipsub protocol streams that are allowed to be open concurrently
Optional
maxSpecify max buffer size in bytes for OutboundStream. If full it will throw and reject sending any more data.
Optional
maxSpecify the maximum number of outbound gossipsub protocol streams that are allowed to be open concurrently
mcacheGossip is the number of windows to gossip about
mcacheLength is the number of windows to retain full messages for IWANT responses
override the default MessageCache
Optional
messagehandle this many incoming pubsub messages concurrently
Optional
metricsOptional
metricsmessage id function
Uint8Array message id to string function
Optional
multicodecsOptional
opportunisticOptional
opportunisticOptional
pruneOptional
pruneoverride constants for fine tuning
Optional
pubThe PubSub Topic to use. Defaults to DefaultPubSubTopic.
One and only one pubsub topic is used by Waku. This is used by:
The usage of the default pubsub topic is recommended. See Waku v2 Topic Usage Recommendations for details.
peer score parameters
peer score thresholds
seenTTL is the number of milliseconds to retain message IDs in the seen cache
Generated using TypeDoc
D sets the optimal degree for a Gossipsub topic mesh.