package frdrpc
Get desktop application:
View/edit binary Protocol Buffers messages
service FaradayServer
faraday.proto:7* frcli: `outliers` Get close recommendations for currently open channels based on whether it is an outlier. Example request: http://localhost:8466/v1/faraday/outliers/REVENUE?rec_request.minimum_monitored=123
message
faraday.proto:97optional rec_request = 1
The parameters that are common to all close recommendations.
float outlier_multiplier = 2
The number of inter-quartile ranges a value needs to be beneath the lower quartile/ above the upper quartile to be considered a lower/upper outlier. Lower values will be more aggressive in recommending channel closes, and upper values will be more conservative. Recommended values are 1.5 for aggressive recommendations and 3 for conservative recommendations.
* frcli: `threshold` Get close recommendations for currently open channels based whether they are below a set threshold. Example request: http://localhost:8466/v1/faraday/threshold/UPTIME?rec_request.minimum_monitored=123
message
faraday.proto:113optional rec_request = 1
The parameters that are common to all close recommendations.
float threshold_value = 2
The threshold that recommendations will be calculated based on. For uptime: ratio of uptime to observed lifetime beneath which channels will be recommended for closure. For revenue: revenue per block that capital has been committed to the channel beneath which channels will be recommended for closure. This value is provided per block so that channels that have been open for different periods of time can be compared. For incoming volume: The incoming volume per block that capital has been committed to the channel beneath which channels will be recommended for closure. This value is provided per block so that channels that have been open for different periods of time can be compared. For outgoing volume: The outgoing volume per block that capital has been committed to the channel beneath which channels will be recommended for closure. This value is provided per block so that channels that have been open for different periods of time can be compared. For total volume: The total volume per block that capital has been committed to the channel beneath which channels will be recommended for closure. This value is provided per block so that channels that have been open for different periods of time can be compared.
rpc RevenueReport (, )
faraday.proto:34* frcli: `revenue` Get a pairwise revenue report for a channel. Example request: http://localhost:8466/v1/faraday/revenue
message
faraday.proto:182repeated string chan_points = 1
The funding transaction outpoints for the channels to generate a revenue report for. If this is empty, it will be generated for all open and closed channels. Channel funding points should be expressed with the format fundingTxID:outpoint.
uint64 start_time = 2
Start time is beginning of the range over which the report will be generated, expressed as unix epoch offset in seconds.
uint64 end_time = 3
End time is end of the range over which the report will be generated, expressed as unix epoch offset in seconds.
message
faraday.proto:204repeated reports = 1
Reports is a set of pairwise revenue report generated for the channel(s) over the period specified.
rpc ChannelInsights (, )
faraday.proto:42* frcli: `insights` List currently open channel with routing and uptime information. Example request: http://localhost:8466/v1/faraday/insights
message
faraday.proto:256(message has no fields)
message
faraday.proto:259repeated channel_insights = 1
Insights for the set of currently open channels.
rpc ExchangeRate (, )
faraday.proto:51* frcli: Get fiat prices for btc. Example request: http://localhost:8466/v1/faraday/exchangerate
message
faraday.proto:348repeated uint64 timestamps = 3
A set of timestamps for which we want the bitcoin price.
Granularity granularity = 4
The level of granularity at which we want the bitcoin price to be quoted.
FiatBackend fiat_backend = 5
The api to be used for fiat related queries.
repeated custom_prices = 8
Custom price points to use if the CUSTOM FiatBackend option is set.
message
faraday.proto:366repeated rates = 2
Rates contains a set of exchange rates for the set of timestamps
rpc NodeAudit (, )
faraday.proto:59* Get a report of your node's activity over a period. Example request: http://localhost:8466/v1/faraday/nodeaudit
message
faraday.proto:396uint64 start_time = 1
The unix time from which to produce the report, inclusive.
uint64 end_time = 2
The unix time until which to produce the report, exclusive.
bool disable_fiat = 4
Set to generate a report without conversion to fiat. If set, fiat values will display as 0.
Granularity granularity = 5
The level of granularity at which we wish to produce fiat prices.
repeated custom_categories = 6
An optional set of custom categories which can be used to identify bespoke categories in the report. Each category must have a unique name, and may not have common identifier regexes. Transactions that are matched to these categories report the category name in the CustomCategory field.
FiatBackend fiat_backend = 7
The api to be used for fiat related queries.
repeated custom_prices = 8
Custom price points to use if the CUSTOM FiatBackend option is set.
message
faraday.proto:556repeated reports = 1
On chain reports for the period queried.
rpc CloseReport (, )
faraday.proto:67* Get a channel close report for a specific channel. Example request: http://localhost:8466/v1/faraday/closereport
message
faraday.proto:561string channel_point = 1
The funding outpoint of the channel the report should be created for, formatted txid:outpoint.
message
faraday.proto:569string channel_point = 1
The funding outpoint of the channel.
bool channel_initiator = 2
True if we opened the channel, false if the remote peer did.
string close_type = 3
The type of close that resolved this channel.
string close_txid = 4
The transaction id of the close transaction that confirmed on chain.
string open_fee = 5
The fee we paid on chain to open this channel in satoshis, note that this field will be zero if the remote party paid.
string close_fee = 6
The fee we paid on chain for the close transaction in staoshis, note that this field will be zero if the remote party paid.
message
faraday.proto:373Used in: , , ,
string price = 1
The price of 1 BTC, expressed in USD.
uint64 price_timestamp = 2
The timestamp for this price price provided.
string currency = 3
The currency that the price is denoted in.
message
faraday.proto:264Used in:
string chan_point = 1
The outpoint of the channel's funding transaction.
uint64 monitored_seconds = 2
The amount of time in seconds that we have monitored the channel peer's uptime for.
uint64 uptime_seconds = 3
The amount of time in seconds that the channel peer has been online over the period it has been monitored for.
int64 volume_incoming_msat = 4
The volume, in millisatoshis, that has been forwarded with this channel as the incoming channel.
int64 volume_outgoing_msat = 5
The volume, in millisatoshis, that has been forwarded with this channel as the outgoing channel.
int64 fees_earned_msat = 6
The total fees earned by this channel for its participation in forwards, expressed in millisatoshis. Note that we attribute fees evenly across incoming and outgoing channels.
uint32 confirmations = 7
The number of confirmations the funding transaction has.
bool private = 8
True if the channel is private.
message
faraday.proto:70Used in: ,
int64 minimum_monitored = 1
The minimum amount of time in seconds that a channel should have been monitored by lnd to be eligible for close. This value is in place to protect against closing of newer channels.
CloseRecommendationRequest.Metric metric = 2
The data point base close recommendations on. Available options are: Uptime: ratio of channel peer's uptime to the period they have been monitored to. Revenue: the revenue that the channel has produced per block that its funding transaction has been confirmed for.
Used in:
UNKNOWN = 0
UPTIME = 1
REVENUE = 2
INCOMING_VOLUME = 3
OUTGOING_VOLUME = 4
TOTAL_VOLUME = 5
message
faraday.proto:147Used as response type in: FaradayServer.OutlierRecommendations, FaradayServer.ThresholdRecommendations
int32 total_channels = 1
The total number of channels, before filtering out channels that are not eligible for close recommendations.
int32 considered_channels = 2
The number of channels that were considered for close recommendations.
repeated recommendations = 3
A set of channel close recommendations. The absence of a channel in this set implies that it was not considered for close because it did not meet the criteria for close recommendations (it is private, or has not been monitored for long enough).
message
faraday.proto:429Used in:
string name = 1
The name for the custom category which will contain all transactions that are labelled with a string matching one of the regexes provided in label identifiers.
bool on_chain = 2
Set to true to apply this category to on chain transactions. Can be set in conjunction with off_chain to apply the category to all transactions.
bool off_chain = 3
Set to true to apply this category to off chain transactions. Can be set in conjunction with on_chain to apply the category to all transactions.
repeated string label_patterns = 5
A set of regular expressions which identify transactions by their label as belonging in this custom category. If a label matches any single regex in the set, it is considered to be in the category. These expressions will be matched against various labels that are present in lnd: on chain transactions will be matched against their label field, off chain receipts will be matched against their memo. At present, there is no way to match forwards or off chain payments. These expressions must be unique across custom categories, otherwise faraday will not be able to identify which custom category a transaction belongs in.
Used in:
UNKNOWN = 0
LOCAL_CHANNEL_OPEN = 1
A channel opening transaction for a channel opened by our node.
REMOTE_CHANNEL_OPEN = 2
A channel opening transaction for a channel opened by a remote node.
CHANNEL_OPEN_FEE = 3
The on chain fee paid to open a channel.
CHANNEL_CLOSE = 4
A channel closing transaction.
RECEIPT = 5
Receipt of funds. On chain this reflects receives, off chain settlement of invoices.
PAYMENT = 6
Payment of funds. On chain this reflects sends, off chain settlement of our payments.
FEE = 7
Payment of fees.
CIRCULAR_RECEIPT = 8
Receipt of a payment to ourselves.
FORWARD = 9
A forward through our node.
FORWARD_FEE = 10
Fees earned from forwarding.
CIRCULAR_PAYMENT = 11
Sending of a payment to ourselves.
CIRCULAR_FEE = 12
The fees paid to send an off chain payment to ourselves.
SWEEP = 13
A transaction that sweeps funds back into our wallet's control.
SWEEP_FEE = 14
The amount of fees paid for a sweep transaction.
CHANNEL_CLOSE_FEE = 15
The fees paid to close a channel.
message
faraday.proto:384Used in:
uint64 timestamp = 1
timestamp is the timestamp of the original request made.
optional btc_price = 2
Price is the bitcoin price approximation for the timestamp queried. Note that this value has its own timestamp because we are not guaranteed to get price points for the exact timestamp that was queried.
FiatBackend is the API endpoint to be used for any fiat related queries.
Used in: ,
UNKNOWN_FIATBACKEND = 0
COINCAP = 1
Use the CoinCap API for fiat price information. This API is reached through the following URL: https://api.coincap.io/v2/assets/bitcoin/history
COINDESK = 2
Use the CoinDesk API for fiat price information. This API is reached through the following URL: https://api.coindesk.com/v1/bpi/historical/close.json
CUSTOM = 3
Use custom price data provided in a CSV file for fiat price information.
COINGECKO = 4
Use the CoinGecko API for fiat price information. This API is reached through the following URL: https://api.coingecko.com/api/v3/coins/bitcoin/market_chart
Granularity describes the aggregation level at which the Bitcoin price should be queried. Note that setting lower levels of granularity may require more queries to the fiat backend.
Used in: ,
UNKNOWN_GRANULARITY = 0
MINUTE = 1
FIVE_MINUTES = 2
FIFTEEN_MINUTES = 3
THIRTY_MINUTES = 4
HOUR = 5
SIX_HOURS = 6
TWELVE_HOURS = 7
DAY = 8
message
faraday.proto:228Used in:
int64 amount_outgoing_msat = 1
Amount outgoing msat is the amount in millisatoshis that arrived on the pair channel to be forwarded onwards by our channel.
int64 fees_outgoing_msat = 2
Fees outgoing is the amount of fees in millisatoshis that we attribute to the channel for its role as the outgoing channel in forwards.
int64 amount_incoming_msat = 3
Amount incoming msat is the amount in millisatoshis that arrived on our channel to be forwarded onwards by the pair channel.
int64 fees_incoming_msat = 4
Fees incoming is the amount of fees in millisatoshis that we attribute to the channel for its role as the incoming channel in forwards.
message
faraday.proto:168Used in:
string chan_point = 1
The channel point [funding txid: outpoint] of the channel being considered for close.
float value = 2
The value of the metric that close recommendations were based on.
bool recommend_close = 3
A boolean indicating whether we recommend closing the channel.
message
faraday.proto:514Used in:
uint64 timestamp = 1
The unix timestamp of the event.
bool on_chain = 2
Whether the entry occurred on chain or off chain.
uint64 amount = 3
The amount of the entry, expressed in millisatoshis.
bool credit = 4
Whether the entry is a credit or a debit.
string asset = 5
The asset affected by the entry.
EntryType type = 6
The kind of activity that this entry represents.
string custom_category = 12
This field will be populated for entry type custom, and represents the name of a custom category that the report was produced with.
string txid = 7
The transaction id of the entry.
string fiat = 8
The fiat amount of the entry's amount in the currency specified in the btc_price field.
string reference = 9
A unique identifier for the entry, if available.
string note = 10
An additional note for the entry, providing additional context.
optional btc_price = 11
The bitcoin price and timestamp used to calculate our fiat value.
message
faraday.proto:212Used in:
string target_channel = 1
Target channel is the channel that the report is generated for; incoming fields in the report mean that this channel was the incoming channel, and the pair as the outgoing, outgoing fields mean that this channel was the outgoing channel and the peer was the incoming channel.
map<string, > pair_reports = 2
Pair reports maps the channel point of a peer that we generated revenue with to a report detailing the revenue.