lightningnetwork / lnd / 15280233992

// Copyright (c) 2013-2017 The btcsuite developers

// Copyright (c) 2015-2016 The Decred developers

// Copyright (C) 2015-2022 The Lightning Network Developers

package lnd

import (

        "encoding/hex"

        "errors"

        "fmt"

        "io"

        "net"

        "os"

        "os/user"

        "path/filepath"

        "reflect"

        "regexp"

        "strconv"

        "strings"

        "time"

        "github.com/btcsuite/btcd/btcutil"

        "github.com/btcsuite/btcd/chaincfg"

        flags "github.com/jessevdk/go-flags"

        "github.com/lightninglabs/neutrino"

        "github.com/lightningnetwork/lnd/autopilot"

        "github.com/lightningnetwork/lnd/build"

        "github.com/lightningnetwork/lnd/chainreg"

        "github.com/lightningnetwork/lnd/chanbackup"

        "github.com/lightningnetwork/lnd/channeldb"

        "github.com/lightningnetwork/lnd/discovery"

        "github.com/lightningnetwork/lnd/funding"

        "github.com/lightningnetwork/lnd/htlcswitch"

        "github.com/lightningnetwork/lnd/htlcswitch/hodl"

        "github.com/lightningnetwork/lnd/input"

        "github.com/lightningnetwork/lnd/lncfg"

        "github.com/lightningnetwork/lnd/lnrpc"

        "github.com/lightningnetwork/lnd/lnrpc/peersrpc"

        "github.com/lightningnetwork/lnd/lnrpc/routerrpc"

        "github.com/lightningnetwork/lnd/lnrpc/signrpc"

        "github.com/lightningnetwork/lnd/lnutils"

        "github.com/lightningnetwork/lnd/lnwallet"

        "github.com/lightningnetwork/lnd/lnwire"

        "github.com/lightningnetwork/lnd/routing"

        "github.com/lightningnetwork/lnd/signal"

        "github.com/lightningnetwork/lnd/tor"

)

