github.com/jeffallen/go-ethereum@v1.1.4-0.20150910155051-571d3236c49c/whisper/doc.go (about)

     1  // Copyright 2014 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 PoC-1.
    19  
    20  (https://github.com/ethereum/wiki/wiki/Whisper-PoC-1-Protocol-Spec)
    21  
    22  Whisper combines aspects of both DHTs and datagram messaging systems (e.g. UDP).
    23  As such it may be likened and compared to both, not dissimilar to the
    24  matter/energy duality (apologies to physicists for the blatant abuse of a
    25  fundamental and beautiful natural principle).
    26  
    27  Whisper is a pure identity-based messaging system. Whisper provides a low-level
    28  (non-application-specific) but easily-accessible API without being based upon
    29  or prejudiced by the low-level hardware attributes and characteristics,
    30  particularly the notion of singular endpoints.
    31  */
    32  package whisper