11954082915

Committed 21 Nov 2024 01:20PM UTC coverage: 59.327% (+0.6%) from 58.776%

Build # 11954082915

Build Type

Pull #8754

github

Committed by

ViktorTigerstrom

Commit Message

itest: wrap deriveCustomScopeAccounts at 80 chars

This commit fixes that word wrapping for the deriveCustomScopeAccounts
function docs, and ensures that it wraps at 80 characters or less.

Pull Request Pull Request #8754: Add `Outbound` Remote Signer implementation

Run Details

1940 of 2984 new or added lines in 44 files covered. (65.01%)

226 existing lines in 37 files now uncovered.

135234 of 227947 relevant lines covered (59.33%)

19316.75 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

65.01

/lnrpc/chainrpc/chain_server.go

//go:build chainrpc
// +build chainrpc

package chainrpc

import (
        "bytes"
        "context"
        "errors"
        "os"
        "path/filepath"
        "sync"
        "sync/atomic"

        "github.com/btcsuite/btcd/chaincfg/chainhash"
        "github.com/btcsuite/btcd/wire"
        "github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
        "github.com/lightningnetwork/lnd/chainntnfs"
        "github.com/lightningnetwork/lnd/lnrpc"
        "github.com/lightningnetwork/lnd/macaroons"
        "google.golang.org/grpc"
        "gopkg.in/macaroon-bakery.v2/bakery"
)

const (
        // subServerName is the name of the RPC sub-server. We'll use this name
        // to register ourselves, and we also require that the main
        // SubServerConfigDispatcher instance recognize this as the name of the
        // config file that we need.
        subServerName = "ChainRPC"
)

var (
        // macaroonOps are the set of capabilities that our minted macaroon (if
        // it doesn't already exist) will have.
        macaroonOps = []bakery.Op{
                {
                        Entity: "onchain",
                        Action: "read",
                },
        }

        // macPermissions maps RPC calls to the permissions they require.
        macPermissions = map[string][]bakery.Op{
                "/chainrpc.ChainKit/GetBlock": {{
                        Entity: "onchain",
                        Action: "read",
                }},
                "/chainrpc.ChainKit/GetBlockHeader": {{
                        Entity: "onchain",
                        Action: "read",
                }},
                "/chainrpc.ChainKit/GetBestBlock": {{
                        Entity: "onchain",
                        Action: "read",
                }},
                "/chainrpc.ChainKit/GetBlockHash": {{
                        Entity: "onchain",
                        Action: "read",
                }},
                "/chainrpc.ChainNotifier/RegisterConfirmationsNtfn": {{
                        Entity: "onchain",
                        Action: "read",
                }},
                "/chainrpc.ChainNotifier/RegisterSpendNtfn": {{
                        Entity: "onchain",
                        Action: "read",
                }},
                "/chainrpc.ChainNotifier/RegisterBlockEpochNtfn": {{
                        Entity: "onchain",
                        Action: "read",
                }},
        }

        // DefaultChainNotifierMacFilename is the default name of the chain
        // notifier macaroon that we expect to find via a file handle within the
        // main configuration file in this package.
        DefaultChainNotifierMacFilename = "chainnotifier.macaroon"

        // ErrChainNotifierServerShuttingDown is an error returned when we are
        // waiting for a notification to arrive but the chain notifier server
        // has been shut down.
        ErrChainNotifierServerShuttingDown = errors.New("chain notifier RPC " +
                "subserver shutting down")

        // ErrChainNotifierServerNotActive indicates that the chain notifier hasn't
        // finished the startup process.
        ErrChainNotifierServerNotActive = errors.New("chain notifier RPC is " +
                "still in the process of starting")
)

// ServerShell is a shell struct holding a reference to the actual sub-server.
// It is used to register the gRPC sub-server with the root server before we
// have the necessary dependencies to populate the actual sub-server.
type ServerShell struct {
        ChainKitServer
        ChainNotifierServer
}

