summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAmir Taaki <genjix@riseup.net>2014-04-01 03:50:35 (GMT)
committer Amir Taaki <genjix@riseup.net>2014-04-01 03:50:35 (GMT)
commitce596962afd7ec3025021b8ef9c147e9fd00ea40 (patch)
tree9486f4ba0bee1572065ab160839b16b9e44fcfbf
parent007ad0e55966943a375299c6ae7754cb7c3d6870 (diff)
added detail of returned result to documentation comment for blockchain::fetch_stealth().
-rw-r--r--include/bitcoin/blockchain/blockchain.hpp10
1 files changed, 10 insertions, 0 deletions
diff --git a/include/bitcoin/blockchain/blockchain.hpp b/include/bitcoin/blockchain/blockchain.hpp
index 9769685..7df88ac 100644
--- a/include/bitcoin/blockchain/blockchain.hpp
+++ b/include/bitcoin/blockchain/blockchain.hpp
@@ -319,6 +319,16 @@ public:
* Fetch possible stealth results. These results can then be iterated
* to discover new payments belonging to a particular stealth address.
* This is for recipient privacy.
+ * The result is a list of rows with the following fields:
+ *
+ * @code
+ * struct stealth_row
+ * {
+ * data_chunk ephemkey;
+ * payment_address address;
+ * hash_digest transaction_hash;
+ * };
+ * @endcode
*
* The prefix is a special value that can be adjusted to provide
* greater precision at the expense of deniability.