README
¶
faraday
Faraday is an external service intended to be run in conjunction with the lnd implementation of the Lightning Network. It queries LND for information about its existing channels and provides channel close recommendations if channels are under-performing.
Installation
A Makefile is provided. To install faraday and all its dependencies, run:
go get -d github.com/lightninglabs/faraday
cd $GOPATH/src/github.com/lightninglabs/faraday
make && make install
Tests
To run all the unit tests in the repo, use:
make check
Usage
Faraday connects to a single instance of lnd. It requires access to a macaroon with read permissions and a valid TLS certificate. It will attempt to use the default lnd values if no command line flags are specified.
./faraday \
--macaroondir={directory containing macaroon} \
--macaroonfile={macaroon with read permissions} \
--tlscertpath={path to lnd cert} \
--rpserver={host:port of lnd's rpserver}
By default, faraday runs on mainnet. The --testnet, --simnet or --regtest flags can be used to run in test environments.
RPCServer
Faraday serves requests over grpc by default on localhost:8465. This default can be overwritten:
--rpclisten={host:port to listen for requests}
Cli Tool
The RPC server can be conveniently accessed using a command line tool.
- Run faraday as detailed above
./frcli {command}
insights: expose metrics gathered for one or many channels.revenue: generate a revenue report over a time period for one or many channels.outliers: close recommendations based whether channels are outliers based on a variety of metrics.threshold: close recommendations based on thresholds a variety of metrics.
Metrics currently tracked
The following metrics are tracked in faraday and exposed via insights and used for outliers and threshold close recommendations.
- Uptime
- Revenue
- Total Volume
- Incoming Volume
- Outgoing Volume
Documentation
¶
Overview ¶
Package faraday contains the main function for faraday.
Index ¶
Constants ¶
const Subsystem = "FRDY"
Subsystem defines the logging code for this subsystem.
Variables ¶
var Commit string
Commit stores the current commit hash of this build, this should be set using the -ldflags during compilation.
Functions ¶
func Main ¶
func Main() error
Main is the real entry point for faraday. It is required to ensure that defers are properly executed when os.Exit() is called.
func UseLogger ¶
UseLogger uses a specified Logger to output package logging info. This should be used in preference to SetLogWriter if the caller is also using btclog.
func Version ¶
func Version() string
Version returns the application version as a properly formed string per the semantic versioning 2.0.0 spec (http://semver.org/).
Types ¶
type Config ¶
type Config struct {
// RPCServer is host:port that lnd's RPC server is listening on.
RPCServer string `long:"rpcserver" description:"host:port that LND is listening for RPC connections on"`
// MacaroonDir is the directory containing macaroons.
MacaroonDir string `long:"macaroondir" description:"Dir containing macaroons"`
// MacaroonFile is the file name of the macaroon to use.
MacaroonFile string `long:"macaroonfile" description:"Macaroon file to use."`
// TLSCertPath is the path to the tls cert that faraday should use.
TLSCertPath string `long:"tlscertpath" description:"Path to TLS cert"`
// TestNet is set to true when running on testnet.
TestNet bool `long:"testnet" description:"Use the testnet network"`
// Simnet is set to true when using btcd's simnet.
Simnet bool `long:"simnet" description:"Use simnet"`
// Simnet is set to true when using bitcoind's regtest.
Regtest bool `long:"regtest" description:"Use regtest"`
// MinimumMonitored is the minimum amount of time that a channel must be monitored for before we consider it for termination.
MinimumMonitored time.Duration `` /* 163-byte string literal not displayed */
// DebugLevel is a string defining the log level for the service either
// for all subsystems the same or individual level by subsystem.
DebugLevel string `long:"debuglevel" description:"Debug level for faraday and its subsystems."`
// RPCListen is the listen address for the faraday rpc server.
RPCListen string `long:"rpclisten" description:"Address to listen on for gRPC clients."`
// RESTListen is the listen address for the faraday REST server.
RESTListen string `long:"restlisten" description:"Address to listen on for REST clients. If not specified, no REST listener will be started."`
// CORSOrigin specifies the CORS header that should be set on REST responses. No header is added if the value is empty.
CORSOrigin string `long:"corsorigin" description:"The value to send in the Access-Control-Allow-Origin header. Header will be omitted if empty."`
// contains filtered or unexported fields
}
func DefaultConfig ¶
func DefaultConfig() Config
DefaultConfig returns all default values for the Config struct.
func LoadConfig ¶
LoadConfig starts with a skeleton default config, and reads in user provided configuration from the command line. It does not provide a full set of defaults or validate user input because validation and sensible default setting are performed by the lndclient package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
faraday
command
|
|
|
frcli
command
|
|
|
Package dataset provides a basic dataset type which provides functionality for detecting inter-quartile range outliers.
|
Package dataset provides a basic dataset type which provides functionality for detecting inter-quartile range outliers. |
|
Package frdrpc is a reverse proxy.
|
Package frdrpc is a reverse proxy. |
|
Package recommend provides recommendations for closing channels with the constraints provided in its close recommendation config.
|
Package recommend provides recommendations for closing channels with the constraints provided in its close recommendation config. |