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
@@ -25,12 +25,12 @@ type AnnounceSignatures struct {
|
||||
ShortChannelID ShortChannelID
|
||||
|
||||
// NodeSignature is the signature which contains the signed announce
|
||||
// channel message, by this signature we proof that we posses of the
|
||||
// channel message, by this signature we proof that we possess of the
|
||||
// node pub key and creating the reference node_key -> bitcoin_key.
|
||||
NodeSignature *btcec.Signature
|
||||
|
||||
// BitcoinSignature is the signature which contains the signed node
|
||||
// public key, by this signature we proof that we posses of the
|
||||
// public key, by this signature we proof that we possess of the
|
||||
// bitcoin key and and creating the reverse reference bitcoin_key ->
|
||||
// node_key.
|
||||
BitcoinSignature *btcec.Signature
|
||||
|
||||
@@ -31,7 +31,7 @@ func (c ChannelID) String() string {
|
||||
}
|
||||
|
||||
// NewChanIDFromOutPoint converts a target OutPoint into a ChannelID that is
|
||||
// usable within the network. In order to covert the OutPoint into a ChannelID,
|
||||
// usable within the network. In order to convert the OutPoint into a ChannelID,
|
||||
// we XOR the lower 2-bytes of the txid within the OutPoint with the big-endian
|
||||
// serialization of the Index of the OutPoint, truncated to 2-bytes.
|
||||
func NewChanIDFromOutPoint(op *wire.OutPoint) ChannelID {
|
||||
|
||||
@@ -8,7 +8,7 @@ import (
|
||||
"github.com/roasbeef/btcd/chaincfg/chainhash"
|
||||
)
|
||||
|
||||
// ChanUpdateFlag is a btifield that signals various options concerning a
|
||||
// ChanUpdateFlag is a bitfield that signals various options concerning a
|
||||
// particular channel edge. Each bit is to be examined in order to determine
|
||||
// how the ChannelUpdate message is to be interpreted.
|
||||
type ChanUpdateFlag uint16
|
||||
@@ -27,7 +27,7 @@ const (
|
||||
|
||||
// ChannelUpdate message is used after channel has been initially announced.
|
||||
// Each side independently announces its fees and minimum expiry for HTLCs and
|
||||
// other parameters. Also this message is used to redeclare initially setted
|
||||
// other parameters. Also this message is used to redeclare initially set
|
||||
// channel parameters.
|
||||
type ChannelUpdate struct {
|
||||
// Signature is used to validate the announced data and prove the
|
||||
|
||||
@@ -15,7 +15,7 @@ import (
|
||||
//
|
||||
// NOTE: The responder is able to send a signature without any additional
|
||||
// messages as all transactions are assembled observing BIP 69 which defines a
|
||||
// cannonical ordering for input/outputs. Therefore, both sides are able to
|
||||
// canonical ordering for input/outputs. Therefore, both sides are able to
|
||||
// arrive at an identical closure transaction as they know the order of the
|
||||
// inputs/outputs.
|
||||
type ClosingSigned struct {
|
||||
|
||||
@@ -23,7 +23,7 @@ type CommitSig struct {
|
||||
// additional data due to the piggybacking of Bob's next revocation
|
||||
// hash in his prior RevokeAndAck message, as well as the canonical
|
||||
// ordering used for all inputs/outputs within commitment transactions.
|
||||
// If initiating a new commitment state, this signature shoud ONLY
|
||||
// If initiating a new commitment state, this signature should ONLY
|
||||
// cover all of the sending party's pending log updates, and the log
|
||||
// updates of the remote party that have been ACK'd.
|
||||
CommitSig *btcec.Signature
|
||||
|
||||
+1
-1
@@ -62,7 +62,7 @@ type ErrorData []byte
|
||||
// TODO(roasbeef): remove the error code
|
||||
type Error struct {
|
||||
// ChanID references the active channel in which the error occurred
|
||||
// within. If the ChanID is all zeroes, then this error applies to the
|
||||
// within. If the ChanID is all zeros, then this error applies to the
|
||||
// entire established connection.
|
||||
ChanID ChannelID
|
||||
|
||||
|
||||
+1
-1
@@ -17,7 +17,7 @@ import (
|
||||
"github.com/roasbeef/btcutil"
|
||||
)
|
||||
|
||||
// MaxSliceLength is the maximum allowed lenth for any opaque byte slices in
|
||||
// MaxSliceLength is the maximum allowed length for any opaque byte slices in
|
||||
// the wire protocol.
|
||||
const MaxSliceLength = 65535
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ type UpdateAddHTLC struct {
|
||||
Amount MilliSatoshi
|
||||
|
||||
// PaymentHash is the payment hash to be included in the HTLC this
|
||||
// request creates. The pre-image to this HTLC must be revelaed by the
|
||||
// request creates. The pre-image to this HTLC must be revealed by the
|
||||
// upstream peer in order to fully settle the HTLC.
|
||||
PaymentHash [32]byte
|
||||
|
||||
|
||||
Reference in new issue
Block a user