From df019c11ecb1a495191d2555227ec7b603090c86 Mon Sep 17 00:00:00 2001 From: thunderbiscuit Date: Wed, 1 Feb 2023 14:03:49 -0500 Subject: [PATCH] Add new getInternalAddress method to Kotlin API docs --- api-docs/kotlin/src/main/kotlin/org/bitcoindevkit/bdk.kt | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/api-docs/kotlin/src/main/kotlin/org/bitcoindevkit/bdk.kt b/api-docs/kotlin/src/main/kotlin/org/bitcoindevkit/bdk.kt index 1413a35..bcfc21a 100644 --- a/api-docs/kotlin/src/main/kotlin/org/bitcoindevkit/bdk.kt +++ b/api-docs/kotlin/src/main/kotlin/org/bitcoindevkit/bdk.kt @@ -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 {}