wakuv2

package
v0.179.16 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 13, 2024 License: MPL-2.0 Imports: 60 Imported by: 0

README

waku

Table of contents

What is Waku?

Waku is a communication protocol for sending messages between Dapps. Waku is a fork of the Ethereum Whisper subprotocol, although not directly compatible with Whisper, both Waku and Whisper subprotocols can communicate via bridging.

Waku was created to solve scaling issues with Whisper and currently diverges from Whisper in the following ways:

  • RLPx subprotocol is changed from shh/6 to waku/1.
  • Light node capability is added.*
  • Optional rate limiting is added.
  • Status packet has following additional parameters: light-node, confirmations-enabled and rate-limits
  • Mail Server and Mail Client functionality is now part of the specification.
  • P2P Message packet contains a list of envelopes instead of a single envelope.

*As per vacp2p/specs#117 Waku de jure introduced light nodes as far as updates to the written Whisper specifications. Though the de facto case is that the go-ethereum Whisper implementation had already implemented light nodes and weren't a new feature in code.

Although status-go's Waku light node functionality is a direct fork of go-ethereum's Whisper light node functionality, technically, as far as specifications are concerned, light nodes are considered a new feature introduced in Waku.

Waku versioning

This package follows a versioning pattern that makes clean separation between breaking versions. As detailed in the PR that introduced this strategy to the package.

... the way we will move across versions is to maintain completely separate codebases and eventually remove those that are not supported anymore.

This has the drawback of some code duplication, but the advantage is that is more explicit what each version requires, and changes in one version will not impact the other, so we won't pile up backward compatible code. This is the same strategy used by whisper in go ethereum and is influenced by https://www.youtube.com/watch?v=oyLBGkS5ICk.

Familiarise yourself with the Spec-ulation Keynote by Rich Hickey, if you wish to more deeply understand the rationale for this versioning implementation.

This means that breaking changes will necessitate a new protocol version and a new version sub-package. The packages follow the naming convention of v* where * represents the major / breaking version number of the protocol.

Currently the package has the following version sub-packages:

What does this package do?

The basic function of this package is to implement the waku specifications, and provide the status-go binary with the ability to send and receive messages via Waku.

Waku package files

Root

waku.go

waku.go serves as the main entry point for the package and where the main Waku{} struct lives.

api.go

api.go is home to the PublicWakuAPI{} struct which provides the waku RPC service that can be used publicly without security implications.

PublicWakuAPI{} wraps the main Waku{}, making the Waku{} functionality suitable for external consumption.

Consumption

PublicWakuAPI{} is wrapped by eth-node\bridge\geth.gethPublicWakuAPIWrapper{}, which is initialised via eth-node\bridge\geth.NewGethPublicWakuAPIWrapper() and exposed via gethWakuWrapper.PublicWakuAPI() and is finally consumed by wider parts of the application.

Notes

It is worth noting that each function of PublicWakuAPI{} received an unused context.Context parameter. This is originally passed in way higher up the food-chain and without significant refactoring is not a simple thing to remove / change. Mobile bindings depend on the ability to pass in a context.

config.go

config.go is home to the Config{} struct and the declaration of DefaultConfig.

Config{} is used to initialise the settings of an instantiated Waku{}. waku.New() creates a new instance of a Waku{} and takes a Config{} as a parameter, if nil is passed instead of an instance of Config{}, DefaultConfig is used.

Configuration values
Name Type Description
MaxMessageSize uint32 Sets the maximum size of a waku message in bytes
MinimumAcceptedPoW float64 Sets the minimum amount of work a message needs to have to be accepted by the waku node
BloomFilterMode bool When true, the waku node only matches against bloom filter
LightClient bool When true, the waku node does not forward messages
FullNode bool When true, the waku node forwards all messages
RestrictLightClientsConn bool When true, the waku node does not accept light clients as peers if it is a light client itself
EnableConfirmations bool When true, sends message confirmations
Default

The default configuration for a status-go Waku node is:

MaxMessageSize           : 1Mb
MinimumAcceptedPoW       : 0.2
RestrictLightClientsConn : true
mailserver.go

mailserver.go is home to MailServer interface, which is implemented by mailserver.WakuMailServer{} found in the package file mailserver/mailserver.go. MailServer represents a mail server, capable of receiving and archiving messages for subsequent delivery to the peers.

