whisperv5

Sep 14, 2017

Changes in this version

+ const DefaultMaxMessageSize

+ const MaxMessageSize

+ 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 ErrSymAsym = errors.New("specify either a symmetric or an asymmetric key")

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

+ type Config struct

+ MaxMessageSize uint32

+ MinimumAcceptedPOW float64

+ 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 Info struct

+ MaxMessageSize uint32

+ Memory int

+ Messages int

+ MinPow float64

+ type Message struct

+ Dst []byte

+ Hash []byte

+ 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 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 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) 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) GetSymKey(ctx context.Context, id string) (hexutil.Bytes, error)

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

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

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

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

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

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

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

type TopicType

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

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

type Whisper

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

+ func (w *Whisper) MaxMessageSize() uint32

+ func (w *Whisper) MinPow() float64

+ func (w *Whisper) Overflow() bool

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

Jun 1, 2017

Changes in this version

+ const AESNonceLength

type PostArgs

+ Sig string

type PublicWhisperAPI

+ func (api *PublicWhisperAPI) GetFloatingMessages(id string) []*WhisperMessage

+ func (api *PublicWhisperAPI) GetNewSubscriptionMessages(id string) []*WhisperMessage

type WhisperFilterArgs

+ Sig string

Apr 14, 2017

Changes in this version

+ const DefaultMaxMessageLength

+ const DefaultMinimumPoW

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

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

+ func ValidateKeyID(id string) error

type Filter

+ AllowP2P bool

+ type PostArgs struct

+ Key string

+ Padding hexutil.Bytes

+ Payload hexutil.Bytes

+ PowTarget float64

+ PowTime uint32

+ SignWith string

+ TTL uint32

+ TargetPeer string

+ Topic hexutil.Bytes

+ Type string

+ type PublicWhisperAPI struct

+ func NewPublicWhisperAPI(w *Whisper) *PublicWhisperAPI

+ func (api *PublicWhisperAPI) AddSymmetricKeyDirect(key hexutil.Bytes) (string, error)

+ func (api *PublicWhisperAPI) AddSymmetricKeyFromPassword(password string) (string, error)

+ func (api *PublicWhisperAPI) AllowP2PMessagesFromPeer(enode string) error

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

+ func (api *PublicWhisperAPI) DeleteSymmetricKey(name string) (bool, error)

+ func (api *PublicWhisperAPI) GenerateSymmetricKey() (string, error)

+ func (api *PublicWhisperAPI) GetMessages(filterId string) []*WhisperMessage

+ func (api *PublicWhisperAPI) GetPrivateKey(id string) (string, error)

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

+ func (api *PublicWhisperAPI) GetSubscriptionMessages(filterId string) []*WhisperMessage

+ func (api *PublicWhisperAPI) GetSymmetricKey(name string) (hexutil.Bytes, error)

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

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

+ func (api *PublicWhisperAPI) Info() (string, error)

+ func (api *PublicWhisperAPI) NewKeyPair() (string, error)

+ func (api *PublicWhisperAPI) Post(args PostArgs) error

+ func (api *PublicWhisperAPI) SetMaxMessageLength(val int) error

+ func (api *PublicWhisperAPI) SetMinimumPoW(val float64) error

+ func (api *PublicWhisperAPI) Start() error

+ func (api *PublicWhisperAPI) Stop() error

+ func (api *PublicWhisperAPI) Subscribe(args WhisperFilterArgs) (string, error)

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

+ func (api *PublicWhisperAPI) Version() (hexutil.Uint, error)

+ type Statistics struct

type Whisper

+ func New() *Whisper

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

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

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

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

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

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

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

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

+ func (w *Whisper) RegisterServer(server MailServer)

+ func (w *Whisper) SetMaxMessageLength(val int) error

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

+ func (w *Whisper) Stats() string

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

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

+ type WhisperFilterArgs struct

+ AllowP2P bool

+ Key string

+ MinPoW float64

+ SignedWith string

+ Symmetric bool

+ Topics [][]byte

+ func (args *WhisperFilterArgs) UnmarshalJSON(b []byte) (err error)

+ type WhisperMessage struct

+ Dst string

+ Hash string

+ Padding string

+ Payload string

+ PoW float64

+ Src string

+ TTL uint32

+ Timestamp uint32

+ Topic string

+ func NewWhisperMessage(message *ReceivedMessage) *WhisperMessage

Feb 1, 2017

Changes in this version

+ const AESNonceMaxLength

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

