12199391122

Committed 06 Dec 2024 01:10PM UTC coverage: 49.807% (-9.1%) from 58.933%

Build # 12199391122

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #9337 from Guayaba221/patch-1

chore: fix typo in ruby.md

Run Details

100137 of 201051 relevant lines covered (49.81%)

2.07 hits per line

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

89.77

/amp/shard_tracker.go

package amp

import (
        "crypto/rand"
        "encoding/binary"
        "fmt"
        "sync"

        "github.com/lightningnetwork/lnd/lntypes"
        "github.com/lightningnetwork/lnd/lnwire"
        "github.com/lightningnetwork/lnd/record"
        "github.com/lightningnetwork/lnd/routing/shards"
)

// Shard is an implementation of the shards.PaymentShards interface specific
// to AMP payments.
type Shard struct {
        child *Child
        mpp   *record.MPP
        amp   *record.AMP
}

// A compile time check to ensure Shard implements the shards.PaymentShard
// interface.
var _ shards.PaymentShard = (*Shard)(nil)

// Hash returns the hash used for the HTLC representing this AMP shard.
func (s *Shard) Hash() lntypes.Hash {
        return s.child.Hash
}

// MPP returns any extra MPP records that should be set for the final hop on
// the route used by this shard.
func (s *Shard) MPP() *record.MPP {
        return s.mpp
}

// AMP returns any extra AMP records that should be set for the final hop on
// the route used by this shard.
func (s *Shard) AMP() *record.AMP {
        return s.amp
}

// ShardTracker is an implementation of the shards.ShardTracker interface
// that is able to generate payment shards according to the AMP splitting
// algorithm. It can be used to generate new hashes to use for HTLCs, and also
// cancel shares used for failed payment shards.
type ShardTracker struct {
        setID       [32]byte
        paymentAddr [32]byte
        totalAmt    lnwire.MilliSatoshi

        sharer Sharer

        shards map[uint64]*Child
        sync.Mutex
}

// A compile time check to ensure ShardTracker implements the
// shards.ShardTracker interface.
var _ shards.ShardTracker = (*ShardTracker)(nil)

// NewShardTracker creates a new shard tracker to use for AMP payments. The
// root shard, setID, payment address and total amount must be correctly set in
// order for the TLV options to include with each shard to be created
// correctly.
func NewShardTracker(root, setID, payAddr [32]byte,
        totalAmt lnwire.MilliSatoshi) *ShardTracker {

        // Create a new seed sharer from this root.
        rootShare := Share(root)
        rootSharer := SeedSharerFromRoot(&rootShare)

        return &ShardTracker{
                setID:       setID,
                paymentAddr: payAddr,
                totalAmt:    totalAmt,
                sharer:      rootSharer,
                shards:      make(map[uint64]*Child),
        }
}

// NewShard registers a new attempt with the ShardTracker and returns a
// new shard representing this attempt. This attempt's shard should be canceled
// if it ends up not being used by the overall payment, i.e. if the attempt
// fails.
func (s *ShardTracker) NewShard(pid uint64, last bool) (shards.PaymentShard,
        error) {

        s.Lock()
        defer s.Unlock()

        // Use a random child index.
        var childIndex [4]byte
        if _, err := rand.Read(childIndex[:]); err != nil {
                return nil, err
        }
        idx := binary.BigEndian.Uint32(childIndex[:])

        // Depending on whether we are requesting the last shard or not, either
        // split the current share into two, or get a Child directly from the
        // current sharer.
        var child *Child
        if last {
                child = s.sharer.Child(idx)

                // If this was the last shard, set the current share to the
                // zero share to indicate we cannot split it further.
                s.sharer = s.sharer.Zero()
        } else {
                left, sharer, err := s.sharer.Split()
                if err != nil {
                        return nil, err
                }

                s.sharer = sharer
                child = left.Child(idx)
        }

        // Track the new child and return the shard.
        s.shards[pid] = child

        mpp := record.NewMPP(s.totalAmt, s.paymentAddr)
        amp := record.NewAMP(
                child.ChildDesc.Share, s.setID, child.ChildDesc.Index,
        )

        return &Shard{
                child: child,
                mpp:   mpp,
                amp:   amp,
        }, nil
}

// CancelShard cancel's the shard corresponding to the given attempt ID.
func (s *ShardTracker) CancelShard(pid uint64) error {
        s.Lock()
        defer s.Unlock()

        c, ok := s.shards[pid]
        if !ok {
                return fmt.Errorf("pid not found")
        }
        delete(s.shards, pid)

        // Now that we are canceling this shard, we XOR the share back into our
        // current share.
        s.sharer = s.sharer.Merge(c)
        return nil
}

// GetHash retrieves the hash used by the shard of the given attempt ID. This
// will return an error if the attempt ID is unknown.
func (s *ShardTracker) GetHash(pid uint64) (lntypes.Hash, error) {
        s.Lock()
        defer s.Unlock()

        c, ok := s.shards[pid]
        if !ok {
                return lntypes.Hash{}, fmt.Errorf("AMP shard for attempt %v "+
                        "not found", pid)
        }

        return c.Hash, nil
}

