rust-libp2p/libp2p-peerstore/src/lib.rs

// Copyright 2017 Parity Technologies (UK) Ltd.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

//! The `peerstore` crate allows one to store information about a peer.
//!
//! `peerstore` is a key-value database, where the keys are multihashes (which usually corresponds
//! to the hash of the public key of the peer, but that is not enforced by this crate) and the
//! values are the public key and a list of multiaddresses. Contrary a regular key-value storage,
//! the multiaddresses stored by the `peerstore` have a time-to-live after which they disappear.
//!
//! This crate consists in a generic `Peerstore` trait and the follow implementations:
//!
//! - `JsonPeerstore`: Stores the information in a single JSON file.
//! - `MemoryPeerstore`: Stores the information in memory.
//!
//! Note that the peerstore implementations do not consider information inside a peer store to be
//! critical. In case of an error (eg. corrupted file, disk error, etc.) they will prefer to lose
//! data rather than returning the error.
//!
//! # Example
//! 
//! ```
//! extern crate multiaddr;
//! extern crate libp2p_peerstore;
//! 
//! # fn main() {
//! use libp2p_peerstore::memory_peerstore::MemoryPeerstore;
//! use libp2p_peerstore::{Peerstore, PeerAccess};
//! use multiaddr::Multiaddr;
//! use std::time::Duration;
//! 
//! // In this example we use a `MemoryPeerstore`, but you can easily swap it for another backend.
//! let mut peerstore = MemoryPeerstore::empty();
//! let peer_id = vec![1, 2, 3, 4];
//! 
//! // Let's write some information about a peer.
//! {
//!     // `peer` mutably borrows the peerstore, so we have to do it in a local scope.
//!     let mut peer = peerstore.peer_or_create(&peer_id);
//!     peer.set_pub_key(vec![60, 90, 120, 150]);
//!     peer.add_addr(Multiaddr::new("/ip4/10.11.12.13/tcp/20000").unwrap(),
//!                   Duration::from_millis(5000));
//! }
//! 
//! // Now let's load back the info.
//! {
//!     let mut peer = peerstore.peer(&peer_id).expect("peer doesn't exist in the peerstore");
//!     println!("pub key = {:?}", peer.get_pub_key());     // should be [60, 90, 120, 150]
//!     println!("addresses = {:?}", peer.addrs().collect::<Vec<_>>());
//! }
//! # }
//! ```

extern crate base58;
extern crate datastore;
extern crate futures;
extern crate multiaddr;
extern crate owning_ref;
extern crate serde;
#[macro_use]
extern crate serde_derive;

pub use self::peerstore::{Peerstore, PeerAccess};

#[macro_use]
mod peerstore_tests;

pub mod json_peerstore;
pub mod memory_peerstore;
mod peerstore;
mod peer_info;

pub type PeerId = Vec<u8>;
pub type TTL = std::time::Duration;