You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Move `#[cfg(feature = "keep-finalized-transactions")]` to before the
doc comment on the three gated FFI accessors. The
`contrib/verify_ffi.py` doc-extractor walks back from `#[no_mangle]`
collecting `///` lines and stops at the first non-doc, non-blank
line — putting `#[cfg]` between the doc and `#[no_mangle]` made the
docstrings invisible.
- Regenerate `key-wallet-ffi/FFI_API.md` with the updated descriptions
for `managed_core_account_get_transaction_count`,
`managed_core_account_get_transactions`, and
`managed_core_account_free_transactions`.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: key-wallet-ffi/FFI_API.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -231,7 +231,7 @@ Functions: 109
231
231
| `managed_account_collection_summary_data` | Get structured account collection summary data for managed collection ... | managed_account_collection |
232
232
| `managed_account_collection_summary_free` | Free a managed account collection summary and all its allocated memory #... | managed_account_collection |
233
233
| `managed_core_account_free` | Free a managed account handle # Safety - `account` must be a valid pointer... | managed_account |
234
-
| `managed_core_account_free_transactions` | Free transactions array returned by managed_core_account_get_transactions #... | managed_account |
234
+
| `managed_core_account_free_transactions` | Free transactions array returned by managed_core_account_get_transactions | managed_account |
235
235
| `managed_core_account_get_account_type` | Get the account type of a managed account # Safety - `account` must be a... | managed_account |
236
236
| `managed_core_account_get_address_pool` | Get an address pool from a managed account by type This function returns... | managed_account |
237
237
| `managed_core_account_get_balance` | Get the balance of a managed account # Safety - `account` must be a valid... | managed_account |
@@ -240,8 +240,8 @@ Functions: 109
240
240
| `managed_core_account_get_internal_address_pool` | Get the internal address pool from a managed account This function returns... | managed_account |
241
241
| `managed_core_account_get_is_watch_only` | Check if a managed account is watch-only # Safety - `account` must be a... | managed_account |
242
242
| `managed_core_account_get_network` | Get the network of a managed account # Safety - `account` must be a valid... | managed_account |
243
-
| `managed_core_account_get_transaction_count` | Get the number of transactions in a managed account # Safety - `account`... | managed_account |
244
-
| `managed_core_account_get_transactions` | Get all transactions from a managed account Returns an array of... | managed_account |
243
+
| `managed_core_account_get_transaction_count` | Get the number of transactions in a managed account | managed_account |
244
+
| `managed_core_account_get_transactions` | Get all transactions from a managed account | managed_account |
245
245
| `managed_core_account_get_utxo_count` | Get the number of UTXOs in a managed account # Safety - `account` must be... | managed_account |
246
246
| `managed_platform_account_free` | Free a managed platform account handle # Safety - `account` must be a... | managed_account |
247
247
| `managed_platform_account_get_account_index` | Get the account index of a managed platform account # Safety - `account`... | managed_account |
Free transactions array returned by managed_core_account_get_transactions # Safety - `transactions` must be a pointer returned by `managed_core_account_get_transactions` - `count` must be the count returned by `managed_core_account_get_transactions` - This function must only be called once per allocation
3068
+
Free transactions array returned by managed_core_account_get_transactions. Only available when the `keep-finalized-transactions` Cargo feature is enabled (matches the visibility of `managed_core_account_get_transactions`). # Safety - `transactions` must be a pointer returned by `managed_core_account_get_transactions` - `count` must be the count returned by `managed_core_account_get_transactions` - This function must only be called once per allocation
3069
3069
3070
3070
**Safety:**
3071
3071
- `transactions` must be a pointer returned by `managed_core_account_get_transactions` - `count` must be the count returned by `managed_core_account_get_transactions` - This function must only be called once per allocation
Get the number of transactions in a managed account # Safety - `account` must be a valid pointer to an FFIManagedCoreAccount instance
3212
+
Get the number of transactions in a managed account. Only available when the `keep-finalized-transactions` Cargo feature is enabled. With the feature on, every processed transaction (including finalized ones) lives in the in-memory map for the wallet's lifetime and this count reflects the full history. With the feature off (the default), records of finalized transactions (IS-locked or chainlocked) are dropped from the map immediately to bound memory growth — exposing the resulting partial count via the FFI would be misleading, so the accessor isn't compiled in. # Safety - `account` must be a valid pointer to an FFIManagedCoreAccount instance
3213
3213
3214
3214
**Safety:**
3215
3215
- `account` must be a valid pointer to an FFIManagedCoreAccount instance
@@ -3225,7 +3225,7 @@ managed_core_account_get_transactions(account: *const FFIManagedCoreAccount, tra
3225
3225
```
3226
3226
3227
3227
**Description:**
3228
-
Get all transactions from a managed account Returns an array of FFITransactionRecord structures. # Safety - `account` must be a valid pointer to an FFIManagedCoreAccount instance - `transactions_out` must be a valid pointer to receive the transactions array pointer - `count_out` must be a valid pointer to receive the count - The caller must free the returned array using `managed_core_account_free_transactions`
3228
+
Get all transactions from a managed account. Only available when the `keep-finalized-transactions` Cargo feature is enabled. With the feature on, every processed transaction (including finalized ones) lives in the in-memory map and this returns the full history. With the feature off (the default), finalized records (IS-locked or chainlocked txs) are dropped from the map immediately to bound memory growth — exposing the resulting partial array via the FFI would be misleading, so the accessor isn't compiled in. Returns an array of FFITransactionRecord structures. # Safety - `account` must be a valid pointer to an FFIManagedCoreAccount instance - `transactions_out` must be a valid pointer to receive the transactions array pointer - `count_out` must be a valid pointer to receive the count - The caller must free the returned array using `managed_core_account_free_transactions`
3229
3229
3230
3230
**Safety:**
3231
3231
- `account` must be a valid pointer to an FFIManagedCoreAccount instance - `transactions_out` must be a valid pointer to receive the transactions array pointer - `count_out` must be a valid pointer to receive the count - The caller must free the returned array using `managed_core_account_free_transactions`
0 commit comments