whisper

Jan 26, 2021

Changes in this version

+ const BloomFilterSize

+ const DefaultMaxMessageSize

+ const DefaultMinimumPoW

+ const DefaultSyncAllowance

+ const DefaultTTL

+ const EnvelopeHeaderLength

+ const EnvelopeOtherError

+ const EnvelopeTimeNotSynced

+ const MaxLimitInMessagesRequest

+ const MaxLimitInSyncMailRequest

+ const MaxMessageSize

+ const NumberOfMessageCodes

+ const ProtocolName

+ const ProtocolVersion

+ const ProtocolVersionStr

+ const SizeMask

+ const TopicLength

+ var DefaultConfig = Config

+ var ErrInvalidPublicKey = errors.New("invalid public key")

+ var ErrInvalidSigningPubKey = errors.New("invalid signing public key")

+ var ErrInvalidSymmetricKey = errors.New("invalid symmetric key")

+ var ErrNoTopics = errors.New("missing topic(s)")

+ var ErrRateLimitExceeded = errors.New("rate limit has been exceeded")

+ var ErrSymAsym = errors.New("specify either a symmetric or an asymmetric key")

+ var ErrTooLowPoW = errors.New("message rejected, PoW too low")

+ func BloomFilterMatch(filter, sample []byte) bool

+ func BytesToUintBigEndian(b []byte) (res uint64)

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

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

+ func GenerateRandomID() (id string, err error)

+ func IsPubKeyEqual(a, b *ecdsa.PublicKey) bool

+ func MakeFullNodeBloom() []byte

+ func NewSentMessage(params *MessageParams) (*sentMessage, error)

+ func TopicToBloom(topic TopicType) []byte

+ func ValidatePublicKey(k *ecdsa.PublicKey) bool

+ type Bridge interface

+ Pipe func() (<-chan *Envelope, chan<- *Envelope)

+ type Config struct

+ DisableConfirmations bool

+ MaxMessageSize uint32

+ MinimumAcceptedPOW float64

+ RestrictConnectionBetweenLightClients bool

+ type Criteria struct

+ AllowP2P bool

+ MinPow float64

+ PrivateKeyID string

+ Sig []byte

+ SymKeyID string

+ Topics []TopicType

+ func (c *Criteria) UnmarshalJSON(input []byte) error

+ func (c Criteria) MarshalJSON() ([]byte, error)

+ type DropPeerRateLimiterHandler struct

+ Tolerance int64

+ func (h *DropPeerRateLimiterHandler) ExceedIPLimit() error

+ func (h *DropPeerRateLimiterHandler) ExceedPeerLimit() error

+ type Envelope struct

+ Data []byte

+ Expiry uint32

+ Nonce uint64

+ TTL uint32

+ Topic TopicType

+ func NewEnvelope(ttl uint32, topic TopicType, msg *sentMessage, now time.Time) *Envelope

+ func (e *Envelope) Bloom() []byte

+ func (e *Envelope) DecodeRLP(s *rlp.Stream) error

+ func (e *Envelope) Hash() common.Hash

+ func (e *Envelope) Open(watcher *Filter) (msg *ReceivedMessage)

+ func (e *Envelope) OpenAsymmetric(key *ecdsa.PrivateKey) (*ReceivedMessage, error)

+ func (e *Envelope) OpenSymmetric(key []byte) (msg *ReceivedMessage, err error)

+ func (e *Envelope) PoW() float64

+ func (e *Envelope) Seal(options *MessageParams) error

+ type EnvelopeError struct

+ Code uint

+ Description string

+ Hash common.Hash

+ func ErrorToEnvelopeError(hash common.Hash, err error) EnvelopeError

+ type EnvelopeEvent struct

+ Batch common.Hash

+ Data interface{}

+ Event EventType

+ Hash common.Hash

+ Peer enode.ID

+ Topic TopicType

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

+ type EventType string

+ const EventBatchAcknowledged

+ const EventEnvelopeAvailable

+ const EventEnvelopeExpired

+ const EventEnvelopeReceived

+ const EventEnvelopeSent

+ const EventMailServerEnvelopeArchived

+ const EventMailServerRequestCompleted

