From 550341c0368a91939d793c7f0fa8a2c2ca55f939 Mon Sep 17 00:00:00 2001 From: yyforyongyu Date: Thu, 26 Nov 2020 05:12:29 +0800 Subject: [PATCH] lnwire: fix typo --- lnwire/announcement_signatures.go | 2 +- lnwire/channel_reestablish.go | 8 ++++---- lnwire/channel_update.go | 2 +- lnwire/commit_sig.go | 2 +- lnwire/error.go | 4 ++-- lnwire/features.go | 8 ++++---- lnwire/init_message.go | 2 +- lnwire/node_announcement.go | 6 +++--- lnwire/onion_error.go | 2 +- lnwire/open_channel.go | 2 +- lnwire/query_short_chan_ids.go | 8 ++++---- lnwire/reply_short_chan_ids_end.go | 2 +- lnwire/revoke_and_ack.go | 2 +- 13 files changed, 25 insertions(+), 25 deletions(-) diff --git a/lnwire/announcement_signatures.go b/lnwire/announcement_signatures.go index 01245213..639704de 100644 --- a/lnwire/announcement_signatures.go +++ b/lnwire/announcement_signatures.go @@ -5,7 +5,7 @@ import ( "io/ioutil" ) -// AnnounceSignatures this is a direct message between two endpoints of a +// AnnounceSignatures is a direct message between two endpoints of a // channel and serves as an opt-in mechanism to allow the announcement of // the channel to the rest of the network. It contains the necessary // signatures by the sender to construct the channel announcement message. diff --git a/lnwire/channel_reestablish.go b/lnwire/channel_reestablish.go index 42abcf95..6fa8f8ac 100644 --- a/lnwire/channel_reestablish.go +++ b/lnwire/channel_reestablish.go @@ -11,9 +11,9 @@ import ( // to report their local state, and their current knowledge of the state of the // remote commitment chain. If a deviation is detected and can be recovered // from, then the necessary messages will be retransmitted. If the level of -// desynchronization if irreconcilable, then the channel will be force closed. +// desynchronization is irreconcilable, then the channel will be force closed. type ChannelReestablish struct { - // ChanID is the channel ID of the channel state we're attempting + // ChanID is the channel ID of the channel state we're attempting to // synchronize with the remote party. ChanID ChannelID @@ -105,7 +105,7 @@ func (a *ChannelReestablish) Decode(r io.Reader, pver uint32) error { return err } - // This message has to currently defined optional fields. As a result, + // This message has currently defined optional fields. As a result, // we'll only proceed if there's still bytes remaining within the // reader. // @@ -127,7 +127,7 @@ func (a *ChannelReestablish) Decode(r io.Reader, pver uint32) error { copy(a.LastRemoteCommitSecret[:], buf[:]) // We'll conclude by parsing out the commitment point. We don't check - // the error in this case, as it hey included the commit secret, then + // the error in this case, as it has included the commit secret, then // they MUST also include the commit point. return ReadElement(r, &a.LocalUnrevokedCommitPoint) } diff --git a/lnwire/channel_update.go b/lnwire/channel_update.go index c0e9e74d..037f3d55 100644 --- a/lnwire/channel_update.go +++ b/lnwire/channel_update.go @@ -75,7 +75,7 @@ type ChannelUpdate struct { // ShortChannelID is the unique description of the funding transaction. ShortChannelID ShortChannelID - // Timestamp allows ordering in the case of multiple announcements. We + // Timestamp allows ordering in the case of multiple announcements. We // should ignore the message if timestamp is not greater than // the last-received. Timestamp uint32 diff --git a/lnwire/commit_sig.go b/lnwire/commit_sig.go index 2455c016..f15a9738 100644 --- a/lnwire/commit_sig.go +++ b/lnwire/commit_sig.go @@ -5,7 +5,7 @@ import ( ) // CommitSig is sent by either side to stage any pending HTLC's in the -// receiver's pending set into a new commitment state. Implicitly, the new +// receiver's pending set into a new commitment state. Implicitly, the new // commitment transaction constructed which has been signed by CommitSig // includes all HTLC's in the remote node's pending set. A CommitSig message // may be sent after a series of UpdateAddHTLC/UpdateFulfillHTLC messages in diff --git a/lnwire/error.go b/lnwire/error.go index c9fa39a8..3717f8a8 100644 --- a/lnwire/error.go +++ b/lnwire/error.go @@ -15,7 +15,7 @@ const ( ErrMaxPendingChannels FundingError = 1 // ErrSynchronizingChain is returned by a remote peer that receives a - // channel update or a funding request while their still syncing to the + // channel update or a funding request while it's still syncing to the // latest state of the blockchain. ErrSynchronizingChain FundingError = 2 @@ -39,7 +39,7 @@ func (e FundingError) String() string { } } -// Error returns the human redable version of the target FundingError. +// Error returns the human readable version of the target FundingError. // // NOTE: Satisfies the Error interface. func (e FundingError) Error() string { diff --git a/lnwire/features.go b/lnwire/features.go index 250c041e..45ef6eeb 100644 --- a/lnwire/features.go +++ b/lnwire/features.go @@ -66,7 +66,7 @@ const ( // able to decode the new TLV information included in the onion packet. TLVOnionPayloadRequired FeatureBit = 8 - // TLVOnionPayloadRequired is an optional feature bit that indicates a + // TLVOnionPayloadOptional is an optional feature bit that indicates a // node is able to decode the new TLV information included in the onion // packet. TLVOnionPayloadOptional FeatureBit = 9 @@ -114,7 +114,7 @@ const ( // outputs. AnchorsRequired FeatureBit = 20 - // AnchorsRequired is an optional feature bit that signals that the + // AnchorsOptional is an optional feature bit that signals that the // node supports channels to be made using commitments having anchor // outputs. AnchorsOptional FeatureBit = 21 @@ -126,7 +126,7 @@ const ( // message to signal the type of message, that leaves us with 65533 bytes // for the init message itself. Next, we reserve 4 bytes to encode the // lengths of both the local and global feature vectors, so 65529 bytes - // for the local and global features. Knocking off one byte for the sake + // for the local and global features. Knocking off one byte for the sake // of the calculation, that leads us to 32764 bytes for each feature // vector, or 131056 different features. maxAllowedSize = 32764 @@ -427,7 +427,7 @@ func (fv *FeatureVector) UnknownRequiredFeatures() []FeatureBit { // Name returns a string identifier for the feature represented by this bit. If // the bit does not represent a known feature, this returns a string indicating -// as much. +// as such. func (fv *FeatureVector) Name(bit FeatureBit) string { name, known := fv.featureNames[bit] if !known { diff --git a/lnwire/init_message.go b/lnwire/init_message.go index 0236a71f..e1ddbb01 100644 --- a/lnwire/init_message.go +++ b/lnwire/init_message.go @@ -12,7 +12,7 @@ type Init struct { // merged with those presented in Features. GlobalFeatures *RawFeatureVector - // Features is a feature vector containing a the features supported by + // Features is a feature vector containing the features supported by // the remote node. // // NOTE: Older nodes may place some features in GlobalFeatures, but all diff --git a/lnwire/node_announcement.go b/lnwire/node_announcement.go index f0d897bc..35534352 100644 --- a/lnwire/node_announcement.go +++ b/lnwire/node_announcement.go @@ -34,9 +34,9 @@ func (e ErrInvalidNodeAlias) Error() string { return "node alias has non-utf8 characters" } -// NodeAlias a hex encoded UTF-8 string that may be displayed as an alternative -// to the node's ID. Notice that aliases are not unique and may be freely -// chosen by the node operators. +// NodeAlias is a hex encoded UTF-8 string that may be displayed as an +// alternative to the node's ID. Notice that aliases are not unique and may be +// freely chosen by the node operators. type NodeAlias [32]byte // NewNodeAlias creates a new instance of a NodeAlias. Verification is diff --git a/lnwire/onion_error.go b/lnwire/onion_error.go index c6235552..35555e26 100644 --- a/lnwire/onion_error.go +++ b/lnwire/onion_error.go @@ -39,7 +39,7 @@ const ( // FlagPerm error flag indicates a permanent failure. FlagPerm FailCode = 0x4000 - // FlagNode error flag indicates anode failure. + // FlagNode error flag indicates a node failure. FlagNode FailCode = 0x2000 // FlagUpdate error flag indicates a new channel update is enclosed diff --git a/lnwire/open_channel.go b/lnwire/open_channel.go index f78cc26e..a165ef75 100644 --- a/lnwire/open_channel.go +++ b/lnwire/open_channel.go @@ -106,7 +106,7 @@ type OpenChannel struct { DelayedPaymentPoint *btcec.PublicKey // HtlcPoint is the base point used to derive the set of keys for this - // party that will be used within the HTLC public key scripts. This + // party that will be used within the HTLC public key scripts. This // value is combined with the receiver's revocation base point in order // to derive the keys that are used within HTLC scripts. HtlcPoint *btcec.PublicKey diff --git a/lnwire/query_short_chan_ids.go b/lnwire/query_short_chan_ids.go index cb24178b..3c2b9948 100644 --- a/lnwire/query_short_chan_ids.go +++ b/lnwire/query_short_chan_ids.go @@ -70,7 +70,7 @@ func ErrUnknownShortChanIDEncoding(encoding ShortChanIDEncoding) error { // message. type QueryShortChanIDs struct { // ChainHash denotes the target chain that we're querying for the - // channel channel ID's of. + // channel ID's of. ChainHash chainhash.Hash // EncodingType is a signal to the receiver of the message that @@ -155,8 +155,8 @@ func decodeShortChanIDs(r io.Reader) (ShortChanIDEncoding, []ShortChannelID, err // In this encoding, we'll simply read a sort array of encoded short // channel ID's from the buffer. case EncodingSortedPlain: - // If after extracting the encoding type, then number of - // remaining bytes instead a whole multiple of the size of an + // If after extracting the encoding type, the number of + // remaining bytes is not a whole multiple of the size of an // encoded short channel ID (8 bytes), then we'll return a // parsing error. if len(queryBody)%8 != 0 { @@ -254,7 +254,7 @@ func decodeShortChanIDs(r io.Reader) (ShortChanIDEncoding, []ShortChannelID, err "ID: %v", err) } - // We successfully read the next ID, so well collect + // We successfully read the next ID, so we'll collect // that in the set of final ID's to return. shortChanIDs = append(shortChanIDs, cid) diff --git a/lnwire/reply_short_chan_ids_end.go b/lnwire/reply_short_chan_ids_end.go index ce5f8f74..d77aa0b5 100644 --- a/lnwire/reply_short_chan_ids_end.go +++ b/lnwire/reply_short_chan_ids_end.go @@ -9,7 +9,7 @@ import ( // ReplyShortChanIDsEnd is a message that marks the end of a streaming message // response to an initial QueryShortChanIDs message. This marks that the // receiver of the original QueryShortChanIDs for the target chain has either -// sent all adequate responses it knows of, or doesn't now of any short chan +// sent all adequate responses it knows of, or doesn't know of any short chan // ID's for the target chain. type ReplyShortChanIDsEnd struct { // ChainHash denotes the target chain that we're respond to a short diff --git a/lnwire/revoke_and_ack.go b/lnwire/revoke_and_ack.go index d685f0f3..0cfa2bc2 100644 --- a/lnwire/revoke_and_ack.go +++ b/lnwire/revoke_and_ack.go @@ -26,7 +26,7 @@ type RevokeAndAck struct { // NextRevocationKey is the next commitment point which should be used // for the next commitment transaction the remote peer creates for us. - // This, in conjunction without revocation base point will be used to + // This, in conjunction with revocation base point will be used to // create the proper revocation key used within the commitment // transaction. NextRevocationKey *btcec.PublicKey