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 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
// 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 super::{Hash, NanoTokens, Transaction, UniquePubkey};
use crate::{DerivationIndex, Result, Signature, SpendAddress, TransferError};
use custom_debug::Debug;
use serde::{Deserialize, Serialize};
use std::cmp::Ordering;
/// SignedSpend's are constructed when a CashNote is logged to the spentbook.
#[derive(Debug, Clone, PartialOrd, Ord, Serialize, Deserialize)]
pub struct SignedSpend {
/// The Spend, which together with signature over it, constitutes the SignedSpend.
pub spend: Spend,
/// The DerivedSecretKey's signature over (the hash of) Spend, confirming that the CashNote was intended to be spent.
#[debug(skip)]
pub derived_key_sig: Signature,
}
impl SignedSpend {
/// Get public key of input CashNote.
pub fn unique_pubkey(&self) -> &UniquePubkey {
&self.spend.unique_pubkey
}
/// Get the SpendAddress where this Spend shoud be
pub fn address(&self) -> SpendAddress {
SpendAddress::from_unique_pubkey(&self.spend.unique_pubkey)
}
/// Get the hash of the transaction this CashNote is spent in
pub fn spent_tx_hash(&self) -> Hash {
self.spend.spent_tx.hash()
}
/// Get the transaction this CashNote is spent in
pub fn spent_tx(&self) -> Transaction {
self.spend.spent_tx.clone()
}
/// Get the hash of the transaction this CashNote was created in
pub fn parent_tx_hash(&self) -> Hash {
self.spend.parent_tx.hash()
}
/// Get Nano
pub fn token(&self) -> &NanoTokens {
&self.spend.token
}
/// Get reason.
pub fn reason(&self) -> Hash {
self.spend.reason
}
/// Represent this SignedSpend as bytes.
pub fn to_bytes(&self) -> Vec<u8> {
let mut bytes: Vec<u8> = Default::default();
bytes.extend(self.spend.to_bytes());
bytes.extend(self.derived_key_sig.to_bytes());
bytes
}
/// Verify a SignedSpend
///
/// Checks that
/// - the spend was indeed spent for the given Tx
/// - it was signed by the DerivedSecretKey that owns the CashNote for this Spend
/// - the signature is valid
/// - its value didn't change between the two transactions it is involved in (creation and spending)
///
/// It does NOT check:
/// - if the spend exists on the Network
/// - the spend's parents and if they exist on the Network
pub fn verify(&self, spent_tx_hash: Hash) -> Result<()> {
// verify that input spent_tx_hash matches self.spent_tx_hash
if spent_tx_hash != self.spent_tx_hash() {
return Err(TransferError::TransactionHashMismatch(
spent_tx_hash,
self.spent_tx_hash(),
));
}
// check that the spend is an output of its parent tx
let parent_tx = &self.spend.parent_tx;
let unique_key = self.unique_pubkey();
if !parent_tx
.outputs
.iter()
.any(|o| o.unique_pubkey() == unique_key)
{
return Err(TransferError::InvalidParentTx(format!(
"spend {unique_key} is not an output of the its parent tx: {parent_tx:?}"
)));
}
// check that the spend is an input of its spent tx
let spent_tx = &self.spend.spent_tx;
if !spent_tx
.inputs
.iter()
.any(|i| i.unique_pubkey() == unique_key)
{
return Err(TransferError::InvalidSpentTx(format!(
"spend {unique_key} is not an input of the its spent tx: {spent_tx:?}"
)));
}
// check that the value of the spend wasn't tampered with
let claimed_value = self.spend.token;
let creation_value = self
.spend
.parent_tx
.outputs
.iter()
.find(|o| o.unique_pubkey == self.spend.unique_pubkey)
.map(|o| o.amount)
.unwrap_or(NanoTokens::zero());
let spent_value = self
.spend
.spent_tx
.inputs
.iter()
.find(|i| i.unique_pubkey == self.spend.unique_pubkey)
.map(|i| i.amount)
.unwrap_or(NanoTokens::zero());
if claimed_value != creation_value || creation_value != spent_value {
return Err(TransferError::InvalidSpendValue(*self.unique_pubkey()));
}
// check signature
// the spend is signed by the DerivedSecretKey
// corresponding to the UniquePubkey of the CashNote being spent.
if self
.spend
.unique_pubkey
.verify(&self.derived_key_sig, self.spend.to_bytes())
{
Ok(())
} else {
Err(TransferError::InvalidSpendSignature(*self.unique_pubkey()))
}
}
/// Verify the parents of this Spend, making sure the input parent_spends are ancestors of self.
/// - verifies that the parent_spends where spent in our spend's parent_tx
/// - verifies the parent_tx against the parent_spends
pub fn verify_parent_spends<'a, T>(&self, parent_spends: T) -> Result<()>
where
T: IntoIterator<Item = &'a SignedSpend> + Clone,
{
let unique_key = self.unique_pubkey();
trace!("Verifying parent_spends for {unique_key}");
// Check that the parent where all spent to our parent_tx
let tx_our_cash_note_was_created_in = self.parent_tx_hash();
for p in parent_spends.clone().into_iter() {
let tx_parent_was_spent_in = p.spent_tx_hash();
if tx_our_cash_note_was_created_in != tx_parent_was_spent_in {
return Err(TransferError::InvalidParentSpend(format!(
"Parent spend was spent in another transaction. Expected: {tx_our_cash_note_was_created_in:?} Got: {tx_parent_was_spent_in:?}"
)));
}
}
// Here we check that the CashNote we're trying to spend was created in a valid tx
if let Err(e) = self
.spend
.parent_tx
.verify_against_inputs_spent(parent_spends)
{
return Err(TransferError::InvalidParentSpend(format!(
"Parent Tx verification failed: {e:?}"
)));
}
trace!("Validated parent_spends for {unique_key}");
Ok(())
}
}
// Impl manually to avoid clippy complaint about Hash conflict.
impl PartialEq for SignedSpend {
fn eq(&self, other: &Self) -> bool {
self.spend == other.spend && self.derived_key_sig == other.derived_key_sig
}
}
impl Eq for SignedSpend {}
impl std::hash::Hash for SignedSpend {
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
let bytes = self.to_bytes();
bytes.hash(state);
}
}
/// Represents the data to be signed by the DerivedSecretKey of the CashNote being spent.
#[derive(custom_debug::Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Spend {
/// UniquePubkey of input CashNote that this SignedSpend is proving to be spent.
pub unique_pubkey: UniquePubkey,
/// The transaction that the input CashNote is being spent in (where it is an input)
#[debug(skip)]
pub spent_tx: Transaction,
/// Reason why this CashNote was spent.
#[debug(skip)]
pub reason: Hash,
/// The amount of the input CashNote.
#[debug(skip)]
pub token: NanoTokens,
/// The transaction that the input CashNote was created in (where it is an output)
#[debug(skip)]
pub parent_tx: Transaction,
/// Data to claim the Network Royalties (if any) from the Spend's descendants (outputs in spent_tx)
#[debug(skip)]
pub network_royalties: Vec<DerivationIndex>,
}
impl Spend {
/// Represent this Spend as bytes.
/// There is no from_bytes, because this function is not symetric as it uses hashes
pub fn to_bytes(&self) -> Vec<u8> {
let mut bytes: Vec<u8> = Default::default();
bytes.extend(self.unique_pubkey.to_bytes());
bytes.extend(self.spent_tx.hash().as_ref());
bytes.extend(self.reason.as_ref());
bytes.extend(self.token.to_bytes());
bytes.extend(self.parent_tx.hash().as_ref());
bytes
}
/// represent this Spend as a Hash
pub fn hash(&self) -> Hash {
Hash::hash(&self.to_bytes())
}
}
impl PartialOrd for Spend {
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
Some(self.cmp(other))
}
}
impl Ord for Spend {
fn cmp(&self, other: &Self) -> Ordering {
self.unique_pubkey.cmp(&other.unique_pubkey)
}
}