multi: fix several typos in godoc comments
This commit is contained in:
1 parent
b74a281b57
commit
adf0d98194
37 files changed
+70
-70
No files matched your search
@@ -5,7 +5,7 @@ import (
|
||||
"github.com/roasbeef/btcd/wire"
|
||||
)
|
||||
|
||||
// FilteredChainView repersents a subscription to a certain subset of of the
|
||||
// FilteredChainView represents a subscription to a certain subset of of the
|
||||
// UTXO set for a particular chain. This interface is useful from the point of
|
||||
// view of maintaining an up-to-date channel graph for the Lighting Network.
|
||||
// The subset of the UTXO to be subscribed is that of all the currently opened
|
||||
|
||||
@@ -51,7 +51,7 @@ type topologyClientUpdate struct {
|
||||
}
|
||||
|
||||
// SubscribeTopology returns a new topology client which can be used by the
|
||||
// caller to receive notifications when ever a change in the channel graph
|
||||
// caller to receive notifications whenever a change in the channel graph
|
||||
// topology occurs. Changes that will be sent at notifications include: new
|
||||
// nodes appearing, node updating their attributes, new channels, channels
|
||||
// closing, and updates in the routing policies of a channel's directed edges.
|
||||
|
||||
+1
-1
@@ -109,7 +109,7 @@ type Route struct {
|
||||
|
||||
// TotalFees is the sum of the fees paid at each hop within the final
|
||||
// route. In the case of a one-hop payment, this value will be zero as
|
||||
// we don't need to pay a fee it ourself.
|
||||
// we don't need to pay a fee to ourself.
|
||||
TotalFees lnwire.MilliSatoshi
|
||||
|
||||
// TotalAmount is the total amount of funds required to complete a
|
||||
|
||||
@@ -690,7 +690,7 @@ func TestRouteFailDisabledEdge(t *testing.T) {
|
||||
t.Fatalf("unable to update edge: %v", err)
|
||||
}
|
||||
|
||||
// Now, if we attempt to route throuhg that edge, we should get a
|
||||
// Now, if we attempt to route through that edge, we should get a
|
||||
// failure as it is no longer elligble.
|
||||
_, err = findPath(nil, graph, sourceNode, target, ignoredVertexes,
|
||||
ignoredEdges, payAmt)
|
||||
|
||||
+7
-7
@@ -32,9 +32,9 @@ const (
|
||||
DefaultFinalCLTVDelta = 9
|
||||
)
|
||||
|
||||
// ChannelGraphSource represent the source of information about the topology of
|
||||
// lightning network, it responsible for addition of nodes, edges
|
||||
// and applying edges updates, return the current block with with out
|
||||
// ChannelGraphSource represents the source of information about the topology of
|
||||
// the lightning network. It's responsible for the addition of nodes, edges,
|
||||
// applying edge updates, and returning the current block height with which the
|
||||
// topology is synchronized.
|
||||
type ChannelGraphSource interface {
|
||||
// AddNode is used to add information about a node to the router
|
||||
@@ -56,7 +56,7 @@ type ChannelGraphSource interface {
|
||||
UpdateEdge(policy *channeldb.ChannelEdgePolicy) error
|
||||
|
||||
// ForAllOutgoingChannels is used to iterate over all channels
|
||||
// eminating from the "source" node which is the center of the
|
||||
// emanating from the "source" node which is the center of the
|
||||
// star-graph.
|
||||
ForAllOutgoingChannels(cb func(c *channeldb.ChannelEdgeInfo,
|
||||
e *channeldb.ChannelEdgePolicy) error) error
|
||||
@@ -79,7 +79,7 @@ type ChannelGraphSource interface {
|
||||
}
|
||||
|
||||
// FeeSchema is the set fee configuration for a Lighting Node on the network.
|
||||
// Using the coefficients described within he schema, the required fee to
|
||||
// Using the coefficients described within the schema, the required fee to
|
||||
// forward outgoing payments can be derived.
|
||||
type FeeSchema struct {
|
||||
// BaseFee is the base amount of milli-satoshis that will be chained
|
||||
@@ -1331,7 +1331,7 @@ type LightningPayment struct {
|
||||
// FinalCLTVDelta is the CTLV expiry delta to use for the _final_ hop
|
||||
// in the route. This means that the final hop will have a CLTV delta
|
||||
// of at least: currentHeight + FinalCLTVDelta. If this value is
|
||||
// unspcified, then a default value of DefaultFinalCLTVDelta will be
|
||||
// unspecified, then a default value of DefaultFinalCLTVDelta will be
|
||||
// used.
|
||||
FinalCLTVDelta *uint16
|
||||
|
||||
@@ -1740,7 +1740,7 @@ func (r *ChannelRouter) ForEachNode(cb func(*channeldb.LightningNode) error) err
|
||||
})
|
||||
}
|
||||
|
||||
// ForAllOutgoingChannels is used to iterate over all outgiong channel owned by
|
||||
// ForAllOutgoingChannels is used to iterate over all outgoing channels owned by
|
||||
// the router.
|
||||
//
|
||||
// NOTE: This method is part of the ChannelGraphSource interface.
|
||||
|
||||
Reference in new issue
Block a user