Update changelog

Author: mrtnetwork

CHANGELOG.md

@@ -1,3 +1,27 @@
+## 6.0.0
+- Added support for FF1.
+- Added support for f4jumble.
+- Added support for BLS12-381.
+- Added support for Jubjub.
+- Added support for Vesta–Pallas.
+- Added support for Sinsemilla.
+- Added support for Poseidon
+- Added support for ZIP-32 hierarchical key derivation
+- Added support for Zcash addresses:
+  - Unified Addresses (UA)
+  - Sapling
+  - Orchard
+  - Transparent (P2PKH, P2SH)
+- Added support for Zcash viewing and spending keys:
+  - USK
+  - UFVK
+  - UIVK
+- Added support for RedJubjub / RedDSA signatures
+- Minimum required Dart SDK version updated to 3.7.
+- Reduce static final variables.
+
+
+
 ## 5.4.0
 - Update dependecies.
 

lib/bech32/bech32_utils.dart

@@ -131,7 +131,7 @@ class Bech32BaseUtils {
     }
     if (pad) {
       if (bits > 0) {
-        // Pad the value with zeros to reach toBits
+        // SinsemillaPad the value with zeros to reach toBits
         ret.add((acc << (toBits - bits)) & maxOutVal);
       }
     } else if (bits >= fromBits ||

lib/bip/address/zcash/src/converter.dart

@@ -11,7 +11,7 @@ class ZCashAddrDecoder
   @override
   ZCashDecodedAddressResult decodeAddr(
     String addr, {
-    ZcashNetwork? network,
+    ZCashNetwork? network,
     ZCashAddressType? type,
   }) {
     final decode = ZCashAddressUtils.parseAddress(
@@ -30,10 +30,10 @@ class ZCashAddrEncoder implements BlockchainAddressEncoder {
   @override
   String encodeKey(
     List<int> keyBytes, {
-    ZcashNetwork? network,
+    ZCashNetwork? network,
     ZCashAddressType? addrType,
   }) {
-    network ??= ZcashNetwork.mainnet;
+    network ??= ZCashNetwork.mainnet;
     addrType ??= AddrKeyValidator.getAddrArg<ZCashAddressType>(
       addrType,
       "addrType",
@@ -49,9 +49,9 @@ class ZCashAddrEncoder implements BlockchainAddressEncoder {
 class ZCashUnifiedAddrEncoder implements BlockchainAddressEncoder {
   String encodeUnifiedReceivers(
     List<ZUnifiedReceiver> receivers, {
-    ZcashNetwork? network,
+    ZCashNetwork? network,
   }) {
-    network ??= ZcashNetwork.mainnet;
+    network ??= ZCashNetwork.mainnet;
     return ZCashAddressUtils.encodeAddress(
       bytes: const [],
       type: ZCashAddressType.unified,
@@ -61,8 +61,8 @@ class ZCashUnifiedAddrEncoder implements BlockchainAddressEncoder {
   }
 
   @override
-  String encodeKey(List<int> keyBytes, {ZcashNetwork? network}) {
-    network ??= ZcashNetwork.mainnet;
+  String encodeKey(List<int> keyBytes, {ZCashNetwork? network}) {
+    network ??= ZCashNetwork.mainnet;
     return ZCashAddressUtils.encodeAddress(
       bytes: keyBytes,
       type: ZCashAddressType.unified,

lib/bip/address/zcash/src/types.dart

@@ -16,7 +16,7 @@ enum ZCashAddressType {
 class ZCashDecodedAddressResult {
   final List<ZUnifiedReceiver>? unifiedReceiver;
   final List<int> addressBytes;
-  final ZcashNetwork network;
+  final ZCashNetwork network;
   final ZCashAddressType type;
   ZCashDecodedAddressResult({
     this.unifiedReceiver,

lib/bip/address/zcash/src/utils.dart

@@ -107,7 +107,7 @@ class ZCashAddressUtils {
 
   static ZCashDecodedAddressResult? parseAddress(
     String address, {
-    ZcashNetwork? expectedNetwork,
+    ZCashNetwork? expectedNetwork,
     ZCashAddressType? exceptedType,
   }) {
     final decode = _parseAddress(address, exceptedType: exceptedType);
@@ -122,9 +122,9 @@ class ZCashAddressUtils {
   }
 
   static void _validate({
-    required ZcashNetwork network,
+    required ZCashNetwork network,
     required ZCashAddressType type,
-    ZcashNetwork? expectedNetwork,
+    ZCashNetwork? expectedNetwork,
     ZCashAddressType? exceptedType,
   }) {
     if (expectedNetwork != null && expectedNetwork != network) {
@@ -144,7 +144,7 @@ class ZCashAddressUtils {
   static String encodeAddress({
     required List<int> bytes,
     required ZCashAddressType type,
-    required ZcashNetwork network,
+    required ZCashNetwork network,
     List<ZUnifiedReceiver>? receivers,
   }) {
     final config = ZcashConf().fromNetwork(network);

lib/bip/bip/bip32/base/bip32_base.dart

@@ -71,21 +71,16 @@ abstract class Bip32Base<BIP extends Bip32Base<BIP>>
     );
   }
 
-  /// Creates a BIP-32 key from an extended key string.
-  Bip32Base.fromExtendedKeyBytes(
+  /// Creates a BIP-32 key from an extended key bytese.
+  Bip32Base.fromExtendedPrivateKeyBytes(
     List<int> key, [
     Bip32KeyNetVersions? keyNetVer,
   ]) {
     keyNetVer ??= defaultKeyNetVersion;
-    final deserKey = Bip32KeyDeserializer.deserializeKeyBytes(
-      key,
-      keyNetVer: keyNetVer,
-    );
-
+    final deserKey = Bip32KeyDeserializer.deserializeKeyBytesWithoutPrefix(key);
     final keyBytes = deserKey.keyBytes;
     final Bip32KeyData keyData = deserKey.keyData;
-    final isPublic = deserKey.isPublic;
-
+    assert(!deserKey.isPublic);
     if (keyData.depth.depth == 0) {
       if (!keyData.fingerPrint.isMasterKey()) {
         throw Bip32KeyError('Invalid extended master fingerPrint.');
@@ -95,21 +90,56 @@ abstract class Bip32Base<BIP extends Bip32Base<BIP>>
       }
     }
     _privKey = _initializePrivateKey(
-      isPublic ? null : keyBytes,
-      isPublic ? keyBytes : null,
+      keyBytes,
+      null,
       keyData,
       keyNetVer,
       curveType,
     );
     _pubKey = _initializePublicKey(
-      isPublic ? null : keyBytes,
-      isPublic ? keyBytes : null,
+      keyBytes,
+      null,
       keyData,
       keyNetVer,
       curveType,
     );
   }
 
+  // /// Creates a BIP-32 key from an extended key bytese exclude prefix.
+  // Bip32Base.fromExtendedPrivateKeyBytes(List<int> key) {
+  //   final deserKey = Bip32KeyDeserializer.deserializeKeyBytes(
+  //     key,
+  //     keyNetVer: keyNetVer,
+  //   );
+
+  //   final keyBytes = deserKey.keyBytes;
+  //   final Bip32KeyData keyData = deserKey.keyData;
+  //   final isPublic = deserKey.isPublic;
+
+  //   if (keyData.depth.depth == 0) {
+  //     if (!keyData.fingerPrint.isMasterKey()) {
+  //       throw Bip32KeyError('Invalid extended master fingerPrint.');
+  //     }
+  //     if (keyData.index.index != 0) {
+  //       throw Bip32KeyError('Invalid extended master child index.');
+  //     }
+  //   }
+  //   _privKey = _initializePrivateKey(
+  //     isPublic ? null : keyBytes,
+  //     isPublic ? keyBytes : null,
+  //     keyData,
+  //     keyNetVer,
+  //     curveType,
+  //   );
+  //   _pubKey = _initializePublicKey(
+  //     isPublic ? null : keyBytes,
+  //     isPublic ? keyBytes : null,
+  //     keyData,
+  //     keyNetVer,
+  //     curveType,
+  //   );
+  // }
+
   /// Creates a BIP-32 key from a seed.
   ///
   /// The [seedBytes] parameter is used to generate a master key, and the

lib/bip/bip/bip32/bip32_ex.dart

@@ -7,13 +7,12 @@ import 'package:blockchain_utils/exception/exceptions.dart';
 /// property, if provided.
 class Bip32KeyError extends BlockchainUtilsException {
   const Bip32KeyError(super.message, {super.details});
-  static const notHardenedIndexNotSupported = Bip32KeyError(
+  static Bip32KeyError get notHardenedIndexNotSupported => Bip32KeyError(
     'Private child derivation with not-hardened index is not supported',
   );
-  static const publicDerivationNotSupported = Bip32KeyError(
-    'Public child derivation is not supported',
-  );
-  static const publicHardenedIndexNotSupported = Bip32KeyError(
+  static Bip32KeyError get publicDerivationNotSupported =>
+      Bip32KeyError('Public child derivation is not supported');
+  static Bip32KeyError get publicHardenedIndexNotSupported => Bip32KeyError(
     'Public child derivation with hardened index is not supported',
   );
 }

lib/bip/bip/bip32/bip32_key_ser.dart

@@ -23,10 +23,10 @@ class _Bip32KeySerializer {
   static List<int> serializeBytes(
     List<int> keyBytes,
     Bip32KeyData keyData,
-    List<int> keyNetVerBytes,
+    List<int>? keyNetVerBytes,
   ) {
     return [
-      ...keyNetVerBytes,
+      ...keyNetVerBytes ?? [],
       ...keyData.depth.toBytes(),
       ...keyData.fingerPrint.toBytes(),
       ...keyData.index.toBytes(),
@@ -64,16 +64,17 @@ class Bip32PrivateKeySerializer {
     );
   }
 
-  static List<int> serializeBytes(
-    IPrivateKey privKey,
-    Bip32KeyData keyData, [
+  static List<int> serializeBytes({
+    required IPrivateKey privKey,
+    required Bip32KeyData keyData,
     Bip32KeyNetVersions? keyNetVer,
-  ]) {
+    bool withPrefix = true,
+  }) {
     keyNetVer ??= Bip32Const.mainNetKeyNetVersions;
     return _Bip32KeySerializer.serializeBytes(
       [0x00, ...privKey.raw],
       keyData,
-      keyNetVer.private,
+      withPrefix ? keyNetVer.private : null,
     );
   }
 }
@@ -95,16 +96,17 @@ class Bip32PublicKeySerializer {
     );
   }
 
-  static List<int> serializeBytes(
-    IPublicKey pubKey,
-    Bip32KeyData keyData, [
-    Bip32KeyNetVersions? keyNetVer,
-  ]) {
+  static List<int> serializeBytes({
+    required IPublicKey pubKey,
+    required Bip32KeyData keyData,
+    required Bip32KeyNetVersions? keyNetVer,
+    bool withPrefix = true,
+  }) {
     keyNetVer ??= Bip32Const.mainNetKeyNetVersions;
     return _Bip32KeySerializer.serializeBytes(
       pubKey.compressed,
       keyData,
-      keyNetVer.private,
+      withPrefix ? keyNetVer.private : null,
     );
   }
 }
@@ -160,6 +162,30 @@ class Bip32KeyDeserializer {
     return Bip32DeserializedKey(keyParts.$1, keyParts.$2, isPublic);
   }
 
+  static Bip32DeserializedKey deserializeKeyBytesWithoutPrefix(
+    List<int> serKeyBytes, {
+    bool isPublic = false,
+  }) {
+    // Validate length
+    if (isPublic &&
+        serKeyBytes.length !=
+            (Bip32KeySerConst.serializedPubKeyByteLen -
+                Bip32KeyNetVersionsConst.keyNetVersionByteLen)) {
+      throw Bip32KeyError('Invalid extended public key.');
+    }
+    if (!isPublic &&
+        !Bip32KeySerConst.serializedPrivKeyByteLen.contains(
+          serKeyBytes.length + Bip32KeyNetVersionsConst.keyNetVersionByteLen,
+        )) {
+      throw Bip32KeyError('Invalid extended private key.');
+    }
+
+    // Get parts back
+    final keyParts = _getPartsFromBytes(serKeyBytes, isPublic, offset: 0);
+
+    return Bip32DeserializedKey(keyParts.$1, keyParts.$2, isPublic);
+  }
+
   /// Deserialize a key.
   static Bip32DeserializedKey deserializeKey(
     String serKeyStr, {
@@ -191,9 +217,10 @@ class Bip32KeyDeserializer {
   /// Get back key parts from serialized key bytes.
   static (List<int>, Bip32KeyData) _getPartsFromBytes(
     List<int> serKeyBytes,
-    bool isPublic,
-  ) {
-    final depthIdx = Bip32KeyNetVersions.length;
+    bool isPublic, {
+    int offset = Bip32KeyNetVersionsConst.keyNetVersionByteLen,
+  }) {
+    final depthIdx = offset;
     final fprintIdx = depthIdx + Bip32Depth.fixedLength();
     final keyIndexIdx = fprintIdx + Bip32FingerPrint.fixedLength();
     final chainCodeIdx = keyIndexIdx + Bip32KeyIndex.fixedLength();

lib/bip/bip/bip32/bip32_keys.dart

@@ -11,7 +11,7 @@ abstract class Bip32KeyBase extends CryptoKeyBase<Bip32KeyData> {
   const Bip32KeyBase(super.keyData, this.curveType);
   final EllipticCurveTypes curveType;
   String get toExtended;
-  List<int> get toExtendedBytes;
+  List<int> toExtendedBytes({bool withPrefix = true});
 }
 
 /// Represents a BIP32 public key with associated data such as the elliptic curve type,
@@ -63,8 +63,13 @@ class Bip32PublicKey extends Bip32KeyBase {
   ChainCode get chainCode => keyData.chainCode;
 
   @override
-  List<int> get toExtendedBytes =>
-      Bip32PublicKeySerializer.serializeBytes(pubKey, keyData, keyNetVer);
+  List<int> toExtendedBytes({bool withPrefix = true}) =>
+      Bip32PublicKeySerializer.serializeBytes(
+        pubKey: pubKey,
+        keyData: keyData,
+        withPrefix: withPrefix,
+        keyNetVer: keyNetVer,
+      );
 
   /// Creates a [Bip32PublicKey] from a byte representation, key data, key network versions, and curve type.
   static Bip32PublicKey fromBytes(
@@ -126,8 +131,13 @@ class Bip32PrivateKey extends Bip32KeyBase {
   }
 
   @override
-  List<int> get toExtendedBytes =>
-      Bip32PrivateKeySerializer.serializeBytes(privKey, keyData, keyNetVer);
+  List<int> toExtendedBytes({bool withPrefix = true}) =>
+      Bip32PrivateKeySerializer.serializeBytes(
+        privKey: privKey,
+        keyData: keyData,
+        keyNetVer: keyNetVer,
+        withPrefix: withPrefix,
+      );
 
   /// Creates a Bip32PrivateKey from a byte representation, key data, key network versions, and curve type.
   static Bip32PrivateKey fromBytes(

lib/bip/bip/bip32/slip10/bip32_slip10_secp256k1.dart

@@ -39,9 +39,11 @@ class Bip32Slip10Secp256k1 extends Bip32Base<Bip32Slip10Secp256k1> {
   Bip32Slip10Secp256k1.fromExtendedKey(super.exKeyStr, [super.keyNetVer])
     : super.fromExtendedKey();
 
-  /// constructor for creating a key from an extended key string.
-  Bip32Slip10Secp256k1.fromExtendedKeyBytes(super.exKeyStr, [super.keyNetVer])
-    : super.fromExtendedKeyBytes();
+  /// constructor for creating a key from an extended key bytes exclude prefix.
+  Bip32Slip10Secp256k1.fromExtendedPrivateKeyBytes(
+    super.exKeyStr, [
+    super.keyNetVer,
+  ]) : super.fromExtendedPrivateKeyBytes();
 
   /// Returns the curve type, SECP256K1.
   @override