Skip to content

Commit c6a4ed6

Browse files
authored
docs: update stale wallet_check_transaction docs (#613)
Remove references to old output params (`inputs_spent_out`, `addresses_used_out`, `new_balance_out`, `new_address_out`, `new_address_count_out`) that no longer exist in the signature.
1 parent c4fac22 commit c6a4ed6

File tree

2 files changed

+3
-7
lines changed

2 files changed

+3
-7
lines changed

key-wallet-ffi/FFI_API.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1321,10 +1321,10 @@ wallet_check_transaction(wallet: *mut FFIWallet, tx_bytes: *const u8, tx_len: us
13211321
```
13221322

13231323
**Description:**
1324-
Check if a transaction belongs to the wallet using ManagedWalletInfo # Safety - `wallet` must be a valid mutable pointer to an FFIWallet - `tx_bytes` must be a valid pointer to transaction bytes with at least `tx_len` bytes - `inputs_spent_out` must be a valid pointer to store the spent inputs count - `addresses_used_out` must be a valid pointer to store the used addresses count - `new_balance_out` must be a valid pointer to store the new balance - `new_address_out` must be a valid pointer to store the address array pointer - `new_address_count_out` must be a valid pointer to store the address count - `error` must be a valid pointer to an FFIError
1324+
Check if a transaction belongs to the wallet using ManagedWalletInfo # Safety - `wallet` must be a valid mutable pointer to an FFIWallet - `tx_bytes` must be a valid pointer to transaction bytes with at least `tx_len` bytes - `result_out` must be a valid pointer to store the result - `error` must be a valid pointer to an FFIError
13251325

13261326
**Safety:**
1327-
- `wallet` must be a valid mutable pointer to an FFIWallet - `tx_bytes` must be a valid pointer to transaction bytes with at least `tx_len` bytes - `inputs_spent_out` must be a valid pointer to store the spent inputs count - `addresses_used_out` must be a valid pointer to store the used addresses count - `new_balance_out` must be a valid pointer to store the new balance - `new_address_out` must be a valid pointer to store the address array pointer - `new_address_count_out` must be a valid pointer to store the address count - `error` must be a valid pointer to an FFIError
1327+
- `wallet` must be a valid mutable pointer to an FFIWallet - `tx_bytes` must be a valid pointer to transaction bytes with at least `tx_len` bytes - `result_out` must be a valid pointer to store the result - `error` must be a valid pointer to an FFIError
13281328

13291329
**Module:** `transaction`
13301330

key-wallet-ffi/src/transaction.rs

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -385,11 +385,7 @@ pub struct FFITransactionCheckResult {
385385
///
386386
/// - `wallet` must be a valid mutable pointer to an FFIWallet
387387
/// - `tx_bytes` must be a valid pointer to transaction bytes with at least `tx_len` bytes
388-
/// - `inputs_spent_out` must be a valid pointer to store the spent inputs count
389-
/// - `addresses_used_out` must be a valid pointer to store the used addresses count
390-
/// - `new_balance_out` must be a valid pointer to store the new balance
391-
/// - `new_address_out` must be a valid pointer to store the address array pointer
392-
/// - `new_address_count_out` must be a valid pointer to store the address count
388+
/// - `result_out` must be a valid pointer to store the result
393389
/// - `error` must be a valid pointer to an FFIError
394390
#[no_mangle]
395391
pub unsafe extern "C" fn wallet_check_transaction(

0 commit comments

Comments
 (0)