package
10.9.0+incompatible
Repository: https://github.com/status-im/status-go.git
Documentation: pkg.go.dev
# Functions
BloomFilterMatch returns true if a sample matches a bloom filter.
BytesToTopic converts from the byte array representation of a topic into the TopicType type.
MakeFullNodeBloom returns a bloom filter which matches all topics.
No description provided by the author
No description provided by the author
TopicToBloom converts the topic (4 bytes) to the bloom filter (64 bytes).
No description provided by the author
# Constants
BloomFilterSize is the expected length of a bloom filter byte array, in bytes.
EnvelopeOtherError represents the code passed to notify of a generic error situation.
EnvelopeTimeNotSynced represents the code passed to notify of a clock skew situation.
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.
TopicLength is the expected length of the topic, in bytes.
# Structs
No description provided by the author
No description provided by the author
Criteria holds various filter options for inbound messages.
EnvelopeError code and optional description of the error.
EnvelopeEvent used for envelopes events.
No description provided by the author
MailServerResponse is the response payload sent by the mailserver.
Message is the RPC representation of a whisper message.
NewMessage represents a new whisper message that is posted through the RPC.
No description provided by the author
No description provided by the author
SubscriptionOptions represents the parameters passed to Subscribe() to customize the subscription behavior.
SyncEventResponse is a response from the Mail Server form which the peer received envelopes.
SyncMailRequest contains details which envelopes should be synced between Mail Servers.
No description provided by the author
# Interfaces
Envelope represents a clear-text data packet to transmit through the Whisper network.
Filter represents a Whisper message filter.
PublicWakuAPI provides the waku RPC service that can be use publicly without security implications.
Subscription represents a stream of events.
Whisper represents a dark communication interface through the Ethereum network, using its very own P2P communication layer.
No description provided by the author
Wrapped tells that a given object has an underlying representation and this representation can be accessed using `Unwrap` method.
# Type aliases
EventType used to define known envelope events.
No description provided by the author
TopicType represents a cryptographically secure, probabilistic partial classifications of a message, determined as the first (left) 4 bytes of the SHA3 hash of some arbitrary data given by the original author of the message.