+ const EventMailServerRequestExpired

+ const EventMailServerRequestSent

+ const EventMailServerSyncFinished

+ type Filter struct

+ AllowP2P bool

+ KeyAsym *ecdsa.PrivateKey

+ KeySym []byte

+ Messages MessageStore

+ PoW float64

+ Src *ecdsa.PublicKey

+ SymKeyHash common.Hash

+ Topics [][]byte

+ func (f *Filter) MatchEnvelope(envelope *Envelope) bool

+ func (f *Filter) MatchMessage(msg *ReceivedMessage) bool

+ func (f *Filter) Retrieve() []*ReceivedMessage

+ func (f *Filter) Trigger(msg *ReceivedMessage)

+ type Filters struct

+ func NewFilters(w *Whisper) *Filters

+ func (fs *Filters) Get(id string) *Filter

+ func (fs *Filters) Install(watcher *Filter) (string, error)

+ func (fs *Filters) NotifyWatchers(env *Envelope, p2pMessage bool)

+ func (fs *Filters) Uninstall(id string) bool

+ type Info struct

+ MaxMessageSize uint32

+ Memory int

+ Messages int

+ MinPow float64

+ type MailServer interface

+ Archive func(env *Envelope)

+ Deliver func(peerID []byte, req MessagesRequest)

+ DeliverMail func(peerID []byte, req *Envelope)

+ SyncMail func(peerID []byte, req SyncMailRequest) error

+ type MailServerResponse struct

+ Cursor []byte

+ Error error

+ LastEnvelopeHash common.Hash

+ type MemoryMessageStore struct

+ func NewMemoryMessageStore() *MemoryMessageStore

+ func (store *MemoryMessageStore) Add(msg *ReceivedMessage) error

+ func (store *MemoryMessageStore) Pop() ([]*ReceivedMessage, error)

+ type Message struct

+ Dst []byte

+ Hash []byte

+ P2P bool

+ Padding []byte

+ Payload []byte

+ PoW float64

+ Sig []byte

+ TTL uint32

+ Timestamp uint32

+ Topic TopicType

+ func ToWhisperMessage(message *ReceivedMessage) *Message

+ func (m *Message) UnmarshalJSON(input []byte) error

+ func (m Message) MarshalJSON() ([]byte, error)

+ type MessageParams struct

+ Dst *ecdsa.PublicKey

+ KeySym []byte

+ Padding []byte

+ Payload []byte

+ PoW float64

+ Src *ecdsa.PrivateKey

+ TTL uint32

+ Topic TopicType

+ WorkTime uint32

+ type MessageStore interface

+ Add func(*ReceivedMessage) error

+ Pop func() ([]*ReceivedMessage, error)

+ type MessagesRequest struct

+ Bloom []byte

+ Cursor []byte

+ From uint32

+ ID []byte

+ Limit uint32

+ To uint32

+ func (r MessagesRequest) Validate() error

+ type MessagesResponse struct

+ Errors []EnvelopeError

+ Hash common.Hash

+ type MetricsRateLimiterHandler struct

+ func (MetricsRateLimiterHandler) ExceedIPLimit() error

+ func (MetricsRateLimiterHandler) ExceedPeerLimit() error

+ type MultiVersionResponse struct

+ Response rlp.RawValue

+ Version uint

+ func (m MultiVersionResponse) DecodeResponse1() (resp MessagesResponse, err error)

+ type NewMessage struct

+ Padding []byte

+ Payload []byte

+ PowTarget float64

+ PowTime uint32

+ PublicKey []byte

+ Sig string

+ SymKeyID string

+ TTL uint32

+ TargetPeer string

+ Topic TopicType

+ func (n *NewMessage) UnmarshalJSON(input []byte) error

+ func (n NewMessage) MarshalJSON() ([]byte, error)

+ type Peer struct

+ func (peer *Peer) ID() []byte

+ type PeerRateLimiter struct

+ func NewPeerRateLimiter(cfg *PeerRateLimiterConfig, handlers ...RateLimiterHandler) *PeerRateLimiter

+ type PeerRateLimiterConfig struct

+ LimitPerSecIP int64

