frost/bdk-ffi
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add new getInternalAddress method to Kotlin API docs

Browse Source
This commit is contained in:
thunderbiscuit 2023-02-01 14:03:49 -05:00
parent 11d7d6b80f
commit df019c11ec
No known key found for this signature in database
GPG Key ID: 88253696EB836462
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
api-docs/kotlin/src/main/kotlin/org/bitcoindevkit/bdk.kt
View File

@ -384,6 +384,15 @@ class Wallet(
*/
fun getAddress(addressIndex: AddressIndex): AddressInfo {}
/**
* Return a derived address using the internal (change) descriptor.
* If the wallet doesn't have an internal descriptor it will use the external descriptor.
* See [AddressIndex] for available address index selection strategies. If none of the keys
* in the descriptor are derivable (i.e. does not end with /\*) then the same address will always
* be returned for any [AddressIndex].
*/
fun getInternalAddress(addressIndex: AddressIndex): AddressInfo {}
/** Return the wallet's balance, across different categories. See [Balance] for the categories. Note that this method only operates on the internal database, which first needs to be [Wallet.sync] manually. */
fun getBalance(): Balance {}