const (

        defaultDataDirname        = "data"

        defaultChainSubDirname    = "chain"

        defaultGraphSubDirname    = "graph"

        defaultTowerSubDirname    = "watchtower"

        defaultTLSCertFilename    = "tls.cert"

        defaultTLSKeyFilename     = "tls.key"

        defaultAdminMacFilename   = "admin.macaroon"

        defaultReadMacFilename    = "readonly.macaroon"

        defaultInvoiceMacFilename = "invoice.macaroon"

        defaultLogLevel           = "info"

        defaultLogDirname         = "logs"

        defaultLogFilename        = "lnd.log"

        defaultRPCPort            = 10009

        defaultRESTPort           = 8080

        defaultPeerPort           = 9735

        defaultRPCHost            = "localhost"

        defaultNoSeedBackup                  = false

        defaultPaymentsExpirationGracePeriod = time.Duration(0)

        defaultTrickleDelay                  = 90 * 1000

        defaultChanStatusSampleInterval      = time.Minute

        defaultChanEnableTimeout             = 19 * time.Minute

        defaultChanDisableTimeout            = 20 * time.Minute

        defaultHeightHintCacheQueryDisable   = false

        defaultMinBackoff                    = time.Second

        defaultMaxBackoff                    = time.Hour

        defaultLetsEncryptDirname            = "letsencrypt"

        defaultLetsEncryptListen             = ":80"

        defaultTorSOCKSPort            = 9050

        defaultTorDNSHost              = "soa.nodes.lightning.directory"

        defaultTorDNSPort              = 53

        defaultTorControlPort          = 9051

        defaultTorV2PrivateKeyFilename = "v2_onion_private_key"

        defaultTorV3PrivateKeyFilename = "v3_onion_private_key"

        // defaultZMQReadDeadline is the default read deadline to be used for

        // both the block and tx ZMQ subscriptions.

        defaultZMQReadDeadline = 5 * time.Second

        // DefaultAutogenValidity is the default validity of a self-signed

        // certificate. The value corresponds to 14 months

        // (14 months * 30 days * 24 hours).

        defaultTLSCertDuration = 14 * 30 * 24 * time.Hour

        // minTimeLockDelta is the minimum timelock we require for incoming

        // HTLCs on our channels.

        minTimeLockDelta = routing.MinCLTVDelta

        // MaxTimeLockDelta is the maximum CLTV delta that can be applied to

        // forwarded HTLCs.

        MaxTimeLockDelta = routing.MaxCLTVDelta

        // defaultAcceptorTimeout is the time after which an RPCAcceptor will time

        // out and return false if it hasn't yet received a response.

        defaultAcceptorTimeout = 15 * time.Second

        defaultAlias = ""

        defaultColor = "#3399FF"

        // defaultCoopCloseTargetConfs is the default confirmation target

        // that will be used to estimate a fee rate to use during a

        // cooperative channel closure initiated by a remote peer. By default

        // we'll set this to a lax value since we weren't the ones that

        // initiated the channel closure.

        defaultCoopCloseTargetConfs = 6

        // defaultBlockCacheSize is the size (in bytes) of blocks that will be

        // keep in memory if no size is specified.

        defaultBlockCacheSize uint64 = 20 * 1024 * 1024 // 20 MB

        // defaultHostSampleInterval is the default amount of time that the

        // HostAnnouncer will wait between DNS resolutions to check if the

        // backing IP of a host has changed.

        defaultHostSampleInterval = time.Minute * 5

        defaultChainInterval = time.Minute

        defaultChainTimeout  = time.Second * 30

        defaultChainBackoff  = time.Minute * 2

        defaultChainAttempts = 3

        // Set defaults for a health check which ensures that we have space

        // available on disk. Although this check is off by default so that we

        // avoid breaking any existing setups (particularly on mobile), we still

        // set the other default values so that the health check can be easily

        // enabled with sane defaults.

        defaultRequiredDisk = 0.1

        defaultDiskInterval = time.Hour * 12

        defaultDiskTimeout  = time.Second * 5

        defaultDiskBackoff  = time.Minute

        defaultDiskAttempts = 0

        // Set defaults for a health check which ensures that the TLS certificate

        // is not expired. Although this check is off by default (not all setups

        // require it), we still set the other default values so that the health

        // check can be easily enabled with sane defaults.

        defaultTLSInterval = time.Minute

        defaultTLSTimeout  = time.Second * 5

        defaultTLSBackoff  = time.Minute

        defaultTLSAttempts = 0

        // Set defaults for a health check which ensures that the tor

        // connection is alive. Although this check is off by default (not all

        // setups require it), we still set the other default values so that

        // the health check can be easily enabled with sane defaults.

        defaultTCInterval = time.Minute

        defaultTCTimeout  = time.Second * 5

        defaultTCBackoff  = time.Minute

        defaultTCAttempts = 0

        // Set defaults for a health check which ensures that the remote signer

        // RPC connection is alive. Although this check is off by default (only

        // active when remote signing is turned on), we still set the other

        // default values so that the health check can be easily enabled with

        // sane defaults.

        defaultRSInterval = time.Minute

        defaultRSTimeout  = time.Second * 1

        defaultRSBackoff  = time.Second * 30

        defaultRSAttempts = 1

        // Set defaults for a health check which ensures that the leader

        // election is functioning correctly. Although this check is off by

        // default (as etcd leader election is only used in a clustered setup),

        // we still set the default values so that the health check can be

        // easily enabled with sane defaults. Note that by default we only run

        // this check once, as it is critical for the node's operation.

        defaultLeaderCheckInterval = time.Minute

        defaultLeaderCheckTimeout  = time.Second * 5

        defaultLeaderCheckBackoff  = time.Second * 5

        defaultLeaderCheckAttempts = 1

        // defaultRemoteMaxHtlcs specifies the default limit for maximum

        // concurrent HTLCs the remote party may add to commitment transactions.

        // This value can be overridden with --default-remote-max-htlcs.

        defaultRemoteMaxHtlcs = 483

        // defaultMaxLocalCSVDelay is the maximum delay we accept on our

        // commitment output. The local csv delay maximum is now equal to

        // the remote csv delay maximum we require for the remote commitment

        // transaction.

        defaultMaxLocalCSVDelay = 2016

        // defaultChannelCommitInterval is the default maximum time between

        // receiving a channel state update and signing a new commitment.

        defaultChannelCommitInterval = 50 * time.Millisecond

        // maxChannelCommitInterval is the maximum time the commit interval can

        // be configured to.

        maxChannelCommitInterval = time.Hour

        // defaultPendingCommitInterval specifies the default timeout value

        // while waiting for the remote party to revoke a locally initiated

        // commitment state.

        defaultPendingCommitInterval = 1 * time.Minute

        // maxPendingCommitInterval specifies the max allowed duration when

        // waiting for the remote party to revoke a locally initiated

        // commitment state.

        maxPendingCommitInterval = 5 * time.Minute

        // defaultChannelCommitBatchSize is the default maximum number of

        // channel state updates that is accumulated before signing a new

        // commitment.

        defaultChannelCommitBatchSize = 10

        // defaultCoinSelectionStrategy is the coin selection strategy that is

        // used by default to fund transactions.

        defaultCoinSelectionStrategy = "largest"

        // defaultKeepFailedPaymentAttempts is the default setting for whether

        // to keep failed payments in the database.

        defaultKeepFailedPaymentAttempts = false

        // defaultGrpcServerPingTime is the default duration for the amount of

        // time of no activity after which the server pings the client to see if

        // the transport is still alive. If set below 1s, a minimum value of 1s

        // will be used instead.

        defaultGrpcServerPingTime = time.Minute

        // defaultGrpcServerPingTimeout is the default duration the server waits

        // after having pinged for keepalive check, and if no activity is seen

        // even after that the connection is closed.

        defaultGrpcServerPingTimeout = 20 * time.Second

        // defaultGrpcClientPingMinWait is the default minimum amount of time a

        // client should wait before sending a keepalive ping.

        defaultGrpcClientPingMinWait = 5 * time.Second

        // defaultHTTPHeaderTimeout is the default timeout for HTTP requests.

        DefaultHTTPHeaderTimeout = 5 * time.Second

        // DefaultNumRestrictedSlots is the default number of restricted slots

        // we'll allocate in the server.

        DefaultNumRestrictedSlots = 30

        // BitcoinChainName is a string that represents the Bitcoin blockchain.

        BitcoinChainName = "bitcoin"

        bitcoindBackendName = "bitcoind"

        btcdBackendName     = "btcd"

        neutrinoBackendName = "neutrino"

        defaultPrunedNodeMaxPeers = 4

        defaultNeutrinoMaxPeers   = 8

        // defaultNoDisconnectOnPongFailure is the default value for whether we

        // should *not* disconnect from a peer if we don't receive a pong

        // response in time after we send a ping.

        defaultNoDisconnectOnPongFailure = false

)