+ LimitPerSecPeerID int64

+ WhitelistedIPs []string

+ WhitelistedPeerIDs []enode.ID

+ type PublicWhisperAPI struct

+ func NewPublicWhisperAPI(w *Whisper) *PublicWhisperAPI

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

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

+ func (api *PublicWhisperAPI) CancelLightClient(ctx context.Context) bool

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

+ func (api *PublicWhisperAPI) DeleteMessageFilter(id string) (bool, error)

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

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

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

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

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

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

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

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

+ func (api *PublicWhisperAPI) Info(ctx context.Context) Info

+ func (api *PublicWhisperAPI) MakeLightClient(ctx context.Context) bool

+ func (api *PublicWhisperAPI) MarkTrustedPeer(ctx context.Context, url string) (bool, error)

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

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

+ func (api *PublicWhisperAPI) NewMessageFilter(req Criteria) (string, error)

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

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

+ func (api *PublicWhisperAPI) SetBloomFilter(ctx context.Context, bloom hexutil.Bytes) (bool, error)

+ func (api *PublicWhisperAPI) SetMaxMessageSize(ctx context.Context, size uint32) (bool, error)

+ func (api *PublicWhisperAPI) SetMinPoW(ctx context.Context, pow float64) (bool, error)

+ func (api *PublicWhisperAPI) UninstallFilter(id string)

+ func (api *PublicWhisperAPI) Unsubscribe(id string)

+ func (api *PublicWhisperAPI) Version(ctx context.Context) string

+ type RateLimiterHandler interface

+ ExceedIPLimit func() error

+ ExceedPeerLimit func() error

+ type RateLimits struct

+ IPLimits uint64

+ PeerIDLimits uint64

+ TopicLimits uint64

+ func (r RateLimits) IsZero() bool

+ type RawSyncResponse struct

+ Cursor []byte

+ Envelopes []rlp.RawValue

+ Error string

+ Final bool

+ type ReceivedMessage struct

+ Dst *ecdsa.PublicKey

+ EnvelopeHash common.Hash

+ P2P bool

+ Padding []byte

+ Payload []byte

+ PoW float64

+ Raw []byte

+ Salt []byte

+ Sent uint32

+ Signature []byte

+ Src *ecdsa.PublicKey

+ SymKeyHash common.Hash

+ TTL uint32

+ Topic TopicType

+ func (msg *ReceivedMessage) SigToPubKey() *ecdsa.PublicKey

+ func (msg *ReceivedMessage) ValidateAndParse() bool

+ type Statistics struct

+ type SyncEventResponse struct

+ Cursor []byte

+ Error string

+ type SyncMailRequest struct

+ Bloom []byte

+ Cursor []byte

+ Limit uint32

+ Lower uint32

+ Upper uint32

+ func (r SyncMailRequest) Validate() error

+ type SyncResponse struct

+ Cursor []byte

+ Envelopes []*Envelope

+ Error string

+ Final bool

+ type TimeSyncError error

+ type TopicType [TopicLength]byte

+ func BytesToTopic(b []byte) (t TopicType)

+ func (t *TopicType) String() string

+ func (t *TopicType) UnmarshalText(input []byte) error

+ func (t TopicType) MarshalText() ([]byte, error)

+ type Version1MessageResponse struct

+ Response MessagesResponse

+ Version uint

+ func NewMessagesResponse(batch common.Hash, errors []EnvelopeError) Version1MessageResponse

+ type Whisper struct

+ func New(cfg *Config) *Whisper

+ func (w *Whisper) GetEnvelope(hash common.Hash) *Envelope

+ func (whisper *Whisper) APIs() []rpc.API

+ func (whisper *Whisper) AddKeyPair(key *ecdsa.PrivateKey) (string, error)

+ func (whisper *Whisper) AddSymKey(id string, key []byte) (string, error)

+ func (whisper *Whisper) AddSymKeyDirect(key []byte) (string, error)

+ func (whisper *Whisper) AddSymKeyFromPassword(password string) (string, error)

+ func (whisper *Whisper) AllowP2PMessagesFromPeer(peerID []byte) error

+ func (whisper *Whisper) BloomFilter() []byte