type Filter

+ func (f *Filter) MatchTopic(topic TopicType) bool

type Peer

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

type Whisper

+ func (w *Whisper) SendP2PDirect(peer *Peer, envelope *Envelope) error

Nov 16, 2016

Changes in this version

+ const DefaultTTL

+ const EnvelopeVersion

+ const MaxMessageLength

+ const MinimumPoW

+ const NumberOfMessageCodes

+ const ProtocolName

+ const ProtocolVersion

+ const ProtocolVersionStr

+ const SynchAllowance

+ const TopicLength

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

+ func DeriveOneTimeKey(key []byte, salt []byte, version uint64) ([]byte, error)

+ func ValidatePublicKey(k *ecdsa.PublicKey) bool

+ type Envelope struct

+ AESNonce []byte

+ Data []byte

+ EnvNonce uint64

+ Expiry uint32

+ Salt []byte

+ TTL uint32

+ Topic TopicType

+ Version []byte

+ func NewEnvelope(ttl uint32, topic TopicType, salt []byte, aesNonce []byte, msg *SentMessage) *Envelope

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

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

+ func (e *Envelope) IsSymmetric() bool

+ 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)

+ func (e *Envelope) Ver() uint64

+ type Filter struct

+ AcceptP2P bool

+ KeyAsym *ecdsa.PrivateKey

+ KeySym []byte

+ Messages map[common.Hash]*ReceivedMessage

+ PoW float64

+ Src *ecdsa.PublicKey

+ SymKeyHash common.Hash

+ Topics []TopicType

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

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

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

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

+ type Filters struct

+ func NewFilters(w *Whisper) *Filters

+ func (fs *Filters) Get(i int) *Filter

+ func (fs *Filters) Install(watcher *Filter) int

+ func (fs *Filters) NotifyWatchers(env *Envelope, messageCode uint64)

+ func (fs *Filters) Uninstall(id int)

+ type MailServer interface

+ Archive func(env *Envelope)

+ DeliverMail func(whisperPeer *Peer, data []byte)

+ type MessageParams struct

+ Dst *ecdsa.PublicKey

+ KeySym []byte

+ Padding []byte

+ Payload []byte

+ PoW float64

+ Src *ecdsa.PrivateKey

+ TTL uint32

+ Topic TopicType

+ WorkTime uint32

+ type Peer struct

+ type ReceivedMessage struct

+ Dst *ecdsa.PublicKey

+ EnvelopeHash common.Hash

+ EnvelopeVersion uint64

+ Padding []byte

+ Payload []byte

+ PoW float64

+ Raw []byte

+ Sent uint32

+ Signature []byte

+ Src *ecdsa.PublicKey

+ SymKeyHash common.Hash

+ TTL uint32

+ Topic TopicType

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

+ func (msg *ReceivedMessage) Validate() bool

+ type SentMessage struct

+ Raw []byte

+ func NewSentMessage(params *MessageParams) *SentMessage

+ func (msg *SentMessage) Wrap(options *MessageParams) (envelope *Envelope, err error)

+ type TopicType [TopicLength]byte

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

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

+ func (topic *TopicType) String() string

+ type Whisper struct

+ func NewWhisper(server MailServer) *Whisper

+ func (w *Whisper) AddSymKey(name string, key []byte) error

+ func (w *Whisper) DeleteIdentity(key string)

+ func (w *Whisper) DeleteSymKey(name string)

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

+ func (w *Whisper) GenerateSymKey(name string) error

+ func (w *Whisper) GetFilter(id int) *Filter

+ func (w *Whisper) GetIdentity(pubKey string) *ecdsa.PrivateKey

+ func (w *Whisper) GetSymKey(name string) []byte

+ func (w *Whisper) HasIdentity(pubKey string) bool

+ func (w *Whisper) HasSymKey(name string) bool

+ func (w *Whisper) MarkPeerTrusted(peerID []byte) error

+ func (w *Whisper) Messages(id int) []*ReceivedMessage

+ func (w *Whisper) NewIdentity() *ecdsa.PrivateKey

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

+ func (w *Whisper) RequestHistoricMessages(peerID []byte, data []byte) error

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

+ func (w *Whisper) SendP2PMessage(peerID []byte, envelope *Envelope) error

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

+ func (w *Whisper) Stop() error

+ func (w *Whisper) Unwatch(id int)

+ func (w *Whisper) Version() uint

+ func (w *Whisper) Watch(f *Filter) int

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