// Server is a sub-server of the main RPC server. It serves the chainkit RPC
// and chain notifier RPC. This RPC sub-server allows external callers to access
// the full chainkit and chain notifier capabilities of lnd. This allows callers
// to create custom protocols, external to lnd, even backed by multiple distinct
// lnd across independent failure domains.
type Server struct {
        injected int32 // To be used atomically.

        // Required by the grpc-gateway/v2 library for forward compatibility.
        UnimplementedChainNotifierServer
        UnimplementedChainKitServer

        stopped sync.Once

        cfg Config

        quit chan struct{}
}

// New returns a new instance of the chainrpc ChainNotifier sub-server. We also
// return the set of permissions for the macaroons that we may create within
// this method. If the macaroons we need aren't found in the filepath, then
// we'll create them on start up. If we're unable to locate, or create the
// macaroons we need, then we'll return with an error.
func New() (*Server, lnrpc.MacaroonPerms, error) {
        return &Server{
                cfg:  Config{},
                quit: make(chan struct{}),
        }, macPermissions, nil
}

// Compile-time checks to ensure that Server fully implements the
// ChainNotifierServer gRPC service, ChainKitServer gRPC service, and
// lnrpc.SubServer interface.
var _ ChainNotifierServer = (*Server)(nil)
var _ ChainKitServer = (*Server)(nil)
var _ lnrpc.SubServer = (*Server)(nil)

// Stop signals any active goroutines for a graceful closure.
//
// NOTE: This is part of the lnrpc.SubServer interface.
func (s *Server) Stop() error {
        s.stopped.Do(func() {
                close(s.quit)
        })

        return nil
}

// InjectDependencies populates the sub-server's dependencies. If the
// finalizeDependencies boolean is true, then the sub-server will finalize its
// dependencies and return an error if any required dependencies are missing.
//
// NOTE: This is part of the lnrpc.SubServer interface.
func (s *Server) InjectDependencies(
        configRegistry lnrpc.SubServerConfigDispatcher,
        finalizeDependencies bool) error {

        if finalizeDependencies && atomic.AddInt32(&s.injected, 1) != 1 {
                return lnrpc.ErrDependenciesFinalized
        }

        cfg, err := getConfig(configRegistry, finalizeDependencies)
        if err != nil {
                return err
        }

        if finalizeDependencies {
                s.cfg = *cfg

                return nil
        }

        // If the path of the chain notifier macaroon wasn't generated, then
        // we'll assume that it's found at the default network directory.
        if cfg.ChainNotifierMacPath == "" {
                cfg.ChainNotifierMacPath = filepath.Join(
                        cfg.NetworkDir, DefaultChainNotifierMacFilename,
                )
        }

        // Now that we know the full path of the chain notifier macaroon, we can
        // check to see if we need to create it or not. If stateless_init is set
        // then we don't write the macaroons.
        macFilePath := cfg.ChainNotifierMacPath
        if cfg.MacService != nil && !cfg.MacService.StatelessInit &&
                !lnrpc.FileExists(macFilePath) {

                log.Infof("Baking macaroons for ChainNotifier RPC Server "+
                        "at: %v", macFilePath)

                // At this point, we know that the chain notifier macaroon
                // doesn't yet, exist, so we need to create it with the help of
                // the main macaroon service.
                chainNotifierMac, err := cfg.MacService.NewMacaroon(
                        context.Background(), macaroons.DefaultRootKeyID,
                        macaroonOps...,
                )
                if err != nil {
                        return err
                }
                chainNotifierMacBytes, err := chainNotifierMac.M().MarshalBinary()
                if err != nil {
                        return err
                }
                err = os.WriteFile(macFilePath, chainNotifierMacBytes, 0644)
                if err != nil {
                        _ = os.Remove(macFilePath)
                        return err
                }
        }

        s.cfg = *cfg

        return nil
}