var (

        // DefaultLndDir is the default directory where lnd tries to find its

        // configuration file and store its data. This is a directory in the

        // user's application data, for example:

        //   C:\Users\<username>\AppData\Local\Lnd on Windows

        //   ~/.lnd on Linux

        //   ~/Library/Application Support/Lnd on MacOS

        DefaultLndDir = btcutil.AppDataDir("lnd", false)

        // DefaultConfigFile is the default full path of lnd's configuration

        // file.

        DefaultConfigFile = filepath.Join(DefaultLndDir, lncfg.DefaultConfigFilename)

        defaultDataDir = filepath.Join(DefaultLndDir, defaultDataDirname)

        defaultLogDir  = filepath.Join(DefaultLndDir, defaultLogDirname)

        defaultTowerDir = filepath.Join(defaultDataDir, defaultTowerSubDirname)

        defaultTLSCertPath    = filepath.Join(DefaultLndDir, defaultTLSCertFilename)

        defaultTLSKeyPath     = filepath.Join(DefaultLndDir, defaultTLSKeyFilename)

        defaultLetsEncryptDir = filepath.Join(DefaultLndDir, defaultLetsEncryptDirname)

        defaultBtcdDir         = btcutil.AppDataDir(btcdBackendName, false)

        defaultBtcdRPCCertFile = filepath.Join(defaultBtcdDir, "rpc.cert")

        defaultBitcoindDir = btcutil.AppDataDir(BitcoinChainName, false)

        defaultTorSOCKS   = net.JoinHostPort("localhost", strconv.Itoa(defaultTorSOCKSPort))

        defaultTorDNS     = net.JoinHostPort(defaultTorDNSHost, strconv.Itoa(defaultTorDNSPort))

        defaultTorControl = net.JoinHostPort("localhost", strconv.Itoa(defaultTorControlPort))

        // bitcoindEsimateModes defines all the legal values for bitcoind's

        // estimatesmartfee RPC call.

        defaultBitcoindEstimateMode = "CONSERVATIVE"

        bitcoindEstimateModes       = [2]string{"ECONOMICAL", defaultBitcoindEstimateMode}

)

// Config defines the configuration options for lnd.

//

// See LoadConfig for further details regarding the configuration

// loading+parsing process.

//

//nolint:ll

