github.com/luckypickle/go-ethereum-vet@v1.14.2/whisper/whisperv6/doc.go (about)

     1  // Copyright 2016 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  /*
    18  Package whisper implements the Whisper protocol (version 6).
    19  
    20  Whisper combines aspects of both DHTs and datagram messaging systems (e.g. UDP).
    21  As such it may be likened and compared to both, not dissimilar to the
    22  matter/energy duality (apologies to physicists for the blatant abuse of a
    23  fundamental and beautiful natural principle).
    24  
    25  Whisper is a pure identity-based messaging system. Whisper provides a low-level
    26  (non-application-specific) but easily-accessible API without being based upon
    27  or prejudiced by the low-level hardware attributes and characteristics,
    28  particularly the notion of singular endpoints.
    29  */
    30  
    31  // Contains the Whisper protocol constant definitions
    32  
    33  package whisperv6
    34  
    35  import (
    36  	"time"
    37  )
    38  
    39  // Whisper protocol parameters
    40  const (
    41  	ProtocolVersion    = uint64(6) // Protocol version number
    42  	ProtocolVersionStr = "6.0"     // The same, as a string
    43  	ProtocolName       = "shh"     // Nickname of the protocol in geth
    44  
    45  	// whisper protocol message codes, according to EIP-627
    46  	statusCode           = 0   // used by whisper protocol
    47  	messagesCode         = 1   // normal whisper message
    48  	powRequirementCode   = 2   // PoW requirement
    49  	bloomFilterExCode    = 3   // bloom filter exchange
    50  	p2pRequestCode       = 126 // peer-to-peer message, used by Dapp protocol
    51  	p2pMessageCode       = 127 // peer-to-peer message (to be consumed by the peer, but not forwarded any further)
    52  	NumberOfMessageCodes = 128
    53  
    54  	SizeMask      = byte(3) // mask used to extract the size of payload size field from the flags
    55  	signatureFlag = byte(4)
    56  
    57  	TopicLength     = 4  // in bytes
    58  	signatureLength = 65 // in bytes
    59  	aesKeyLength    = 32 // in bytes
    60  	aesNonceLength  = 12 // in bytes; for more info please see cipher.gcmStandardNonceSize & aesgcm.NonceSize()
    61  	keyIDSize       = 32 // in bytes
    62  	BloomFilterSize = 64 // in bytes
    63  	flagsLength     = 1
    64  
    65  	EnvelopeHeaderLength = 20
    66  
    67  	MaxMessageSize        = uint32(10 * 1024 * 1024) // maximum accepted size of a message.
    68  	DefaultMaxMessageSize = uint32(1024 * 1024)
    69  	DefaultMinimumPoW     = 0.2
    70  
    71  	padSizeLimit      = 256 // just an arbitrary number, could be changed without breaking the protocol
    72  	messageQueueLimit = 1024
    73  
    74  	expirationCycle   = time.Second
    75  	transmissionCycle = 300 * time.Millisecond
    76  
    77  	DefaultTTL           = 50 // seconds
    78  	DefaultSyncAllowance = 10 // seconds
    79  )
    80  
    81  // MailServer represents a mail server, capable of
    82  // archiving the old messages for subsequent delivery
    83  // to the peers. Any implementation must ensure that both
    84  // functions are thread-safe. Also, they must return ASAP.
    85  // DeliverMail should use directMessagesCode for delivery,
    86  // in order to bypass the expiry checks.
    87  type MailServer interface {
    88  	Archive(env *Envelope)
    89  	DeliverMail(whisperPeer *Peer, request *Envelope)
    90  }