lnd: add AuxLeafStore as top level config

chainreg/chainregistry.go

@@ -24,6 +24,7 @@ import (
  "github.com/lightningnetwork/lnd/chainntnfs/neutrinonotify"
  "github.com/lightningnetwork/lnd/channeldb"
  "github.com/lightningnetwork/lnd/channeldb/models"
+ "github.com/lightningnetwork/lnd/fn"
  "github.com/lightningnetwork/lnd/input"
  "github.com/lightningnetwork/lnd/keychain"
  "github.com/lightningnetwork/lnd/kvdb"
@@ -63,6 +64,10 @@ type Config struct {
  // state.
  ChanStateDB *channeldb.ChannelStateDB
 
+ // AuxLeafStore is an optional store that can be used to store auxiliary
+ // leaves for certain custom channel types.
+ AuxLeafStore fn.Option[lnwallet.AuxLeafStore]
+
  // BlockCache is the main cache for storing block information.
  BlockCache *blockcache.BlockCache
 

config_builder.go

@@ -34,6 +34,7 @@ import (
  "github.com/lightningnetwork/lnd/chainreg"
  "github.com/lightningnetwork/lnd/channeldb"
  "github.com/lightningnetwork/lnd/clock"
+ "github.com/lightningnetwork/lnd/fn"
  "github.com/lightningnetwork/lnd/invoices"
  "github.com/lightningnetwork/lnd/keychain"
  "github.com/lightningnetwork/lnd/kvdb"
@@ -104,7 +105,7 @@ type DatabaseBuilder interface {
 type WalletConfigBuilder interface {
  // BuildWalletConfig is responsible for creating or unlocking and then
  // fully initializing a wallet.
- BuildWalletConfig(context.Context, *DatabaseInstances,
+ BuildWalletConfig(context.Context, *DatabaseInstances, *AuxComponents,
  *rpcperms.InterceptorChain,
  []*ListenerWithSignal) (*chainreg.PartialChainControl,
  *btcwallet.Config, func(), error)
@@ -145,6 +146,17 @@ type ImplementationCfg struct {
  // ChainControlBuilder is a type that can provide a custom wallet
  // implementation.
  ChainControlBuilder
+ // AuxComponents is a set of auxiliary components that can be used by
+ // lnd for certain custom channel types.
+ AuxComponents
+}
+
+// AuxComponents is a set of auxiliary components that can be used by lnd for
+// certain custom channel types.
+type AuxComponents struct {
+ // AuxLeafStore is an optional data source that can be used by custom
+ // channels to fetch+store various data.
+ AuxLeafStore fn.Option[lnwallet.AuxLeafStore]
 }
 
 // DefaultWalletImpl is the default implementation of our normal, btcwallet
@@ -229,7 +241,8 @@ func (d *DefaultWalletImpl) Permissions() map[string][]bakery.Op {
 //
 // NOTE: This is part of the WalletConfigBuilder interface.
 func (d *DefaultWalletImpl) BuildWalletConfig(ctx context.Context,
- dbs *DatabaseInstances, interceptorChain *rpcperms.InterceptorChain,
+ dbs *DatabaseInstances, aux *AuxComponents,
+ interceptorChain *rpcperms.InterceptorChain,
  grpcListeners []*ListenerWithSignal) (*chainreg.PartialChainControl,
  *btcwallet.Config, func(), error) {
 
@@ -549,6 +562,7 @@ func (d *DefaultWalletImpl) BuildWalletConfig(ctx context.Context,
  HeightHintDB: dbs.HeightHintDB,
  ChanStateDB: dbs.ChanStateDB.ChannelStateDB(),
  NeutrinoCS: neutrinoCS,
+ AuxLeafStore: aux.AuxLeafStore,
  ActiveNetParams: d.cfg.ActiveNetParams,
  FeeURL: d.cfg.FeeURL,
  Dialer: func(addr string) (net.Conn, error) {
@@ -607,8 +621,9 @@ func (d *DefaultWalletImpl) BuildWalletConfig(ctx context.Context,
 
 // proxyBlockEpoch proxies a block epoch subsections to the underlying neutrino
 // rebroadcaster client.
-func proxyBlockEpoch(notifier chainntnfs.ChainNotifier,
-) func() (*blockntfns.Subscription, error) {
+func proxyBlockEpoch(
+ notifier chainntnfs.ChainNotifier) func() (*blockntfns.Subscription,
+ error) {
 
  return func() (*blockntfns.Subscription, error) {
  blockEpoch, err := notifier.RegisterBlockEpochNtfn(
@@ -699,6 +714,7 @@ func (d *DefaultWalletImpl) BuildChainControl(
  ChainIO: walletController,
  NetParams: *walletConfig.NetParams,
  CoinSelectionStrategy: walletConfig.CoinSelectionStrategy,
+ AuxLeafStore: partialChainControl.Cfg.AuxLeafStore,
  }
 
  // The broadcast is already always active for neutrino nodes, so we
@@ -878,6 +894,10 @@ type DatabaseInstances struct {
  // for native SQL queries for tables that already support it. This may
  // be nil if the use-native-sql flag was not set.
  NativeSQLStore *sqldb.BaseDB
+
+ // AuxLeafStore is an optional data source that can be used by custom
+ // channels to fetch+store various data.
+ AuxLeafStore fn.Option[lnwallet.AuxLeafStore]
 }
 
 // DefaultDatabaseBuilder is a type that builds the default database backends

contractcourt/chain_arbitrator.go

@@ -217,6 +217,10 @@ type ChainArbitratorConfig struct {
  // meanwhile, turn `PaymentCircuit` into an interface or bring it to a
  // lower package.
  QueryIncomingCircuit func(circuit models.CircuitKey) *models.CircuitKey
+
+ // AuxLeafStore is an optional store that can be used to store auxiliary
+ // leaves for certain custom channel types.
+ AuxLeafStore fn.Option[lnwallet.AuxLeafStore]
 }
 
 // ChainArbitrator is a sub-system that oversees the on-chain resolution of all
@@ -299,8 +303,13 @@ func (a *arbChannel) NewAnchorResolutions() (*lnwallet.AnchorResolutions,
  return nil, err
  }
 
+ var chanOpts []lnwallet.ChannelOpt
+ a.c.cfg.AuxLeafStore.WhenSome(func(s lnwallet.AuxLeafStore) {
+ chanOpts = append(chanOpts, lnwallet.WithLeafStore(s))
+ })
+
  chanMachine, err := lnwallet.NewLightningChannel(
- a.c.cfg.Signer, channel, nil,
+ a.c.cfg.Signer, channel, nil, chanOpts...,
  )
  if err != nil {
  return nil, err
@@ -344,10 +353,15 @@ func (a *arbChannel) ForceCloseChan() (*lnwallet.LocalForceCloseSummary, error)
  return nil, err
  }
 
+ var chanOpts []lnwallet.ChannelOpt
+ a.c.cfg.AuxLeafStore.WhenSome(func(s lnwallet.AuxLeafStore) {
+ chanOpts = append(chanOpts, lnwallet.WithLeafStore(s))
+ })
+
  // Finally, we'll force close the channel completing
  // the force close workflow.
  chanMachine, err := lnwallet.NewLightningChannel(
- a.c.cfg.Signer, channel, nil,
+ a.c.cfg.Signer, channel, nil, chanOpts...,
  )
  if err != nil {
  return nil, err

lnd.go

@@ -437,7 +437,8 @@ func Main(cfg *Config, lisCfg ListenerCfg, implCfg *ImplementationCfg,
  defer cleanUp()
 
  partialChainControl, walletConfig, cleanUp, err := implCfg.BuildWalletConfig(
- ctx, dbs, interceptorChain, grpcListeners,
+ ctx, dbs, &implCfg.AuxComponents, interceptorChain,
+ grpcListeners,
  )
  if err != nil {
  return mkErr("error creating wallet config: %v", err)
@@ -580,7 +581,7 @@ func Main(cfg *Config, lisCfg ListenerCfg, implCfg *ImplementationCfg,
  server, err := newServer(
  cfg, cfg.Listeners, dbs, activeChainControl, &idKeyDesc,
  activeChainControl.Cfg.WalletUnlockParams.ChansToRestore,
- multiAcceptor, torController, tlsManager,
+ multiAcceptor, torController, tlsManager, implCfg,
  )
  if err != nil {
  return mkErr("unable to create server: %v", err)

lnwallet/config.go

@@ -5,6 +5,7 @@ import (
  "github.com/btcsuite/btcwallet/wallet"
  "github.com/lightningnetwork/lnd/chainntnfs"
  "github.com/lightningnetwork/lnd/channeldb"
+ "github.com/lightningnetwork/lnd/fn"
  "github.com/lightningnetwork/lnd/input"
  "github.com/lightningnetwork/lnd/keychain"
  "github.com/lightningnetwork/lnd/lnwallet/chainfee"
@@ -62,4 +63,8 @@ type Config struct {
  // CoinSelectionStrategy is the strategy that is used for selecting
  // coins when funding a transaction.
  CoinSelectionStrategy wallet.CoinSelectionStrategy
+
+ // AuxLeafStore is an optional store that can be used to store auxiliary
+ // leaves for certain custom channel types.
+ AuxLeafStore fn.Option[AuxLeafStore]
 }

peer/brontide.go

@@ -359,6 +359,10 @@ type Config struct {
  AddLocalAlias func(alias, base lnwire.ShortChannelID,
  gossip bool) error
 
+ // AuxLeafStore is an optional store that can be used to store auxiliary
+ // leaves for certain custom channel types.
+ AuxLeafStore fn.Option[lnwallet.AuxLeafStore]
+
  // PongBuf is a slice we'll reuse instead of allocating memory on the
  // heap. Since only reads will occur and no writes, there is no need
  // for any synchronization primitives. As a result, it's safe to share

server.go

@@ -157,6 +157,8 @@ type server struct {
 
  cfg *Config
 
+ implCfg *ImplementationCfg
+
  // identityECDH is an ECDH capable wrapper for the private key used
  // to authenticate any incoming connections.
  identityECDH keychain.SingleKeyECDH
@@ -480,8 +482,8 @@ func newServer(cfg *Config, listenAddrs []net.Addr,
  nodeKeyDesc *keychain.KeyDescriptor,
  chansToRestore walletunlocker.ChannelsToRecover,
  chanPredicate chanacceptor.ChannelAcceptor,
- torController *tor.Controller, tlsManager *TLSManager) (*server,
- error) {
+ torController *tor.Controller, tlsManager *TLSManager,
+ implCfg *ImplementationCfg) (*server, error) {
 
  var (
  err error
@@ -567,6 +569,7 @@ func newServer(cfg *Config, listenAddrs []net.Addr,
 
  s := &server{
  cfg: cfg,
+ implCfg: implCfg,
  graphDB: dbs.GraphDB.ChannelGraph(),
  chanStateDB: dbs.ChanStateDB.ChannelStateDB(),
  addrSource: dbs.ChanStateDB,
@@ -1245,6 +1248,7 @@ func newServer(cfg *Config, listenAddrs []net.Addr,
 
  return &pc.Incoming
  },
+ AuxLeafStore: implCfg.AuxLeafStore,
  }, dbs.ChanStateDB)
 
  // Select the configuration and funding parameters for Bitcoin.
@@ -1578,7 +1582,7 @@ func newServer(cfg *Config, listenAddrs []net.Addr,
 
  br, err := lnwallet.NewBreachRetribution(
  channel, commitHeight, 0, nil,
- fn.None[lnwallet.AuxLeafStore](),
+ implCfg.AuxLeafStore,
  )
  if err != nil {
  return nil, 0, err