You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This document provides a description of the entries in these reports.
5
6
6
7
## Bitcoin Backend
7
-
It is strongly recommended that Faraday is run with a connection to a Bitcon node when these reports are generated. This is required to lookup fee entries for channel close transactions and sweep fees. If a connection to a bitcoin node is not provided, warnings will be logged for the transactions that do not have fee entries.
8
+
It is strongly recommended that Faraday is run with a connection to a Bitcoin
9
+
node when these reports are generated. This is required to lookup fee entries
10
+
for channel close transactions and sweep fees. If a connection to a bitcoin node
11
+
is not provided, warnings will be logged for the transactions that do not have
12
+
fee entries.
8
13
9
14
## Common Fields
10
-
For brevity, the following fields which have the same meaning for each entry will be omitted:
11
-
- Timestamp: The timestamp of the block that the channel open transaction appeared in.
12
-
- Fiat: The value of the amount field in specified currency. Note that values less than one satoshi will be rounded down to zero.
15
+
For brevity, the following fields which have the same meaning for each entry
16
+
will be omitted:
17
+
- Timestamp: The timestamp of the block that the channel open transaction
18
+
appeared in.
19
+
- Fiat: The value of the amount field in specified currency. Note that values
20
+
less than one satoshi will be rounded down to zero.
13
21
- OnChain: Whether the transaction occurred off chain, or on chain.
14
-
- Credit: True when an entry increased our balances, false when an entry decreased our balances.
22
+
- Credit: True when an entry increased our balances, false when an entry
23
+
decreased our balances.
15
24
16
-
Note that fee entries reference the entry they are associated with by appending a fee marker (:-1) to the original reference. The fee entry will have a reference formatted as follows: `original reference:-1`.
25
+
Note that fee entries reference the entry they are associated with by appending
26
+
a fee marker (:-1) to the original reference. The fee entry will have a
27
+
reference formatted as follows: `original reference:-1`.
17
28
18
29
## On Chain Reports
19
30
@@ -22,8 +33,9 @@ Local channel open entry types represent channel opens that were initiated by
22
33
our node. These entries are accompanied by a separate Channel Open Fees entry,
23
34
because the opening party pays on chain fees.
24
35
25
-
- Amount: The amount in millisatoshis that we added to the channel, excluding on chain fees.
26
-
- TxID: The on chain transaction ID for the channel open.
36
+
- Amount: The amount in millisatoshis that we added to the channel, excluding on
37
+
chain fees.
38
+
- TXID: The on chain transaction ID for the channel open.
27
39
- Reference: The unique channel ID assigned to the channel.
28
40
- Note: A note with details of who opened the channel.
29
41
@@ -42,82 +54,113 @@ The fees paid to open a channel that we initiated.
42
54
Remote channel open entry types represent channels that were opened by remote
43
55
peers.
44
56
45
-
- Amount: Zero, our balance is unaffected by remote channel creation, with the exception of a push amount listed below.
46
-
- TxID: The on chain transaction ID for the channel open.
57
+
- Amount: Zero, our balance is unaffected by remote channel creation, except for
58
+
a push amount listed below.
59
+
- TXID: The on chain transaction ID for the channel open.
47
60
- Reference: The unique channel ID assigned to the channel.
48
61
- Note: A note containing the pubkey of the peer that opened a channel to us.
49
62
50
63
Known Omissions:
51
-
- Remote peers may push balance to our node as part of the funding flow. This amount is not currently included in these reports.
64
+
- Remote peers may push balance to our node as part of the funding flow. This
65
+
amount is not currently included in these reports.
52
66
53
67
### Channel Close
54
68
Channel close entries represent the on chain close of a channel.
55
69
56
-
- Amount: The amount in millisatoshis that was paid out to us immediately on channel close.
57
-
- TxID: The on chain transaction ID for the channel close.
70
+
- Amount: The amount in millisatoshis that was paid out to us immediately on
71
+
channel close.
72
+
- TXID: The on chain transaction ID for the channel close.
58
73
- Reference: The channel close transaction ID.
59
74
- Note: A note indicating the type of channel close, and who initiated it.
60
75
61
76
Known Omissions:
62
-
- If our balance is encumbered behind a timelock, or in an unresolved htlc, it will not be paid out as part of this transaction and must be resolved by follow up on chain transactions.
77
+
- If our balance is encumbered behind a timelock, or in an unresolved HTLC, it
78
+
will not be paid out as part of this transaction and must be resolved by
79
+
follow up on chain transactions.
63
80
64
81
### Channel Close Fee
65
-
Channel close fee entries represent the fees we paid on chain to close channels that we initiated. Note that this includes the case where we opened the channel but the remote party closed the channel.
82
+
Channel close fee entries represent the fees we paid on chain to close channels
83
+
that we initiated. Note that this includes the case where we opened the channel
84
+
but the remote party closed the channel.
66
85
67
-
- Amount: The amount in millisatoshis that we paid in on chain fees to close the channel.
68
-
- TxID: The on chain transaction ID for the channel close.
86
+
- Amount: The amount in millisatoshis that we paid in on chain fees to close the
87
+
channel.
88
+
- TXID: The on chain transaction ID for the channel close.
69
89
- Reference: The channel close transaction ID:-1.
70
90
- Note: Not set for close fees.
71
91
72
92
Known Omissions:
73
-
- If a channel was closed before we started saving our channel information for use after close (<lnd 0.9), we will not know which party opened the channel, so fees may be omitted.
93
+
- If a channel was closed before we started saving our channel information for
94
+
use after close (<lnd 0.9), we will not know which party opened the channel,
95
+
so fees may be omitted.
74
96
75
97
### Receipt
76
-
A receipt is an on chain transaction which paid to our wallet which was not related to the opening/closing of channels.
98
+
A receipt is an on chain transaction which paid to our wallet which was not
99
+
related to the opening/closing of channels.
77
100
78
-
- Amount: The amount in millisatoshis that was paid to an address controlled by our wallet.
79
-
- TxID: The on chain transaction ID.
101
+
- Amount: The amount in millisatoshis that was paid to an address controlled by
102
+
our wallet.
103
+
- TXID: The on chain transaction ID.
80
104
- Reference: The on chain transaction ID.
81
-
- Note: An optional label set on transaction publish (see [lnd transaction labels](https://github.com/lightningnetwork/lnd/blob/master/lnrpc/walletrpc/walletkit.proto#L136)).
105
+
- Note: An optional label set on transaction publish (see
106
+
[lnd transaction labels][1]).
82
107
83
108
Known Omissions:
84
-
- This entry type will include on chain resolutions for channel closes that sweep balances back to our node.
109
+
- This entry type will include on chain resolutions for channel closes that
110
+
sweep balances back to our node.
85
111
86
112
### Payment
87
-
A payment is an on chain transaction which was paid from our wallet and was not related to the opening/closing of channels.
88
-
- Amount: The amount in millisatoshis that was paid from an address controlled by our wallet.
89
-
- TxID: The on chain transaction ID.
113
+
A payment is an on chain transaction which was paid from our wallet and was not
114
+
related to the opening/closing of channels.
115
+
- Amount: The amount in millisatoshis that was paid from an address controlled
116
+
by our wallet.
117
+
- TXID: The on chain transaction ID.
90
118
- Reference: The on chain transaction ID.
91
-
- Note: An optional label set on transaction publish (see [lnd transaction labels](https://github.com/lightningnetwork/lnd/blob/master/lnrpc/walletrpc/walletkit.proto#L136)).
119
+
- Note: An optional label set on transaction publish (see
120
+
[lnd transaction labels][1]).
92
121
93
122
Known Omissions:
94
-
- This entry type will include the on chain resolution of htlcs when we force close on our peers and have to settle or fail them on chain.
95
-
- The current accounting package does not support accounting for payments with duplicate payment hashes, which were allowed in previous versions of lnd. Duplicate payments should be deleted or a time range that does not include them should be specified.
96
-
- Legacy payments that were made in older versions of lnd that were created without a payment request will not have any information stored about their destination. We therefore cannot identify whether these are circular payments (they will be identified as regular payments). A warning will be logged when we encounter this type of payment.
123
+
- This entry type will include the on chain resolution of HTLCs when we force
124
+
close on our peers and have to settle or fail them on chain.
125
+
- The current accounting package does not support accounting for payments with
126
+
duplicate payment hashes, which were allowed in previous versions of lnd.
127
+
Duplicate payments should be deleted or a time range that does not include
128
+
them should be specified.
129
+
- Legacy payments that were made in older versions of lnd that were created
130
+
without a payment request will not have any information stored about their
131
+
destination. We therefore cannot identify whether these are circular payments
132
+
(they will be identified as regular payments). A warning will be logged when
133
+
we encounter this type of payment.
97
134
98
135
### Fee
99
136
A fee entry represents the on chain fees we paid for a transaction.
100
137
101
138
- Amount: The amount in millisatoshis that was paid in fees from our wallet.
102
-
-TxID: The on chain transaction ID.
139
+
-TXID: The on chain transaction ID.
103
140
- Reference: TransactionID:-1.
104
141
- Note: Note set for fees.
105
142
106
143
### Sweep
107
-
A sweep is an on chain transaction which is used to sweep our own funds back to our wallet. This is required when a channel is force closed and need to sweep time locked commitment outputs, htlcs or both.
144
+
A sweep is an on chain transaction which is used to sweep our own funds back to
145
+
our wallet. This is required when a channel is force closed and need to sweep
146
+
time locked commitment outputs, HTLCs or both.
108
147
109
-
-TxID: The on chain transaction ID.
148
+
-TXID: The on chain transaction ID.
110
149
- Reference: The on chain transaction ID.
111
-
- Note: An optional label set on transaction publish (see [lnd transaction labels](https://github.com/lightningnetwork/lnd/blob/master/lnrpc/walletrpc/walletkit.proto#L136)).
150
+
- Note: An optional label set on transaction publish (see
151
+
[lnd transaction labels][1]).
112
152
113
153
Known Omissions:
114
-
- Note that this entry type does not include the first stage success/timeout transactions that are required to resolve htlcs when we force close on our peer. We currently do not have the information required to identify these transactions available, so they are included in payments, see known omissions.
154
+
- Note that this entry type does not include the first stage success/timeout
155
+
transactions that are required to resolve HTLCs when we force close on our
156
+
peer. We currently do not have the information required to identify these
157
+
transactions available, so they are included in payments, see known omissions.
115
158
116
159
### Sweep Fee
117
160
A fee entry represents the on chain fees we paid for a sweep.
118
161
119
162
- Amount: The amount in millisatoshis that was paid in fees from our wallet.
120
-
-TxID: The on chain transaction ID.
163
+
-TXID: The on chain transaction ID.
121
164
- Reference: TransactionID:-1.
122
165
- Note: Not set for fees.
123
166
@@ -126,68 +169,85 @@ A fee entry represents the on chain fees we paid for a sweep.
126
169
### Receipt
127
170
Receipts off chain represent invoices that are paid via the Lightning Network.
128
171
129
-
- Amount: The amount in millisatoshis that we were paid, note that this may be greater than the original invoice value.
130
-
- TxID: The payment hash of the invoice.
172
+
- Amount: The amount in millisatoshis that we were paid, note that this may be
173
+
greater than the original invoice value.
174
+
- TXID: The payment hash of the invoice.
131
175
- Reference: The preimage of the invoice.
132
-
- Note: Optionally set if the invoice had a memo attached, was overpaid, or was a keysend.
176
+
- Note: Optionally set if the invoice had a memo attached, was overpaid, or was
177
+
a keysend.
133
178
134
179
### Circular Receipt
135
180
Circular receipts record instances where we have paid one of our own invoices.
136
181
137
-
- Amount: The amount in millisatoshis that we were paid, note that this may be greater than the original invoice value.
138
-
- TxID: The payment hash of the invoice.
182
+
- Amount: The amount in millisatoshis that we were paid, note that this may be
183
+
greater than the original invoice value.
184
+
- TXID: The payment hash of the invoice.
139
185
- Reference: The preimage of the invoice.
140
-
- Note: Optionally set if the invoice had a memo attached, was overpaid, or was a keysend.
186
+
- Note: Optionally set if the invoice had a memo attached, was overpaid, or was
187
+
a keysend.
141
188
142
189
### Payment
143
190
Payments off chain represent payments made via the Lightning Network.
144
191
145
-
- Amount: The amount in millisatoshis that we paid, excluding the off chain fees paid.
146
-
- TxID: The payment hash.
192
+
- Amount: The amount in millisatoshis that we paid, excluding the off chain fees
193
+
paid.
194
+
- TXID: The payment hash.
147
195
- Reference: Unique payment ID: Payment Preimage.
148
196
- Note: The node pubkey that the payment was made to.
149
197
150
198
### Fee
151
199
- Amount: The amount in millisatoshis that was paid in off chain fees.
- Note: The node pubkey that the payment was made to.
171
221
172
222
### Forwards
173
-
A forward represents a payment that arrives at our node on an incoming channel and is forwarded out on an outgoing channel in exchange for fees. The forward itself does not changes our balance, since it just shifts funds over our channels. We include forwarding entries with zero balances for completeness. Forwarding fee entries reflect the increase in our holdings from the fee we are paid.
174
-
175
-
- Amount: Zero, forwards do not change our balance except for fees, which are separated out.
- Note: The amounts that were forwarded in and out of our node.
179
235
180
236
Known Omissions:
181
-
- We use incoming and outgoing channel ID paired with timestamp as a best-effort version of a txid. Note that this is not strictly unique for a single htlc, it is theoretically possible for two htlcs to pass through the same channel with the same timestamp.
237
+
- We use incoming and outgoing channel ID paired with timestamp as a best-effort
238
+
version of a TXID. Note that this is not strictly unique for a single HTLC, it
239
+
is theoretically possible for two HTLCs to pass through the same channel with
240
+
the same timestamp.
182
241
183
242
### Forward Fee
184
243
Forward fee entries represent the fees we earned from forwarding payments.
185
244
186
245
- Amount: The amount in millisatoshis of fees we earned from the forward.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments