feat: rust key derivation

catalyst_voices_packages/catalyst_key_derivation/example/lib/main.dart

@@ -1,3 +1,5 @@
+import 'dart:js_interop';
+
 import 'package:catalyst_key_derivation/catalyst_key_derivation.dart';
 import 'package:flutter/material.dart';
 
@@ -35,6 +37,10 @@ class MyApp extends StatelessWidget {
 
   Future<void> _doMagic() async {
     // ignore: avoid_print
-    print(await greet(name: 'Tom'));
+    U8Array96 xprv = await mnemonicToXprv(
+        mnemonic: "prevent company field green slot measure chief hero apple task eagle sunset endorse dress seed");
+    print(xprv);
+    U8Array96 derive_xprv = await deriveXprivateKey(xprivateKeyBytes: xprv, path: "m/1852'/1815'/0'/2/0");
+    print(derive_xprv);
   }
 }

catalyst_voices_packages/catalyst_key_derivation/lib/catalyst_key_derivation.dart

@@ -1,4 +1,5 @@
 library catalyst_key_derivation;
 
+export 'src/rust/api/key_derivation.dart';
 export 'src/rust/api/simple.dart';
 export 'src/rust/frb_generated.dart' show RustLib;

catalyst_voices_packages/catalyst_key_derivation/lib/src/rust/api/key_derivation.dart

@@ -0,0 +1,63 @@
+// This file is automatically generated, so please do not edit it.
+// @generated by `flutter_rust_bridge`@ 2.5.1.
+
+// ignore_for_file: invalid_use_of_internal_member, unused_import, unnecessary_import
+
+import '../frb_generated.dart';
+import 'package:collection/collection.dart';
+import 'package:flutter_rust_bridge/flutter_rust_bridge_for_generated.dart';
+
+// These functions are ignored because they are not marked as `pub`: `derive_xprivate_key_helper`, `mnemonic_to_xprv_helper`
+
+/// Generate a new extended private key (`XPrv`) from a mnemonic and passphrase.
+/// This function works with BIP-0039 mnemonics.
+/// For more information: Cardano Icarus master node derivation
+/// https://github.com/satoshilabs/slips/blob/master/slip-0023.md
+///
+/// # Arguments
+///
+/// - `mnemonic`: A string representing the mnemonic.
+/// - `passphrase`: An optional string representing the passphrase.
+///
+/// # Returns
+///
+/// Returns the `XPrv` extended private key as a `Result`.
+/// If the conversion is successful, it returns `Ok` with the extended private key
+/// (`XPrv`).
+Future<U8Array96> mnemonicToXprv(
+        {required String mnemonic, String? passphrase}) =>
+    RustLib.instance.api.crateApiKeyDerivationMnemonicToXprv(
+        mnemonic: mnemonic, passphrase: passphrase);
+
+/// Derive a new extended private key from the given extended private key.
+/// - V2 derivation scheme is used as it is mention in [SLIP-0023](https://github.com/satoshilabs/slips/blob/master/slip-0023.md).
+/// - More information about child key derivation can be found in [BIP32-Ed25519](https://input-output-hk.github.io/adrestia/static/Ed25519_BIP.pdf).
+///
+/// # Arguments
+///
+/// - `xprivate_key_bytes`: An extended private key of type `XPrvBytes`.
+/// - `path`: Derivation path. eg. m/0/2'/3 where ' represents hardened derivation.
+///
+/// # Returns
+///
+/// Returns the `XPrv` extended private key as a `Result`.
+/// If the derivation path is successful, it returns `Ok` with the extended private key
+/// (`XPrv`).
+Future<U8Array96> deriveXprivateKey(
+        {required U8Array96 xprivateKeyBytes, required String path}) =>
+    RustLib.instance.api.crateApiKeyDerivationDeriveXprivateKey(
+        xprivateKeyBytes: xprivateKeyBytes, path: path);
+
+class U8Array96 extends NonGrowableListView<int> {
+  static const arraySize = 96;
+
+  @internal
+  Uint8List get inner => _inner;
+  final Uint8List _inner;
+
+  U8Array96(this._inner)
+      : assert(_inner.length == arraySize),
+        super(_inner);
+
+  U8Array96.init() : this(Uint8List(arraySize));
+}

catalyst_voices_packages/catalyst_key_derivation/lib/src/rust/frb_generated.dart

@@ -3,6 +3,7 @@
 
 // ignore_for_file: unused_import, unused_element, unnecessary_import, duplicate_ignore, invalid_use_of_internal_member, annotate_overrides, non_constant_identifier_names, curly_braces_in_flow_control_structures, prefer_const_literals_to_create_immutables, unused_field
 
