From 12e9a18357d452ea6ce97f3a17e4b46d61923961 Mon Sep 17 00:00:00 2001 From: Shobit Beltangdy Date: Sat, 17 Dec 2022 09:11:52 -0800 Subject: [PATCH] Update Wallet.getBalance doc to reflect Balance return type This is a fix for issue #284 --- api-docs/kotlin/src/main/kotlin/org/bitcoindevkit/bdk.kt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 f97fd09..5accca1 100644 --- a/api-docs/kotlin/src/main/kotlin/org/bitcoindevkit/bdk.kt +++ b/api-docs/kotlin/src/main/kotlin/org/bitcoindevkit/bdk.kt @@ -367,8 +367,8 @@ class Wallet( */ fun getAddress(addressIndex: AddressIndex): AddressInfo {} - /** Return the balance, meaning the sum of this wallet’s unspent outputs’ values. Note that this method only operates on the internal database, which first needs to be [Wallet.sync] manually. */ - fun getBalance(): ULong {} + /** 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 {} /** Sign a transaction with all the wallet’s signers. */ fun sign(psbt: PartiallySignedBitcoinTransaction): Boolean {}