package
0.2.14-alpha
Repository: https://github.com/lightninglabs/faraday.git
Documentation: pkg.go.dev

# Functions

FeeReference returns a special unique reference for the fee paid on a transaction.
NewCustomCategory creates compiles the set of regexes provided and returning a new category.
NewOffChainConfig creates a config for creating off chain reports.
NewOnChainConfig returns an on chain config from the lnd services provided.
OffChainReport gets a report of off chain activity using live price data.
OnChainReport produces a report of our on chain activity for a period using live price data.
UseLogger uses a specified Logger to output package logging info.

# Constants

EntryTypeChannelClose represents a channel closing transaction.
EntryTypeChannelCloseFee represents fees our node paid to close a channel.
EntryTypeChannelOpenFee records the fees we paid on chain when opening a channel to a remote peer.
EntryTypeCircularPayment represents an operational payment which we pay to ourselves to rebalance channels.
EntryTypeCircularPaymentFee represents a the fees paid on an operational payment paid to ourselves to rebalance channels.
EntryTypeCircularReceipt represents an invoice that we paid to ourselves.
EntryTypeFee represent fees paid for on chain transactions or off chain routing.
EntryTypeForward represents a forward through our node.
EntryTypeForwardFee represents the fees we earned forwarding a payment.
EntryTypeLocalChannelOpen represents the funding transaction we created to open a channel to a remote peer.
EntryTypePayment indicates that we have made a payment.
EntryTypeReceipt indicates that we have received a payment.
EntryTypeRemoteChannelOpen represents the funding transaction that our peer created to open a channel to us.
EntryTypeSweep represents an on chain payment which swept funds back to our own wallet.
EntryTypeSweepFee represents the fees that were paid to sweep funds back to our own wallet.
Subsystem defines the logging code for this subsystem.

# Variables

ErrReceiveWithFee is returned if we get an on chain receive with a fee, which we do not expect.

# Structs

CommonConfig contains the items that are common to both types of requests.
CustomCategory describes a custom category which can be used to identify special case groups of transactions.
HarmonyEntry represents a single action on our balance.
OffChainConfig contains all the functionality required to produce an off chain report.
OnChainConfig contains all the functionality required to produce an on chain report.

# Type aliases

EntryType indicates the lightning specific type of an entry.
Report contains a set of entries.