ant-node 0.4.1

The Autonomi node binary
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

// Copyright 2024 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 ant_protocol::PrettyPrintRecordKey;
use libp2p::PeerId;
use thiserror::Error;

pub(super) type Result<T, E = Error> = std::result::Result<T, E>;

const SCRATCHPAD_MAX_SIZE: usize = ant_protocol::storage::Scratchpad::MAX_SIZE;

/// Put validation errors.
#[derive(Debug, Error)]
#[allow(missing_docs)]
pub enum PutValidationError {
    #[error("Error while requesting data from the local swarm")]
    LocalSwarmError,

    #[error("The record header cannot be deserialized")]
    InvalidRecordHeader,

    #[error("The record cannot be deserialized to the expected type")]
    InvalidRecord(PrettyPrintRecordKey<'static>),

    #[error("The Record::key does not match with the key derived from Record::value")]
    RecordKeyMismatch,

    #[error("Failed to serialize the record")]
    RecordSerializationFailed(PrettyPrintRecordKey<'static>),

    // ---------- Payment errors
    #[error("The record did not contain any payments: {0:?}")]
    NoPayment(PrettyPrintRecordKey<'static>),

    /// At this point in replication flows, payment is unimportant and should not be supplied
    #[error("Record should not be a `WithPayment` type: {0:?}")]
    UnexpectedRecordWithPayment(PrettyPrintRecordKey<'static>),

    #[error("Our node did not receive any payment for record: {0:?}")]
    PaymentNotMadeToOurNode(PrettyPrintRecordKey<'static>),

    #[error("The payment was made to an incorrect data type: {0:?}")]
    PaymentMadeToIncorrectDataType(PrettyPrintRecordKey<'static>),

    #[error(
        "The payment quote has out of range payees for record: {record_key:?}. Payees: {payees:?}"
    )]
    PaymentQuoteOutOfRange {
        record_key: PrettyPrintRecordKey<'static>,
        payees: Vec<PeerId>,
    },

    #[error(
        "Failed to verify payment with EVM network for record: {record_key:?}. Error: {error}"
    )]
    PaymentVerificationFailed {
        record_key: PrettyPrintRecordKey<'static>,
        error: ant_evm::payment_vault::error::Error,
    },

    // ---------- Chunk errors
    #[error("Chunk is too large: {0} bytes, when max size is {1} bytes")]
    OversizedChunk(usize, usize),

    // ------------ Scratchpad Errors
    #[error("A newer version of this Scratchpad already exists")]
    IgnoringOutdatedScratchpadPut,

    #[error("Scratchpad signature is invalid")]
    InvalidScratchpadSignature,

    #[error("Scratchpad too big: {0}, max size is {SCRATCHPAD_MAX_SIZE}")]
    ScratchpadTooBig(usize),

    // ---------- GraphEntry errors
    #[error("There are no GraphEntries in the record: {0:?}")]
    EmptyGraphEntry(PrettyPrintRecordKey<'static>),

    // ---------- Pointer errors
    #[error("Pointer signature is invalid")]
    InvalidPointerSignature,
}

/// Internal node error.
#[derive(Debug, Error)]
#[allow(missing_docs)]
pub enum Error {
    #[error("Network error {0}")]
    Network(#[from] ant_networking::NetworkError),

    #[error("Failed to parse NodeEvent")]
    NodeEventParsingFailed,

    #[error("Failed to obtain node's current port")]
    FailedToGetNodePort,

    // ---------- Quote Errors
    #[error("The content of the payment quote is invalid")]
    InvalidQuoteContent,

    #[error("The payment quote's signature is invalid")]
    InvalidQuoteSignature,
}