// Name returns a unique string representation of the sub-server. This can be
// used to identify the sub-server and also de-duplicate them.
//
// NOTE: This is part of the lnrpc.SubServer interface.
func (s *Server) Name() string {
        return subServerName
}

// RegisterWithRootServer will be called by the root gRPC server to direct a RPC
// sub-server to register itself with the main gRPC root server. Until this is
// called, each sub-server won't be able to have requests routed towards it.
//
// NOTE: This is part of the lnrpc.GrpcHandler interface.
func (r *ServerShell) RegisterWithRootServer(grpcServer *grpc.Server) error {
        // We make sure that we register it with the main gRPC server to ensure
        // all our methods are routed properly.
        RegisterChainNotifierServer(grpcServer, r)
        log.Debug("ChainNotifier RPC server successfully register with root " +
                "gRPC server")

        RegisterChainKitServer(grpcServer, r)
        log.Debug("ChainKit RPC server successfully register with root gRPC " +
                "server")

        return nil
}

// RegisterWithRestServer will be called by the root REST mux to direct a sub
// RPC server to register itself with the main REST mux server. Until this is
// called, each sub-server won't be able to have requests routed towards it.
//
// NOTE: This is part of the lnrpc.GrpcHandler interface.
func (r *ServerShell) RegisterWithRestServer(ctx context.Context,
        mux *runtime.ServeMux, dest string, opts []grpc.DialOption) error {

        // We make sure that we register it with the main REST server to ensure
        // all our methods are routed properly.
        err := RegisterChainNotifierHandlerFromEndpoint(ctx, mux, dest, opts)
        if err != nil {
                log.Errorf("Could not register ChainNotifier REST server "+
                        "with root REST server: %v", err)
                return err
        }

        log.Debugf("ChainNotifier REST server successfully registered with " +
                "root REST server")

        // Register chainkit with the main REST server to ensure all our methods
        // are routed properly.
        err = RegisterChainKitHandlerFromEndpoint(ctx, mux, dest, opts)
        if err != nil {
                log.Errorf("Could not register ChainKit REST server with root "+
                        "REST server: %v", err)
                return err
        }
        log.Debugf("ChainKit REST server successfully registered with root " +
                "REST server")

        return nil
}

// CreateSubServer creates an instance of the sub-server, and returns the
// macaroon permissions that the sub-server wishes to pass on to the root server
// for all methods routed towards it.
//
// NOTE: This is part of the lnrpc.GrpcHandler interface.
func (r *ServerShell) CreateSubServer() (
        lnrpc.SubServer, lnrpc.MacaroonPerms, error) {

        subServer, macPermissions, err := New()
        if err != nil {
                return nil, nil, err
        }

        r.ChainNotifierServer = subServer
        r.ChainKitServer = subServer
        return subServer, macPermissions, nil
}

// GetBlock returns a block given the corresponding block hash.
func (s *Server) GetBlock(_ context.Context,
        in *GetBlockRequest) (*GetBlockResponse, error) {

        // We'll start by reconstructing the RPC request into what the
        // underlying chain functionality expects.
        var blockHash chainhash.Hash
        copy(blockHash[:], in.BlockHash)

        block, err := s.cfg.Chain.GetBlock(&blockHash)
        if err != nil {
                return nil, err
        }

        // Serialize block for RPC response.
        var blockBuf bytes.Buffer
        err = block.Serialize(&blockBuf)
        if err != nil {
                return nil, err
        }
        rawBlock := blockBuf.Bytes()

        return &GetBlockResponse{RawBlock: rawBlock}, nil
}

