bitsplain 0.1.0-alpha.1

Bitsplain helps understand Bitcoin-related binary data
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

//! Functions decoding textual input according to various encoding schemes.

use std::ops::Deref;

use bytes::Bytes;

/// Binary data with information about their origin.
#[derive(Clone, Debug)]
pub enum Binary {
    Hex(Bytes),
    Base58Check(Bytes),
    Base64(Bytes),
    Bech32(String, Bytes),
    Raw(Bytes),
}

impl Deref for Binary {
    type Target = [u8];

    fn deref(&self) -> &Self::Target {
        match self {
            Binary::Hex(v) => v,
            Binary::Base58Check(v) => v,
            Binary::Base64(v) => v,
            Binary::Raw(v) => v,
            Binary::Bech32(_, v) => v,
        }
    }
}

/// Attempt to decode string as hexadecimal string.
pub fn string_to_hex(s: &str) -> Option<Binary> {
    hex::decode(s).ok().map(|b| Binary::Hex(b.into()))
}

/// Attempt to decode string as Base64-encoded string.
pub fn string_to_base64(s: &str) -> Option<Binary> {
    use base64::Engine;
    base64::engine::general_purpose::STANDARD
        .decode(s)
        .ok()
        .map(|b| Binary::Base64(b.into()))
}

/// Attempt to decode string as Base58-encoded string.
pub fn string_to_base58(s: &str) -> Option<Binary> {
    use bitcoin::util::base58::*;
    from_check(s).ok().map(|b| Binary::Base58Check(b.into()))
}

/// Attempt to decode string as Bech32-encoded string without checksum.
pub fn string_to_bech32(s: &str) -> Option<Binary> {
    bech32::decode_without_checksum(s)
        .ok()
        .and_then(|(hrp, data)| {
            bech32::convert_bits(&data, 5, 8, false)
                .ok()
                .map(|data| Binary::Bech32(hrp, data.into()))
        })
}

/// Attempt to decode raw byets as string.
pub fn binary_to_string(b: &[u8]) -> Option<String> {
    String::from_utf8(b.to_vec()).ok()
}