diff --git a/docs/accounting.md b/docs/accounting.md index cfbad51..0e083ab 100644 --- a/docs/accounting.md +++ b/docs/accounting.md @@ -1,19 +1,30 @@ # Accounting Reports Faraday produces accounting reports on a node's on chain and off chain activity. -These reports are formatted using the [Harmony Reporting Standard](https://github.com/harmony-csv/harmony). +These reports are formatted using the [Harmony Reporting +Standard](https://github.com/harmony-csv/harmony). This document provides a description of the entries in these reports. ## Bitcoin Backend -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. +It is strongly recommended that Faraday is run with a connection to a Bitcoin +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. ## Common Fields -For brevity, the following fields which have the same meaning for each entry will be omitted: -- Timestamp: The timestamp of the block that the channel open transaction appeared in. -- Fiat: The value of the amount field in specified currency. Note that values less than one satoshi will be rounded down to zero. +For brevity, the following fields which have the same meaning for each entry +will be omitted: +- Timestamp: The timestamp of the block that the channel open transaction + appeared in. +- Fiat: The value of the amount field in specified currency. Note that values + less than one satoshi will be rounded down to zero. - OnChain: Whether the transaction occurred off chain, or on chain. -- Credit: True when an entry increased our balances, false when an entry decreased our balances. +- Credit: True when an entry increased our balances, false when an entry + decreased our balances. -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`. +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`. ## On Chain Reports @@ -22,8 +33,9 @@ Local channel open entry types represent channel opens that were initiated by our node. These entries are accompanied by a separate Channel Open Fees entry, because the opening party pays on chain fees. -- Amount: The amount in millisatoshis that we added to the channel, excluding on chain fees. -- TxID: The on chain transaction ID for the channel open. +- Amount: The amount in millisatoshis that we added to the channel, excluding on + chain fees. +- TXID: The on chain transaction ID for the channel open. - Reference: The unique channel ID assigned to the channel. - Note: A note with details of who opened the channel. @@ -42,82 +54,113 @@ The fees paid to open a channel that we initiated. Remote channel open entry types represent channels that were opened by remote peers. -- Amount: Zero, our balance is unaffected by remote channel creation, with the exception of a push amount listed below. -- TxID: The on chain transaction ID for the channel open. +- Amount: Zero, our balance is unaffected by remote channel creation, except for + a push amount listed below. +- TXID: The on chain transaction ID for the channel open. - Reference: The unique channel ID assigned to the channel. - Note: A note containing the pubkey of the peer that opened a channel to us. Known Omissions: -- Remote peers may push balance to our node as part of the funding flow. This amount is not currently included in these reports. +- Remote peers may push balance to our node as part of the funding flow. This + amount is not currently included in these reports. ### Channel Close Channel close entries represent the on chain close of a channel. -- Amount: The amount in millisatoshis that was paid out to us immediately on channel close. -- TxID: The on chain transaction ID for the channel close. +- Amount: The amount in millisatoshis that was paid out to us immediately on + channel close. +- TXID: The on chain transaction ID for the channel close. - Reference: The channel close transaction ID. - Note: A note indicating the type of channel close, and who initiated it. Known Omissions: -- 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. +- 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. ### Channel Close Fee -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. +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. -- Amount: The amount in millisatoshis that we paid in on chain fees to close the channel. -- TxID: The on chain transaction ID for the channel close. +- Amount: The amount in millisatoshis that we paid in on chain fees to close the + channel. +- TXID: The on chain transaction ID for the channel close. - Reference: The channel close transaction ID:-1. - Note: Not set for close fees. Known Omissions: -- If a channel was closed before we started saving our channel information for use after close (