Skip to content

refactor: fix last clippy warnings in dash_spv #131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
QuantumExplorer merged 3 commits into from
Sep 2, 2025
Merged

refactor: fix last clippy warnings in dash_spv #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9af4e64
feat: update test configurations for improved initialization
QuantumExplorer Sep 2, 2025
87560ea
fixes
QuantumExplorer Sep 2, 2025
50e36ef
ffi docs
QuantumExplorer Sep 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/rust.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ jobs:
strategy:
matrix:
rust: [stable]
dashversion: ["22.0.0", "22.1.3"]
dashversion: ["22.1.3"]
steps:
- name: Checkout Crate
uses: actions/checkout@v4
Expand Down
114 changes: 99 additions & 15 deletions dash-spv-ffi/FFI_API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ Functions: 4

| Function | Description | Module |
|----------|-------------|--------|
| `dash_spv_ffi_client_destroy` | No description | client |
| `dash_spv_ffi_client_new` | No description | client |
| `dash_spv_ffi_client_start` | No description | client |
| `dash_spv_ffi_client_stop` | No description | client |
| `dash_spv_ffi_client_destroy` | Destroy the client and free associated resources | client |
| `dash_spv_ffi_client_new` | Create a new SPV client and return an opaque pointer | client |
| `dash_spv_ffi_client_start` | Start the SPV client | client |
| `dash_spv_ffi_client_stop` | Stop the SPV client | client |

### Configuration

Expand Down Expand Up @@ -71,12 +71,12 @@ Functions: 7
| Function | Description | Module |
|----------|-------------|--------|
| `dash_spv_ffi_client_cancel_sync` | Cancels the sync operation | client |
| `dash_spv_ffi_client_get_sync_progress` | No description | client |
| `dash_spv_ffi_client_is_filter_sync_available` | No description | client |
| `dash_spv_ffi_client_get_sync_progress` | Get the current sync progress snapshot | client |
| `dash_spv_ffi_client_is_filter_sync_available` | Check if compact filter sync is currently available | client |
| `dash_spv_ffi_client_sync_to_tip` | Sync the SPV client to the chain tip | client |
| `dash_spv_ffi_client_sync_to_tip_with_progress` | Sync the SPV client to the chain tip with detailed progress updates | client |
| `dash_spv_ffi_client_test_sync` | Performs a test synchronization of the SPV client # Parameters - `client`: P... | client |
| `dash_spv_ffi_sync_progress_destroy` | No description | client |
| `dash_spv_ffi_sync_progress_destroy` | Destroy a `FFISyncProgress` object returned by this crate | client |

### Address Monitoring

Expand All @@ -102,7 +102,7 @@ Functions: 1

| Function | Description | Module |
|----------|-------------|--------|
| `dash_spv_ffi_client_enable_mempool_tracking` | No description | client |
| `dash_spv_ffi_client_enable_mempool_tracking` | Enable mempool tracking with a given strategy | client |

### Platform Integration

Expand All @@ -121,7 +121,7 @@ Functions: 1

| Function | Description | Module |
|----------|-------------|--------|
| `dash_spv_ffi_client_set_event_callbacks` | No description | client |
| `dash_spv_ffi_client_set_event_callbacks` | Set event callbacks for the client | client |

### Error Handling

Expand All @@ -143,13 +143,13 @@ Functions: 15
| `dash_spv_ffi_checkpoint_before_timestamp` | Get the last checkpoint at or before a given UNIX timestamp (seconds) | checkpoints |
| `dash_spv_ffi_checkpoint_latest` | Get the latest checkpoint for the given network | checkpoints |
| `dash_spv_ffi_checkpoints_between_heights` | Get all checkpoints between two heights (inclusive) | checkpoints |
| `dash_spv_ffi_client_get_stats` | No description | client |
| `dash_spv_ffi_client_get_stats` | Get current runtime statistics for the SPV client | client |
| `dash_spv_ffi_client_get_wallet_manager` | Get the wallet manager from the SPV client Returns an opaque pointer to FFIW... | client |
| `dash_spv_ffi_client_record_send` | No description | client |
| `dash_spv_ffi_client_rescan_blockchain` | No description | client |
| `dash_spv_ffi_client_record_send` | Record that we attempted to send a transaction by its txid | client |
| `dash_spv_ffi_client_rescan_blockchain` | Request a rescan of the blockchain from a given height (not yet implemented) | client |
| `dash_spv_ffi_enable_test_mode` | No description | utils |
| `dash_spv_ffi_init_logging` | No description | utils |
| `dash_spv_ffi_spv_stats_destroy` | No description | client |
| `dash_spv_ffi_init_logging` | Initialize logging for the SPV library | utils |
| `dash_spv_ffi_spv_stats_destroy` | Destroy an `FFISpvStats` object returned by this crate | client |
| `dash_spv_ffi_string_array_destroy` | Destroy an array of FFIString pointers (Vec<*mut FFIString>) and their contents | types |
| `dash_spv_ffi_string_destroy` | No description | types |
| `dash_spv_ffi_version` | No description | utils |
Expand All @@ -164,6 +164,12 @@ Functions: 15
dash_spv_ffi_client_destroy(client: *mut FFIDashSpvClient) -> ()
```

**Description:**
Destroy the client and free associated resources. # Safety - `client` must be either null or a pointer obtained from `dash_spv_ffi_client_new`.

**Safety:**
- `client` must be either null or a pointer obtained from `dash_spv_ffi_client_new`.

**Module:** `client`

---
Expand All @@ -174,6 +180,12 @@ dash_spv_ffi_client_destroy(client: *mut FFIDashSpvClient) -> ()
dash_spv_ffi_client_new(config: *const FFIClientConfig,) -> *mut FFIDashSpvClient
```

**Description:**
Create a new SPV client and return an opaque pointer. # Safety - `config` must be a valid, non-null pointer for the duration of the call. - The returned pointer must be freed with `dash_spv_ffi_client_destroy`.

**Safety:**
- `config` must be a valid, non-null pointer for the duration of the call. - The returned pointer must be freed with `dash_spv_ffi_client_destroy`.

**Module:** `client`

---
Expand All @@ -184,6 +196,12 @@ dash_spv_ffi_client_new(config: *const FFIClientConfig,) -> *mut FFIDashSpvClien
dash_spv_ffi_client_start(client: *mut FFIDashSpvClient) -> i32
```

**Description:**
Start the SPV client. # Safety - `client` must be a valid, non-null pointer to a created client.

**Safety:**
- `client` must be a valid, non-null pointer to a created client.

**Module:** `client`

---
Expand All @@ -194,6 +212,12 @@ dash_spv_ffi_client_start(client: *mut FFIDashSpvClient) -> i32
dash_spv_ffi_client_stop(client: *mut FFIDashSpvClient) -> i32
```

**Description:**
Stop the SPV client. # Safety - `client` must be a valid, non-null pointer to a created client.

**Safety:**
- `client` must be a valid, non-null pointer to a created client.

**Module:** `client`

---
Expand Down Expand Up @@ -606,6 +630,12 @@ The client pointer must be valid and non-null.
dash_spv_ffi_client_get_sync_progress(client: *mut FFIDashSpvClient,) -> *mut FFISyncProgress
```

**Description:**
Get the current sync progress snapshot. # Safety - `client` must be a valid, non-null pointer.

**Safety:**
- `client` must be a valid, non-null pointer.

**Module:** `client`

---
Expand All @@ -616,6 +646,12 @@ dash_spv_ffi_client_get_sync_progress(client: *mut FFIDashSpvClient,) -> *mut FF
dash_spv_ffi_client_is_filter_sync_available(client: *mut FFIDashSpvClient,) -> bool
```

**Description:**
Check if compact filter sync is currently available. # Safety - `client` must be a valid, non-null pointer.

**Safety:**
- `client` must be a valid, non-null pointer.

**Module:** `client`

---
Expand Down Expand Up @@ -674,6 +710,12 @@ This function is unsafe because it dereferences a raw pointer. The caller must e
dash_spv_ffi_sync_progress_destroy(progress: *mut FFISyncProgress) -> ()
```

**Description:**
Destroy a `FFISyncProgress` object returned by this crate. # Safety - `progress` must be a pointer returned from this crate, or null.

**Safety:**
- `progress` must be a pointer returned from this crate, or null.

**Module:** `client`

---
Expand Down Expand Up @@ -748,6 +790,12 @@ Destroys the raw transaction bytes allocated for an FFIUnconfirmedTransaction #
dash_spv_ffi_client_enable_mempool_tracking(client: *mut FFIDashSpvClient, strategy: FFIMempoolStrategy,) -> i32
```

**Description:**
Enable mempool tracking with a given strategy. # Safety - `client` must be a valid, non-null pointer.

**Safety:**
- `client` must be a valid, non-null pointer.

**Module:** `client`

---
Expand Down Expand Up @@ -826,6 +874,12 @@ This function is unsafe because: - The caller must ensure the handle pointer is
dash_spv_ffi_client_set_event_callbacks(client: *mut FFIDashSpvClient, callbacks: FFIEventCallbacks,) -> i32
```

**Description:**
Set event callbacks for the client. # Safety - `client` must be a valid, non-null pointer.

**Safety:**
- `client` must be a valid, non-null pointer.

**Module:** `client`

---
Expand Down Expand Up @@ -931,6 +985,12 @@ Get all checkpoints between two heights (inclusive). Returns an `FFIArray` of `
dash_spv_ffi_client_get_stats(client: *mut FFIDashSpvClient,) -> *mut FFISpvStats
```

**Description:**
Get current runtime statistics for the SPV client. # Safety - `client` must be a valid, non-null pointer.

**Safety:**
- `client` must be a valid, non-null pointer.

**Module:** `client`

---
Expand All @@ -942,7 +1002,7 @@ dash_spv_ffi_client_get_wallet_manager(client: *mut FFIDashSpvClient,) -> *mut c
```

**Description:**
Get the wallet manager from the SPV client Returns an opaque pointer to FFIWalletManager that contains a cloned Arc reference to the wallet manager. This allows direct interaction with the wallet manager without going through the client. # Safety The caller must ensure that: - The client pointer is valid - The returned pointer is freed using `wallet_manager_free` from key-wallet-ffi # Returns An opaque pointer (void*) to the wallet manager, or NULL if the client is not initialized. Swift should treat this as an OpaquePointer.
Get the wallet manager from the SPV client Returns an opaque pointer to FFIWalletManager that contains a cloned Arc reference to the wallet manager. This allows direct interaction with the wallet manager without going through the client. # Safety The caller must ensure that: - The client pointer is valid - The returned pointer is freed using `wallet_manager_free` from key-wallet-ffi # Returns An opaque pointer (void*) to the wallet manager, or NULL if the client is not initialized. Swift should treat this as an OpaquePointer. Get a handle to the wallet manager owned by this client. # Safety - `client` must be a valid, non-null pointer.

**Safety:**
The caller must ensure that: - The client pointer is valid - The returned pointer is freed using `wallet_manager_free` from key-wallet-ffi
Expand All @@ -957,6 +1017,12 @@ The caller must ensure that: - The client pointer is valid - The returned pointe
dash_spv_ffi_client_record_send(client: *mut FFIDashSpvClient, txid: *const c_char,) -> i32
```

**Description:**
Record that we attempted to send a transaction by its txid. # Safety - `client` and `txid` must be valid, non-null pointers.

**Safety:**
- `client` and `txid` must be valid, non-null pointers.

**Module:** `client`

---
Expand All @@ -967,6 +1033,12 @@ dash_spv_ffi_client_record_send(client: *mut FFIDashSpvClient, txid: *const c_ch
dash_spv_ffi_client_rescan_blockchain(client: *mut FFIDashSpvClient, _from_height: u32,) -> i32
```

**Description:**
Request a rescan of the blockchain from a given height (not yet implemented). # Safety - `client` must be a valid, non-null pointer.

**Safety:**
- `client` must be a valid, non-null pointer.

**Module:** `client`

---
Expand All @@ -987,6 +1059,12 @@ dash_spv_ffi_enable_test_mode() -> ()
dash_spv_ffi_init_logging(level: *const c_char) -> i32
```

**Description:**
Initialize logging for the SPV library. # Safety - `level` may be null or point to a valid, NUL-terminated C string. - If non-null, the pointer must remain valid for the duration of this call.

**Safety:**
- `level` may be null or point to a valid, NUL-terminated C string. - If non-null, the pointer must remain valid for the duration of this call.

**Module:** `utils`

---
Expand All @@ -997,6 +1075,12 @@ dash_spv_ffi_init_logging(level: *const c_char) -> i32
dash_spv_ffi_spv_stats_destroy(stats: *mut FFISpvStats) -> ()
```

**Description:**
Destroy an `FFISpvStats` object returned by this crate. # Safety - `stats` must be a pointer returned from this crate, or null.

**Safety:**
- `stats` must be a pointer returned from this crate, or null.

**Module:** `client`

---
Expand Down
Loading
Loading