From 32a6b25a9151a495f7641c9522b0f221f6162c6b Mon Sep 17 00:00:00 2001 From: Braydon Fuller Date: Wed, 1 Jun 2016 13:07:27 -0400 Subject: [PATCH] docs: clarify getAddressSummary results --- docs/services/bitcoind.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/services/bitcoind.md b/docs/services/bitcoind.md index d38f303e..238a12bd 100644 --- a/docs/services/bitcoind.md +++ b/docs/services/bitcoind.md @@ -270,13 +270,20 @@ The `summary` will have the format (values are in satoshis): totalSpent: 0, balance: 1000000000, unconfirmedBalance: 1000000000, - appearances: 1, // number of transactions + appearances: 1, unconfirmedAppearances: 0, txids: [ '3f7d13efe12e82f873f4d41f7e63bb64708fc4c942eb8c6822fa5bd7606adb00' ] } ``` +**Notes**: +- `totalReceived` does not exclude change *(the amount of satoshis originating from the same address)* +- `unconfirmedBalance` is the delta that the unconfirmed transactions have on the total balance *(can be both positive and negative)* +- `unconfirmedAppearances` is the total number of unconfirmed transactions +- `appearances` is the total confirmed transactions +- `txids` Are sorted in block order with the most recent at the beginning. A maximum of 1000 *(default)* will be returned, the `from` and `to` options can be used to get further values. + ## Events The Bitcoin Service exposes two events via the Bus, and there are a few events that can be directly registered: