From 2bc51c5c3215398875c04456a3f3df1c07b830b5 Mon Sep 17 00:00:00 2001 From: Arnab Sen Date: Fri, 3 Sep 2021 22:08:53 +0530 Subject: [tracing] tracepoints to utxocache add, spent and uncache Signed-off-by: Arnab Sen --- doc/tracing.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) (limited to 'doc') diff --git a/doc/tracing.md b/doc/tracing.md index 4c18179928..5b9ba09c2f 100644 --- a/doc/tracing.md +++ b/doc/tracing.md @@ -124,6 +124,39 @@ Arguments passed: 5. If the flush was pruned as `bool` 6. If it was full flush as `bool` +#### Tracepoint `utxocache:add` + +It is called when a new coin is added to the UTXO cache. + +Arguments passed: +1. Transaction ID (hash) as `pointer to unsigned chars` (i.e. 32 bytes in little-endian) +2. Output index as `uint32` +3. Block height the coin was added to the UTXO-set as `uint32` +4. Value of the coin as `int64` +5. If the coin is a coinbase as `bool` + +#### Tracepoint `utxocache:spent` + +It is called when a coin is spent from the UTXO cache. + +Arguments passed: +1. Transaction ID (hash) as `pointer to unsigned chars` (i.e. 32 bytes in little-endian) +2. Output index as `uint32` +3. Block height the coin was spent, as `uint32` +4. Value of the coin as `int64` +5. If the coin is a coinbase as `bool` + +#### Tracepoint `utxocache:uncache` + +It is called when the UTXO with the given outpoint is removed from the cache. + +Arguments passed: +1. Transaction ID (hash) as `pointer to unsigned chars` (i.e. 32 bytes in little-endian) +2. Output index as `uint32` +3. Block height the coin was uncached, as `uint32` +4. Value of the coin as `int64` +. If the coin is a coinbase as `bool` + ## Adding tracepoints to Bitcoin Core To add a new tracepoint, `#include ` in the compilation unit where -- cgit v1.2.3