feeless 0.1.11

A Nano (cryptocurrency) node and utilities such as nano addresses, hashing blocks, signing, etc.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

#![forbid(unsafe_code)]
#![allow(dead_code)]
// #![warn(missing_docs)] LOL not yet.
//! A set of tools to handle many aspects of the Nano cryptocurrency.
//!
//! See the [feeless.dev website](https://feeless.dev) for more details about this project.
//!
//! ## Keys and signing example
//! ```
//! use feeless::Phrase;
//! use feeless::phrase::Language;
//!
//! # fn main() -> anyhow::Result<()> {
//! // Example phrase from https://docs.nano.org/integration-guides/key-management/#test-vectors
//! let words = "edge defense waste choose enrich upon flee junk siren film clown finish
//!              luggage leader kid quick brick print evidence swap drill paddle truly occur";
//!
//! // Generate the private key from the seed phrase.
//! let phrase = Phrase::from_words(Language::English, words)?;
//!
//! // First account with the password `some password`.
//! let private_key = phrase.to_private(0, "some password")?;
//! let public_key = private_key.to_public()?;
//! let address = public_key.to_address();
//!
//! // The above three lines can be chained like this:
//! let address = phrase.to_private(0, "some password")?.to_public()?.to_address();
//! assert_eq!(address.to_string(), "nano_1pu7p5n3ghq1i1p4rhmek41f5add1uh34xpb94nkbxe8g4a6x1p69emk8y1d");
//!     
//! // Sign a message.
//! let message = "secret message!".as_bytes();
//! let signature = private_key.sign(message)?;
//!
//! // Someone else can verify the message based on your address or public key.
//! address.to_public().verify(message, &signature)?;
//! public_key.verify(message, &signature)?;
//!     
//! # Ok(())
//! # }
//! ```

pub(crate) use encoding::{hex_formatter, to_hex};
pub use keys::address::Address;
pub use keys::phrase;
pub use keys::phrase::Phrase;
pub use keys::private::Private;
pub use keys::public::Public;
pub use keys::seed::Seed;
pub use keys::signature::Signature;
pub use pow::work::Work;
pub use units::rai::Rai;
pub use errors::FeelessError;

#[cfg(feature = "node")]
mod node;

#[cfg(feature = "pcap")]
mod pcap;

#[cfg(feature = "wallet")]
pub mod wallet;

#[doc(hidden)]
pub mod cli;

pub mod blocks;
mod bytes;
mod debug;
mod encoding;
mod keys;
mod network;
mod pow;
mod errors;
pub mod units;
pub mod vanity;

/// The default TCP port that Nano nodes use.
pub const DEFAULT_PORT: u16 = 7075;

fn expect_len(got_len: usize, expected_len: usize, msg: &str) -> Result<(), FeelessError> {
    if got_len != expected_len {
        return Err(errors::FeelessError::WrongLength {
            msg: msg.to_string(),
            expected: expected_len,
            found: got_len,
        })
    }
    Ok(())
}

fn len_err_msg(got_len: usize, expected_len: usize, msg: &str) -> String {
    format!(
        "{} is the wrong length: got: {} expected: {}",
        msg, got_len, expected_len,
    )
}