Refactor derivation functions to use NetworkNodeInfo and simplify parameters

Author: dev2-nomo

lib/src/crypto/network_type.dart

@@ -78,6 +78,16 @@ sealed class UTXONetworkType extends NetworkType {
 
 typedef BIP32Prefixes = ({int private, int public});
 
+class NetworkNodeInfo {
+  final int wif;
+  final BIP32Prefixes keyPrefixes;
+
+  const NetworkNodeInfo({
+    required this.wif,
+    required this.keyPrefixes,
+  });
+}
+
 class NetworkBIP {
   final int wif;
 
@@ -98,19 +108,43 @@ class NetworkBIP {
     DOGE_NETWORK_BIP,
   ];
 
-  static (BIP32Prefixes, NetworkBIP)? findPrefixesFromVersion(int version) {
+  static NetworkNodeInfo? findPrefixesFromVersion(int version) {
     return defaults
         .map((e) {
           final prefixes = e.fromVersion(version);
           if (prefixes != null) {
-            return (prefixes, e);
+            return NetworkNodeInfo(
+              wif: e.wif,
+              keyPrefixes: prefixes,
+            );
           }
           return null;
         })
         .nonNulls
         .firstOrNull;
   }
 
+  NetworkNodeInfo getForPurpose(HDWalletPurpose purpose) {
+    switch (purpose) {
+      case HDWalletPurpose.NO_STRUCTURE:
+      case HDWalletPurpose.BIP44:
+        return NetworkNodeInfo(
+          wif: wif,
+          keyPrefixes: bip32,
+        );
+      case HDWalletPurpose.BIP84:
+        return NetworkNodeInfo(
+          wif: wif,
+          keyPrefixes: bip84,
+        );
+      case HDWalletPurpose.BIP49:
+        return NetworkNodeInfo(
+          wif: wif,
+          keyPrefixes: bip49,
+        );
+    }
+  }
+
   const NetworkBIP({
     required this.bip32,
     required this.bip49,

lib/src/crypto/utxo/utils/derivation.dart

@@ -42,24 +42,28 @@ HDNode deriveMasterNodeFromSeed({
   required HDWalletPath walletPath,
   required UTXONetworkType networkType,
 }) {
-  final parentNode = HDNode.fromSeed(seed, network: networkType.networkBIP);
+  final masterNode = HDNode.fromSeed(
+    seed,
+    network: networkType.networkBIP.getForPurpose(walletPath.purpose),
+  );
+
   final derivationPath = switch (walletPath.basePath) {
     "m/44'/2'" => walletPath.account0Path,
     _ => walletPath.purpose.string,
   };
   final node =
-      parentNode.derivePath(derivationPath); // TODO: Use base Path with Account
+      masterNode.derivePath(derivationPath); // TODO: Use base Path with Account
 
   return node;
 }
 
 HDNode deriveMasterNodeFromExtendedKey(
   String ePubKey, {
-  UTXONetworkType? networkType,
+  NetworkNodeInfo? nodeNetworkInfo,
 }) {
   return HDNode.fromExtendedKey(
     ePubKey,
-    network: networkType?.networkBIP,
+    network: nodeNetworkInfo,
   );
 }
 
@@ -121,8 +125,9 @@ HDNode deriveChildNodeFromPath({
 
 extension on HDNode {
   String toBase58wkCompatibility(int parentFingerprint, int depth) {
-    final version =
-        (!isNeutered) ? network!.bip32.private : network!.bip32.public;
+    final version = !isNeutered
+        ? network!.keyPrefixes.private
+        : network!.keyPrefixes.public;
     Uint8List buffer = new Uint8List(78);
     ByteData bytes = buffer.buffer.asByteData();
     bytes.setUint32(0, version);

lib/src/crypto/utxo/utxo_analyzer.dart

@@ -204,15 +204,17 @@ Future<UTXOTxInfo> fetchUTXOTransactionsFromEpubKey({
   /// Search for Receive and Change Addresses
   ///
 
+  final nodeNetworkInfo = networkType.networkBIP.getForPurpose(purpose);
+
   final masterNode = await isolateManager.executeTask(
     IsolateTask(
       task: (arg) {
         return deriveMasterNodeFromExtendedKey(
           arg.$1,
-          networkType: arg.$2,
+          nodeNetworkInfo: arg.$2,
         );
       },
-      argument: (ePubKey, networkType),
+      argument: (ePubKey, nodeNetworkInfo),
     ),
   );
 

lib/src/wallet/hd_node.dart

@@ -15,7 +15,7 @@ const UINT32_MAX = 4294967295; // 2^32 - 1
 /// Inspired by https://github.com/dart-bitcoin/
 ///
 class HDNode {
-  final NetworkBIP? network;
+  final NetworkNodeInfo? network;
   final Uint8List _q;
   final Uint8List? _p;
   final Uint8List chainCode;
@@ -72,7 +72,7 @@ class HDNode {
   String? extendedPrivateKey({
     int? version,
   }) {
-    version ??= network?.bip32.private;
+    version ??= network?.keyPrefixes.private;
     if (version == null) {
       throw ArgumentError("Missing version");
     }
@@ -100,7 +100,7 @@ class HDNode {
   }
 
   String extendedPublicKey({int? version}) {
-    version ??= network?.bip32.public;
+    version ??= network?.keyPrefixes.public;
     if (version == null) {
       throw ArgumentError("Missing version");
     }
@@ -214,7 +214,7 @@ class HDNode {
     required int depth,
     required int index,
     required int parentFingerprint,
-    NetworkBIP? network,
+    NetworkNodeInfo? network,
   }) {
     if (IL.length != 32) {
       throw ArgumentError("IL should be 32 bytes");
@@ -254,7 +254,7 @@ class HDNode {
     required int depth,
     required int index,
     required int parentFingerprint,
-    NetworkBIP? network,
+    NetworkNodeInfo? network,
   }) {
     if (ecurve.isPoint(publicKey) == false) {
       throw ArgumentError("Point is not on the curve");
@@ -284,7 +284,7 @@ class HDNode {
 
   factory HDNode.fromSeed(
     Uint8List seed, {
-    NetworkBIP? network,
+    NetworkNodeInfo? network,
   }) {
     if (seed.length < 16) {
       throw new ArgumentError("Seed should be at least 128 bits");
@@ -311,7 +311,7 @@ class HDNode {
   ///
   factory HDNode.fromExtendedKey(
     String key, {
-    NetworkBIP? network,
+    NetworkNodeInfo? network,
   }) {
     final buffer = base58CheckDecodeWithVersion(key);
     if (buffer.length != 78) {
@@ -322,23 +322,20 @@ class HDNode {
 
     final version = bytes.getUint32(0);
 
-    final BIP32Prefixes? networkPrefixes;
-
     /// Check if the version is valid if network is provided
-    if (network != null) {
-      networkPrefixes = network.fromVersion(version);
-      if (networkPrefixes == null) {
-        throw ArgumentError("Invalid version for given network");
-      }
-    } else {
+    if (network == null) {
       final result = NetworkBIP.findPrefixesFromVersion(version);
 
       if (result == null) {
         throw ArgumentError("No NetworkBIP found for $version");
       }
 
-      network = result.$2;
-      networkPrefixes = result.$1;
+      network = result;
+    } else {
+      if (version != network.keyPrefixes.private &&
+          version != network.keyPrefixes.public) {
+        throw ArgumentError("Invalid version for given network");
+      }
     }
 
     final depth = bytes.getUint8(4);
@@ -356,7 +353,7 @@ class HDNode {
 
     final chainCode = buffer.sublist(13, 45);
 
-    final isPrivate = networkPrefixes.private == version;
+    final isPrivate = network.keyPrefixes.private == version;
 
     if (isPrivate) {
       if (bytes.getUint8(45) != 0) {

test/ci/bip32/bip32-dart_test.dart

@@ -5,6 +5,7 @@ import 'package:hex/hex.dart';
 import 'package:test/test.dart';
 import 'package:walletkit_dart/src/crypto/network_type.dart';
 import 'package:walletkit_dart/src/domain/constants.dart';
+import 'package:walletkit_dart/src/domain/entities/hd_wallet_type.dart';
 import 'dart:io';
 import 'dart:convert';
 
@@ -31,19 +32,20 @@ void main() {
         if (ff['network'] == 'litecoin') {
           network = LTC_NETWORK_BIP;
         }
-        var hdPrv = HDNode.fromExtendedKey(ff['base58Priv'], network: network);
+        var hdPrv = HDNode.fromExtendedKey(ff['base58Priv']);
         test('works for private key -> HD wallet', () {
           verify(hdPrv, true, ff, network);
         });
 
-        var hdPub = HDNode.fromExtendedKey(ff['base58'], network: network);
+        var hdPub = HDNode.fromExtendedKey(ff['base58']);
         test('works for public key -> HD wallet', () {
           verify(hdPub, false, ff, network);
         });
 
         if (ff['seed'] != null) {
           var seed = HEX.decode(ff['seed']);
-          var hdSeed = HDNode.fromSeed(seed as Uint8List, network: network);
+          var hdSeed = HDNode.fromSeed(seed as Uint8List,
+              network: network.getForPurpose(HDWalletPurpose.BIP44));
           test('works for seed -> HD wallet', () {
             verify(hdSeed, true, ff, network);
           });
@@ -59,7 +61,8 @@ void main() {
         network = LTC_NETWORK_BIP;
       HDNode? hd;
       try {
-        hd = HDNode.fromExtendedKey(f['string'], network: network);
+        hd = HDNode.fromExtendedKey(f['string'],
+            network: network.getForPurpose(HDWalletPurpose.BIP44));
       } catch (err) {
         if (err is FormatException) {
           expect(err.message, f['exception']);
@@ -154,7 +157,6 @@ void main() {
         depth: 0,
         index: 0,
         parentFingerprint: 0,
-        network: BITCOIN_NETWORK_BIP,
       );
     } catch (err) {
       expect((err as ArgumentError).message, "IL should be 32 bytes");
@@ -168,7 +170,6 @@ void main() {
         depth: 0,
         index: 0,
         parentFingerprint: 0,
-        network: BITCOIN_NETWORK_BIP,
       );
     } catch (err) {
       expect((err as ArgumentError).message, "IL should be a private key");
@@ -203,8 +204,9 @@ void main() {
     (fixtures['invalid']['fromSeed'] as List<dynamic>).forEach((f) {
       var hd;
       try {
-        hd = HDNode.fromSeed(HEX.decode(f['seed']) as Uint8List,
-            network: BITCOIN_NETWORK_BIP);
+        hd = HDNode.fromSeed(
+          HEX.decode(f['seed']) as Uint8List,
+        );
       } catch (err) {
         expect((err as ArgumentError).message, f['exception']);
       } finally {
@@ -219,7 +221,7 @@ void main() {
     String sigStr =
         "9636ee2fac31b795a308856b821ebe297dda7b28220fb46ea1fbbd7285977cc04c82b734956246a0f15a9698f03f546d8d96fe006c8e7bd2256ca7c8229e6f5c";
     Uint8List signature = HEX.decode(sigStr) as Uint8List;
-    HDNode node = HDNode.fromSeed(seed, network: BITCOIN_NETWORK_BIP);
+    HDNode node = HDNode.fromSeed(seed);
     expect(HEX.encode(node.sign(hash)), sigStr);
     expect(node.verify(hash, signature), true);
     expect(node.verify(seed, signature), false);

test/ci/derivation/derivation_path_test.dart

@@ -43,10 +43,7 @@ void main() {
       walletPath: bitcoinNSHDPath,
       seed: helloSeed,
     );
-    final node_xpub_ns = deriveMasterNodeFromExtendedKey(
-      helloXpub,
-      networkType: networkType,
-    );
+    final node_xpub_ns = deriveMasterNodeFromExtendedKey(helloXpub);
 
     expect(node_seed_ns.neutered().extendedPublicKey(), helloXpub);
 

test/ci/derivation/derive_addresses_test.dart

@@ -20,7 +20,6 @@ void main() {
 
     final masterNode = deriveMasterNodeFromExtendedKey(
       ePubKey,
-      networkType: t,
     );
     expect(
       deriveChildNode(
@@ -56,7 +55,6 @@ void main() {
         "xpub69QjKT4D1e67mdLGJDUq45wYdQZrVL7DATQ98dPPHiKwkKsrM1uyhbG4UazWemQvmi8GBV5UCpLGrFe8zUebtkw7Ew3bEKzv8bDPA2Difc8";
     final masterNode = deriveMasterNodeFromExtendedKey(
       ePubKey,
-      networkType: t,
     );
     expect(
       deriveChildNode(
@@ -101,7 +99,6 @@ void main() {
         "xpub69QjKT4D1e67mdLGJDUq45wYdQZrVL7DATQ98dPPHiKwkKsrM1uyhbG4UazWemQvmi8GBV5UCpLGrFe8zUebtkw7Ew3bEKzv8bDPA2Difc8";
     final masterNode = deriveMasterNodeFromExtendedKey(
       ePubKey,
-      networkType: t,
     );
     expect(
       deriveChildNode(
@@ -471,7 +468,6 @@ void main() {
 
     final masterNode = deriveMasterNodeFromExtendedKey(
       wkDebugXPUB,
-      networkType: t,
     );
     for (var i = 0; i < 10; i++) {
       final addresses = deriveChildNode(

test/ci/derivation/derive_extended_pubkey_test.dart

@@ -30,7 +30,7 @@ void main() {
     var hdNode = deriveMasterNodeFromExtendedKey(btcPubKey);
 
     expect(
-      hdNode.network?.bip32.public,
+      hdNode.network?.keyPrefixes.public,
       BitcoinNetwork.networkBIP.bip32.public,
     );
 
@@ -40,7 +40,7 @@ void main() {
     hdNode = deriveMasterNodeFromExtendedKey(ltcPubKey);
 
     expect(
-      hdNode.network?.bip32.public,
+      hdNode.network?.keyPrefixes.public,
       LitecoinNetwork.networkBIP.bip32.public,
     );
   });