From 6e054886d8a5cded8bc764f8b397680615120df8 Mon Sep 17 00:00:00 2001 From: AdamISZ Date: Fri, 10 May 2019 17:14:19 +0200 Subject: [PATCH] Typo corrections in various comments --- channeldb/channel.go | 18 +++++++++--------- fundingmanager.go | 16 ++++++++-------- input/input.go | 2 +- input/script_utils.go | 10 +++++----- lnwallet/reservation.go | 2 +- 5 files changed, 24 insertions(+), 24 deletions(-) diff --git a/channeldb/channel.go b/channeldb/channel.go index c3318461..9d7fccc0 100644 --- a/channeldb/channel.go +++ b/channeldb/channel.go @@ -400,7 +400,7 @@ type OpenChannel struct { ChainHash chainhash.Hash // FundingOutpoint is the outpoint of the final funding transaction. - // This value uniquely and globally identities the channel within the + // This value uniquely and globally identifies the channel within the // target blockchain as specified by the chain hash parameter. FundingOutpoint wire.OutPoint @@ -1049,8 +1049,8 @@ func (c *OpenChannel) UpdateCommitment(newCommitment *ChannelCommitment) error { return fmt.Errorf("unable to store chan info: %v", err) } - // With the proper bucket fetched, we'll now write toe latest - // commitment state to dis for the target party. + // With the proper bucket fetched, we'll now write the latest + // commitment state to disk for the target party. err = putChanCommitment( chanBucket, newCommitment, true, ) @@ -1459,7 +1459,7 @@ func (c *OpenChannel) AppendRemoteCommitChain(diff *CommitDiff) error { defer c.Unlock() // If this is a restored channel, then we want to avoid mutating the - // state as all, as it's impossible to do so in a protocol compliant + // state at all, as it's impossible to do so in a protocol compliant // manner. if c.hasChanStatus(ChanStatusRestored) { return ErrNoRestoredChannelMutation @@ -1600,7 +1600,7 @@ func (c *OpenChannel) AdvanceCommitChainTail(fwdPkg *FwdPkg) error { defer c.Unlock() // If this is a restored channel, then we want to avoid mutating the - // state as all, as it's impossible to do so in a protocol compliant + // state at all, as it's impossible to do so in a protocol compliant // manner. if c.hasChanStatus(ChanStatusRestored) { return ErrNoRestoredChannelMutation @@ -1841,10 +1841,10 @@ func (c *OpenChannel) RevocationLogTail() (*ChannelCommitment, error) { } // CommitmentHeight returns the current commitment height. The commitment -// height represents the number of updates to the commitment state to data. +// height represents the number of updates to the commitment state to date. // This value is always monotonically increasing. This method is provided in // order to allow multiple instances of a particular open channel to obtain a -// consistent view of the number of channel updates to data. +// consistent view of the number of channel updates to date. func (c *OpenChannel) CommitmentHeight() (uint64, error) { c.RLock() defer c.RUnlock() @@ -2005,13 +2005,13 @@ type ChannelCloseSummary struct { // confirmed, but not yet been fully resolved. In the case of a channel // that has been cooperatively closed, it will go straight into the // fully resolved state as soon as the closing transaction has been - // confirmed. However, for channel that have been force closed, they'll + // confirmed. However, for channels that have been force closed, they'll // stay marked as "pending" until _all_ the pending funds have been // swept. IsPending bool // RemoteCurrentRevocation is the current revocation for their - // commitment transaction. However, since this the derived public key, + // commitment transaction. However, since this is the derived public key, // we don't yet have the private key so we aren't yet able to verify // that it's actually in the hash chain. RemoteCurrentRevocation *btcec.PublicKey diff --git a/fundingmanager.go b/fundingmanager.go index bc272312..e68f2473 100644 --- a/fundingmanager.go +++ b/fundingmanager.go @@ -241,7 +241,7 @@ type fundingConfig struct { // so that the channel creation process can be completed. Notifier chainntnfs.ChainNotifier - // SignMessage signs an arbitrary method with a given public key. The + // SignMessage signs an arbitrary message with a given public key. The // actual digest signed is the double sha-256 of the message. In the // case that the private key corresponding to the passed public key // cannot be located, then an error is returned. @@ -346,7 +346,7 @@ type fundingConfig struct { // fundingManager acts as an orchestrator/bridge between the wallet's // 'ChannelReservation' workflow, and the wire protocol's funding initiation // messages. Any requests to initiate the funding workflow for a channel, -// either kicked-off locally or remotely handled by the funding manager. +// either kicked-off locally or remotely are handled by the funding manager. // Once a channel's funding workflow has been completed, any local callers, the // local peer, and possibly the remote peer are notified of the completion of // the channel workflow. Additionally, any temporary or permanent access @@ -1083,7 +1083,7 @@ func (f *fundingManager) handleFundingOpen(fmsg *fundingOpenMsg) { // As we're the responder, we get to specify the number of confirmations // that we require before both of us consider the channel open. We'll - // use out mapping to derive the proper number of confirmations based on + // use our mapping to derive the proper number of confirmations based on // the amount of the channel, and also if any funds are being pushed to // us. numConfsReq := f.cfg.NumRequiredConfs(msg.FundingAmount, msg.PushAmount) @@ -1644,7 +1644,7 @@ func (f *fundingManager) handleFundingSigned(fmsg *fundingSignedMsg) { // Now that we have a finalized reservation for this funding flow, // we'll send the to be active channel to the ChainArbitrator so it can - // watch for any on-chin actions before the channel has fully + // watch for any on-chain actions before the channel has fully // confirmed. if err := f.cfg.WatchNewChannel(completeChan, peerKey); err != nil { fndgLog.Errorf("Unable to send new ChannelPoint(%v) for "+ @@ -2407,8 +2407,8 @@ func (f *fundingManager) handleFundingLocked(fmsg *fundingLockedMsg) { f.localDiscoveryMtx.Unlock() } - // First, we'll attempt to locate the channel who's funding workflow is - // being finalized by this message. We got to the database rather than + // First, we'll attempt to locate the channel whose funding workflow is + // being finalized by this message. We go to the database rather than // our reservation map as we may have restarted, mid funding flow. chanID := fmsg.msg.ChanID channel, err := f.cfg.FindChannel(chanID) @@ -2437,7 +2437,7 @@ func (f *fundingManager) handleFundingLocked(fmsg *fundingLockedMsg) { } // Launch a defer so we _ensure_ that the channel barrier is properly - // closed even if the target peer is not longer online at this point. + // closed even if the target peer is no longer online at this point. defer func() { // Close the active channel barrier signalling the readHandler // that commitment related modifications to this channel can @@ -2644,7 +2644,7 @@ func (f *fundingManager) announceChannel(localIDKey, remoteIDKey, localFundingKe } // We only send the channel proof announcement and the node announcement - // because addToRouterGraph previously send the ChannelAnnouncement and + // because addToRouterGraph previously sent the ChannelAnnouncement and // the ChannelUpdate announcement messages. The channel proof and node // announcements are broadcast to the greater network. errChan := f.cfg.SendAnnouncement(ann.chanProof) diff --git a/input/input.go b/input/input.go index 92370ec7..10366b70 100644 --- a/input/input.go +++ b/input/input.go @@ -108,7 +108,7 @@ func NewBaseInput(outpoint *wire.OutPoint, witnessType WitnessType, } // CraftInputScript returns a valid set of input scripts allowing this output -// to be spent. The returns input scripts should target the input at location +// to be spent. The returned input scripts should target the input at location // txIndex within the passed transaction. The input scripts generated by this // method support spending p2wkh, p2wsh, and also nested p2sh outputs. func (bi *BaseInput) CraftInputScript(signer Signer, txn *wire.MsgTx, diff --git a/input/script_utils.go b/input/script_utils.go index c3d49ed0..8a5a0df6 100644 --- a/input/script_utils.go +++ b/input/script_utils.go @@ -315,7 +315,7 @@ func SenderHtlcSpendRedeem(signer Signer, signDesc *SignDescriptor, return nil, err } - // The stack require to spend this output is simply the signature + // The stack required to spend this output is simply the signature // generated above under the receiver's public key, and the payment // pre-image. witnessStack := wire.TxWitness(make([][]byte, 3)) @@ -340,7 +340,7 @@ func SenderHtlcSpendTimeout(receiverSig []byte, signer Signer, // We place a zero as the first item of the evaluated witness stack in // order to force Script execution to the HTLC timeout clause. The - // second zero is require to consume the extra pop due to a bug in the + // second zero is required to consume the extra pop due to a bug in the // original OP_CHECKMULTISIG. witnessStack := wire.TxWitness(make([][]byte, 5)) witnessStack[0] = nil @@ -832,7 +832,7 @@ func CommitScriptToSelf(csvTimeout uint32, selfKey, revokeKey *btcec.PublicKey) // transaction paying to the "other" party. The constructed output is a normal // p2wkh output spendable immediately, requiring no contestation period. func CommitScriptUnencumbered(key *btcec.PublicKey) ([]byte, error) { - // This script goes to the "other" party, and it spendable immediately. + // This script goes to the "other" party, and is spendable immediately. builder := txscript.NewScriptBuilder() builder.AddOp(txscript.OP_0) builder.AddData(btcutil.Hash160(key.SerializeCompressed())) @@ -961,8 +961,8 @@ func SingleTweakBytes(commitPoint, basePoint *btcec.PublicKey) []byte { // := G*(k + sha256(commitPoint || basePoint)) // // Therefore, if a party possess the value k, the private key of the base -// point, then they are able to derive the private key by computing: compute -// the proper private key for the revokeKey by computing: +// point, then they are able to derive the proper private key for the +// revokeKey by computing: // // revokePriv := k + sha256(commitPoint || basePoint) mod N // diff --git a/lnwallet/reservation.go b/lnwallet/reservation.go index 1cfa1c26..287eead8 100644 --- a/lnwallet/reservation.go +++ b/lnwallet/reservation.go @@ -427,7 +427,7 @@ func (r *ChannelReservation) OurSignatures() ([]*input.Script, []byte) { // https://github.com/bitcoin/bips/blob/master/bip-0069.mediawiki. // Additionally, verification is performed in order to ensure that the // counterparty supplied a valid signature to our version of the commitment -// transaction. Once this method returns, caller's should broadcast the +// transaction. Once this method returns, callers should broadcast the // created funding transaction, then call .WaitForChannelOpen() which will // block until the funding transaction obtains the configured number of // confirmations. Once the method unblocks, a LightningChannel instance is