Additionally this package is home to MailServerResponse{} which represents the response payload sent by the mail-server. MailServerResponse{} is ultimately initialised by CreateMailServerEvent(), which is tied to the main Waku{} via the Waku.OnP2PRequestCompleted() function. This is ultimately accessed via the Peer.Run() function and is made available outside of the package with the waku.HandlePeer() function via Waku.protocol.Run := waku.HandlePeer.

Common

bloomfilter.go

bloomfilter.go holds a few bloomfilter specific functions.

const.go

const.go, originally a hangover from the go-ethereum whisperv6/doc.go package file later refactored, is home to the common Waku constants.

Notes

Versions also have version specific const.go files.

envelope.go

envelope.go is home to the Evelope{} and EnvelopeError{} structs. Envelope{} is used as the data packet in which message data is sent through the Waku network.

Envelope{} is accessed via the initialisation function NewEnvelope(), which is exclusively consumed by Message.Wrap() that prepares a message to be sent via Waku.

errors.go

errors.go holds generic package errors.

events.go

events.go handles data related to Waku events. This file contains string type consts that identify known Waku events.

Additionally, the file contains EnvelopeEvent{}, which serves as a representation of events created by envelopes. EnvelopeEvent{}s are initialised exclusively within the waku package.

filter.go

filter.go is home to Filter{} which represents a waku filter.

Usage

A status-go node will install / register filters through RPC calls from a client (eg status-mobile). The basic implementation of a filter requires at least 2 things:

  1. An encryption key, example "superSafeEncryptionKey"
  2. A 4 byte topic (TopicType), example "0x1234"

The node will install the filter [0x1234][{"superSafeEncryptionKey"}] on an instance of Filters{} and will notify its peers of this event

When a node receives an envelope it will attempt to match the topics against the installed filters, and then try to decrypt the envelope if the topic matches.

For example, if a node receives an envelope with topic 0x1234, the node will try to use the installed filter key superSafeEncryptionKey to decrypt the message. On success the node passes the decrypted message to the client.

In addition to the basic example above Filter{} allows for richer filtering:

Field Name Type Description
Src *ecdsa.PublicKey Sender of the message. Currently not used
KeyAsym *ecdsa.PrivateKey Private Key of recipient
KeySym []byte Key associated with the Topic
Topics [][]byte Topics to filter messages with
PoW float64 Proof of work as described in the Waku specs .

Note: In status-mobile each client listens to the topic hash(pk), if a client wants to send a message to hash(pk1) they will also need to listen the hash(pk1) topic. However if the client doesn't want to receive envelopes for topic hash(pk1), the client may set the PoW to 1 so that all envelopes for topic hash(pk1) are discarded.
AllowP2P bool Indicates whether this filter is interested in direct peer-to-peer messages.

Note: Typically set to true, we always want to receive P2P envelopes on a filter from trusted peers
SymKeyHash common.Hash The Keccak256Hash of the symmetric key, needed for optimization

Waku / Whisper divergence

Whisper, will process all the installed filters that the node has, and build a BloomFilter from all the topics of each installed filter (i.e. func ToBloomFilter(topics []TopicType) []byte { ... }). When a peer receives this BloomFilter, it will match the topic on each envelope that they receive against the BloomFilter, if it matches, it will forward this to the peer.

Waku, by default, does not send a BloomFilter, instead sends the topic in a clear array of []TopicType. This is an improvement on Whisper's usage as a BloomFilter may include false positives, which increase bandwidth usage. In contrast, clear topics are matched exactly and therefore don't create redundant bandwidth usage.

helpers.go

helpers.go holds the package's generic functions.

message.go

message.go is home to all message related functionality and contains a number of structs:

Name Description
MessageParams{} Specifies the exact way a message should be wrapped into an Envelope
sentMessage{} Represents an end-user data packet to transmit through the Waku protocol. These are wrapped into Envelopes that need not be understood by intermediate nodes, just forwarded.
ReceivedMessage{} Represents a data packet to be received through the Waku protocol and successfully decrypted.
MessagesRequest{} Contains details of a request for historic messages.
MessagesResponse{} Represents a request response sent after processing batch of envelopes.
MessageStore interface Implemented by MemoryMessageStore{}
MemoryMessageStore{} Represents messages stored in a memory hash table.
metrics.go

metrics.go is home to Prometheus metric hooks, for counting a range of Waku related metrics.

protocol.go

protocol.go houses the Peer and WakuHost interfaces.

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

WakuHost is the local instance of waku, which both interacts with remote clients (peers) and local clients (like status-mobile, via a RPC API).

rate_limiter.go

rate_limiter.go was introduced as an improvement to Whisper allowing Waku nodes to limit the rate at which data is transferred. These limits are defined by the RateLimits{} which allows nodes to limit the following:

