Merge pull request #3 from synonymdev/feat/derive-store-id

feat: add store id derivation

Author: coreyphillips

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "vss-rust-client-ffi"
-version = "0.2.0"
+version = "0.3.0"
 edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

Cargo.toml

@@ -32,12 +32,19 @@ cargo build --release
 ```swift
 import vss_rust_client_ffi
 
-// Initialize VSS client with LNURL-auth
+let mnemonic = "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about"
+let passphrase: String? = nil
+let storeId = try vssDeriveStoreId(
+    prefix: "bitkit_v1_regtest",
+    mnemonic: mnemonic,
+    passphrase: passphrase
+)
+
 try await vssNewClientWithLnurlAuth(
     baseUrl: "https://vss.example.com",
-    storeId: "my-app-store",
-    mnemonic: "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about",
-    passphrase: nil,
+    storeId: storeId,
+    mnemonic: mnemonic,
+    passphrase: passphrase,
     lnurlAuthServerUrl: "https://auth.example.com/lnurl"
 )
 
@@ -73,12 +80,19 @@ vssShutdownClient()
 ```python
 from vss_rust_client_ffi import *
 
-# Initialize VSS client with LNURL-auth
+mnemonic = "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about"
+passphrase = None
+store_id = vss_derive_store_id(
+    prefix="bitkit_v1_regtest",
+    mnemonic=mnemonic,
+    passphrase=passphrase
+)
+
 await vss_new_client_with_lnurl_auth(
     "https://vss.example.com",
-    "my-app-store",
-    "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about",
-    None,  # passphrase
+    store_id,
+    mnemonic,
+    passphrase,
     "https://auth.example.com/lnurl"
 )
 
