feat: add BIP39 mnemonic utility functions

- Adds BIP39 utilities for mnemonic validation, word suggestions, entropy conversion, and seed generation
- Bumps bitcoin-address-generator version to 0.2.0
- Bumps version to 0.1.16

Author: coreyphillips

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "bitkitcore"
-version = "0.1.15"
+version = "0.1.16"
 edition = "2021"
 
 [lib]
@@ -30,7 +30,7 @@ rust-blocktank-client = { version = "0.0.16", features = ["rustls-tls"] }
 reqwest = { version = "0.12.12", features = ["json", "rustls-tls", "rustls-tls-native-roots"], default-features = false }
 r2d2 = "0.8.10"
 r2d2_sqlite = "0.25.0"
-bitcoin-address-generator = "0.1.1"
+bitcoin-address-generator = "0.2.0"
 uuid = { version = "1.16.0", features = ["v4"] }
 hex = "0.4.3"
 bip39 = "2.0"

Cargo.toml

@@ -3,8 +3,8 @@
 
 import PackageDescription
 
-let tag = "v0.1.15"
-let checksum = "49914370d4d8dc016104e3da72acd4f16535eaec3d3c68083238e238660a71ef"
+let tag = "v0.1.16"
+let checksum = "9b9e09eb0dcc570313a26b0a32518deaf561a46d58389cf211eadc0859d8c4eb"
 let url = "https://github.com/synonymdev/bitkit-core/releases/download/\(tag)/BitkitCore.xcframework.zip"
 
 let package = Package(

Package.swift

@@ -3,4 +3,4 @@ android.useAndroidX=true
 android.enableJetifier=true
 kotlin.code.style=official
 group=com.synonym
-version=0.1.15
+version=0.1.16

bindings/android/gradle.properties

@@ -788,6 +788,20 @@ internal interface UniffiForeignFutureCompleteVoid : com.sun.jna.Callback {
 
 
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
 
 
@@ -838,6 +852,8 @@ internal interface UniffiLib : Library {
     ): RustBuffer.ByValue
     fun uniffi_bitkitcore_fn_func_derive_private_key(`mnemonicPhrase`: RustBuffer.ByValue,`derivationPathStr`: RustBuffer.ByValue,`network`: RustBuffer.ByValue,`bip39Passphrase`: RustBuffer.ByValue,uniffi_out_err: UniffiRustCallStatus, 
     ): RustBuffer.ByValue
+    fun uniffi_bitkitcore_fn_func_entropy_to_mnemonic(`entropy`: RustBuffer.ByValue,uniffi_out_err: UniffiRustCallStatus, 
+    ): RustBuffer.ByValue
     fun uniffi_bitkitcore_fn_func_estimate_order_fee(`lspBalanceSat`: Long,`channelExpiryWeeks`: Int,`options`: RustBuffer.ByValue,
     ): Long
     fun uniffi_bitkitcore_fn_func_estimate_order_fee_full(`lspBalanceSat`: Long,`channelExpiryWeeks`: Int,`options`: RustBuffer.ByValue,
@@ -852,6 +868,10 @@ internal interface UniffiLib : Library {
     ): RustBuffer.ByValue
     fun uniffi_bitkitcore_fn_func_get_all_unique_tags(uniffi_out_err: UniffiRustCallStatus, 
     ): RustBuffer.ByValue
+    fun uniffi_bitkitcore_fn_func_get_bip39_suggestions(`partialWord`: RustBuffer.ByValue,`limit`: Int,uniffi_out_err: UniffiRustCallStatus, 
+    ): RustBuffer.ByValue
+    fun uniffi_bitkitcore_fn_func_get_bip39_wordlist(uniffi_out_err: UniffiRustCallStatus, 
+    ): RustBuffer.ByValue
     fun uniffi_bitkitcore_fn_func_get_cjit_entries(`entryIds`: RustBuffer.ByValue,`filter`: RustBuffer.ByValue,`refresh`: Byte,
     ): Long
     fun uniffi_bitkitcore_fn_func_get_gift(`giftId`: RustBuffer.ByValue,
@@ -876,8 +896,14 @@ internal interface UniffiLib : Library {
     ): RustBuffer.ByValue
     fun uniffi_bitkitcore_fn_func_insert_activity(`activity`: RustBuffer.ByValue,uniffi_out_err: UniffiRustCallStatus, 
     ): Unit
+    fun uniffi_bitkitcore_fn_func_is_valid_bip39_word(`word`: RustBuffer.ByValue,uniffi_out_err: UniffiRustCallStatus, 
+    ): Byte
     fun uniffi_bitkitcore_fn_func_lnurl_auth(`domain`: RustBuffer.ByValue,`k1`: RustBuffer.ByValue,`callback`: RustBuffer.ByValue,`bip32Mnemonic`: RustBuffer.ByValue,`network`: RustBuffer.ByValue,`bip39Passphrase`: RustBuffer.ByValue,
     ): Long
+    fun uniffi_bitkitcore_fn_func_mnemonic_to_entropy(`mnemonicPhrase`: RustBuffer.ByValue,uniffi_out_err: UniffiRustCallStatus, 
+    ): RustBuffer.ByValue
+    fun uniffi_bitkitcore_fn_func_mnemonic_to_seed(`mnemonicPhrase`: RustBuffer.ByValue,`passphrase`: RustBuffer.ByValue,uniffi_out_err: UniffiRustCallStatus, 
+    ): RustBuffer.ByValue
     fun uniffi_bitkitcore_fn_func_open_channel(`orderId`: RustBuffer.ByValue,`connectionString`: RustBuffer.ByValue,
     ): Long
     fun uniffi_bitkitcore_fn_func_refresh_active_cjit_entries(
@@ -924,6 +950,8 @@ internal interface UniffiLib : Library {
     ): Unit
     fun uniffi_bitkitcore_fn_func_validate_bitcoin_address(`address`: RustBuffer.ByValue,uniffi_out_err: UniffiRustCallStatus, 
     ): RustBuffer.ByValue
+    fun uniffi_bitkitcore_fn_func_validate_mnemonic(`mnemonicPhrase`: RustBuffer.ByValue,uniffi_out_err: UniffiRustCallStatus, 
+    ): Unit
     fun ffi_bitkitcore_rustbuffer_alloc(`size`: Long,uniffi_out_err: UniffiRustCallStatus, 
     ): RustBuffer.ByValue
     fun ffi_bitkitcore_rustbuffer_from_bytes(`bytes`: ForeignBytes.ByValue,uniffi_out_err: UniffiRustCallStatus, 
@@ -1056,6 +1084,8 @@ internal interface UniffiLib : Library {
     ): Short
     fun uniffi_bitkitcore_checksum_func_derive_private_key(
     ): Short
+    fun uniffi_bitkitcore_checksum_func_entropy_to_mnemonic(
+    ): Short
     fun uniffi_bitkitcore_checksum_func_estimate_order_fee(
     ): Short
     fun uniffi_bitkitcore_checksum_func_estimate_order_fee_full(
@@ -1070,6 +1100,10 @@ internal interface UniffiLib : Library {
     ): Short
     fun uniffi_bitkitcore_checksum_func_get_all_unique_tags(
     ): Short
+    fun uniffi_bitkitcore_checksum_func_get_bip39_suggestions(
+    ): Short
+    fun uniffi_bitkitcore_checksum_func_get_bip39_wordlist(
+    ): Short
     fun uniffi_bitkitcore_checksum_func_get_cjit_entries(
     ): Short
     fun uniffi_bitkitcore_checksum_func_get_gift(
@@ -1094,8 +1128,14 @@ internal interface UniffiLib : Library {
     ): Short
     fun uniffi_bitkitcore_checksum_func_insert_activity(
     ): Short
+    fun uniffi_bitkitcore_checksum_func_is_valid_bip39_word(
+    ): Short
     fun uniffi_bitkitcore_checksum_func_lnurl_auth(
     ): Short
+    fun uniffi_bitkitcore_checksum_func_mnemonic_to_entropy(
+    ): Short
+    fun uniffi_bitkitcore_checksum_func_mnemonic_to_seed(
+    ): Short
     fun uniffi_bitkitcore_checksum_func_open_channel(
     ): Short
     fun uniffi_bitkitcore_checksum_func_refresh_active_cjit_entries(
@@ -1142,6 +1182,8 @@ internal interface UniffiLib : Library {
     ): Short
     fun uniffi_bitkitcore_checksum_func_validate_bitcoin_address(
     ): Short
+    fun uniffi_bitkitcore_checksum_func_validate_mnemonic(
+    ): Short
     fun ffi_bitkitcore_uniffi_contract_version(
     ): Int
 
@@ -1189,6 +1231,9 @@ private fun uniffiCheckApiChecksums(lib: UniffiLib) {
     if (lib.uniffi_bitkitcore_checksum_func_derive_private_key() != 25155.toShort()) {
         throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     }
+    if (lib.uniffi_bitkitcore_checksum_func_entropy_to_mnemonic() != 26123.toShort()) {
+        throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
+    }
     if (lib.uniffi_bitkitcore_checksum_func_estimate_order_fee() != 9548.toShort()) {
         throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     }
@@ -1210,6 +1255,12 @@ private fun uniffiCheckApiChecksums(lib: UniffiLib) {
     if (lib.uniffi_bitkitcore_checksum_func_get_all_unique_tags() != 25431.toShort()) {
         throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     }
+    if (lib.uniffi_bitkitcore_checksum_func_get_bip39_suggestions() != 20658.toShort()) {
+        throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
+    }
+    if (lib.uniffi_bitkitcore_checksum_func_get_bip39_wordlist() != 30814.toShort()) {
+        throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
+    }
     if (lib.uniffi_bitkitcore_checksum_func_get_cjit_entries() != 29342.toShort()) {
         throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     }
@@ -1246,9 +1297,18 @@ private fun uniffiCheckApiChecksums(lib: UniffiLib) {
     if (lib.uniffi_bitkitcore_checksum_func_insert_activity() != 1510.toShort()) {
         throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     }
+    if (lib.uniffi_bitkitcore_checksum_func_is_valid_bip39_word() != 31846.toShort()) {
+        throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
+    }
     if (lib.uniffi_bitkitcore_checksum_func_lnurl_auth() != 58593.toShort()) {
         throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     }
+    if (lib.uniffi_bitkitcore_checksum_func_mnemonic_to_entropy() != 36669.toShort()) {
+        throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
+    }
+    if (lib.uniffi_bitkitcore_checksum_func_mnemonic_to_seed() != 40039.toShort()) {
+        throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
+    }
     if (lib.uniffi_bitkitcore_checksum_func_open_channel() != 21402.toShort()) {
         throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     }
@@ -1318,6 +1378,9 @@ private fun uniffiCheckApiChecksums(lib: UniffiLib) {
     if (lib.uniffi_bitkitcore_checksum_func_validate_bitcoin_address() != 56003.toShort()) {
         throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     }
+    if (lib.uniffi_bitkitcore_checksum_func_validate_mnemonic() != 31005.toShort()) {
+        throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
+    }
 }
 
 // Async support
@@ -5809,6 +5872,12 @@ sealed class AddressException: Exception() {
             get() = ""
     }
 
+    class InvalidEntropy(
+        ) : AddressException() {
+        override val message
+            get() = ""
+    }
+    
     class AddressDerivationFailed(
         ) : AddressException() {
         override val message
@@ -5832,7 +5901,8 @@ public object FfiConverterTypeAddressError : FfiConverterRustBuffer<AddressExcep
             2 -> AddressException.InvalidNetwork()
             3 -> AddressException.MnemonicGenerationFailed()
             4 -> AddressException.InvalidMnemonic()
-            5 -> AddressException.AddressDerivationFailed()
+            5 -> AddressException.InvalidEntropy()
+            6 -> AddressException.AddressDerivationFailed()
             else -> throw RuntimeException("invalid error enum value, something is very wrong!!")
         }
     }
@@ -5855,6 +5925,10 @@ public object FfiConverterTypeAddressError : FfiConverterRustBuffer<AddressExcep
                 // Add the size for the Int that specifies the variant plus the size needed for all fields
                 4UL
             )
+            is AddressException.InvalidEntropy -> (
+                // Add the size for the Int that specifies the variant plus the size needed for all fields
+                4UL
+            )
             is AddressException.AddressDerivationFailed -> (
                 // Add the size for the Int that specifies the variant plus the size needed for all fields
                 4UL
@@ -5880,10 +5954,14 @@ public object FfiConverterTypeAddressError : FfiConverterRustBuffer<AddressExcep
                 buf.putInt(4)
                 Unit
             }
-            is AddressException.AddressDerivationFailed -> {
+            is AddressException.InvalidEntropy -> {
                 buf.putInt(5)
                 Unit
             }
+            is AddressException.AddressDerivationFailed -> {
+                buf.putInt(6)
+                Unit
+            }
         }.let { /* this makes the `when` an expression, which ensures it is exhaustive */ }
     }
 
@@ -10764,6 +10842,16 @@ public object FfiConverterMapStringString: FfiConverterRustBuffer<Map<kotlin.Str
     }
 
 
+    @Throws(AddressException::class) fun `entropyToMnemonic`(`entropy`: kotlin.ByteArray): kotlin.String {
+            return FfiConverterString.lift(
+    uniffiRustCallWithError(AddressException) { _status ->
+    UniffiLib.INSTANCE.uniffi_bitkitcore_fn_func_entropy_to_mnemonic(
+        FfiConverterByteArray.lower(`entropy`),_status)
+}
+    )
+    }
+    
+
     @Throws(BlocktankException::class)
     @Suppress("ASSIGNED_BUT_NEVER_ACCESSED_VARIABLE")
      suspend fun `estimateOrderFee`(`lspBalanceSat`: kotlin.ULong, `channelExpiryWeeks`: kotlin.UInt, `options`: CreateOrderOptions?) : IBtEstimateFeeResponse {
@@ -10843,6 +10931,24 @@ public object FfiConverterMapStringString: FfiConverterRustBuffer<Map<kotlin.Str
     )
     }
 
+ fun `getBip39Suggestions`(`partialWord`: kotlin.String, `limit`: kotlin.UInt): List<kotlin.String> {
+            return FfiConverterSequenceString.lift(
+    uniffiRustCall() { _status ->
+    UniffiLib.INSTANCE.uniffi_bitkitcore_fn_func_get_bip39_suggestions(
+        FfiConverterString.lower(`partialWord`),FfiConverterUInt.lower(`limit`),_status)
+}
+    )
+    }
+    
+ fun `getBip39Wordlist`(): List<kotlin.String> {
+            return FfiConverterSequenceString.lift(
+    uniffiRustCall() { _status ->
+    UniffiLib.INSTANCE.uniffi_bitkitcore_fn_func_get_bip39_wordlist(
+        _status)
+}
+    )
+    }
+    
 
     @Throws(BlocktankException::class)
     @Suppress("ASSIGNED_BUT_NEVER_ACCESSED_VARIABLE")
@@ -11007,6 +11113,15 @@ public object FfiConverterMapStringString: FfiConverterRustBuffer<Map<kotlin.Str
 }
 
 
+ fun `isValidBip39Word`(`word`: kotlin.String): kotlin.Boolean {
+            return FfiConverterBoolean.lift(
+    uniffiRustCall() { _status ->
+    UniffiLib.INSTANCE.uniffi_bitkitcore_fn_func_is_valid_bip39_word(
+        FfiConverterString.lower(`word`),_status)
+}
+    )
+    }
+    
 
     @Throws(LnurlException::class)
     @Suppress("ASSIGNED_BUT_NEVER_ACCESSED_VARIABLE")
@@ -11023,6 +11138,26 @@ public object FfiConverterMapStringString: FfiConverterRustBuffer<Map<kotlin.Str
     )
     }
 
+    @Throws(AddressException::class) fun `mnemonicToEntropy`(`mnemonicPhrase`: kotlin.String): kotlin.ByteArray {
+            return FfiConverterByteArray.lift(
+    uniffiRustCallWithError(AddressException) { _status ->
+    UniffiLib.INSTANCE.uniffi_bitkitcore_fn_func_mnemonic_to_entropy(
+        FfiConverterString.lower(`mnemonicPhrase`),_status)
+}
+    )
+    }
+    
+
+    @Throws(AddressException::class) fun `mnemonicToSeed`(`mnemonicPhrase`: kotlin.String, `passphrase`: kotlin.String?): kotlin.ByteArray {
+            return FfiConverterByteArray.lift(
+    uniffiRustCallWithError(AddressException) { _status ->
+    UniffiLib.INSTANCE.uniffi_bitkitcore_fn_func_mnemonic_to_seed(
+        FfiConverterString.lower(`mnemonicPhrase`),FfiConverterOptionalString.lower(`passphrase`),_status)
+}
+    )
+    }
+    
+
     @Throws(BlocktankException::class)
     @Suppress("ASSIGNED_BUT_NEVER_ACCESSED_VARIABLE")
      suspend fun `openChannel`(`orderId`: kotlin.String, `connectionString`: kotlin.String) : IBtOrder {
@@ -11313,4 +11448,13 @@ public object FfiConverterMapStringString: FfiConverterRustBuffer<Map<kotlin.Str
     }
 
 
+    @Throws(AddressException::class) fun `validateMnemonic`(`mnemonicPhrase`: kotlin.String)
+        = 
+    uniffiRustCallWithError(AddressException) { _status ->
+    UniffiLib.INSTANCE.uniffi_bitkitcore_fn_func_validate_mnemonic(
+        FfiConverterString.lower(`mnemonicPhrase`),_status)
+}
+    
+    
+