Limit Type Description
IPLimits Messages per second from a single IP (default 0, no limits)
PeerIDLimits Messages per second from a single peer ID (default 0, no limits)
TopicLimits Messages per second from a single topic (default 0, no limits)

In addition to the RateLimits{} this file also contains the following interfaces and structs.

Name Description
RateLimiterPeer interface Represents a Peer{} that is capable of being rate limited
RateLimiterHandler interface Represents handler functionality for a Rate Limiter in the cases of exceeding a peer limit and exceeding an IP limit
MetricsRateLimiterHandler{} Implements RateLimiterHandler, represents a handler for reporting rate limit Exceed data to the metrics collection service (currently prometheus)
DropPeerRateLimiterHandler{} Implements RateLimiterHandler, represents a handler that introduces Tolerance to the number of Peer connections before Limit Exceeded errors are returned.
RateLimits{} Represents rate limit settings exchanged using rateLimitingCode packet or in the handshake.
PeerRateLimiterConfig{} Represents configurations for initialising a PeerRateLimiter
PeerRateLimiter{} Represents a rate limiter that limits communication between Peers

The default PeerRateLimiterConfig is:

LimitPerSecIP:      10,
LimitPerSecPeerID:  5,
WhitelistedIPs:     nil,
WhitelistedPeerIDs: nil,
topic.go

topic.go houses the TopicType type.

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

Topics are used to filter incoming messages that the host's user has registered interest in. For further details on filtering see filter.go.

Versioned

For details about the divergence between versions please consult the READMEs of each version package.

Version const.go

const.go is home to the version sub-package's consts. These constants are version dependant and, as expected, may change from version to version.

Version init.go

init.go is home to the version sub-package's initialisation, and is used to initialise struct based variables at runtime.

Version message.go

message.go is home to the MultiVersionResponse{} and Version1MessageResponse{} structs, both of which are exclusively consumed by the version subpackage's Peer{}.

Both of these structs are used for handling Waku message responses, also known as message confirmations.

Version1MessageResponse{} is used for sending message responses. MultiVersionResponse{} is used for handling incoming message responses.

Usage

Message confirmations are used to inform a user, via the UI, that a message has been sent. Initially the message is marked as "Pending" and eventually as "Sent".

In order to trigger the message state transition from "pending" to "sent", Waku uses MessageResponse{}. Each peer on receiving a message will send back a MessageResponse, see the NewMessagesResponse() function.

The Waku host checks that the peer is a mailserver and if this mailserver was selected by the user, if so the message will be marked as "Sent" in the UI.

For further details read the Waku specification section on the subject.

Notes

Versioning at the MessageResponse level (see the struct Version field) should be phased out and defer to the subpackage's version number. Consider removal once we decide to move to a new major Waku version (i.e. waku/2).

Version peer.go

peer.go holds the version's sub-package Peer{} implementation of the common.Peer interface.

Version status_options.go

status_options.go holds the version's sub-package StatusOptions{} which implements the ethereum/go-ethereum/rlp Decoder and Encoder interfaces.

StatusOptions defines additional information shared between peers during the handshake. There might be more options provided than fields in StatusOptions, and as per the specs, should be ignored during deserialisation to stay forward compatible. In the case of RLP, options should be serialised to an array of tuples where the first item is a field name and the second is a RLP-serialised value.

For further details on RLP see:

Documentation

Index

Constants

View Source 
const (
	Version    = uint64(2) // Peer version number
	VersionStr = "2"       // The same, as a string
	Name       = "waku"    // Nickname of the protocol
)

Waku protocol parameters

View Source 
const (
	FilterEventAdded = iota
	FilterEventRemoved
	FilterEventPingResult
	FilterEventSubscribeResult
	FilterEventUnsubscribeResult
	FilterEventGetStats
)

Variables

View Source 
var (
	ErrSymAsym              = errors.New("specify either a symmetric or an asymmetric key")
	ErrInvalidSymmetricKey  = errors.New("invalid symmetric key")
	ErrInvalidPublicKey     = errors.New("invalid public key")
	ErrInvalidSigningPubKey = errors.New("invalid signing public key")
	ErrTooLowPoW            = errors.New("message rejected, PoW too low")
	ErrNoTopics             = errors.New("missing topic(s)")
)

List of errors