1	package amp
2
3	import (
4	"crypto/rand"
5	"encoding/binary"
6	"fmt"
7	"sync"
8
9	"github.com/lightningnetwork/lnd/lntypes"
10	"github.com/lightningnetwork/lnd/lnwire"
11	"github.com/lightningnetwork/lnd/record"
12	"github.com/lightningnetwork/lnd/routing/shards"
13	)
14
15	// Shard is an implementation of the shards.PaymentShards interface specific
16	// to AMP payments.
17	type Shard struct {
18	child *Child
19	mpp *record.MPP
20	amp *record.AMP
21	}
22
23	// A compile time check to ensure Shard implements the shards.PaymentShard
24	// interface.
25	var _ shards.PaymentShard = (*Shard)(nil)
26
27	// Hash returns the hash used for the HTLC representing this AMP shard.
28	func (s *Shard) Hash() lntypes.Hash {	4✔
29	return s.child.Hash	4✔
30	}	4✔
31
32	// MPP returns any extra MPP records that should be set for the final hop on
33	// the route used by this shard.
34	func (s Shard) MPP() record.MPP {	4✔
35	return s.mpp	4✔
36	}	4✔
37
38	// AMP returns any extra AMP records that should be set for the final hop on
39	// the route used by this shard.
40	func (s Shard) AMP() record.AMP {	4✔
41	return s.amp	4✔
42	}	4✔
43
44	// ShardTracker is an implementation of the shards.ShardTracker interface
45	// that is able to generate payment shards according to the AMP splitting
46	// algorithm. It can be used to generate new hashes to use for HTLCs, and also
47	// cancel shares used for failed payment shards.
48	type ShardTracker struct {
49	setID [32]byte
50	paymentAddr [32]byte
51	totalAmt lnwire.MilliSatoshi
52
53	sharer Sharer
54
55	shards map[uint64]*Child
56	sync.Mutex
57	}
58
59	// A compile time check to ensure ShardTracker implements the
60	// shards.ShardTracker interface.
61	var _ shards.ShardTracker = (*ShardTracker)(nil)
62
63	// NewShardTracker creates a new shard tracker to use for AMP payments. The
64	// root shard, setID, payment address and total amount must be correctly set in
65	// order for the TLV options to include with each shard to be created
66	// correctly.
67	func NewShardTracker(root, setID, payAddr [32]byte,
68	totalAmt lnwire.MilliSatoshi) *ShardTracker {	4✔
69		4✔
70	// Create a new seed sharer from this root.	4✔
71	rootShare := Share(root)	4✔
72	rootSharer := SeedSharerFromRoot(&rootShare)	4✔
73		4✔
74	return &ShardTracker{	4✔
75	setID: setID,	4✔
76	paymentAddr: payAddr,	4✔
77	totalAmt: totalAmt,	4✔
78	sharer: rootSharer,	4✔
79	shards: make(map[uint64]*Child),	4✔
80	}	4✔
81	}	4✔
82
83	// NewShard registers a new attempt with the ShardTracker and returns a
84	// new shard representing this attempt. This attempt's shard should be canceled
85	// if it ends up not being used by the overall payment, i.e. if the attempt
86	// fails.
87	func (s *ShardTracker) NewShard(pid uint64, last bool) (shards.PaymentShard,
88	error) {	4✔
89		4✔
90	s.Lock()	4✔
91	defer s.Unlock()	4✔
92		4✔
93	// Use a random child index.	4✔
94	var childIndex [4]byte	4✔
95	if _, err := rand.Read(childIndex[:]); err != nil {	4✔
96	return nil, err	×
97	}	×
98	idx := binary.BigEndian.Uint32(childIndex[:])	4✔
99		4✔
100	// Depending on whether we are requesting the last shard or not, either	4✔
101	// split the current share into two, or get a Child directly from the	4✔
102	// current sharer.	4✔
103	var child *Child	4✔
104	if last {	8✔
105	child = s.sharer.Child(idx)	4✔
106		4✔
107	// If this was the last shard, set the current share to the	4✔
108	// zero share to indicate we cannot split it further.	4✔
109	s.sharer = s.sharer.Zero()	4✔
110	} else {	8✔
111	left, sharer, err := s.sharer.Split()	4✔
112	if err != nil {	4✔
113	return nil, err	×
114	}	×
115
116	s.sharer = sharer	4✔
117	child = left.Child(idx)	4✔
118	}
119
120	// Track the new child and return the shard.
121	s.shards[pid] = child	4✔
122		4✔
123	mpp := record.NewMPP(s.totalAmt, s.paymentAddr)	4✔
124	amp := record.NewAMP(	4✔
125	child.ChildDesc.Share, s.setID, child.ChildDesc.Index,	4✔
126	)	4✔
127		4✔
128	return &Shard{	4✔
129	child: child,	4✔
130	mpp: mpp,	4✔
131	amp: amp,	4✔
132	}, nil	4✔
133	}
134
135	// CancelShard cancel's the shard corresponding to the given attempt ID.
136	func (s *ShardTracker) CancelShard(pid uint64) error {	4✔
137	s.Lock()	4✔
138	defer s.Unlock()	4✔
139		4✔
140	c, ok := s.shards[pid]	4✔
141	if !ok {	4✔
142	return fmt.Errorf("pid not found")	×
143	}	×
144	delete(s.shards, pid)	4✔
145		4✔
146	// Now that we are canceling this shard, we XOR the share back into our	4✔
147	// current share.	4✔
148	s.sharer = s.sharer.Merge(c)	4✔
149	return nil	4✔
150	}
151
152	// GetHash retrieves the hash used by the shard of the given attempt ID. This
153	// will return an error if the attempt ID is unknown.
154	func (s *ShardTracker) GetHash(pid uint64) (lntypes.Hash, error) {	4✔
155	s.Lock()	4✔
156	defer s.Unlock()	4✔
157		4✔
158	c, ok := s.shards[pid]	4✔
159	if !ok {	4✔
160	return lntypes.Hash{}, fmt.Errorf("AMP shard for attempt %v "+	×
161	"not found", pid)	×
162	}	×
163
164	return c.Hash, nil	4✔
165	}

lightningnetwork / lnd / 12199391122

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