From 852a8d8746c371151b215e9e9f79825ff93a5b85 Mon Sep 17 00:00:00 2001 From: chloefeal <188809157+chloefeal@users.noreply.github.com> Date: Wed, 25 Dec 2024 23:06:33 +0800 Subject: [PATCH] chore: fix typo --- build/sub_logger.go | 2 +- chainio/consumer_test.go | 2 +- chainio/dispatcher_test.go | 4 ++-- chainntnfs/bitcoindnotify/bitcoind.go | 2 +- chainntnfs/btcdnotify/btcd.go | 2 +- channeldb/revocation_log_test.go | 2 +- contractcourt/breach_arbitrator.go | 4 ++-- contractcourt/htlc_timeout_resolver.go | 4 ++-- discovery/gossiper_test.go | 2 +- docs/code_contribution_guidelines.md | 2 +- itest/lnd_switch_test.go | 16 ++++++++-------- 11 files changed, 21 insertions(+), 21 deletions(-) diff --git a/build/sub_logger.go b/build/sub_logger.go index 2a68e6cd5..92f52ac23 100644 --- a/build/sub_logger.go +++ b/build/sub_logger.go @@ -11,7 +11,7 @@ import ( // SubLogCreator can be used to create a new logger for a particular subsystem. type SubLogCreator interface { - // Logger returns a new logger for a particular subsytem. + // Logger returns a new logger for a particular subsystem. Logger(subsystemTag string) btclog.Logger } diff --git a/chainio/consumer_test.go b/chainio/consumer_test.go index d1cabf316..50123fa83 100644 --- a/chainio/consumer_test.go +++ b/chainio/consumer_test.go @@ -121,7 +121,7 @@ func TestProcessBlockConsumerQuitAfterSend(t *testing.T) { require.Equal(t, mockBeat, beat) // Instead of sending nil to the consumer's error channel, close the - // quit chanel. + // quit channel. close(quitChan) // Assert ProcessBlock returned nil. diff --git a/chainio/dispatcher_test.go b/chainio/dispatcher_test.go index 11abbeb65..1cab5b998 100644 --- a/chainio/dispatcher_test.go +++ b/chainio/dispatcher_test.go @@ -120,7 +120,7 @@ func TestDispatchSequential(t *testing.T) { // prevConsumer specifies the previous consumer that was called. var prevConsumer string - // Mock the ProcessBlock on consumers to reutrn immediately. + // Mock the ProcessBlock on consumers to return immediately. consumer1.On("ProcessBlock", mockBeat).Return(nil).Run( func(args mock.Arguments) { // Check the order of the consumers. @@ -260,7 +260,7 @@ func TestDispatchBlocks(t *testing.T) { b.RegisterQueue([]Consumer{consumer}) // Mock the consumer to return nil error on ProcessBlock. This - // implictly asserts that the step `notifyQueues` is successfully + // implicitly asserts that the step `notifyQueues` is successfully // reached in the `dispatchBlocks` method. consumer.On("ProcessBlock", mock.Anything).Return(nil).Once() diff --git a/chainntnfs/bitcoindnotify/bitcoind.go b/chainntnfs/bitcoindnotify/bitcoind.go index 59c03d517..20e09d7f2 100644 --- a/chainntnfs/bitcoindnotify/bitcoind.go +++ b/chainntnfs/bitcoindnotify/bitcoind.go @@ -491,7 +491,7 @@ out: func (b *BitcoindNotifier) handleRelevantTx(tx *btcutil.Tx, mempool bool, height uint32) { - // If this is a mempool spend, we'll ask the mempool notifier to hanlde + // If this is a mempool spend, we'll ask the mempool notifier to handle // it. if mempool { err := b.memNotifier.ProcessRelevantSpendTx(tx) diff --git a/chainntnfs/btcdnotify/btcd.go b/chainntnfs/btcdnotify/btcd.go index e3bff289c..d5750ec2a 100644 --- a/chainntnfs/btcdnotify/btcd.go +++ b/chainntnfs/btcdnotify/btcd.go @@ -539,7 +539,7 @@ out: func (b *BtcdNotifier) handleRelevantTx(tx *btcutil.Tx, mempool bool, height uint32) { - // If this is a mempool spend, we'll ask the mempool notifier to hanlde + // If this is a mempool spend, we'll ask the mempool notifier to handle // it. if mempool { err := b.memNotifier.ProcessRelevantSpendTx(tx) diff --git a/channeldb/revocation_log_test.go b/channeldb/revocation_log_test.go index 2df6627e2..dcce16a03 100644 --- a/channeldb/revocation_log_test.go +++ b/channeldb/revocation_log_test.go @@ -565,7 +565,7 @@ func TestPutRevocationLog(t *testing.T) { }, { // Test dust htlc is not saved. - name: "dust htlc not saved with amout data", + name: "dust htlc not saved with amount data", commit: testCommitDust, ourIndex: 0, theirIndex: 1, diff --git a/contractcourt/breach_arbitrator.go b/contractcourt/breach_arbitrator.go index 33bc7f7e3..d11b725ed 100644 --- a/contractcourt/breach_arbitrator.go +++ b/contractcourt/breach_arbitrator.go @@ -1719,7 +1719,7 @@ func NewRetributionStore(db kvdb.Backend) *RetributionStore { } // taprootBriefcaseFromRetInfo creates a taprootBriefcase from a retribution -// info struct. This stores all the tap tweak informatoin we need to inrder to +// info struct. This stores all the tap tweak information we need to inrder to // be able to hadnel breaches after a restart. func taprootBriefcaseFromRetInfo(retInfo *retributionInfo) *taprootBriefcase { tapCase := newTaprootBriefcase() @@ -1776,7 +1776,7 @@ func taprootBriefcaseFromRetInfo(retInfo *retributionInfo) *taprootBriefcase { return tapCase } -// applyTaprootRetInfo attaches the taproot specific inforamtion in the tapCase +// applyTaprootRetInfo attaches the taproot specific information in the tapCase // to the passed retInfo struct. func applyTaprootRetInfo(tapCase *taprootBriefcase, retInfo *retributionInfo) error { diff --git a/contractcourt/htlc_timeout_resolver.go b/contractcourt/htlc_timeout_resolver.go index 872a3da92..54a6a08df 100644 --- a/contractcourt/htlc_timeout_resolver.go +++ b/contractcourt/htlc_timeout_resolver.go @@ -444,7 +444,7 @@ func (h *htlcTimeoutResolver) Resolve() (ContractResolver, error) { } // sweepTimeoutTx sends a second level timeout transaction to the sweeper. -// This transaction uses the SINLGE|ANYONECANPAY flag. +// This transaction uses the SINGLE|ANYONECANPAY flag. func (h *htlcTimeoutResolver) sweepTimeoutTx() error { var inp input.Input if h.isTaproot() { @@ -1070,7 +1070,7 @@ func (h *htlcTimeoutResolver) sweepTimeoutTxOutput() error { // TODO(yy): use the result chan returned from SweepInput to get the // confirmation status of this sweeping tx so we don't need to make - // anothe subscription via `RegisterSpendNtfn` for this outpoint here + // another subscription via `RegisterSpendNtfn` for this outpoint here // in the resolver. _, err = h.Sweeper.SweepInput( inp, diff --git a/discovery/gossiper_test.go b/discovery/gossiper_test.go index b74f69bf0..5e2ebeac4 100644 --- a/discovery/gossiper_test.go +++ b/discovery/gossiper_test.go @@ -2709,7 +2709,7 @@ func assertBroadcast(t *testing.T, ctx *testCtx, num int) []lnwire.Message { return msgs } -// assertProcessAnnouncemnt is a helper method that checks that the result of +// assertProcessAnnouncement is a helper method that checks that the result of // processing an announcement is successful. func assertProcessAnnouncement(t *testing.T, result chan error) { t.Helper() diff --git a/docs/code_contribution_guidelines.md b/docs/code_contribution_guidelines.md index 62c7d889b..68995be03 100644 --- a/docs/code_contribution_guidelines.md +++ b/docs/code_contribution_guidelines.md @@ -337,7 +337,7 @@ Examples of common patterns w.r.t commit structures within the project: small scale, fix typos, or any changes that do not modify the code, the commit message of the HEAD commit of the PR should end with `[skip ci]` to skip the CI checks. When pushing to such an existing PR, the latest commit - being pushed should end with `[skip ci]` as to not inadvertantly trigger the + being pushed should end with `[skip ci]` as to not inadvertently trigger the CI checks. ## Sign your git commits diff --git a/itest/lnd_switch_test.go b/itest/lnd_switch_test.go index 10be21613..82900c9d3 100644 --- a/itest/lnd_switch_test.go +++ b/itest/lnd_switch_test.go @@ -64,7 +64,7 @@ func testSwitchCircuitPersistence(ht *lntest.HarnessTest) { // transaction, in channel Bob->Alice->David->Carol, order is Carol, // David, Alice, Bob. var amountPaid = int64(5000) - s.assertAmoutPaid(ht, amountPaid, numPayments) + s.assertAmountPaid(ht, amountPaid, numPayments) // Lastly, we will send one more payment to ensure all channels are // still functioning properly. @@ -80,7 +80,7 @@ func testSwitchCircuitPersistence(ht *lntest.HarnessTest) { ht.CompletePaymentRequests(s.bob, payReqs) amountPaid = int64(6000) - s.assertAmoutPaid(ht, amountPaid, numPayments+1) + s.assertAmountPaid(ht, amountPaid, numPayments+1) } // testSwitchOfflineDelivery constructs a set of multihop payments, and tests @@ -136,7 +136,7 @@ func testSwitchOfflineDelivery(ht *lntest.HarnessTest) { // transaction, in channel Bob->Alice->David->Carol, order is Carol, // David, Alice, Bob. var amountPaid = int64(5000) - s.assertAmoutPaid(ht, amountPaid, numPayments) + s.assertAmountPaid(ht, amountPaid, numPayments) // Lastly, we will send one more payment to ensure all channels are // still functioning properly. @@ -152,7 +152,7 @@ func testSwitchOfflineDelivery(ht *lntest.HarnessTest) { ht.CompletePaymentRequests(s.bob, payReqs) amountPaid = int64(6000) - s.assertAmoutPaid(ht, amountPaid, numPayments+1) + s.assertAmountPaid(ht, amountPaid, numPayments+1) } // testSwitchOfflineDeliveryPersistence constructs a set of multihop payments, @@ -218,7 +218,7 @@ func testSwitchOfflineDeliveryPersistence(ht *lntest.HarnessTest) { // transaction, in channel Bob->Alice->David->Carol, order is Carol, // David, Alice, Bob. var amountPaid = int64(5000) - s.assertAmoutPaid(ht, amountPaid, numPayments) + s.assertAmountPaid(ht, amountPaid, numPayments) // Lastly, we will send one more payment to ensure all channels are // still functioning properly. @@ -238,7 +238,7 @@ func testSwitchOfflineDeliveryPersistence(ht *lntest.HarnessTest) { ht.CompletePaymentRequests(s.bob, payReqs) amountPaid = int64(6000) - s.assertAmoutPaid(ht, amountPaid, numPayments+1) + s.assertAmountPaid(ht, amountPaid, numPayments+1) } // testSwitchOfflineDeliveryOutgoingOffline constructs a set of multihop @@ -453,10 +453,10 @@ func (s *scenarioFourNodes) assertHTLCs(ht *lntest.HarnessTest, num int) { ht.AssertNumActiveHtlcs(s.carol, num) } -// assertAmoutPaid is a helper method which takes a given paid amount +// assertAmountPaid is a helper method which takes a given paid amount // and number of payments and asserts the desired payments are made in // the four nodes. -func (s *scenarioFourNodes) assertAmoutPaid(ht *lntest.HarnessTest, +func (s *scenarioFourNodes) assertAmountPaid(ht *lntest.HarnessTest, amt int64, num int64) { ht.AssertAmountPaid(