lnwire: lnwire: add a ChannelUpdate interface

In this commit, a new ChannelUpdate interface is added and
ChannelUpdate1 is made to implement the new interface.

lnwire/channel_update.go

@@ -279,3 +279,91 @@ func (a *ChannelUpdate1) DataToSign() ([]byte, error) {
 
 	return buf.Bytes(), nil
 }
+
+// SCID returns the ShortChannelID of the channel that the update applies to.
+//
+// NOTE: this is part of the ChannelUpdate interface.
+func (a *ChannelUpdate1) SCID() ShortChannelID {
+	return a.ShortChannelID
+}
+
+// IsNode1 is true if the update was produced by node 1 of the channel peers.
+// Node 1 is the node with the lexicographically smaller public key.
+//
+// NOTE: this is part of the ChannelUpdate interface.
+func (a *ChannelUpdate1) IsNode1() bool {
+	return a.ChannelFlags&ChanUpdateDirection == 0
+}
+
+// IsDisabled is true if the update is announcing that the channel should be
+// considered disabled.
+//
+// NOTE: this is part of the ChannelUpdate interface.
+func (a *ChannelUpdate1) IsDisabled() bool {
+	return a.ChannelFlags&ChanUpdateDisabled == ChanUpdateDisabled
+}
+
+// GetChainHash returns the hash of the chain that the message is referring to.
+//
+// NOTE: this is part of the ChannelUpdate interface.
+func (a *ChannelUpdate1) GetChainHash() chainhash.Hash {
+	return a.ChainHash
+}
+
+// ForwardingPolicy returns the set of forwarding constraints of the update.
+//
+// NOTE: this is part of the ChannelUpdate interface.
+func (a *ChannelUpdate1) ForwardingPolicy() *ForwardingPolicy {
+	return &ForwardingPolicy{
+		TimeLockDelta: a.TimeLockDelta,
+		BaseFee:       MilliSatoshi(a.BaseFee),
+		FeeRate:       MilliSatoshi(a.FeeRate),
+		MinHTLC:       a.HtlcMinimumMsat,
+		HasMaxHTLC:    a.MessageFlags.HasMaxHtlc(),
+		MaxHTLC:       a.HtlcMaximumMsat,
+	}
+}
+
+// CmpAge can be used to determine if the update is older or newer than the
+// passed update. It returns 1 if this update is newer, -1 if it is older, and
+// 0 if they are the same age.
+//
+// NOTE: this is part of the ChannelUpdate interface.
+func (a *ChannelUpdate1) CmpAge(update ChannelUpdate) (CompareResult, error) {
+	other, ok := update.(*ChannelUpdate1)
+	if !ok {
+		return 0, fmt.Errorf("expected *ChannelUpdate1, got: %T",
+			update)
+	}
+
+	switch {
+	case a.Timestamp > other.Timestamp:
+		return GreaterThan, nil
+	case a.Timestamp < other.Timestamp:
+		return LessThan, nil
+	default:
+		return EqualTo, nil
+	}
+}
+
+// SetDisabledFlag can be used to adjust the disabled flag of an update.
+//
+// NOTE: this is part of the ChannelUpdate interface.
+func (a *ChannelUpdate1) SetDisabledFlag(disabled bool) {
+	if disabled {
+		a.ChannelFlags |= ChanUpdateDisabled
+	} else {
+		a.ChannelFlags &= ^ChanUpdateDisabled
+	}
+}
+
+// SetSCID can be used to overwrite the SCID of the update.
+//
+// NOTE: this is part of the ChannelUpdate interface.
+func (a *ChannelUpdate1) SetSCID(scid ShortChannelID) {
+	a.ShortChannelID = scid
+}
+
+// A compile time assertion to ensure ChannelUpdate1 implements the
+// ChannelUpdate interface.
+var _ ChannelUpdate = (*ChannelUpdate1)(nil)

lnwire/interfaces.go

@@ -34,3 +34,88 @@ type ChannelAnnouncement interface {
 
 	Message
 }
+
+// CompareResult represents the result after comparing two things.
+type CompareResult uint8
+
+const (
+	// LessThan indicates that base object is less than the object it was
+	// compared to.
+	LessThan CompareResult = iota
+
+	// EqualTo indicates that the base object is equal to the object it was
+	// compared to.
+	EqualTo
+
+	// GreaterThan indicates that base object is greater than the object it
+	// was compared to.
+	GreaterThan
+)
+
+// ChannelUpdate is an interface that describes a message used to update the
+// forwarding rules of a channel.
+type ChannelUpdate interface {
+	// SCID returns the ShortChannelID of the channel that the update
+	// applies to.
+	SCID() ShortChannelID
+
+	// IsNode1 is true if the update was produced by node 1 of the channel
+	// peers. Node 1 is the node with the lexicographically smaller public
+	// key.
+	IsNode1() bool
+
+	// IsDisabled is true if the update is announcing that the channel
+	// should be considered disabled.
+	IsDisabled() bool
+
+	// GetChainHash returns the hash of the chain that the message is
+	// referring to.
+	GetChainHash() chainhash.Hash
+
+	// ForwardingPolicy returns the set of forwarding constraints of the
+	// update.
+	ForwardingPolicy() *ForwardingPolicy
+
+	// CmpAge can be used to determine if the update is older or newer than
+	// the passed update. It returns LessThan if this update is older than
+	// the passed update, GreaterThan if it is newer and EqualTo if they are
+	// the same age.
+	CmpAge(update ChannelUpdate) (CompareResult, error)
+
+	// SetDisabledFlag can be used to adjust the disabled flag of an update.
+	SetDisabledFlag(bool)
+
+	// SetSCID can be used to overwrite the SCID of the update.
+	SetSCID(scid ShortChannelID)
+
+	Message
+}
+
+// ForwardingPolicy defines the set of forwarding constraints advertised in a
+// ChannelUpdate message.
+type ForwardingPolicy struct {
+	// TimeLockDelta is the minimum number of blocks that the node requires
+	// to be added to the expiry of HTLCs. This is a security parameter
+	// determined by the node operator. This value represents the required
+	// gap between the time locks of the incoming and outgoing HTLC's set
+	// to this node.
+	TimeLockDelta uint16
+
+	// BaseFee is the base fee that must be used for incoming HTLC's to
+	// this particular channel. This value will be tacked onto the required
+	// for a payment independent of the size of the payment.
+	BaseFee MilliSatoshi
+
+	// FeeRate is the fee rate that will be charged per millionth of a
+	// satoshi.
+	FeeRate MilliSatoshi
+
+	// HtlcMinimumMsat is the minimum HTLC value which will be accepted.
+	MinHTLC MilliSatoshi
+
+	// HasMaxHTLC is true if the MaxHTLC field is provided in the update.
+	HasMaxHTLC bool
+
+	// HtlcMaximumMsat is the maximum HTLC value which will be accepted.
+	MaxHTLC MilliSatoshi
+}