type Config struct {

        ShowVersion bool `short:"V" long:"version" description:"Display version information and exit"`

        LndDir       string `long:"lnddir" description:"The base directory that contains lnd's data, logs, configuration file, etc. This option overwrites all other directory options."`

        ConfigFile   string `short:"C" long:"configfile" description:"Path to configuration file"`

        DataDir      string `short:"b" long:"datadir" description:"The directory to store lnd's data within"`

        SyncFreelist bool   `long:"sync-freelist" description:"Whether the databases used within lnd should sync their freelist to disk. This is disabled by default resulting in improved memory performance during operation, but with an increase in startup time."`

        TLSCertPath        string        `long:"tlscertpath" description:"Path to write the TLS certificate for lnd's RPC and REST services"`

        TLSKeyPath         string        `long:"tlskeypath" description:"Path to write the TLS private key for lnd's RPC and REST services"`

        TLSExtraIPs        []string      `long:"tlsextraip" description:"Adds an extra ip to the generated certificate"`

        TLSExtraDomains    []string      `long:"tlsextradomain" description:"Adds an extra domain to the generated certificate"`

        TLSAutoRefresh     bool          `long:"tlsautorefresh" description:"Re-generate TLS certificate and key if the IPs or domains are changed"`

        TLSDisableAutofill bool          `long:"tlsdisableautofill" description:"Do not include the interface IPs or the system hostname in TLS certificate, use first --tlsextradomain as Common Name instead, if set"`

        TLSCertDuration    time.Duration `long:"tlscertduration" description:"The duration for which the auto-generated TLS certificate will be valid for"`

        TLSEncryptKey      bool          `long:"tlsencryptkey" description:"Automatically encrypts the TLS private key and generates ephemeral TLS key pairs when the wallet is locked or not initialized"`

        NoMacaroons     bool          `long:"no-macaroons" description:"Disable macaroon authentication, can only be used if server is not listening on a public interface."`

        AdminMacPath    string        `long:"adminmacaroonpath" description:"Path to write the admin macaroon for lnd's RPC and REST services if it doesn't exist"`

        ReadMacPath     string        `long:"readonlymacaroonpath" description:"Path to write the read-only macaroon for lnd's RPC and REST services if it doesn't exist"`

        InvoiceMacPath  string        `long:"invoicemacaroonpath" description:"Path to the invoice-only macaroon for lnd's RPC and REST services if it doesn't exist"`

        LogDir          string        `long:"logdir" description:"Directory to log output."`

        MaxLogFiles     int           `long:"maxlogfiles" description:"Maximum logfiles to keep (0 for no rotation). DEPRECATED: use --logging.file.max-files instead" hidden:"true"`

        MaxLogFileSize  int           `long:"maxlogfilesize" description:"Maximum logfile size in MB. DEPRECATED: use --logging.file.max-file-size instead" hidden:"true"`

        AcceptorTimeout time.Duration `long:"acceptortimeout" description:"Time after which an RPCAcceptor will time out and return false if it hasn't yet received a response"`

        LetsEncryptDir    string `long:"letsencryptdir" description:"The directory to store Let's Encrypt certificates within"`

        LetsEncryptListen string `long:"letsencryptlisten" description:"The IP:port on which lnd will listen for Let's Encrypt challenges. Let's Encrypt will always try to contact on port 80. Often non-root processes are not allowed to bind to ports lower than 1024. This configuration option allows a different port to be used, but must be used in combination with port forwarding from port 80. This configuration can also be used to specify another IP address to listen on, for example an IPv6 address."`

        LetsEncryptDomain string `long:"letsencryptdomain" description:"Request a Let's Encrypt certificate for this domain. Note that the certificate is only requested and stored when the first rpc connection comes in."`

        // We'll parse these 'raw' string arguments into real net.Addrs in the

        // loadConfig function. We need to expose the 'raw' strings so the

        // command line library can access them.

        // Only the parsed net.Addrs should be used!

        RawRPCListeners       []string `long:"rpclisten" description:"Add an interface/port/socket to listen for RPC connections"`

        RawRESTListeners      []string `long:"restlisten" description:"Add an interface/port/socket to listen for REST connections"`

        RawListeners          []string `long:"listen" description:"Add an interface/port to listen for peer connections"`

        RawExternalIPs        []string `long:"externalip" description:"Add an ip:port to the list of local addresses we claim to listen on to peers. If a port is not specified, the default (9735) will be used regardless of other parameters"`

        RawExternalDNSAddress string   `long:"external-dns-address" description:"Specify a DNS hostname for the node's external address. If no port is provided, the default (9735) is used."`

        ExternalHosts         []string `long:"externalhosts" description:"Add a hostname:port that should be periodically resolved to announce IPs for. If a port is not specified, the default (9735) will be used."`

        RPCListeners          []net.Addr

        RESTListeners         []net.Addr

        RestCORS              []string `long:"restcors" description:"Add an ip:port/hostname to allow cross origin access from. To allow all origins, set as \"*\"."`

        Listeners             []net.Addr

        ExternalIPs           []net.Addr

        ExternalDNSAddress    *lnwire.DNSAddr

        DisableListen         bool          `long:"nolisten" description:"Disable listening for incoming peer connections"`

        DisableRest           bool          `long:"norest" description:"Disable REST API"`

        DisableRestTLS        bool          `long:"no-rest-tls" description:"Disable TLS for REST connections"`

        WSPingInterval        time.Duration `long:"ws-ping-interval" description:"The ping interval for REST based WebSocket connections, set to 0 to disable sending ping messages from the server side"`

        WSPongWait            time.Duration `long:"ws-pong-wait" description:"The time we wait for a pong response message on REST based WebSocket connections before the connection is closed as inactive"`

        NAT                   bool          `long:"nat" description:"Toggle NAT traversal support (using either UPnP or NAT-PMP) to automatically advertise your external IP address to the network -- NOTE this does not support devices behind multiple NATs"`

        AddPeers              []string      `long:"addpeer" description:"Specify peers to connect to first"`

        MinBackoff            time.Duration `long:"minbackoff" description:"Shortest backoff when reconnecting to persistent peers. Valid time units are {s, m, h}."`

        MaxBackoff            time.Duration `long:"maxbackoff" description:"Longest backoff when reconnecting to persistent peers. Valid time units are {s, m, h}."`

        ConnectionTimeout     time.Duration `long:"connectiontimeout" description:"The timeout value for network connections. Valid time units are {ms, s, m, h}."`

        DebugLevel string `short:"d" long:"debuglevel" description:"Logging level for all subsystems {trace, debug, info, warn, error, critical} -- You may also specify <global-level>,<subsystem>=<level>,<subsystem2>=<level>,... to set the log level for individual subsystems -- Use show to list available subsystems"`

        CPUProfile      string `long:"cpuprofile" description:"DEPRECATED: Use 'pprof.cpuprofile' option. Write CPU profile to the specified file" hidden:"true"`

        Profile         string `long:"profile" description:"DEPRECATED: Use 'pprof.profile' option. Enable HTTP profiling on either a port or host:port" hidden:"true"`

        BlockingProfile int    `long:"blockingprofile" description:"DEPRECATED: Use 'pprof.blockingprofile' option. Used to enable a blocking profile to be served on the profiling port. This takes a value from 0 to 1, with 1 including every blocking event, and 0 including no events." hidden:"true"`

        MutexProfile    int    `long:"mutexprofile" description:"DEPRECATED: Use 'pprof.mutexprofile' option. Used to Enable a mutex profile to be served on the profiling port. This takes a value from 0 to 1, with 1 including every mutex event, and 0 including no events." hidden:"true"`

        Pprof *lncfg.Pprof `group:"Pprof" namespace:"pprof"`

        UnsafeDisconnect   bool   `long:"unsafe-disconnect" description:"DEPRECATED: Allows the rpcserver to intentionally disconnect from peers with open channels. THIS FLAG WILL BE REMOVED IN 0.10.0" hidden:"true"`

        UnsafeReplay       bool   `long:"unsafe-replay" description:"Causes a link to replay the adds on its commitment txn after starting up, this enables testing of the sphinx replay logic."`

        MaxPendingChannels int    `long:"maxpendingchannels" description:"The maximum number of incoming pending channels permitted per peer."`

        BackupFilePath     string `long:"backupfilepath" description:"The target location of the channel backup file"`

        NoBackupArchive bool `long:"no-backup-archive" description:"If set to true, channel backups will be deleted or replaced rather than being archived to a separate location."`

        FeeURL string `long:"feeurl" description:"DEPRECATED: Use 'fee.url' option. Optional URL for external fee estimation. If no URL is specified, the method for fee estimation will depend on the chosen backend and network. Must be set for neutrino on mainnet." hidden:"true"`

        Bitcoin      *lncfg.Chain    `group:"Bitcoin" namespace:"bitcoin"`

        BtcdMode     *lncfg.Btcd     `group:"btcd" namespace:"btcd"`

        BitcoindMode *lncfg.Bitcoind `group:"bitcoind" namespace:"bitcoind"`

        NeutrinoMode *lncfg.Neutrino `group:"neutrino" namespace:"neutrino"`

        BlockCacheSize uint64 `long:"blockcachesize" description:"The maximum capacity of the block cache"`

        Autopilot *lncfg.AutoPilot `group:"Autopilot" namespace:"autopilot"`

        Tor *lncfg.Tor `group:"Tor" namespace:"tor"`

        SubRPCServers *subRPCServerConfigs `group:"subrpc"`

        Hodl *hodl.Config `group:"hodl" namespace:"hodl"`

        NoNetBootstrap bool `long:"nobootstrap" description:"If true, then automatic network bootstrapping will not be attempted."`

        NoSeedBackup             bool   `long:"noseedbackup" description:"If true, NO SEED WILL BE EXPOSED -- EVER, AND THE WALLET WILL BE ENCRYPTED USING THE DEFAULT PASSPHRASE. THIS FLAG IS ONLY FOR TESTING AND SHOULD NEVER BE USED ON MAINNET."`

        WalletUnlockPasswordFile string `long:"wallet-unlock-password-file" description:"The full path to a file (or pipe/device) that contains the password for unlocking the wallet; if set, no unlocking through RPC is possible and lnd will exit if no wallet exists or the password is incorrect; if wallet-unlock-allow-create is also set then lnd will ignore this flag if no wallet exists and allow a wallet to be created through RPC."`

        WalletUnlockAllowCreate  bool   `long:"wallet-unlock-allow-create" description:"Don't fail with an error if wallet-unlock-password-file is set but no wallet exists yet."`

        ResetWalletTransactions bool `long:"reset-wallet-transactions" description:"Removes all transaction history from the on-chain wallet on startup, forcing a full chain rescan starting at the wallet's birthday. Implements the same functionality as btcwallet's dropwtxmgr command. Should be set to false after successful execution to avoid rescanning on every restart of lnd."`

        CoinSelectionStrategy string `long:"coin-selection-strategy" description:"The strategy to use for selecting coins for wallet transactions." choice:"largest" choice:"random"`

        PaymentsExpirationGracePeriod time.Duration `long:"payments-expiration-grace-period" description:"A period to wait before force closing channels with outgoing htlcs that have timed-out and are a result of this node initiated payments."`

        TrickleDelay                  int           `long:"trickledelay" description:"Time in milliseconds between each release of announcements to the network"`

        ChanEnableTimeout             time.Duration `long:"chan-enable-timeout" description:"The duration that a peer connection must be stable before attempting to send a channel update to re-enable or cancel a pending disables of the peer's channels on the network."`

        ChanDisableTimeout            time.Duration `long:"chan-disable-timeout" description:"The duration that must elapse after first detecting that an already active channel is actually inactive and sending channel update disabling it to the network. The pending disable can be canceled if the peer reconnects and becomes stable for chan-enable-timeout before the disable update is sent."`

        ChanStatusSampleInterval      time.Duration `long:"chan-status-sample-interval" description:"The polling interval between attempts to detect if an active channel has become inactive due to its peer going offline."`

        HeightHintCacheQueryDisable   bool          `long:"height-hint-cache-query-disable" description:"Disable queries from the height-hint cache to try to recover channels stuck in the pending close state. Disabling height hint queries may cause longer chain rescans, resulting in a performance hit. Unset this after channels are unstuck so you can get better performance again."`

        Alias                         string        `long:"alias" description:"The node alias. Used as a moniker by peers and intelligence services"`

        Color                         string        `long:"color" description:"The color of the node in hex format (i.e. '#3399FF'). Used to customize node appearance in intelligence services"`

        MinChanSize                   int64         `long:"minchansize" description:"The smallest channel size (in satoshis) that we should accept. Incoming channels smaller than this will be rejected"`

        MaxChanSize                   int64         `long:"maxchansize" description:"The largest channel size (in satoshis) that we should accept. Incoming channels larger than this will be rejected"`

        CoopCloseTargetConfs          uint32        `long:"coop-close-target-confs" description:"The target number of blocks that a cooperative channel close transaction should confirm in. This is used to estimate the fee to use as the lower bound during fee negotiation for the channel closure."`

        ChannelCommitInterval time.Duration `long:"channel-commit-interval" description:"The maximum time that is allowed to pass between receiving a channel state update and signing the next commitment. Setting this to a longer duration allows for more efficient channel operations at the cost of latency."`

        PendingCommitInterval time.Duration `long:"pending-commit-interval" description:"The maximum time that is allowed to pass while waiting for the remote party to revoke a locally initiated commitment state. Setting this to a longer duration if a slow response is expected from the remote party or large number of payments are attempted at the same time."`

        ChannelCommitBatchSize uint32 `long:"channel-commit-batch-size" description:"The maximum number of channel state updates that is accumulated before signing a new commitment."`

        KeepFailedPaymentAttempts bool `long:"keep-failed-payment-attempts" description:"Keeps persistent record of all failed payment attempts for successfully settled payments."`

        StoreFinalHtlcResolutions bool `long:"store-final-htlc-resolutions" description:"Persistently store the final resolution of incoming htlcs."`

        DefaultRemoteMaxHtlcs uint16 `long:"default-remote-max-htlcs" description:"The default max_htlc applied when opening or accepting channels. This value limits the number of concurrent HTLCs that the remote party can add to the commitment. The maximum possible value is 483."`

        NumGraphSyncPeers      int           `long:"numgraphsyncpeers" description:"The number of peers that we should receive new graph updates from. This option can be tuned to save bandwidth for light clients or routing nodes."`

        HistoricalSyncInterval time.Duration `long:"historicalsyncinterval" description:"The polling interval between historical graph sync attempts. Each historical graph sync attempt ensures we reconcile with the remote peer's graph from the genesis block."`

        IgnoreHistoricalGossipFilters bool `long:"ignore-historical-gossip-filters" description:"If true, will not reply with historical data that matches the range specified by a remote peer's gossip_timestamp_filter. Doing so will result in lower memory and bandwidth requirements."`

        RejectPush bool `long:"rejectpush" description:"If true, lnd will not accept channel opening requests with non-zero push amounts. This should prevent accidental pushes to merchant nodes."`

        RejectHTLC bool `long:"rejecthtlc" description:"If true, lnd will not forward any HTLCs that are meant as onward payments. This option will still allow lnd to send HTLCs and receive HTLCs but lnd won't be used as a hop."`

        AcceptPositiveInboundFees bool `long:"accept-positive-inbound-fees" description:"If true, lnd will also allow setting positive inbound fees. By default, lnd only allows to set negative inbound fees (an inbound \"discount\") to remain backwards compatible with senders whose implementations do not yet support inbound fees."`

        // RequireInterceptor determines whether the HTLC interceptor is

        // registered regardless of whether the RPC is called or not.

        RequireInterceptor bool `long:"requireinterceptor" description:"Whether to always intercept HTLCs, even if no stream is attached"`

        StaggerInitialReconnect bool `long:"stagger-initial-reconnect" description:"If true, will apply a randomized staggering between 0s and 30s when reconnecting to persistent peers on startup. The first 10 reconnections will be attempted instantly, regardless of the flag's value"`

        MaxOutgoingCltvExpiry uint32 `long:"max-cltv-expiry" description:"The maximum number of blocks funds could be locked up for when forwarding payments."`

        MaxChannelFeeAllocation float64 `long:"max-channel-fee-allocation" description:"The maximum percentage of total funds that can be allocated to a channel's commitment fee. This only applies for the initiator of the channel. Valid values are within [0.1, 1]."`

        MaxCommitFeeRateAnchors uint64 `long:"max-commit-fee-rate-anchors" description:"The maximum fee rate in sat/vbyte that will be used for commitments of channels of the anchors type. Must be large enough to ensure transaction propagation"`

        DryRunMigration bool `long:"dry-run-migration" description:"If true, lnd will abort committing a migration if it would otherwise have been successful. This leaves the database unmodified, and still compatible with the previously active version of lnd."`

        net tor.Net

        EnableUpfrontShutdown bool `long:"enable-upfront-shutdown" description:"If true, option upfront shutdown script will be enabled. If peers that we open channels with support this feature, we will automatically set the script to which cooperative closes should be paid out to on channel open. This offers the partial protection of a channel peer disconnecting from us if cooperative close is attempted with a different script."`

        AcceptKeySend bool `long:"accept-keysend" description:"If true, spontaneous payments through keysend will be accepted. [experimental]"`

        AcceptAMP bool `long:"accept-amp" description:"If true, spontaneous payments via AMP will be accepted."`

        KeysendHoldTime time.Duration `long:"keysend-hold-time" description:"If non-zero, keysend payments are accepted but not immediately settled. If the payment isn't settled manually after the specified time, it is canceled automatically. [experimental]"`

        GcCanceledInvoicesOnStartup bool `long:"gc-canceled-invoices-on-startup" description:"If true, we'll attempt to garbage collect canceled invoices upon start."`

        GcCanceledInvoicesOnTheFly bool `long:"gc-canceled-invoices-on-the-fly" description:"If true, we'll delete newly canceled invoices on the fly."`

        DustThreshold uint64 `long:"dust-threshold" description:"DEPRECATED: Sets the max fee exposure in satoshis for a channel after which HTLC's will be failed." hidden:"true"`

        MaxFeeExposure uint64 `long:"channel-max-fee-exposure" description:" Limits the maximum fee exposure in satoshis of a channel. This value is enforced for all channels and is independent of the channel initiator."`

        Fee *lncfg.Fee `group:"fee" namespace:"fee"`

        Invoices *lncfg.Invoices `group:"invoices" namespace:"invoices"`

        Routing *lncfg.Routing `group:"routing" namespace:"routing"`

        Gossip *lncfg.Gossip `group:"gossip" namespace:"gossip"`

        Workers *lncfg.Workers `group:"workers" namespace:"workers"`

        Caches *lncfg.Caches `group:"caches" namespace:"caches"`

        Prometheus lncfg.Prometheus `group:"prometheus" namespace:"prometheus"`

        WtClient *lncfg.WtClient `group:"wtclient" namespace:"wtclient"`

        Watchtower *lncfg.Watchtower `group:"watchtower" namespace:"watchtower"`

        ProtocolOptions *lncfg.ProtocolOptions `group:"protocol" namespace:"protocol"`

        AllowCircularRoute bool `long:"allow-circular-route" description:"If true, our node will allow htlc forwards that arrive and depart on the same channel."`

        HealthChecks *lncfg.HealthCheckConfig `group:"healthcheck" namespace:"healthcheck"`

        DB *lncfg.DB `group:"db" namespace:"db"`

        Cluster *lncfg.Cluster `group:"cluster" namespace:"cluster"`

        RPCMiddleware *lncfg.RPCMiddleware `group:"rpcmiddleware" namespace:"rpcmiddleware"`

        RemoteSigner *lncfg.RemoteSigner `group:"remotesigner" namespace:"remotesigner"`

        Sweeper *lncfg.Sweeper `group:"sweeper" namespace:"sweeper"`

        Htlcswitch *lncfg.Htlcswitch `group:"htlcswitch" namespace:"htlcswitch"`

        GRPC *GRPCConfig `group:"grpc" namespace:"grpc"`

        // SubLogMgr is the root logger that all the daemon's subloggers are

        // hooked up to.

        SubLogMgr  *build.SubLoggerManager

        LogRotator *build.RotatingLogWriter

        LogConfig  *build.LogConfig `group:"logging" namespace:"logging"`

        // networkDir is the path to the directory of the currently active

        // network. This path will hold the files related to each different

        // network.

        networkDir string

        // ActiveNetParams contains parameters of the target chain.

        ActiveNetParams chainreg.BitcoinNetParams

        // Estimator is used to estimate routing probabilities.

        Estimator routing.Estimator

        // Dev specifies configs used for integration tests, which is always

        // empty if not built with `integration` flag.

        Dev *lncfg.DevConfig `group:"dev" namespace:"dev"`

        // HTTPHeaderTimeout is the maximum duration that the server will wait

        // before timing out reading the headers of an HTTP request.

        HTTPHeaderTimeout time.Duration `long:"http-header-timeout" description:"The maximum duration that the server will wait before timing out reading the headers of an HTTP request."`

        // NumRestrictedSlots is the number of restricted slots we'll allocate

        // in the server.

        NumRestrictedSlots uint64 `long:"num-restricted-slots" description:"The number of restricted slots we'll allocate in the server."`

        // NoDisconnectOnPongFailure controls if we'll disconnect if a peer

        // doesn't respond to a pong in time.

        NoDisconnectOnPongFailure bool `long:"no-disconnect-on-pong-failure" description:"If true, a peer will *not* be disconnected if a pong is not received in time or is mismatched. Defaults to false, meaning peers *will* be disconnected on pong failure."`

}