// GetBlockHeader returns a block header given the corresponding block hash.
func (s *Server) GetBlockHeader(_ context.Context,
        in *GetBlockHeaderRequest) (*GetBlockHeaderResponse, error) {

        // We'll start by reconstructing the RPC request into what the
        // underlying chain functionality expects.
        var blockHash chainhash.Hash
        copy(blockHash[:], in.BlockHash)

        blockHeader, err := s.cfg.Chain.GetBlockHeader(&blockHash)
        if err != nil {
                return nil, err
        }

        // Serialize block header for RPC response.
        var headerBuf bytes.Buffer
        err = blockHeader.Serialize(&headerBuf)
        if err != nil {
                return nil, err
        }
        rawHeader := headerBuf.Bytes()

        return &GetBlockHeaderResponse{RawBlockHeader: rawHeader}, nil
}

// GetBestBlock returns the latest block hash and current height of the valid
// most-work chain.
func (s *Server) GetBestBlock(_ context.Context,
        _ *GetBestBlockRequest) (*GetBestBlockResponse, error) {

        blockHash, blockHeight, err := s.cfg.Chain.GetBestBlock()
        if err != nil {
                return nil, err
        }

        return &GetBestBlockResponse{
                BlockHash:   blockHash[:],
                BlockHeight: blockHeight,
        }, nil
}

// GetBlockHash returns the hash of the block in the best blockchain
// at the given height.
func (s *Server) GetBlockHash(_ context.Context,
        req *GetBlockHashRequest) (*GetBlockHashResponse, error) {

        blockHash, err := s.cfg.Chain.GetBlockHash(req.BlockHeight)
        if err != nil {
                return nil, err
        }

        return &GetBlockHashResponse{
                BlockHash: blockHash[:],
        }, nil
}

// RegisterConfirmationsNtfn is a synchronous response-streaming RPC that
// registers an intent for a client to be notified once a confirmation request
// has reached its required number of confirmations on-chain.
//
// A client can specify whether the confirmation request should be for a
// particular transaction by its hash or for an output script by specifying a
// zero hash.
//
// NOTE: This is part of the chainrpc.ChainNotifierService interface.
func (s *Server) RegisterConfirmationsNtfn(in *ConfRequest,
        confStream ChainNotifier_RegisterConfirmationsNtfnServer) error {

        if !s.cfg.ChainNotifier.Started() {
                return ErrChainNotifierServerNotActive
        }

        // We'll start by reconstructing the RPC request into what the
        // underlying ChainNotifier expects.
        var txid chainhash.Hash
        copy(txid[:], in.Txid)

        var opts []chainntnfs.NotifierOption
        if in.IncludeBlock {
                opts = append(opts, chainntnfs.WithIncludeBlock())
        }

        // We'll then register for the spend notification of the request.
        confEvent, err := s.cfg.ChainNotifier.RegisterConfirmationsNtfn(
                &txid, in.Script, in.NumConfs, in.HeightHint, opts...,
        )
        if err != nil {
                return err
        }
        defer confEvent.Cancel()

        // With the request registered, we'll wait for its spend notification to
        // be dispatched.
        for {
                select {
                // The transaction satisfying the request has confirmed on-chain
                // and reached its required number of confirmations. We'll
                // dispatch an event to the caller indicating so.
                case details, ok := <-confEvent.Confirmed:
                        if !ok {
                                return chainntnfs.ErrChainNotifierShuttingDown
                        }

                        var rawTxBuf bytes.Buffer
                        err := details.Tx.Serialize(&rawTxBuf)
                        if err != nil {
                                return err
                        }

                        // If the block was included (should only be there if
                        // IncludeBlock is true), then we'll encode the bytes
                        // to send with the response.
                        var blockBytes []byte
                        if details.Block != nil {
                                var blockBuf bytes.Buffer
                                err := details.Block.Serialize(&blockBuf)
                                if err != nil {
                                        return err
                                }

                                blockBytes = blockBuf.Bytes()
                        }

                        rpcConfDetails := &ConfDetails{
                                RawTx:       rawTxBuf.Bytes(),
                                BlockHash:   details.BlockHash[:],
                                BlockHeight: details.BlockHeight,
                                TxIndex:     details.TxIndex,
                                RawBlock:    blockBytes,
                        }

                        conf := &ConfEvent{
                                Event: &ConfEvent_Conf{
                                        Conf: rpcConfDetails,
                                },
                        }
                        if err := confStream.Send(conf); err != nil {
                                return err
                        }

                // The transaction satisfying the request has been reorged out
                // of the chain, so we'll send an event describing it.
                case _, ok := <-confEvent.NegativeConf:
                        if !ok {
                                return chainntnfs.ErrChainNotifierShuttingDown
                        }

                        reorg := &ConfEvent{
                                Event: &ConfEvent_Reorg{Reorg: &Reorg{}},
                        }
                        if err := confStream.Send(reorg); err != nil {
                                return err
                        }

                // The transaction satisfying the request has confirmed and is
                // no longer under the risk of being reorged out of the chain,
                // so we can safely exit.
                case _, ok := <-confEvent.Done:
                        if !ok {
                                return chainntnfs.ErrChainNotifierShuttingDown
                        }

                        return nil

                // The response stream's context for whatever reason has been
                // closed. If context is closed by an exceeded deadline we will
                // return an error.
                case <-confStream.Context().Done():
                        if errors.Is(confStream.Context().Err(), context.Canceled) {
                                return nil
                        }
                        return confStream.Context().Err()

                // The server has been requested to shut down.
                case <-s.quit:
                        return ErrChainNotifierServerShuttingDown
                }
        }
}