View Source 
var (
	ErrBadLightClientConfig = errors.New("either peer exchange server or discv5 must be disabled, and the peer exchange client must be enabled")
	ErrBadFullNodeConfig    = errors.New("peer exchange server and discv5 must be enabled, and the peer exchange client must be disabled")
)
View Source 
var DefaultConfig = Config{
	MaxMessageSize:    common.DefaultMaxMessageSize,
	Host:              "0.0.0.0",
	Port:              0,
	KeepAliveInterval: 10,
	DiscoveryLimit:    20,
	MinPeersForRelay:  1,
	MinPeersForFilter: 2,
	AutoUpdate:        false,
}

Functions

func CreateMailServerEvent 

func CreateMailServerEvent(nodeID enode.ID, payload []byte) (*common.EnvelopeEvent, error)

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`

func CreateMailServerRequestCompletedPayload 

func CreateMailServerRequestCompletedPayload(requestID, lastEnvelopeHash gethcommon.Hash, cursor []byte) []byte

CreateMailServerRequestCompletedPayload creates a payload representing a successful request to mailserver

func CreateMailServerRequestFailedPayload 

func CreateMailServerRequestFailedPayload(requestID gethcommon.Hash, err error) []byte

CreateMailServerRequestFailedPayload creates a payload representing a failed request to a mailserver

func FormatPeerStats added in v0.88.4 

func FormatPeerStats(wakuNode *node.WakuNode, peers node.PeerStats) map[string]types.WakuV2Peer

Types

type BandwidthTelemetryClient added in v0.128.0 

type BandwidthTelemetryClient struct {
	// contains filtered or unexported fields
}

func NewBandwidthTelemetryClient added in v0.128.0 

func NewBandwidthTelemetryClient(logger *zap.Logger, serverURL string) *BandwidthTelemetryClient

func (*BandwidthTelemetryClient) PushProtocolStats added in v0.128.0 

func (c *BandwidthTelemetryClient) PushProtocolStats(relayStats metrics.Stats, storeStats metrics.Stats)

type Config 

type Config struct {
	MaxMessageSize           uint32           `toml:",omitempty"` // Maximal message length allowed by the waku node
	Host                     string           `toml:",omitempty"`
	Port                     int              `toml:",omitempty"`
	EnablePeerExchangeServer bool             `toml:",omitempty"` // PeerExchange server makes sense only when discv5 is running locally as it will have a cache of peers that it can respond to in case a PeerExchange request comes from the PeerExchangeClient
	EnablePeerExchangeClient bool             `toml:",omitempty"`
	KeepAliveInterval        int              `toml:",omitempty"`
	MinPeersForRelay         int              `toml:",omitempty"` // Indicates the minimum number of peers required for using Relay Protocol
	MinPeersForFilter        int              `toml:",omitempty"` // Indicates the minimum number of peers required for using Filter Protocol
	LightClient              bool             `toml:",omitempty"` // Indicates if the node is a light client
	WakuNodes                []string         `toml:",omitempty"`
	Rendezvous               bool             `toml:",omitempty"`
	DiscV5BootstrapNodes     []string         `toml:",omitempty"`
	Nameserver               string           `toml:",omitempty"` // Optional nameserver to use for dns discovery
	Resolver                 ethdisc.Resolver `toml:",omitempty"` // Optional resolver to use for dns discovery
	EnableDiscV5             bool             `toml:",omitempty"` // Indicates whether discv5 is enabled or not
	DiscoveryLimit           int              `toml:",omitempty"` // Indicates the number of nodes to discover with peer exchange client
	AutoUpdate               bool             `toml:",omitempty"`
	UDPPort                  int              `toml:",omitempty"`
	EnableStore              bool             `toml:",omitempty"`
	StoreCapacity            int              `toml:",omitempty"`
	StoreSeconds             int              `toml:",omitempty"`
	TelemetryServerURL       string           `toml:",omitempty"`
	DefaultShardPubsubTopic  string           `toml:",omitempty"` // Pubsub topic to be used by default for messages that do not have a topic assigned (depending whether sharding is used or not)
	UseShardAsDefaultTopic   bool             `toml:",omitempty"`
	ClusterID                uint16           `toml:",omitempty"`
	EnableConfirmations      bool             `toml:",omitempty"` // Enable sending message confirmations
	SkipPublishToTopic       bool             `toml:",omitempty"` // Used in testing
}

Config represents the configuration state of a waku node.

func (*Config) Validate added in v0.176.5 

func (c *Config) Validate(logger *zap.Logger) error

type Criteria 

type Criteria struct {
	SymKeyID      string             `json:"symKeyID"`
	PrivateKeyID  string             `json:"privateKeyID"`
	Sig           []byte             `json:"sig"`
	PubsubTopic   string             `json:"pubsubTopic"`
	ContentTopics []common.TopicType `json:"topics"`
}

Criteria holds various filter options for inbound messages.

type FilterEvent added in v0.167.6 

type FilterEvent struct {
	// contains filtered or unexported fields
}

type FilterManager added in v0.167.6 

type FilterManager struct {
	// contains filtered or unexported fields
}

type FilterSubs added in v0.167.6 

type FilterSubs map[string]subscription.SubscriptionSet

type ITelemetryClient added in v0.171.11 

type ITelemetryClient interface {
	PushReceivedEnvelope(*protocol.Envelope)
}

type Info 

type Info struct {
	Messages       int    `json:"messages"`       // Number of floating messages.
	MaxMessageSize uint32 `json:"maxMessageSize"` // Maximum accepted message size
}

Info contains diagnostic information.

type MailServer 

type MailServer interface {
	Archive(env *common.Envelope)
	DeliverMail(peerID []byte, request *common.Envelope) // DEPRECATED; use Deliver()
	Deliver(peerID []byte, request common.MessagesRequest)
}

MailServer represents a mail server, capable of archiving the old messages for subsequent delivery to the peers. Any implementation must ensure that both functions are thread-safe. Also, they must return ASAP. DeliverMail should use p2pMessageCode for delivery, in order to bypass the expiry checks.

type MailServerResponse 

type MailServerResponse struct {
	LastEnvelopeHash gethcommon.Hash
	Cursor           []byte
	Error            error
}

MailServerResponse is the response payload sent by the mailserver.

type Message 

type Message struct {
	Sig          []byte           `json:"sig,omitempty"`
	Timestamp    uint32           `json:"timestamp"`
	PubsubTopic  string           `json:"pubsubTopic"`
	ContentTopic common.TopicType `json:"topic"`
	Payload      []byte           `json:"payload"`
	Padding      []byte           `json:"padding"`
	Hash         []byte           `json:"hash"`
	Dst          []byte           `json:"recipientPublicKey,omitempty"`
}

Message is the RPC representation of a waku message.

func ToWakuMessage 

func ToWakuMessage(message *common.ReceivedMessage) *Message

ToWakuMessage converts an internal message into an API version.

type NewMessage 

type NewMessage struct {
	SymKeyID     string           `json:"symKeyID"`
	PublicKey    []byte           `json:"pubKey"`
	Sig          string           `json:"sig"`
	PubsubTopic  string           `json:"pubsubTopic"`
	ContentTopic common.TopicType `json:"topic"`
	Payload      []byte           `json:"payload"`
	Padding      []byte           `json:"padding"`
	TargetPeer   string           `json:"targetPeer"`
	Ephemeral    bool             `json:"ephemeral"`
}

NewMessage represents a new waku message that is posted through the RPC.

type PublicWakuAPI 

type PublicWakuAPI struct {
	// contains filtered or unexported fields
}

PublicWakuAPI provides the waku RPC service that can be use publicly without security implications.

func NewPublicWakuAPI 

func NewPublicWakuAPI(w *Waku) *PublicWakuAPI

NewPublicWakuAPI create a new RPC waku service.

func (*PublicWakuAPI) AddPrivateKey 

func (api *PublicWakuAPI) AddPrivateKey(ctx context.Context, privateKey hexutil.Bytes) (string, error)

AddPrivateKey imports the given private key.

func (*PublicWakuAPI) AddSymKey 

func (api *PublicWakuAPI) AddSymKey(ctx context.Context, key hexutil.Bytes) (string, error)

AddSymKey import a symmetric key. It returns an ID that can be used to refer to the key. Can be used encrypting and decrypting messages where the key is known to both parties.

func (*PublicWakuAPI) BloomFilter added in v0.85.0 

func (api *PublicWakuAPI) BloomFilter() []byte

func (*PublicWakuAPI) DeleteKeyPair 

func (api *PublicWakuAPI) DeleteKeyPair(ctx context.Context, key string) (bool, error)

DeleteKeyPair removes the key with the given key if it exists.

func (*PublicWakuAPI) DeleteMessageFilter 

func (api *PublicWakuAPI) DeleteMessageFilter(id string) (bool, error)

DeleteMessageFilter deletes a filter.

func (*PublicWakuAPI) DeleteSymKey 

func (api *PublicWakuAPI) DeleteSymKey(ctx context.Context, id string) bool

DeleteSymKey deletes the symmetric key that is associated with the given id.

func (*PublicWakuAPI) GenerateSymKeyFromPassword 

func (api *PublicWakuAPI) GenerateSymKeyFromPassword(ctx context.Context, passwd string) (string, error)

GenerateSymKeyFromPassword derive a key from the given password, stores it, and returns its ID.

func (*PublicWakuAPI) GetFilterMessages 

func (api *PublicWakuAPI) GetFilterMessages(id string) ([]*Message, error)

GetFilterMessages returns the messages that match the filter criteria and are received between the last poll and now.

func (*PublicWakuAPI) GetPrivateKey 

func (api *PublicWakuAPI) GetPrivateKey(ctx context.Context, id string) (hexutil.Bytes, error)

GetPrivateKey returns the private key associated with the given key. The key is the hex encoded representation of a key in the form specified in section 4.3.6 of ANSI X9.62.

func (*PublicWakuAPI) GetPublicKey 

func (api *PublicWakuAPI) GetPublicKey(ctx context.Context, id string) (hexutil.Bytes, error)

GetPublicKey returns the public key associated with the given key. The key is the hex encoded representation of a key in the form specified in section 4.3.6 of ANSI X9.62.

func (*PublicWakuAPI) GetSymKey 

func (api *PublicWakuAPI) GetSymKey(ctx context.Context, id string) (hexutil.Bytes, error)

GetSymKey returns the symmetric key associated with the given id.

func (*PublicWakuAPI) HasKeyPair 

func (api *PublicWakuAPI) HasKeyPair(ctx context.Context, id string) bool

HasKeyPair returns an indication if the node has a key pair that is associated with the given id.

func (*PublicWakuAPI) HasSymKey 

func (api *PublicWakuAPI) HasSymKey(ctx context.Context, id string) bool

HasSymKey returns an indication if the node has a symmetric key associated with the given key.

func (*PublicWakuAPI) Info 

func (api *PublicWakuAPI) Info(ctx context.Context) Info

Info returns diagnostic information about the waku node.

func (*PublicWakuAPI) Messages 

func (api *PublicWakuAPI) Messages(ctx context.Context, crit Criteria) (*rpc.Subscription, error)

Messages set up a subscription that fires events when messages arrive that match the given set of criteria.

func (*PublicWakuAPI) NewKeyPair 

func (api *PublicWakuAPI) NewKeyPair(ctx context.Context) (string, error)

NewKeyPair generates a new public and private key pair for message decryption and encryption. It returns an ID that can be used to refer to the keypair.

func (*PublicWakuAPI) NewMessageFilter 

func (api *PublicWakuAPI) NewMessageFilter(req Criteria) (string, error)

NewMessageFilter creates a new filter that can be used to poll for (new) messages that satisfy the given criteria.

func (*PublicWakuAPI) NewSymKey 

func (api *PublicWakuAPI) NewSymKey(ctx context.Context) (string, error)

NewSymKey generate a random symmetric key. It returns an ID that can be used to refer to the key. Can be used encrypting and decrypting messages where the key is known to both parties.

func (*PublicWakuAPI) Post 

func (api *PublicWakuAPI) Post(ctx context.Context, req NewMessage) (hexutil.Bytes, error)

Post posts a message on the Waku network. returns the hash of the message in case of success.

func (*PublicWakuAPI) UninstallFilter 

func (api *PublicWakuAPI) UninstallFilter(ctx context.Context, id string)

UninstallFilter is alias for Unsubscribe

func (*PublicWakuAPI) Unsubscribe 

func (api *PublicWakuAPI) Unsubscribe(ctx context.Context, id string)

Unsubscribe disables and removes an existing filter.

type Waku 

type Waku struct {
	// contains filtered or unexported fields
}

Waku represents a dark communication interface through the Ethereum network, using its very own P2P communication layer.

func New 

func New(nodeKey string, fleet string, cfg *Config, logger *zap.Logger, appDB *sql.DB, ts *timesource.NTPTimeSource, onHistoricMessagesRequestFailed func([]byte, peer.ID, error), onPeerStats func(types.ConnStatus)) (*Waku, error)

New creates a WakuV2 client ready to communicate through the LibP2P network.

func (*Waku) APIs 

func (w *Waku) APIs() []rpc.API

APIs returns the RPC descriptors the Waku implementation offers

func (*Waku) AddKeyPair 

func (w *Waku) AddKeyPair(key *ecdsa.PrivateKey) (string, error)

AddKeyPair imports a asymmetric private key and returns it identifier.

func (*Waku) AddRelayPeer added in v0.88.4 

func (w *Waku) AddRelayPeer(address string) (peer.ID, error)

func (*Waku) AddStorePeer added in v0.88.4 

func (w *Waku) AddStorePeer(address string) (peer.ID, error)

func (*Waku) AddSymKey 

func (w *Waku) AddSymKey(id string, key []byte) (string, error)

AddSymKey stores the key with a given id.

func (*Waku) AddSymKeyDirect 

func (w *Waku) AddSymKeyDirect(key []byte) (string, error)

AddSymKeyDirect stores the key, and returns its id.

func (*Waku) AddSymKeyFromPassword 

func (w *Waku) AddSymKeyFromPassword(password string) (string, error)

AddSymKeyFromPassword generates the key from password, stores it, and returns its id.

func (*Waku) Clean added in v0.172.10 

func (w *Waku) Clean() error

func (*Waku) ClearEnvelopesCache added in v0.172.11 

func (w *Waku) ClearEnvelopesCache()

func (*Waku) ConnectionChanged added in v0.117.1 

func (w *Waku) ConnectionChanged(state connection.State)

func (*Waku) CurrentTime 

func (w *Waku) CurrentTime() time.Time

CurrentTime returns current time.

func (*Waku) DeleteKeyPair 

func (w *Waku) DeleteKeyPair(key string) bool

DeleteKeyPair deletes the specified key if it exists.

func (*Waku) DeleteKeyPairs 

func (w *Waku) DeleteKeyPairs() error

DeleteKeyPairs removes all cryptographic identities known to the node

func (*Waku) DeleteSymKey 

func (w *Waku) DeleteSymKey(id string) bool

DeleteSymKey deletes the key associated with the name string if it exists.

func (*Waku) DialPeer added in v0.88.4 

func (w *Waku) DialPeer(address string) error

func (*Waku) DialPeerByID added in v0.88.4 

func (w *Waku) DialPeerByID(peerID string) error

func (*Waku) DropPeer added in v0.88.4 

func (w *Waku) DropPeer(peerID string) error

func (*Waku) GenerateSymKey 

func (w *Waku) GenerateSymKey() (string, error)

GenerateSymKey generates a random symmetric key and stores it under id, which is then returned. Will be used in the future for session key exchange.

func (*Waku) GetEnvelope 

func (w *Waku) GetEnvelope(hash gethcommon.Hash) *common.ReceivedMessage

GetEnvelope retrieves an envelope from the message queue by its hash. It returns nil if the envelope can not be found.

func (*Waku) GetFilter 

func (w *Waku) GetFilter(id string) *common.Filter

GetFilter returns the filter by id.

func (*Waku) GetNodeENRString added in v0.179.12 

func (w *Waku) GetNodeENRString() (string, error)

func (*Waku) GetPrivateKey 

func (w *Waku) GetPrivateKey(id string) (*ecdsa.PrivateKey, error)

GetPrivateKey retrieves the private key of the specified identity.

func (*Waku) GetStats added in v0.83.8 

func (w *Waku) GetStats() types.StatsSummary

func (*Waku) GetSymKey 

func (w *Waku) GetSymKey(id string) ([]byte, error)

GetSymKey returns the symmetric key associated with the given id.

func (*Waku) HasKeyPair 

func (w *Waku) HasKeyPair(id string) bool

HasKeyPair checks if the waku node is configured with the private key of the specified public pair.

func (*Waku) HasSymKey 

func (w *Waku) HasSymKey(id string) bool

HasSymKey returns true if there is a key associated with the given id. Otherwise returns false.

func (*Waku) IsEnvelopeCached 

func (w *Waku) IsEnvelopeCached(hash gethcommon.Hash) bool

isEnvelopeCached checks if envelope with specific hash has already been received and cached.

func (*Waku) ListenAddresses added in v0.115.4 

func (w *Waku) ListenAddresses() []string

func (*Waku) MarkP2PMessageAsProcessed added in v0.91.13 

func (w *Waku) MarkP2PMessageAsProcessed(hash gethcommon.Hash)

func (*Waku) MaxMessageSize 

func (w *Waku) MaxMessageSize() uint32

MaxMessageSize returns the maximum accepted message size.

func (*Waku) NewKeyPair 

func (w *Waku) NewKeyPair() (string, error)

NewKeyPair generates a new cryptographic identity for the client, and injects it into the known identities for message decryption. Returns ID of the new key pair.

func (*Waku) OnNewEnvelopes 

func (w *Waku) OnNewEnvelopes(envelope *protocol.Envelope, msgType common.MessageType, processImmediately bool) error

func (*Waku) PeerCount added in v0.88.4 

func (w *Waku) PeerCount() int

func (*Waku) PeerID added in v0.174.5 

func (w *Waku) PeerID() peer.ID

func (*Waku) Peers added in v0.88.4 

func (w *Waku) Peers() map[string]types.WakuV2Peer

func (*Waku) Peerstore added in v0.179.12 

func (w *Waku) Peerstore() peerstore.Peerstore

func (*Waku) ProcessingP2PMessages added in v0.91.13 

func (w *Waku) ProcessingP2PMessages() bool

func (*Waku) Protocols 

func (w *Waku) Protocols() []p2p.Protocol

Protocols returns the waku sub-protocols ran by this particular client.

func (*Waku) Query 

func (w *Waku) Query(ctx context.Context, peerID peer.ID, pubsubTopic string, topics []common.TopicType, from uint64, to uint64, opts []store.HistoryRequestOption, processEnvelopes bool) (cursor *storepb.Index, envelopesCount int, err error)

func (*Waku) RemovePubsubTopicKey added in v0.172.11 

func (w *Waku) RemovePubsubTopicKey(topic string) error

func (*Waku) RetrievePubsubTopicKey added in v0.170.0 

func (w *Waku) RetrievePubsubTopicKey(topic string) (*ecdsa.PrivateKey, error)

func (*Waku) SelectKeyPair 

func (w *Waku) SelectKeyPair(key *ecdsa.PrivateKey) error

SelectKeyPair adds cryptographic identity, and makes sure that it is the only private key known to the node.

func (*Waku) Send 

func (w *Waku) Send(pubsubTopic string, msg *pb.WakuMessage) ([]byte, error)

Send injects a message into the waku send queue, to be distributed in the network in the coming cycles.

func (*Waku) SendEnvelopeEvent 

func (w *Waku) SendEnvelopeEvent(event common.EnvelopeEvent) int

func (*Waku) SetStatusTelemetryClient added in v0.171.11 

func (w *Waku) SetStatusTelemetryClient(client ITelemetryClient)

func (*Waku) SkipPublishToTopic added in v0.171.25 

func (w *Waku) SkipPublishToTopic(value bool)

func (*Waku) Start 

func (w *Waku) Start() error

Start implements node.Service, starting the background data propagation thread of the Waku protocol.

func (*Waku) StartDiscV5 added in v0.91.8 

func (w *Waku) StartDiscV5() error

func (*Waku) Stop 

func (w *Waku) Stop() error

Stop implements node.Service, stopping the background data propagation thread of the Waku protocol.

func (*Waku) StopDiscV5 added in v0.91.8 

func (w *Waku) StopDiscV5() error

func (*Waku) StoreNode added in v0.176.7 

func (w *Waku) StoreNode() store.Store

func (*Waku) StorePubsubTopicKey added in v0.166.1 

func (w *Waku) StorePubsubTopicKey(topic string, privKey *ecdsa.PrivateKey) error

func (*Waku) Subscribe 

func (w *Waku) Subscribe(f *common.Filter) (string, error)

Subscribe installs a new message handler used for filtering, decrypting and subsequent storing of incoming messages.

func (*Waku) SubscribeEnvelopeEvents 

func (w *Waku) SubscribeEnvelopeEvents(events chan<- common.EnvelopeEvent) event.Subscription

SubscribeEnvelopeEvents subscribes to envelopes feed. In order to prevent blocking waku producers events must be amply buffered.

func (*Waku) SubscribeToConnStatusChanges added in v0.93.2 

func (w *Waku) SubscribeToConnStatusChanges() *types.ConnStatusSubscription

func (*Waku) SubscribeToPubsubTopic added in v0.166.1 

func (w *Waku) SubscribeToPubsubTopic(topic string, pubkey *ecdsa.PublicKey) error

func (*Waku) Trace added in v0.174.5 

func (w *Waku) Trace(evt *pubsub_pb.TraceEvent)

Trace implements EventTracer interface. We use custom logging, because we want to base58-encode the peerIDs. And also make the messageIDs readable.

func (*Waku) Unsubscribe 

func (w *Waku) Unsubscribe(ctx context.Context, id string) error

Unsubscribe removes an installed message handler.

func (*Waku) UnsubscribeFromPubsubTopic added in v0.172.11 

func (w *Waku) UnsubscribeFromPubsubTopic(topic string) error

func (*Waku) UnsubscribeMany 

func (w *Waku) UnsubscribeMany(ids []string) error

Unsubscribe removes an installed message handler.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.