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

// Copyright 2023 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::{
    storage::{Chunk, ChunkAddress, DbcAddress},
    NetworkAddress,
};

use super::RegisterCmd;

// TODO: remove this dependency and define these types herein.
pub use sn_dbc::{Hash, SignedSpend};

use serde::{Deserialize, Serialize};

/// Data and Dbc cmds - recording spends or creating, updating, and removing data.
///
/// See the [`protocol`] module documentation for more details of the types supported by the Safe
/// Network, and their semantics.
///
/// [`protocol`]: crate
#[allow(clippy::large_enum_variant)]
#[derive(Eq, PartialEq, Clone, Serialize, Deserialize, custom_debug::Debug)]
pub enum Cmd {
    /// [`Chunk`] write operation.
    ///
    /// [`Chunk`]: crate::storage::Chunk
    StoreChunk {
        chunk: Chunk,
        // Storage payment proof
        // TODO: temporarily payment proof is optional
        payment: Option<PaymentProof>,
    },
    /// [`Register`] write operation.
    ///
    /// [`Register`]: crate::storage::Register
    Register(RegisterCmd),
    /// [`SignedSpend`] write operation.
    ///
    /// [`SignedSpend`]: sn_dbc::SignedSpend
    /// The spend to be recorded.
    /// It contains the transaction it is being spent in.
    SpendDbc(SignedSpend),
    /// Write operation to notify peer fetch a list of [`NetworkAddress`] from the holder.
    ///
    /// [`NetworkAddress`]: crate::NetworkAddress
    Replicate {
        /// Holder of the replication keys.
        holder: NetworkAddress,
        /// Keys of copy that shall be replicated.
        #[debug(skip)]
        keys: Vec<NetworkAddress>,
    },
}

impl Cmd {
    /// Used to send a cmd to the close group of the address.
    pub fn dst(&self) -> NetworkAddress {
        match self {
            Cmd::StoreChunk { chunk, .. } => {
                NetworkAddress::from_chunk_address(ChunkAddress::new(*chunk.name()))
            }
            Cmd::Register(cmd) => NetworkAddress::from_register_address(cmd.dst()),
            Cmd::SpendDbc(signed_spend) => {
                NetworkAddress::from_dbc_address(DbcAddress::from_dbc_id(signed_spend.dbc_id()))
            }
            Cmd::Replicate { holder, .. } => holder.clone(),
        }
    }
}

impl std::fmt::Display for Cmd {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Cmd::StoreChunk { chunk, .. } => {
                write!(f, "Cmd::StoreChunk({:?})", chunk.name())
            }
            Cmd::Register(cmd) => {
                write!(f, "Cmd::Register({:?})", cmd.name()) // more qualification needed
            }
            Cmd::SpendDbc(signed_spend) => {
                write!(f, "Cmd::SpendDbc({:?})", signed_spend.dbc_id())
            }
            Cmd::Replicate { holder, keys } => {
                write!(
                    f,
                    "Cmd::Replicate({:?} has {} keys)",
                    holder.as_peer_id(),
                    keys.len()
                )
            }
        }
    }
}

// Data type of each of the nodes in the binary Merkle-tree built for payment proofs
pub type MerkleTreeNodesType = [u8; 32];

#[derive(Clone, Eq, PartialEq, Serialize, Deserialize, custom_debug::Debug)]
pub struct PaymentProof {
    // Reason-hash value set in the input/parent DBCs spent for this storage payment.
    // TOOD: pass the output DBC instead, nodes can check input/parent DBCs' reason-hash among other pending validations.
    pub reason_hash: Hash,
    // Merkletree audit trail to prove the Chunk has been paid by the
    // given DBC (using the DBC's 'reason' field)
    pub audit_trail: Vec<MerkleTreeNodesType>,
    // Path of the audit trail
    pub path: Vec<usize>,
}