12312390362

Committed 13 Dec 2024 08:44AM UTC coverage: 57.458% (+8.5%) from 48.92%

Build # 12312390362

Build Type

Pull #9343

github

Committed by

ellemouton

Commit Message

fn: rework the ContextGuard and add tests

In this commit, the ContextGuard struct is re-worked such that the
context that its new main WithCtx method provides is cancelled in sync
with a parent context being cancelled or with it's quit channel being
cancelled. Tests are added to assert the behaviour. In order for the
close of the quit channel to be consistent with the cancelling of the
derived context, the quit channel _must_ be contained internal to the
ContextGuard so that callers are only able to close the channel via the
exposed Quit method which will then take care to first cancel any
derived context that depend on the quit channel before returning.

Pull Request Pull Request #9343: fn: expand the ContextGuard and add tests

Run Details

101853 of 177264 relevant lines covered (57.46%)

24972.93 hits per line

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

61.9

/netann/node_signer.go

package netann

import (
        "fmt"

        "github.com/btcsuite/btcd/btcec/v2/ecdsa"
        "github.com/lightningnetwork/lnd/keychain"
        "github.com/lightningnetwork/lnd/lnwallet"
)

// NodeSigner is an implementation of the MessageSigner interface backed by the
// identity private key of running lnd node.
type NodeSigner struct {
        keySigner keychain.SingleKeyMessageSigner
}

// NewNodeSigner creates a new instance of the NodeSigner backed by the target
// private key.
func NewNodeSigner(keySigner keychain.SingleKeyMessageSigner) *NodeSigner {
        return &NodeSigner{
                keySigner: keySigner,
        }
}

// SignMessage signs a double-sha256 digest of the passed msg under the
// resident node's private key described in the key locator. If the target key
// locator is _not_ the node's private key, then an error will be returned.
func (n *NodeSigner) SignMessage(keyLoc keychain.KeyLocator,
        msg []byte, doubleHash bool) (*ecdsa.Signature, error) {

        // If this isn't our identity public key, then we'll exit early with an
        // error as we can't sign with this key.
        if keyLoc != n.keySigner.KeyLocator() {
                return nil, fmt.Errorf("unknown public key locator")
        }

        // Otherwise, we'll sign the double-sha256 of the target message.
        sig, err := n.keySigner.SignMessage(msg, doubleHash)
        if err != nil {
                return nil, fmt.Errorf("can't sign the message: %w", err)
        }

        return sig, nil
}

// SignMessageCompact signs a single or double sha256 digest of the msg
// parameter under the resident node's private key. The returned signature is a
// pubkey-recoverable signature.
func (n *NodeSigner) SignMessageCompact(msg []byte, doubleHash bool) ([]byte,
        error) {

        return n.keySigner.SignMessageCompact(msg, doubleHash)
}

// A compile time check to ensure that NodeSigner implements the MessageSigner
// interface.
var _ lnwallet.MessageSigner = (*NodeSigner)(nil)

1	package netann
2
3	import (
4	"fmt"
5
6	"github.com/btcsuite/btcd/btcec/v2/ecdsa"
7	"github.com/lightningnetwork/lnd/keychain"
8	"github.com/lightningnetwork/lnd/lnwallet"
9	)
10
11	// NodeSigner is an implementation of the MessageSigner interface backed by the
12	// identity private key of running lnd node.
13	type NodeSigner struct {
14	keySigner keychain.SingleKeyMessageSigner
15	}
16
17	// NewNodeSigner creates a new instance of the NodeSigner backed by the target
18	// private key.
19	func NewNodeSigner(keySigner keychain.SingleKeyMessageSigner) *NodeSigner {	42✔
20	return &NodeSigner{	42✔
21	keySigner: keySigner,	42✔
22	}	42✔
23	}	42✔
24
25	// SignMessage signs a double-sha256 digest of the passed msg under the
26	// resident node's private key described in the key locator. If the target key
27	// locator is _not_ the node's private key, then an error will be returned.
28	func (n *NodeSigner) SignMessage(keyLoc keychain.KeyLocator,
29	msg []byte, doubleHash bool) (*ecdsa.Signature, error) {	100✔
30		100✔
31	// If this isn't our identity public key, then we'll exit early with an	100✔
32	// error as we can't sign with this key.	100✔
33	if keyLoc != n.keySigner.KeyLocator() {	100✔
34	return nil, fmt.Errorf("unknown public key locator")	×
35	}	×
36
37	// Otherwise, we'll sign the double-sha256 of the target message.
38	sig, err := n.keySigner.SignMessage(msg, doubleHash)	100✔
39	if err != nil {	100✔
40	return nil, fmt.Errorf("can't sign the message: %w", err)	×
41	}	×
42
43	return sig, nil	100✔
44	}
45
46	// SignMessageCompact signs a single or double sha256 digest of the msg
47	// parameter under the resident node's private key. The returned signature is a
48	// pubkey-recoverable signature.
49	func (n *NodeSigner) SignMessageCompact(msg []byte, doubleHash bool) ([]byte,
50	error) {	×
51		×
52	return n.keySigner.SignMessageCompact(msg, doubleHash)	×
53	}	×
54
55	// A compile time check to ensure that NodeSigner implements the MessageSigner
56	// interface.
57	var _ lnwallet.MessageSigner = (*NodeSigner)(nil)

lightningnetwork / lnd / 12312390362

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