feat: small fixes #155
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,7 +5,7 @@ | |
| /// 2. No longer requires going through the client for each operation | ||
| /// 3. Cleaner and more efficient access to wallet functionality | ||
| use dash_spv_ffi::*; | ||
| use key_wallet_ffi::{wallet_manager_wallet_count, FFIError}; | ||
|
|
||
| fn main() { | ||
| unsafe { | ||
|
|
@@ -21,22 +21,22 @@ fn main() { | |
| panic!("Failed to create client"); | ||
| } | ||
|
|
||
| // Get the wallet manager - this returns a strongly typed pointer that | ||
| // shares the Arc with the SPV client, allowing direct interaction | ||
| let wallet_manager = dash_spv_ffi_client_get_wallet_manager(client); | ||
| if wallet_manager.is_null() { | ||
| panic!("Failed to get wallet manager"); | ||
| } | ||
|
|
||
| // Now we can use the wallet manager directly | ||
| // No need to go through client -> inner -> spv_client -> wallet() | ||
|
|
||
| // Get the number of wallets (should be 0 initially) | ||
| let mut error = std::mem::zeroed::<FFIError>(); | ||
| let wallet_count = wallet_manager_wallet_count( | ||
| wallet_manager as *const key_wallet_ffi::FFIWalletManager, | ||
| &mut error, | ||
| ); | ||
| println!("Number of wallets: {}", wallet_count); | ||
|
|
||
| // Note: To get total balance, you would need to iterate through wallets | ||
|
|
@@ -66,7 +66,7 @@ fn main() { | |
| // Clean up | ||
| // The wallet manager can now be independently destroyed | ||
| // It maintains its own Arc reference to the underlying wallet | ||
| dash_spv_ffi_wallet_manager_free(wallet_manager); | ||
| dash_spv_ffi_client_destroy(client); | ||
| dash_spv_ffi_config_destroy(config); | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -161,6 +161,17 @@ typedef struct FFIEventCallbacks { | |
| void *user_data; | ||
| } FFIEventCallbacks; | ||
|
|
||
| /** | ||
| * Opaque handle to the wallet manager owned by the SPV client. | ||
| * | ||
| * This is intentionally zero-sized so it can be used purely as an FFI handle | ||
| * while still allowing Rust to cast to the underlying key-wallet manager | ||
| * implementation when necessary. | ||
| */ | ||
| typedef struct FFIWalletManager { | ||
| uint8_t _private[0]; | ||
| } FFIWalletManager; | ||
|
|
||
| /** | ||
| * Handle for Core SDK that can be passed to Platform SDK | ||
| */ | ||
|
|
@@ -531,27 +542,35 @@ int32_t dash_spv_ffi_client_enable_mempool_tracking(struct FFIDashSpvClient *cli | |
| /** | ||
| * Get the wallet manager from the SPV client | ||
| * | ||
| * Returns a pointer to an `FFIWalletManager` wrapper that clones the underlying | ||
| * `Arc<RwLock<WalletManager>>`. This allows direct interaction with the wallet | ||
| * manager without going back through the client for each call. | ||
| * | ||
| * # Safety | ||
| * | ||
| * The caller must ensure that: | ||
| * - The client pointer is valid | ||
| * - The returned pointer is released exactly once using | ||
| * `dash_spv_ffi_wallet_manager_free` | ||
| * | ||
| * # Returns | ||
| * | ||
| * A pointer to the wallet manager wrapper, or NULL if the client is not initialized. | ||
| */ | ||
| struct FFIWalletManager *dash_spv_ffi_client_get_wallet_manager(struct FFIDashSpvClient *client) ; | ||
|
|
||
| /** | ||
| * Release a wallet manager obtained from `dash_spv_ffi_client_get_wallet_manager`. | ||
| * | ||
| * This simply forwards to `wallet_manager_free` in key-wallet-ffi so that | ||
| * lifetime management is consistent between direct key-wallet usage and the | ||
| * SPV client pathway. | ||
| * | ||
| * # Safety | ||
| * - `manager` must either be null or a pointer previously returned by | ||
| * `dash_spv_ffi_client_get_wallet_manager`. | ||
| */ | ||
| void dash_spv_ffi_wallet_manager_free(struct FFIWalletManager *manager) ; | ||
|
|
||
| struct FFIClientConfig *dash_spv_ffi_config_new(FFINetwork network) ; | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -287,7 +287,10 @@ def generate_markdown(functions: List[FFIFunction]) -> str: | |
| md.append("2. **Cleanup Required**: All returned pointers must be freed using the appropriate `_destroy` function") | ||
| md.append("3. **Thread Safety**: The SPV client is thread-safe") | ||
| md.append("4. **Error Handling**: Check return codes and use `dash_spv_ffi_get_last_error()` for details") | ||
| md.append( | ||
| "5. **Shared Ownership**: `dash_spv_ffi_client_get_wallet_manager()` returns `FFIWalletManager*` " | ||
| "that must be released with `dash_spv_ffi_wallet_manager_free()`" | ||
| ) | ||
| md.append("") | ||
|
|
||
| # Usage Examples | ||
|
|
@@ -312,8 +315,8 @@ def generate_markdown(functions: List[FFIFunction]) -> str: | |
| md.append("// Sync to chain tip") | ||
| md.append("dash_spv_ffi_client_sync_to_tip(client, NULL, NULL);") | ||
| md.append("") | ||
| md.append("// Get wallet manager (shares ownership with the client)") | ||
| md.append("FFIWalletManager* wallet_manager = dash_spv_ffi_client_get_wallet_manager(client);") | ||
| md.append("") | ||
| md.append("// Clean up") | ||
| md.append("dash_spv_ffi_client_destroy(client);") | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| use crate::{ | ||
| null_check, set_last_error, FFIClientConfig, FFIDetailedSyncProgress, FFIErrorCode, | ||
| FFIEventCallbacks, FFIMempoolStrategy, FFISpvStats, FFISyncProgress, FFIWalletManager, | ||
| }; | ||
| // Import wallet types from key-wallet-ffi | ||
| use key_wallet_ffi::FFIWalletManager as KeyWalletFFIWalletManager; | ||
|
|
||
| use dash_spv::storage::DiskStorageManager; | ||
| use dash_spv::types::SyncStage; | ||
|
|
@@ -1485,27 +1485,24 @@ pub unsafe extern "C" fn dash_spv_ffi_client_record_send( | |
|
|
||
| /// Get the wallet manager from the SPV client | ||
| /// | ||
| /// Returns a pointer to an `FFIWalletManager` wrapper that clones the underlying | ||
| /// `Arc<RwLock<WalletManager>>`. This allows direct interaction with the wallet | ||
| /// manager without going back through the client for each call. | ||
| /// | ||
| /// # Safety | ||
| /// | ||
| /// The caller must ensure that: | ||
| /// - The client pointer is valid | ||
| /// - The returned pointer is released exactly once using | ||
| /// `dash_spv_ffi_wallet_manager_free` | ||
| /// | ||
| /// # Returns | ||
| /// | ||
| /// A pointer to the wallet manager wrapper, or NULL if the client is not initialized. | ||
| #[no_mangle] | ||
| pub unsafe extern "C" fn dash_spv_ffi_client_get_wallet_manager( | ||
| client: *mut FFIDashSpvClient, | ||
| ) -> *mut FFIWalletManager { | ||
| null_check!(client, std::ptr::null_mut()); | ||
|
|
||
| let client = &*client; | ||
|
|
@@ -1517,11 +1514,29 @@ pub unsafe extern "C" fn dash_spv_ffi_client_get_wallet_manager( | |
| let runtime = client.runtime.clone(); | ||
|
|
||
| // Create the FFIWalletManager with the cloned Arc | ||
| let manager = KeyWalletFFIWalletManager::from_arc(wallet_arc, runtime); | ||
|
|
||
| Box::into_raw(Box::new(manager)) as *mut FFIWalletManager | ||
| } else { | ||
| set_last_error("Client not initialized"); | ||
| std::ptr::null_mut() | ||
| } | ||
| } | ||
|
|
||
| /// Release a wallet manager obtained from `dash_spv_ffi_client_get_wallet_manager`. | ||
| /// | ||
| /// This simply forwards to `wallet_manager_free` in key-wallet-ffi so that | ||
| /// lifetime management is consistent between direct key-wallet usage and the | ||
| /// SPV client pathway. | ||
| /// | ||
| /// # Safety | ||
| /// - `manager` must either be null or a pointer previously returned by | ||
| /// `dash_spv_ffi_client_get_wallet_manager`. | ||
| #[no_mangle] | ||
| pub unsafe extern "C" fn dash_spv_ffi_wallet_manager_free(manager: *mut FFIWalletManager) { | ||
| if manager.is_null() { | ||
| return; | ||
| } | ||
|
|
||
| key_wallet_ffi::wallet_manager::wallet_manager_free(manager as *mut KeyWalletFFIWalletManager); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,16 @@ use dash_spv::{ChainState, PeerInfo, SpvStats, SyncProgress}; | |
| use std::ffi::{CStr, CString}; | ||
| use std::os::raw::{c_char, c_void}; | ||
|
|
||
| /// Opaque handle to the wallet manager owned by the SPV client. | ||
| /// | ||
| /// This is intentionally zero-sized so it can be used purely as an FFI handle | ||
| /// while still allowing Rust to cast to the underlying key-wallet manager | ||
| /// implementation when necessary. | ||
| #[repr(C)] | ||
| pub struct FFIWalletManager { | ||
| _private: [u8; 0], | ||
| } | ||
|
|
||
| #[repr(C)] | ||
| pub struct FFIString { | ||
| pub ptr: *mut c_char, | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Example leaks the wallet manager; add a free call.
The “Basic SPV Client Usage” example obtains
FFIWalletManager*but never frees it. This encourages leaks in client code. Adddash_spv_ffi_wallet_manager_free(wallet_manager);(before destroying the client or right after use).Apply this diff to the example:
📝 Committable suggestion
🤖 Prompt for AI Agents