13035292482

Committed 29 Jan 2025 03:59PM UTC coverage: 49.3% (-9.5%) from 58.777%

Build # 13035292482

Build Type

Pull #9456

github

Committed by

mohamedawnallah

Commit Message

docs: update release-notes-0.19.0.md

In this commit, we warn users about the removal
of RPCs `SendToRoute`, `SendToRouteSync`, `SendPayment`,
and `SendPaymentSync` in the next release 0.20.

Pull Request Pull Request #9456: lnrpc+docs: deprecate warning `SendToRoute`, `SendToRouteSync`, `SendPayment`, and `SendPaymentSync` in Release 0.19

Run Details

100634 of 204126 relevant lines covered (49.3%)

1.54 hits per line

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

0.0

/channeldb/migration/lnwire21/msat.go

package lnwire

import (
        "fmt"
        "io"

        "github.com/btcsuite/btcd/btcutil"
        "github.com/lightningnetwork/lnd/tlv"
)

const (
        // mSatScale is a value that's used to scale satoshis to milli-satoshis, and
        // the other way around.
        mSatScale uint64 = 1000

        // MaxMilliSatoshi is the maximum number of msats that can be expressed
        // in this data type.
        MaxMilliSatoshi = ^MilliSatoshi(0)
)

// MilliSatoshi are the native unit of the Lightning Network. A milli-satoshi
// is simply 1/1000th of a satoshi. There are 1000 milli-satoshis in a single
// satoshi. Within the network, all HTLC payments are denominated in
// milli-satoshis. As milli-satoshis aren't deliverable on the native
// blockchain, before settling to broadcasting, the values are rounded down to
// the nearest satoshi.
type MilliSatoshi uint64

// NewMSatFromSatoshis creates a new MilliSatoshi instance from a target amount
// of satoshis.
func NewMSatFromSatoshis(sat btcutil.Amount) MilliSatoshi {
        return MilliSatoshi(uint64(sat) * mSatScale)
}

// ToBTC converts the target MilliSatoshi amount to its corresponding value
// when expressed in BTC.
func (m MilliSatoshi) ToBTC() float64 {
        sat := m.ToSatoshis()
        return sat.ToBTC()
}

// ToSatoshis converts the target MilliSatoshi amount to satoshis. Simply, this
// sheds a factor of 1000 from the mSAT amount in order to convert it to SAT.
func (m MilliSatoshi) ToSatoshis() btcutil.Amount {
        return btcutil.Amount(uint64(m) / mSatScale)
}

// String returns the string representation of the mSAT amount.
func (m MilliSatoshi) String() string {
        return fmt.Sprintf("%v mSAT", uint64(m))
}

// TODO(roasbeef): extend with arithmetic operations?

// Record returns a TLV record that can be used to encode/decode a MilliSatoshi
// to/from a TLV stream.
func (m *MilliSatoshi) Record() tlv.Record {
        return tlv.MakeDynamicRecord(
                0, m, tlv.SizeBigSize(m), encodeMilliSatoshis,
                decodeMilliSatoshis,
        )
}
func encodeMilliSatoshis(w io.Writer, val interface{}, buf *[8]byte) error {
        if v, ok := val.(*MilliSatoshi); ok {
                bigSize := uint64(*v)

                return tlv.EBigSize(w, &bigSize, buf)
        }

        return tlv.NewTypeForEncodingErr(val, "lnwire.MilliSatoshi")
}

func decodeMilliSatoshis(r io.Reader, val interface{}, buf *[8]byte,
        l uint64) error {

        if v, ok := val.(*MilliSatoshi); ok {
                var bigSize uint64
                err := tlv.DBigSize(r, &bigSize, buf, l)
                if err != nil {
                        return err
                }

                *v = MilliSatoshi(bigSize)

                return nil
        }

        return tlv.NewTypeForDecodingErr(val, "lnwire.MilliSatoshi", l, l)
}

1	package lnwire
2
3	import (
4	"fmt"
5	"io"
6
7	"github.com/btcsuite/btcd/btcutil"
8	"github.com/lightningnetwork/lnd/tlv"
9	)
10
11	const (
12	// mSatScale is a value that's used to scale satoshis to milli-satoshis, and
13	// the other way around.
14	mSatScale uint64 = 1000
15
16	// MaxMilliSatoshi is the maximum number of msats that can be expressed
17	// in this data type.
18	MaxMilliSatoshi = ^MilliSatoshi(0)
19	)
20
21	// MilliSatoshi are the native unit of the Lightning Network. A milli-satoshi
22	// is simply 1/1000th of a satoshi. There are 1000 milli-satoshis in a single
23	// satoshi. Within the network, all HTLC payments are denominated in
24	// milli-satoshis. As milli-satoshis aren't deliverable on the native
25	// blockchain, before settling to broadcasting, the values are rounded down to
26	// the nearest satoshi.
27	type MilliSatoshi uint64
28
29	// NewMSatFromSatoshis creates a new MilliSatoshi instance from a target amount
30	// of satoshis.
31	func NewMSatFromSatoshis(sat btcutil.Amount) MilliSatoshi {	×
32	return MilliSatoshi(uint64(sat) * mSatScale)	×
33	}	×
34
35	// ToBTC converts the target MilliSatoshi amount to its corresponding value
36	// when expressed in BTC.
37	func (m MilliSatoshi) ToBTC() float64 {	×
38	sat := m.ToSatoshis()	×
39	return sat.ToBTC()	×
40	}	×
41
42	// ToSatoshis converts the target MilliSatoshi amount to satoshis. Simply, this
43	// sheds a factor of 1000 from the mSAT amount in order to convert it to SAT.
44	func (m MilliSatoshi) ToSatoshis() btcutil.Amount {	×
45	return btcutil.Amount(uint64(m) / mSatScale)	×
46	}	×
47
48	// String returns the string representation of the mSAT amount.
49	func (m MilliSatoshi) String() string {	×
50	return fmt.Sprintf("%v mSAT", uint64(m))	×
51	}	×
52
53	// TODO(roasbeef): extend with arithmetic operations?
54
55	// Record returns a TLV record that can be used to encode/decode a MilliSatoshi
56	// to/from a TLV stream.
57	func (m *MilliSatoshi) Record() tlv.Record {	×
58	return tlv.MakeDynamicRecord(	×
59	0, m, tlv.SizeBigSize(m), encodeMilliSatoshis,	×
60	decodeMilliSatoshis,	×
61	)	×
62	}	×
63	func encodeMilliSatoshis(w io.Writer, val interface{}, buf *[8]byte) error {	×
64	if v, ok := val.(*MilliSatoshi); ok {	×
65	bigSize := uint64(*v)	×
66		×
67	return tlv.EBigSize(w, &bigSize, buf)	×
68	}	×
69
70	return tlv.NewTypeForEncodingErr(val, "lnwire.MilliSatoshi")	×
71	}
72
73	func decodeMilliSatoshis(r io.Reader, val interface{}, buf *[8]byte,
74	l uint64) error {	×
75		×
76	if v, ok := val.(*MilliSatoshi); ok {	×
77	var bigSize uint64	×
78	err := tlv.DBigSize(r, &bigSize, buf, l)	×
79	if err != nil {	×
80	return err	×
81	}	×
82
83	*v = MilliSatoshi(bigSize)	×
84		×
85	return nil	×
86	}
87
88	return tlv.NewTypeForDecodingErr(val, "lnwire.MilliSatoshi", l, l)	×
89	}

lightningnetwork / lnd / 13035292482

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