// GRPCConfig holds the configuration options for the gRPC server.

// See https://github.com/grpc/grpc-go/blob/v1.41.0/keepalive/keepalive.go#L50

// for more details. Any value of 0 means we use the gRPC internal default

// values.

//

//nolint:ll

type GRPCConfig struct {

        // ServerPingTime is a duration for the amount of time of no activity

        // after which the server pings the client to see if the transport is

        // still alive. If set below 1s, a minimum value of 1s will be used

        // instead.

        ServerPingTime time.Duration `long:"server-ping-time" description:"How long the server waits on a gRPC stream with no activity before pinging the client."`

        // ServerPingTimeout is the duration the server waits after having

        // pinged for keepalive check, and if no activity is seen even after

        // that the connection is closed.

        ServerPingTimeout time.Duration `long:"server-ping-timeout" description:"How long the server waits for the response from the client for the keepalive ping response."`

        // ClientPingMinWait is the minimum amount of time a client should wait

        // before sending a keepalive ping.

        ClientPingMinWait time.Duration `long:"client-ping-min-wait" description:"The minimum amount of time the client should wait before sending a keepalive ping."`

        // ClientAllowPingWithoutStream specifies whether pings from the client

        // are allowed even if there are no active gRPC streams. This might be

        // useful to keep the underlying HTTP/2 connection open for future

        // requests.

        ClientAllowPingWithoutStream bool `long:"client-allow-ping-without-stream" description:"If true, the server allows keepalive pings from the client even when there are no active gRPC streams. This might be useful to keep the underlying HTTP/2 connection open for future requests."`

}

// DefaultConfig returns all default values for the Config struct.

//

//nolint:ll

// LoadConfig initializes and parses the config using a config file and command

// line options.

//

// The configuration proceeds as follows:

//  1. Start with a default config with sane settings

//  2. Pre-parse the command line to check for an alternative config file

//  3. Load configuration file overwriting defaults with any specified options

//  4. Parse CLI options and overwrite/add any specified options

        // Show the version and exit if the version flag was specified.

        // If the config file path has not been modified by the user, then we'll

        // use the default config file path. However, if the user has modified

        // their lnddir, then we should assume they intend to use the config

        // file within it.

        // User specified --lnddir but no --configfile. Update the config file

        // path to the lnd config directory, but don't require it to exist.

        case configFileDir != DefaultLndDir &&

        // User did specify an explicit --configfile, so we check that it does

        // exist under that path to avoid surprises.

        }

        // Next, load any additional configuration options from the file.

        }

        // Finally, parse the remaining command line options again to ensure

        // they take precedence.

        // Make sure everything we just loaded makes sense.

        // Warn about missing config file only after all other configuration is

        // done. This prevents the warning on help messages and invalid options.

        // Note this should go directly before the return.

        // Finally, log warnings for deprecated config options if they are set.

}

// ValidateConfig check the given configuration to be sane. This makes sure no

// illegal values or combination of values are set. All file system paths are

// normalized. The cleaned up config is returned on success.

func ValidateConfig(cfg Config, interceptor signal.Interceptor, fileParser,

        // If the provided lnd directory is not the default, we'll modify the

        // path to all of the files and directories that will live within it.