modulepackage
6.2.1002
Repository: https://github.com/status-im/status-go.git
Documentation: pkg.go.dev
# Packages
No description provided by the author
# Functions
No description provided by the author
BytesToTopic converts from the byte array representation of a topic into the TopicType type.
BytesToUintBigEndian converts the slice to 64-bit unsigned integer.
CreateMailServerEvent returns EnvelopeEvent with correct data if payload corresponds to any of the know mailserver events: * request completed successfully * request failed If the payload is unknown/unparseable, it returns `nil`.
CreateMailServerRequestCompletedPayload creates a payload representing a successful request to mailserver.
CreateMailServerRequestFailedPayload creates a payload representing a failed request to a mailserver.
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.
IsPubKeyEqual checks that two public keys are equal.
No description provided by the author
New creates a Whisper client ready to communicate through the Ethereum P2P network.
NewEnvelope wraps a Whisper 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.
NewMessagesResponse returns instane of the version messages response.
No description provided by the author
NewPublicWhisperAPI create a new RPC whisper service.
NewSentMessage creates and initializes a non-signed, non-encrypted Whisper message.
TopicToBloom converts the topic (4 bytes) to the bloom filter (64 bytes).
ToWhisperMessage converts an internal message into an API version.
ValidatePublicKey checks the format of the given public key.
# Constants
in bytes.
Whisper protocol parameters.
Whisper protocol parameters.
seconds.
seconds.
Whisper protocol parameters.
Whisper protocol parameters.
Whisper 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.
Whisper protocol parameters.
Whisper protocol parameters.
maximum accepted size of a message.
Whisper protocol parameters.
Nickname of the protocol in geth.
Protocol version number.
The same, as a string.
mask used to extract the size of payload size field from the flags.
in bytes.
# Variables
DefaultConfig represents (shocker!) the default configuration.
List of errors.
List of errors.
List of errors.
List of errors.
No description provided by the author
List of errors.
List of errors.
# Structs
Config represents the configuration state of a whisper node.
Criteria holds various filter options for inbound messages.
No description provided by the author
Envelope represents a clear-text data packet to transmit through the Whisper network.
EnvelopeError code and optional description of the error.
EnvelopeEvent used for envelopes events.
Filter represents a Whisper message filter.
Filters represents a collection of filters.
Info contains diagnostic information.
MailServerResponse is the response payload sent by the mailserver.
MemoryMessageStore stores massages in memory hash table.
Message is the RPC representation of a whisper message.
MessageParams specifies the exact way a message should be wrapped into an Envelope.
MessagesRequest contains details of a request of historic messages.
MessagesResponse sent as a response after processing batch of envelopes.
No description provided by the author
MultiVersionResponse allows to decode response into chosen version.
NewMessage represents a new whisper message that is posted through the RPC.
Peer represents a whisper protocol peer connection.
No description provided by the author
No description provided by the author
PublicWhisperAPI provides the whisper RPC service that can be use publicly without security implications.
RateLimits contains information about rate limit settings.
RawSyncResponse is a struct representing a response sent to the peer asking for syncing archived envelopes.
ReceivedMessage represents a data packet to be received through the Whisper protocol and successfully decrypted.
Statistics holds several message-related counter for analytics purposes.
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.
SyncResponse is a struct representing a response sent to the peer asking for syncing archived envelopes.
Version1MessageResponse first version of the message response.
Whisper represents a dark communication interface through the Ethereum network, using its very own P2P communication layer.
# Interfaces
No description provided by the author
MailServer represents a mail server, capable of archiving the old messages for subsequent delivery to the peers.
MessageStore defines interface for temporary message store.
No description provided by the author
# Type aliases
EventType used to define known envelope events.
TimeSyncError error for clock skew errors.
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.