autonomi 0.8.0

Autonomi client API
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

// Copyright 2025 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under The General Public License (GPL), version 3.
// Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed
// under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. Please review the Licences for the specific language governing
// permissions and limitations relating to use of the SAFE Network Software.

use crate::networking::{OneShotTaskResult, PeerQuoteWithStorageProof};
use ant_evm::{merkle_payments::MerklePaymentCandidateNode, PaymentQuote};
use ant_protocol::storage::DataTypes;
use ant_protocol::NetworkAddress;
use libp2p::{
    kad::{PeerInfo, Quorum, Record},
    PeerId,
};
use std::num::NonZeroUsize;

/// Task for the underlying network driver
/// Sent by the [`crate::Network`], handled by the [`crate::driver::NetworkDriver`]
///
/// - [`crate::Network`]: The client interface to the network, sends [`NetworkTask`] to the [`crate::driver::NetworkDriver`]
/// - [`NetworkTask`]: The task to be processed by the network driver
/// - [`crate::driver::NetworkDriver`]:
///     - the NetworkDriver sends the query to the network [`crate::driver::NetworkDriver::process_task`]
///     - it then waits for libp2p events and updates the pending tasks accordingly [`crate::driver::NetworkDriver::process_swarm_event`]
///     - ultimately sending the result back to the [`crate::Network`] via the oneshot channel provided when the task was created
#[derive(custom_debug::Debug)]
pub(super) enum NetworkTask {
    /// cf [`crate::driver::task_handler::TaskHandler::update_closest_peers`]
    GetClosestPeers {
        addr: NetworkAddress,
        #[debug(skip)]
        resp: OneShotTaskResult<Vec<PeerInfo>>,
        n: NonZeroUsize,
    },
    /// cf [`crate::driver::task_handler::TaskHandler::update_get_record`]
    GetRecord {
        addr: NetworkAddress,
        quorum: Quorum,
        #[debug(skip)]
        resp: OneShotTaskResult<(Option<Record>, Vec<PeerId>)>,
    },
    /// cf [`crate::driver::task_handler::TaskHandler::update_put_record_kad`]
    #[allow(dead_code)]
    PutRecordKad {
        #[debug(skip)]
        record: Record,
        /// Empty vec results in regular store to peers closest to record address
        to: Vec<PeerInfo>,
        quorum: Quorum,
        #[debug(skip)]
        resp: OneShotTaskResult<()>,
    },
    /// cf [`crate::driver::task_handler::TaskHandler::update_put_record_kad_req`]
    PutRecordReq {
        #[debug(skip)]
        record: Record,
        to: PeerInfo,
        #[debug(skip)]
        resp: OneShotTaskResult<()>,
    },
    /// cf [`crate::driver::task_handler::TaskHandler::update_get_quote`]
    GetQuote {
        addr: NetworkAddress,
        peer: PeerInfo,
        data_type: u32,
        data_size: usize,
        #[debug(skip)]
        resp: OneShotTaskResult<Option<(PeerInfo, PaymentQuote)>>,
    },
    /// cf [`crate::driver::task_handler::TaskHandler::update_get_version`]
    GetVersion {
        peer: PeerInfo,
        #[debug(skip)]
        resp: OneShotTaskResult<String>,
    },
    /// Get a record directly from a specific peer using request/response
    GetRecordFromPeer {
        addr: NetworkAddress,
        peer: PeerInfo,
        #[debug(skip)]
        resp: OneShotTaskResult<Option<Record>>,
    },
    /// Get storage proofs directly from a specific peer using request/response
    GetStorageProofsFromPeer {
        addr: NetworkAddress,
        peer: PeerInfo,
        nonce: u64,
        difficulty: usize,
        data_type: DataTypes,
        data_size: usize,
        #[debug(skip)]
        resp: OneShotTaskResult<PeerQuoteWithStorageProof>,
    },
    /// Get closest peers from a specific peer using request/response
    GetClosestPeersFromPeer {
        addr: NetworkAddress,
        peer: PeerInfo,
        num_of_peers: Option<usize>,
        #[debug(skip)]
        resp: OneShotTaskResult<Vec<(NetworkAddress, Vec<libp2p::Multiaddr>)>>,
    },
    /// Get information about the amount of connections made
    ConnectionsMade {
        #[debug(skip)]
        resp: OneShotTaskResult<usize>,
    },
    /// Get a Merkle candidate quote from a specific peer
    /// Used for Merkle batch payment system
    GetMerkleCandidateQuote {
        addr: NetworkAddress,
        peer: PeerInfo,
        data_type: u32,
        data_size: usize,
        merkle_payment_timestamp: u64,
        #[debug(skip)]
        resp: OneShotTaskResult<MerklePaymentCandidateNode>,
    },
}