+import 'api/key_derivation.dart';
 import 'api/simple.dart';
 import 'dart:async';
 import 'dart:convert';
@@ -68,7 +69,7 @@ class RustLib extends BaseEntrypoint<RustLibApi, RustLibApiImpl, RustLibWire> {
   String get codegenVersion => '2.5.1';
 
   @override
-  int get rustContentHash => -1918914929;
+  int get rustContentHash => 424624821;
 
   static const kDefaultExternalLibraryLoaderConfig =
       ExternalLibraryLoaderConfig(
@@ -79,6 +80,12 @@ class RustLib extends BaseEntrypoint<RustLibApi, RustLibApiImpl, RustLibWire> {
 }
 
 abstract class RustLibApi extends BaseApi {
+  Future<U8Array96> crateApiKeyDerivationDeriveXprivateKey(
+      {required U8Array96 xprivateKeyBytes, required String path});
+
+  Future<U8Array96> crateApiKeyDerivationMnemonicToXprv(
+      {required String mnemonic, String? passphrase});
+
   Future<String> crateApiSimpleGreet({required String name});
 
   Future<void> crateApiSimpleInitApp();
@@ -92,14 +99,68 @@ class RustLibApiImpl extends RustLibApiImplPlatform implements RustLibApi {
     required super.portManager,
   });
 
+  @override
+  Future<U8Array96> crateApiKeyDerivationDeriveXprivateKey(
+      {required U8Array96 xprivateKeyBytes, required String path}) {
+    return handler.executeNormal(NormalTask(
+      callFfi: (port_) {
+        final serializer = SseSerializer(generalizedFrbRustBinding);
+        sse_encode_u_8_array_96(xprivateKeyBytes, serializer);
+        sse_encode_String(path, serializer);
+        pdeCallFfi(generalizedFrbRustBinding, serializer,
+            funcId: 1, port: port_);
+      },
+      codec: SseCodec(
+        decodeSuccessData: sse_decode_u_8_array_96,
+        decodeErrorData: sse_decode_AnyhowException,
+      ),
+      constMeta: kCrateApiKeyDerivationDeriveXprivateKeyConstMeta,
+      argValues: [xprivateKeyBytes, path],
+      apiImpl: this,
+    ));
+  }
+
+  TaskConstMeta get kCrateApiKeyDerivationDeriveXprivateKeyConstMeta =>
+      const TaskConstMeta(
+        debugName: "derive_xprivate_key",
+        argNames: ["xprivateKeyBytes", "path"],
+      );
+
+  @override
+  Future<U8Array96> crateApiKeyDerivationMnemonicToXprv(
+      {required String mnemonic, String? passphrase}) {
+    return handler.executeNormal(NormalTask(
+      callFfi: (port_) {
+        final serializer = SseSerializer(generalizedFrbRustBinding);
+        sse_encode_String(mnemonic, serializer);
+        sse_encode_opt_String(passphrase, serializer);
+        pdeCallFfi(generalizedFrbRustBinding, serializer,
+            funcId: 2, port: port_);
+      },
+      codec: SseCodec(
+        decodeSuccessData: sse_decode_u_8_array_96,
+        decodeErrorData: sse_decode_AnyhowException,
+      ),
+      constMeta: kCrateApiKeyDerivationMnemonicToXprvConstMeta,
+      argValues: [mnemonic, passphrase],
+      apiImpl: this,
+    ));
+  }
+
+  TaskConstMeta get kCrateApiKeyDerivationMnemonicToXprvConstMeta =>
+      const TaskConstMeta(
+        debugName: "mnemonic_to_xprv",
+        argNames: ["mnemonic", "passphrase"],
+      );
+
   @override
   Future<String> crateApiSimpleGreet({required String name}) {
     return handler.executeNormal(NormalTask(
       callFfi: (port_) {
         final serializer = SseSerializer(generalizedFrbRustBinding);
         sse_encode_String(name, serializer);
         pdeCallFfi(generalizedFrbRustBinding, serializer,
-            funcId: 1, port: port_);
+            funcId: 3, port: port_);
       },
       codec: SseCodec(
         decodeSuccessData: sse_decode_String,
@@ -122,7 +183,7 @@ class RustLibApiImpl extends RustLibApiImplPlatform implements RustLibApi {
       callFfi: (port_) {
         final serializer = SseSerializer(generalizedFrbRustBinding);
         pdeCallFfi(generalizedFrbRustBinding, serializer,
-            funcId: 2, port: port_);
+            funcId: 4, port: port_);
       },
       codec: SseCodec(
         decodeSuccessData: sse_decode_unit,
@@ -139,6 +200,12 @@ class RustLibApiImpl extends RustLibApiImplPlatform implements RustLibApi {
         argNames: [],
       );
 
+  @protected
+  AnyhowException dco_decode_AnyhowException(dynamic raw) {
+    // Codec=Dco (DartCObject based), see doc to use other codecs
+    return AnyhowException(raw as String);
+  }
+
   @protected
   String dco_decode_String(dynamic raw) {
     // Codec=Dco (DartCObject based), see doc to use other codecs
@@ -151,18 +218,37 @@ class RustLibApiImpl extends RustLibApiImplPlatform implements RustLibApi {
     return raw as Uint8List;
   }
 
+  @protected
+  String? dco_decode_opt_String(dynamic raw) {
+    // Codec=Dco (DartCObject based), see doc to use other codecs
+    return raw == null ? null : dco_decode_String(raw);
+  }
+
   @protected
   int dco_decode_u_8(dynamic raw) {
     // Codec=Dco (DartCObject based), see doc to use other codecs
     return raw as int;
   }
 
+  @protected
+  U8Array96 dco_decode_u_8_array_96(dynamic raw) {
+    // Codec=Dco (DartCObject based), see doc to use other codecs
+    return U8Array96(dco_decode_list_prim_u_8_strict(raw));
+  }
+
   @protected
   void dco_decode_unit(dynamic raw) {
     // Codec=Dco (DartCObject based), see doc to use other codecs
     return;
   }
 
+  @protected
+  AnyhowException sse_decode_AnyhowException(SseDeserializer deserializer) {
+    // Codec=Sse (Serialization based), see doc to use other codecs
+    var inner = sse_decode_String(deserializer);
+    return AnyhowException(inner);
+  }
+
   @protected
   String sse_decode_String(SseDeserializer deserializer) {
     // Codec=Sse (Serialization based), see doc to use other codecs
@@ -177,12 +263,30 @@ class RustLibApiImpl extends RustLibApiImplPlatform implements RustLibApi {
     return deserializer.buffer.getUint8List(len_);
   }
 
+  @protected
+  String? sse_decode_opt_String(SseDeserializer deserializer) {
+    // Codec=Sse (Serialization based), see doc to use other codecs
+
+    if (sse_decode_bool(deserializer)) {
+      return (sse_decode_String(deserializer));
+    } else {
+      return null;
+    }
+  }
+
   @protected
   int sse_decode_u_8(SseDeserializer deserializer) {
     // Codec=Sse (Serialization based), see doc to use other codecs
     return deserializer.buffer.getUint8();
   }
 
+  @protected
+  U8Array96 sse_decode_u_8_array_96(SseDeserializer deserializer) {
+    // Codec=Sse (Serialization based), see doc to use other codecs
+    var inner = sse_decode_list_prim_u_8_strict(deserializer);
+    return U8Array96(inner);
+  }
+
   @protected
   void sse_decode_unit(SseDeserializer deserializer) {
     // Codec=Sse (Serialization based), see doc to use other codecs
@@ -200,6 +304,13 @@ class RustLibApiImpl extends RustLibApiImplPlatform implements RustLibApi {
     return deserializer.buffer.getUint8() != 0;
   }
 
+  @protected
+  void sse_encode_AnyhowException(
+      AnyhowException self, SseSerializer serializer) {
+    // Codec=Sse (Serialization based), see doc to use other codecs
+    sse_encode_String(self.message, serializer);
+  }
+
   @protected
   void sse_encode_String(String self, SseSerializer serializer) {
     // Codec=Sse (Serialization based), see doc to use other codecs
@@ -214,12 +325,28 @@ class RustLibApiImpl extends RustLibApiImplPlatform implements RustLibApi {
     serializer.buffer.putUint8List(self);
   }
 
+  @protected
+  void sse_encode_opt_String(String? self, SseSerializer serializer) {
+    // Codec=Sse (Serialization based), see doc to use other codecs
+
+    sse_encode_bool(self != null, serializer);
+    if (self != null) {
+      sse_encode_String(self, serializer);
+    }
+  }
+
   @protected
   void sse_encode_u_8(int self, SseSerializer serializer) {
     // Codec=Sse (Serialization based), see doc to use other codecs
     serializer.buffer.putUint8(self);
   }
 
+  @protected
+  void sse_encode_u_8_array_96(U8Array96 self, SseSerializer serializer) {
+    // Codec=Sse (Serialization based), see doc to use other codecs
+    sse_encode_list_prim_u_8_strict(self.inner, serializer);
+  }
+
   @protected
   void sse_encode_unit(void self, SseSerializer serializer) {
     // Codec=Sse (Serialization based), see doc to use other codecs