Waku Common

BytesToTopic converts from the byte array representation of a topic into the TopicType type.

BytesToUintBigEndian converts the slice to 64-bit unsigned integer.

BytesToUintLittleEndian converts the slice to 64-bit unsigned integer.

ContainsOnlyZeros checks if the data contain only zeros.

ErrorToEnvelopeError converts common golang error into EnvelopeError with a code.

GenerateRandomID generates a random string, which is then returned to be used as a key id.

GenerateSecureRandomData generates random data where extra security is required.

IsPubKeyEqual checks that two public keys are equal.

NewEnvelope wraps a Waku message with expiration and destination data included into an envelope for network forwarding.

NewFilters returns a newly created filter collection.

NewMemoryMessageStore returns pointer to an instance of the MemoryMessageStore.

NewSentMessage creates and initializes a non-signed, non-encrypted Waku message.

ValidateDataIntegrity returns false if the data have the wrong or contains all zeros, which is the simplest and the most common bug.

ValidatePublicKey checks the format of the given public key.

in bytes.

in bytes.

Waku protocol parameters.

Waku protocol parameters.

seconds.

seconds.

Waku protocol parameters.

Waku protocol parameters.

Waku protocol parameters.

EventBatchAcknowledged is sent when batch of envelopes was acknowledged by a peer.

EventEnvelopeAvailable fires when envelop is available for filters.

EventEnvelopeExpired fires when envelop expired.

EventEnvelopeReceived is sent once envelope was received from a peer.

EventEnvelopeSent fires when envelope was sent to a peer.

EventMailServerEnvelopeArchived fires after an envelope has been archived.

EventMailServerRequestCompleted fires after mailserver sends all the requested messages.

EventMailServerRequestExpired fires after mailserver the request TTL ends.

EventMailServerRequestSent fires when such request is sent.

EventMailServerSyncFinished fires when the sync of messages is finished.

Waku protocol parameters.

in bytes.

Waku protocol parameters.

Waku protocol parameters.

maximum accepted size of a message.

Waku protocol parameters.

mask used to extract the size of payload size field from the flags.

in bytes.

Waku protocol parameters.

DropPeerRateLimiterHandler implements RateLimiterHandler, represents a handler that introduces Tolerance to the number of Peer connections before Limit Exceeded errors are returned.

Envelope represents a clear-text data packet to transmit through the Waku network.

EnvelopeError code and optional description of the error.

EnvelopeEvent represents an envelope event.

Filter represents a Waku message filter.

Filters represents a collection of filters.

MemoryMessageStore represents messages stored in a memory hash table.

MessageParams specifies the exact way a message should be wrapped into an Envelope.

MessagesRequest contains details of a request for historic messages.

MessagesResponse sent as a response after processing batch of envelopes.

MetricsRateLimiterHandler implements RateLimiterHandler, represents a handler for reporting rate limit Exceed data to the metrics collection service (currently prometheus).

PeerRateLimiter represents a rate limiter that limits communication between Peers.

PeerRateLimiterConfig represents configurations for initialising a PeerRateLimiter.

RateLimits contains information about rate limit settings.

ReceivedMessage represents a data packet to be received through the Waku protocol and successfully decrypted.

SentMessage represents an end-user data packet to transmit through the Waku protocol.

MessageStore defines interface for temporary message store.

Peer represents a remote Waku client with which the local host waku instance exchanges data / messages.

RateLimiterHandler interface represents handler functionality for a Rate Limiter in the cases of exceeding a peer limit and exceeding an IP limit.

RateLimiterPeer interface represents a Peer that is capable of being rate limited.

WakuHost is the local instance of waku, which both interacts with remote clients (peers) and local clients (through RPC API).

EventType used to define known waku events.

TimeSyncError error for clock skew errors.

TopicType represents a cryptographically secure, probabilistic partial classifications of a message, determined as the first (leftmost) 4 bytes of the SHA3 hash of some arbitrary data given by the original author of the message.