PSBTPathDerivation: use typed array for path, and revert to encapsulating raw pubkey bytes

Author: Thomas Kerin

src/Transaction/PSBT/PSBTBip32Derivation.php

@@ -23,22 +23,24 @@ class PSBTBip32Derivation
      */
     private $path;
 
+    /**
+     * @var BufferInterface
+     */
+    private $rawKey;
+
     /**
      * PSBTBip32Derivation constructor.
+     * @param BufferInterface $rawKey
      * @param int $fpr
-     * @param int[] $path
+     * @param int ...$path
      */
-    public function __construct(int $fpr, array $path)
+    public function __construct(BufferInterface $rawKey, int $fpr, int ...$path)
     {
+        $this->rawKey = $rawKey;
         $this->masterKeyFpr = $fpr;
         $this->path = $path;
     }
 
-    public function getMasterKeyFpr(): int
-    {
-        return $this->masterKeyFpr;
-    }
-
     /**
      * @return int[]
      */
@@ -47,6 +49,16 @@ public function getPath(): array
         return $this->path;
     }
 
+    public function getMasterKeyFpr(): int
+    {
+        return $this->masterKeyFpr;
+    }
+
+    public function getRawPublicKey(): BufferInterface
+    {
+        return $this->rawKey;
+    }
+
     public function getPublicKey(EcAdapterInterface $ecAdapter = null): PublicKeyInterface
     {
         $ecAdapter = $ecAdapter ?: Bitcoin::getEcAdapter();

src/Transaction/PSBT/PSBTInput.php

@@ -225,7 +225,8 @@ public static function fromParser(Parser $parser, VarString $vs): PSBTInput
                         if (array_key_exists($pubKey->getBinary(), $bip32Derivations)) {
                             throw new InvalidPSBTException("Duplicate derivation");
                         }
-                        $bip32Derivations[$pubKey->getBinary()] = self::parseBip32DerivationValue($value);
+                        list ($fpr, $path) = self::parseBip32DerivationValue($value);
+                        $bip32Derivations[$pubKey->getBinary()] = new PSBTBip32Derivation($pubKey, $fpr, ...$path);
                         break;
                     case self::FINAL_SCRIPTSIG:
                         if ($finalScriptWitness !== null) {

src/Transaction/PSBT/PSBTOutput.php

@@ -111,7 +111,8 @@ public static function fromKeyValues(Parser $parser, VarString $vs): PSBTOutput
                     if (array_key_exists($pubKey->getBinary(), $bip32Derivations)) {
                         throw new InvalidPSBTException("Duplicate derivation");
                     }
-                    $bip32Derivations[$pubKey->getBinary()] = self::parseBip32DerivationValue($value);
+                    list ($fpr, $path) = self::parseBip32DerivationValue($value);
+                    $bip32Derivations[$pubKey->getBinary()] = new PSBTBip32Derivation($pubKey, $fpr, ...$path);
                     break;
                 default:
                     if (array_key_exists($key->getBinary(), $unknown)) {

src/Transaction/PSBT/ParseUtil.php

@@ -27,10 +27,10 @@ private static function parsePublicKeyKey(BufferInterface $key): BufferInterface
      * Returns array[fpr(int), path(int[])]
      *
      * @param BufferInterface $value
-     * @return PSBTBip32Derivation
+     * @return array
      * @throws InvalidPSBTException
      */
-    private static function parseBip32DerivationValue(BufferInterface $value): PSBTBip32Derivation
+    private static function parseBip32DerivationValue(BufferInterface $value): array
     {
         $len = $value->getSize();
         if ($len % 4 !== 0 || $len === 0) {
@@ -40,6 +40,6 @@ private static function parseBip32DerivationValue(BufferInterface $value): PSBTB
         $pieces = $len / 4;
         $path = unpack("N{$pieces}", $value->getBinary());
         $fpr = array_shift($path);
-        return new PSBTBip32Derivation($fpr, $path);
+        return [$fpr, $path];
     }
 }

tests/Transaction/PSBT/UpdatorTest.php

@@ -71,7 +71,7 @@ public function testUpdateWithScripts()
             $sequence = new HierarchicalKeySequence();
             $keyFactory = new PublicKeyFactory();
             $key = $keyFactory->fromHex($hexKey);
-            $derivs[$key->getPubKeyHash()->getBinary()] = new PSBTBip32Derivation($fpr, $sequence->decodeAbsolute($path)[1]);
+            $derivs[$key->getPubKeyHash()->getBinary()] = new PSBTBip32Derivation($key->getBuffer(), $fpr, ...$sequence->decodeAbsolute($path)[1]);
         };
         // not all used in script
         $createDeriv("029583bf39ae0a609747ad199addd634fa6108559d6c5cd39b4c2183f1ab96e07f", $fpr, "m/0'/0'/0'");