@@ -117,12 +131,19 @@ vss_shutdown_client()
 ```kotlin
 import uniffi.vss_rust_client_ffi.*
 
-// Initialize VSS client with LNURL-auth
+val mnemonic = "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about"
+val passphrase: String? = null
+val storeId = vssDeriveStoreId(
+    prefix = "bitkit_v1_regtest",
+    mnemonic = mnemonic,
+    passphrase = passphrase
+)
+
 vssNewClientWithLnurlAuth(
     baseUrl = "https://vss.example.com",
-    storeId = "my-app-store",
-    mnemonic = "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about",
-    passphrase = null,
+    storeId = storeId,
+    mnemonic = mnemonic,
+    passphrase = passphrase,
     lnurlAuthServerUrl = "https://auth.example.com/lnurl"
 )
 
@@ -171,6 +192,15 @@ Initialize the global VSS client connection with LNURL-auth authentication. Prov
 #### `vssShutdownClient() -> Void`
 Shutdown the VSS client and clean up resources. Optional but recommended for clean application shutdown.
 
+### Utility Functions
+
+#### `vssDeriveStoreId(prefix: String, mnemonic: String, passphrase: String?) -> String`
+Derives a deterministic VSS store ID from a mnemonic and optional passphrase using BIP32 key derivation.
+
+- `prefix`: A prefix to include in the store ID (e.g., "bitkit_v1_regtest")
+- `mnemonic`: BIP39 mnemonic phrase (12 or 24 words)  
+- `passphrase`: Optional BIP39 passphrase
+
 ### Data Operations
 
 #### `vssStore(key: String, value: Data) -> VssItem`
@@ -294,4 +324,4 @@ This project is licensed under the MIT License - see the LICENSE file for detail
 
 - [VSS Server](https://github.com/lightningdevkit/vss-server) - The VSS server implementation
 - [vss-client](https://crates.io/crates/vss-client) - The underlying Rust client library
-- [UniFFI](https://mozilla.github.io/uniffi-rs/) - The FFI binding generator
+- [UniFFI](https://mozilla.github.io/uniffi-rs/) - The FFI binding generator

README.md

@@ -3,4 +3,4 @@ android.useAndroidX=true
 android.nonTransitiveRClass=true
 kotlin.code.style=official
 # project settings:
-version=0.2.0
+version=0.3.0

bindings/android/gradle.properties

@@ -415,6 +415,13 @@ internal interface _UniFFILib : Library {
 
     fun uniffi_vss_rust_client_ffi_fn_func_vss_delete(`key`: RustBuffer.ByValue): Pointer
 
+    fun uniffi_vss_rust_client_ffi_fn_func_vss_derive_store_id(
+        `prefix`: RustBuffer.ByValue,
+        `mnemonic`: RustBuffer.ByValue,
+        `passphrase`: RustBuffer.ByValue,
+        _uniffi_out_err: RustCallStatus,
+    ): RustBuffer.ByValue
+
     fun uniffi_vss_rust_client_ffi_fn_func_vss_get(`key`: RustBuffer.ByValue): Pointer
 
     fun uniffi_vss_rust_client_ffi_fn_func_vss_list(`prefix`: RustBuffer.ByValue): Pointer
@@ -650,6 +657,8 @@ internal interface _UniFFILib : Library {
 
     fun uniffi_vss_rust_client_ffi_checksum_func_vss_delete(): Short
 
+    fun uniffi_vss_rust_client_ffi_checksum_func_vss_derive_store_id(): Short
+
     fun uniffi_vss_rust_client_ffi_checksum_func_vss_get(): Short
 
     fun uniffi_vss_rust_client_ffi_checksum_func_vss_list(): Short
@@ -684,6 +693,9 @@ private fun uniffiCheckApiChecksums(lib: _UniFFILib) {
     if (lib.uniffi_vss_rust_client_ffi_checksum_func_vss_delete() != 46571.toShort()) {
         throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     }
+    if (lib.uniffi_vss_rust_client_ffi_checksum_func_vss_derive_store_id() != 61324.toShort()) {
+        throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
+    }
     if (lib.uniffi_vss_rust_client_ffi_checksum_func_vss_get() != 59657.toShort()) {
         throw RuntimeException("UniFFI API checksum mismatch: try cleaning and rebuilding your project")
     }
@@ -1397,6 +1409,23 @@ suspend fun `vssDelete`(`key`: String): Boolean =
         VssException.ErrorHandler,
     )
 
+@Throws(VssException::class)
+fun `vssDeriveStoreId`(
+    `prefix`: String,
+    `mnemonic`: String,
+    `passphrase`: String?,
+): String =
+    FfiConverterString.lift(
+        rustCallWithError(VssException) { _status ->
+            _UniFFILib.INSTANCE.uniffi_vss_rust_client_ffi_fn_func_vss_derive_store_id(
+                FfiConverterString.lower(`prefix`),
+                FfiConverterString.lower(`mnemonic`),
+                FfiConverterOptionalString.lower(`passphrase`),
+                _status,
+            )
+        },
+    )
+
 @Throws(VssException::class)
 @Suppress("ASSIGNED_BUT_NEVER_ACCESSED_VARIABLE")
 suspend fun `vssGet`(`key`: String): VssItem? =

bindings/android/src/main/jniLibs/arm64-v8a/libvss_rust_client_ffi.so

@@ -65,6 +65,8 @@ typedef void (*UniFfiRustFutureContinuation)(void * _Nonnull, int8_t);
 // Scaffolding functions
 void* _Nonnull uniffi_vss_rust_client_ffi_fn_func_vss_delete(RustBuffer key
 );
+RustBuffer uniffi_vss_rust_client_ffi_fn_func_vss_derive_store_id(RustBuffer prefix, RustBuffer mnemonic, RustBuffer passphrase, RustCallStatus *_Nonnull out_status
+);
 void* _Nonnull uniffi_vss_rust_client_ffi_fn_func_vss_get(RustBuffer key
 );
 void* _Nonnull uniffi_vss_rust_client_ffi_fn_func_vss_list(RustBuffer prefix
@@ -198,6 +200,9 @@ void ffi_vss_rust_client_ffi_rust_future_complete_void(void* _Nonnull handle, Ru
 );
 uint16_t uniffi_vss_rust_client_ffi_checksum_func_vss_delete(void
 
+);
+uint16_t uniffi_vss_rust_client_ffi_checksum_func_vss_derive_store_id(void
+    
 );
 uint16_t uniffi_vss_rust_client_ffi_checksum_func_vss_get(void