// RegisterSpendNtfn is a synchronous response-streaming RPC that registers an
// intent for a client to be notification once a spend request has been spent by
// a transaction that has confirmed on-chain.
//
// A client can specify whether the spend request should be for a particular
// outpoint  or for an output script by specifying a zero outpoint.
//
// NOTE: This is part of the chainrpc.ChainNotifierService interface.
func (s *Server) RegisterSpendNtfn(in *SpendRequest,
        spendStream ChainNotifier_RegisterSpendNtfnServer) error {

        if !s.cfg.ChainNotifier.Started() {
                return ErrChainNotifierServerNotActive
        }

        // We'll start by reconstructing the RPC request into what the
        // underlying ChainNotifier expects.
        var op *wire.OutPoint
        if in.Outpoint != nil {
                var txid chainhash.Hash
                copy(txid[:], in.Outpoint.Hash)
                op = &wire.OutPoint{Hash: txid, Index: in.Outpoint.Index}
        }

        // We'll then register for the spend notification of the request.
        spendEvent, err := s.cfg.ChainNotifier.RegisterSpendNtfn(
                op, in.Script, in.HeightHint,
        )
        if err != nil {
                return err
        }
        defer spendEvent.Cancel()

        // With the request registered, we'll wait for its spend notification to
        // be dispatched.
        for {
                select {
                // A transaction that spends the given has confirmed on-chain.
                // We'll return an event to the caller indicating so that
                // includes the details of the spending transaction.
                case details, ok := <-spendEvent.Spend:
                        if !ok {
                                return chainntnfs.ErrChainNotifierShuttingDown
                        }

                        var rawSpendingTxBuf bytes.Buffer
                        err := details.SpendingTx.Serialize(&rawSpendingTxBuf)
                        if err != nil {
                                return err
                        }

                        rpcSpendDetails := &SpendDetails{
                                SpendingOutpoint: &Outpoint{
                                        Hash:  details.SpentOutPoint.Hash[:],
                                        Index: details.SpentOutPoint.Index,
                                },
                                RawSpendingTx:      rawSpendingTxBuf.Bytes(),
                                SpendingTxHash:     details.SpenderTxHash[:],
                                SpendingInputIndex: details.SpenderInputIndex,
                                SpendingHeight:     uint32(details.SpendingHeight),
                        }

                        spend := &SpendEvent{
                                Event: &SpendEvent_Spend{
                                        Spend: rpcSpendDetails,
                                },
                        }
                        if err := spendStream.Send(spend); err != nil {
                                return err
                        }

                // The spending transaction of the request has been reorged of
                // the chain. We'll return an event to the caller indicating so.
                case _, ok := <-spendEvent.Reorg:
                        if !ok {
                                return chainntnfs.ErrChainNotifierShuttingDown
                        }

                        reorg := &SpendEvent{
                                Event: &SpendEvent_Reorg{Reorg: &Reorg{}},
                        }
                        if err := spendStream.Send(reorg); err != nil {
                                return err
                        }

                // The spending transaction of the requests has confirmed
                // on-chain and is no longer under the risk of being reorged out
                // of the chain, so we can safely exit.
                case _, ok := <-spendEvent.Done:
                        if !ok {
                                return chainntnfs.ErrChainNotifierShuttingDown
                        }

                        return nil

                // The response stream's context for whatever reason has been
                // closed. If context is closed by an exceeded deadline we will
                // return an error.
                case <-spendStream.Context().Done():
                        if errors.Is(spendStream.Context().Err(), context.Canceled) {
                                return nil
                        }
                        return spendStream.Context().Err()

                // The server has been requested to shut down.
                case <-s.quit:
                        return ErrChainNotifierServerShuttingDown
                }
        }
}