+ func (whisper *Whisper) BloomFilterTolerance() []byte

+ func (whisper *Whisper) DeleteKeyPair(key string) bool

+ func (whisper *Whisper) DeleteKeyPairs() error

+ func (whisper *Whisper) DeleteSymKey(id string) bool

+ func (whisper *Whisper) Envelopes() []*Envelope

+ func (whisper *Whisper) GenerateSymKey() (string, error)

+ func (whisper *Whisper) GetCurrentTime() time.Time

+ func (whisper *Whisper) GetFilter(id string) *Filter

+ func (whisper *Whisper) GetPrivateKey(id string) (*ecdsa.PrivateKey, error)

+ func (whisper *Whisper) GetSymKey(id string) ([]byte, error)

+ func (whisper *Whisper) HandlePeer(peer *p2p.Peer, rw p2p.MsgReadWriter) error

+ func (whisper *Whisper) HasKeyPair(id string) bool

+ func (whisper *Whisper) HasSymKey(id string) bool

+ func (whisper *Whisper) LightClientMode() bool

+ func (whisper *Whisper) LightClientModeConnectionRestricted() bool

+ func (whisper *Whisper) MaxMessageSize() uint32

+ func (whisper *Whisper) MinPow() float64

+ func (whisper *Whisper) MinPowTolerance() float64

+ func (whisper *Whisper) NewKeyPair() (string, error)

+ func (whisper *Whisper) NewMessageStore() MessageStore

+ func (whisper *Whisper) Overflow() bool

+ func (whisper *Whisper) Protocols() []p2p.Protocol

+ func (whisper *Whisper) RateLimits() RateLimits

+ func (whisper *Whisper) RegisterBridge(b Bridge)

+ func (whisper *Whisper) RegisterMailServer(server MailServer)

+ func (whisper *Whisper) RequestHistoricMessages(peerID []byte, envelope *Envelope) error

+ func (whisper *Whisper) RequestHistoricMessagesWithTimeout(peerID []byte, envelope *Envelope, timeout time.Duration) error

+ func (whisper *Whisper) Send(envelope *Envelope) error

+ func (whisper *Whisper) SendHistoricMessageResponse(peerID []byte, payload []byte) error

+ func (whisper *Whisper) SendMessagesRequest(peerID []byte, request MessagesRequest) error

+ func (whisper *Whisper) SendP2PDirect(peerID []byte, envelopes ...*Envelope) error

+ func (whisper *Whisper) SendP2PMessage(peerID []byte, envelopes ...*Envelope) error

+ func (whisper *Whisper) SendRawP2PDirect(peerID []byte, envelopes ...rlp.RawValue) error

+ func (whisper *Whisper) SendRawSyncResponse(peerID []byte, data RawSyncResponse) error

+ func (whisper *Whisper) SendSyncResponse(peerID []byte, data SyncResponse) error

+ func (whisper *Whisper) SetBloomFilter(bloom []byte) error

+ func (whisper *Whisper) SetLightClientMode(v bool)

+ func (whisper *Whisper) SetMaxMessageSize(size uint32) error

+ func (whisper *Whisper) SetMessageStore(fabric func() MessageStore)

+ func (whisper *Whisper) SetMinimumPoW(val float64) error

+ func (whisper *Whisper) SetMinimumPowTest(val float64)

+ func (whisper *Whisper) SetRateLimiter(r *PeerRateLimiter)

+ func (whisper *Whisper) SetTimeSource(timesource func() time.Time)

+ func (whisper *Whisper) Start(*p2p.Server) error

+ func (whisper *Whisper) Stats() Statistics

+ func (whisper *Whisper) Stop() error

+ func (whisper *Whisper) Subscribe(f *Filter) (string, error)

+ func (whisper *Whisper) SubscribeEnvelopeEvents(events chan<- EnvelopeEvent) event.Subscription

+ func (whisper *Whisper) SyncMessages(peerID []byte, req SyncMailRequest) error

+ func (whisper *Whisper) Unsubscribe(id string) error

+ func (whisper *Whisper) UnsubscribeMany(ids []string) error

+ func (whisper *Whisper) Version() uint