From 2f838218a8c4a6d4ab1e6d1db13165de66700a16 Mon Sep 17 00:00:00 2001
From: Dr Maxim Orlovsky <orlovsky@pandoracore.com>
Date: Sat, 28 Nov 2020 13:49:50 +0100
Subject: [PATCH] PSBT: merging new global keys

Plus necessary changes to BIP 32 implementations and error type
---
 src/util/bip32.rs           |  9 +++++--
 src/util/psbt/error.rs      |  5 +++-
 src/util/psbt/map/global.rs | 51 +++++++++++++++++++++++++++++++++++++
 3 files changed, 62 insertions(+), 3 deletions(-)

diff --git a/src/util/bip32.rs b/src/util/bip32.rs
index 1dcabe42..964e79e1 100644
--- a/src/util/bip32.rs
+++ b/src/util/bip32.rs
@@ -126,14 +126,14 @@ impl ChildNumber {
     /// Returns `true` if the child number is a [`Normal`] value.
     ///
     /// [`Normal`]: #variant.Normal
-    pub fn is_normal(self) -> bool {
+    pub fn is_normal(&self) -> bool {
         !self.is_hardened()
     }
 
     /// Returns `true` if the child number is a [`Hardened`] value.
     ///
     /// [`Hardened`]: #variant.Hardened
-    pub fn is_hardened(self) -> bool {
+    pub fn is_hardened(&self) -> bool {
         match self {
             ChildNumber::Hardened {..} => true,
             ChildNumber::Normal {..} => false,
@@ -299,6 +299,11 @@ impl<'a> Iterator for DerivationPathIterator<'a> {
 }
 
 impl DerivationPath {
+    /// Returns length of the derivation path
+    pub fn len(&self) -> usize {
+        self.0.len()
+    }
+
     /// Create a new [DerivationPath] that is a child of this one.
     pub fn child(&self, cn: ChildNumber) -> DerivationPath {
         let mut path = self.0.clone();
diff --git a/src/util/psbt/error.rs b/src/util/psbt/error.rs
index f8bf549a..a418ef07 100644
--- a/src/util/psbt/error.rs
+++ b/src/util/psbt/error.rs
@@ -68,7 +68,9 @@ pub enum Error {
         preimage: Vec<u8>,
         /// Hash value
         hash: Vec<u8>,
-    }
+    },
+    /// Data inconsistency/conflicting data during merge procedure
+    MergeConflict(String),
 }
 
 impl fmt::Display for Error {
@@ -91,6 +93,7 @@ impl fmt::Display for Error {
                 // directly using debug forms of psbthash enums
                 write!(f, "Preimage {:?} does not match {:?} hash {:?}", preimage, hash_type, hash )
             }
+            Error::MergeConflict(ref s) => { write!(f, "Merge conflict: {}", s) }
         }
     }
 }
diff --git a/src/util/psbt/map/global.rs b/src/util/psbt/map/global.rs
index 5a571e51..d58dc6e7 100644
--- a/src/util/psbt/map/global.rs
+++ b/src/util/psbt/map/global.rs
@@ -15,6 +15,7 @@
 use std::collections::BTreeMap;
 use std::collections::btree_map::Entry;
 use std::io::{self, Cursor, Read};
+use std::cmp::Ordering;
 
 use blockdata::transaction::Transaction;
 use consensus::{encode, Encodable, Decodable};
@@ -113,6 +114,8 @@ impl Map for Global {
         Ok(rv)
     }
 
+    // Keep in mind that according to BIP 174 this function must be transitive, i.e.
+    // A.merge(B) == B.merge(A)
     fn merge(&mut self, other: Self) -> Result<(), psbt::Error> {
         if self.unsigned_tx != other.unsigned_tx {
             return Err(psbt::Error::UnexpectedUnsignedTx {
@@ -121,6 +124,54 @@ impl Map for Global {
             });
         }
 
+        // BIP 174: The Combiner must remove any duplicate key-value pairs, in accordance with
+        //          the specification. It can pick arbitrarily when conflicts occur.
+
+        // Keeping the highest version
+        self.version = self.version.max(other.version);
+
+        // Merging xpubs
+        for (xpub, (fingerprint1, derivation1)) in other.xpub {
+            match self.xpub.entry(xpub) {
+                Entry::Vacant(entry) => {
+                    entry.insert((fingerprint1, derivation1));
+                },
+                Entry::Occupied(mut entry) => {
+                    // Here in case of the conflict we select the version with algorithm:
+                    // 1) if fingerprints are equal but derivations are not, we report an error; otherwise
+                    // 2) choose longest unhardened derivation; if equal
+                    // 3) choose longest derivation; if equal
+                    // 4) choose largest fingerprint; if equal
+                    // 5) do nothing
+                    // Clone is required for Rust 1.29 borrow checker
+                    let (fingerprint2, derivation2) = entry.get().clone();
+                    let len1 = derivation1.len();
+                    let len2 = derivation2.len();
+                    let normal_len1 = derivation1.into_iter().rposition(ChildNumber::is_normal);
+                    let normal_len2 = derivation2.into_iter().rposition(ChildNumber::is_normal);
+                    match (normal_len1.cmp(&normal_len2), len1.cmp(&len2), fingerprint1.cmp(&fingerprint2)) {
+                        (Ordering::Equal, Ordering::Equal, Ordering::Equal) => {},
+                        (Ordering::Equal, _, Ordering::Equal) => {
+                            return Err(psbt::Error::MergeConflict(format!(
+                                "global xpub {} has inconsistent key sources",
+                                xpub
+                            ).to_owned()));
+                        }
+                        (Ordering::Greater, _, _)
+                        | (Ordering::Equal, Ordering::Greater, _)
+                        | (Ordering::Equal, Ordering::Equal, Ordering::Greater) => {
+                            entry.insert((fingerprint1, derivation1));
+                        },
+                        (Ordering::Less, _, _)
+                        | (Ordering::Equal, Ordering::Less, _)
+                        | (Ordering::Equal, Ordering::Equal, Ordering::Less) => {
+                            // do nothing here: we already own the proper data
+                        }
+                    }
+                }
+            }
+        }
+
         self.unknown.extend(other.unknown);
         Ok(())
     }