// RegisterBlockEpochNtfn is a synchronous response-streaming RPC that registers
// an intent for a client to be notified of blocks in the chain. The stream will
// return a hash and height tuple of a block for each new/stale block in the
// chain. It is the client's responsibility to determine whether the tuple
// returned is for a new or stale block in the chain.
//
// A client can also request a historical backlog of blocks from a particular
// point. This allows clients to be idempotent by ensuring that they do not
// missing processing a single block within the chain.
//
// NOTE: This is part of the chainrpc.ChainNotifierService interface.
func (s *Server) RegisterBlockEpochNtfn(in *BlockEpoch,
        epochStream ChainNotifier_RegisterBlockEpochNtfnServer) error {

        if !s.cfg.ChainNotifier.Started() {
                return ErrChainNotifierServerNotActive
        }

        // We'll start by reconstructing the RPC request into what the
        // underlying ChainNotifier expects.
        var hash chainhash.Hash
        copy(hash[:], in.Hash)

        // If the request isn't for a zero hash and a zero height, then we
        // should deliver a backlog of notifications from the given block
        // (hash/height tuple) until tip, and continue delivering epochs for
        // new blocks.
        var blockEpoch *chainntnfs.BlockEpoch
        if hash != chainntnfs.ZeroHash && in.Height != 0 {
                blockEpoch = &chainntnfs.BlockEpoch{
                        Hash:   &hash,
                        Height: int32(in.Height),
                }
        }

        epochEvent, err := s.cfg.ChainNotifier.RegisterBlockEpochNtfn(blockEpoch)
        if err != nil {
                return err
        }
        defer epochEvent.Cancel()

        for {
                select {
                // A notification for a block has been received. This block can
                // either be a new block or stale.
                case blockEpoch, ok := <-epochEvent.Epochs:
                        if !ok {
                                return chainntnfs.ErrChainNotifierShuttingDown
                        }

                        epoch := &BlockEpoch{
                                Hash:   blockEpoch.Hash[:],
                                Height: uint32(blockEpoch.Height),
                        }
                        if err := epochStream.Send(epoch); err != nil {
                                return err
                        }

                // The response stream's context for whatever reason has been
                // closed. If context is closed by an exceeded deadline we will
                // return an error.
                case <-epochStream.Context().Done():
                        if errors.Is(epochStream.Context().Err(), context.Canceled) {
                                return nil
                        }
                        return epochStream.Context().Err()

                // The server has been requested to shut down.
                case <-s.quit:
                        return ErrChainNotifierServerShuttingDown
                }
        }
}

lightningnetwork / lnd / 11954082915

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous