dweb 0.13.3

Decentralised web and storage library for Autonomi
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

/*
Copyright (c) 2024-2025 Mark Hughes

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

pub mod convert;
pub mod file;
pub mod graph_entry;
pub mod retry;
pub mod web;

use blsttc::SecretKey;
use color_eyre::{eyre::eyre, Result};

/// Lengths of hex addresses in Autonomi
pub const DATA_ADDRESS_LEN: usize = 64;
pub const HISTORY_ADDRESS_LEN: usize = 96;

/// Check if the main dweb server is running on the given port
pub fn is_main_dweb_server_running(main_port: u16) -> bool {
    if !port_check::is_local_ipv4_port_free(main_port) {
        // The port is in use
        // TODO check if it is a dweb server (but for now assume it is)
        true
    } else {
        false
    }
}

/// Get the maini secret key. This is currently derived from a key set in the environment
/// TODO ?provide a primary method with environment setting as a backup
pub fn get_app_secret_key() -> Result<SecretKey> {
    match crate::autonomi::access::keys::get_vault_secret_key() {
        Ok(secret_key) => Ok(secret_key),
        Err(e) => {
            let message = format!("No secret key is available - {e}");
            println!("DEBUG {message}");
            return Err(eyre!(message));
        }
    }
}

// Make a vector of node Entry with vector[0] being the first node in the history.
// We take the first 'root' node and the first child of the root, the first child
// of that child and so on.
// So if there were multiple children (i.e. conflicting versions) only one is included
// pub fn node_entries_as_vec(register: &Register) -> Vec<Entry> {
//     let merkle_reg = register.inner_merkle_reg();
//     let content = merkle_reg.read();
//     let mut entries_vec: Vec<Entry> = Vec::new();
//     let mut node = content.nodes().nth(0);
//     while node.is_some() {
//         let node_ref = node.unwrap();
//         entries_vec.push(node_ref.value.clone());
//         node = if let Some(first_child_hash) = node_ref.children.clone().into_iter().nth(0) {
//             merkle_reg.node(first_child_hash)
//         } else {
//             None
//         };
//     }
//     entries_vec.reverse();
//     entries_vec
// }

// TODO replace with Transactions based history
// Interim using defanged Register until implemented for Transactions
// Always returns the most recent entry at Vec[1] and a dummy entry, the type at Vec[0]
// pub fn node_entries_as_vec(register: &Register) -> Vec<Entry> {
//     const AWV_REG_TYPE_PUBLIC: &str =
//         "5ebbbc4f061702c875b6cacb76e537eb482713c458b9d83c2f1e86ea9e0d0d0f";

//     let mut entries_vec: Vec<Entry> = Vec::new();

//     let type_entry = match convert::str_to_xor_name(AWV_REG_TYPE_PUBLIC) {
//         Ok(entry) => entry,
//         Err(e) => panic!("Failed to decode AWV_REG_TYPE_PUBLIC"),
//     };
//     entries_vec.push(type_entry.to_vec());
//     if register.values().len() > 0 {
//         entries_vec.push(register.values()[0].to_vec());
//     }
//     entries_vec
// }