From d3bff47167fc5d01f121855a6a054bc85001ac88 Mon Sep 17 00:00:00 2001 From: w3irdrobot Date: Wed, 20 Nov 2024 21:18:28 -0500 Subject: [PATCH] docs: fix broadcast misspelling --- cmd/commands/peersrpc_active.go | 2 +- discovery/gossiper_test.go | 2 +- docs/release-notes/release-notes-0.19.0.md | 4 ++++ itest/lnd_channel_graph_test.go | 4 ++-- rpcserver.go | 2 +- server.go | 6 +++--- 6 files changed, 12 insertions(+), 8 deletions(-) diff --git a/cmd/commands/peersrpc_active.go b/cmd/commands/peersrpc_active.go index 0736750c73..5a1fc85e36 100644 --- a/cmd/commands/peersrpc_active.go +++ b/cmd/commands/peersrpc_active.go @@ -45,7 +45,7 @@ var updateNodeAnnouncementCommand = cli.Command{ Add or remove addresses where your node can be reached at, change the alias/color of the node or enable/disable supported feature bits without restarting the node. A node announcement with the new information will - be created and brodcasted to the network.`, + be created and broadcast to the network.`, ArgsUsage: "[--address_add=] [--address_remove=] [--alias=] " + "[--color=] [--feature_bit_add=] [--feature_bit_remove=]", Flags: []cli.Flag{ diff --git a/discovery/gossiper_test.go b/discovery/gossiper_test.go index db632cdafe..1577ce8c2c 100644 --- a/discovery/gossiper_test.go +++ b/discovery/gossiper_test.go @@ -3996,7 +3996,7 @@ func TestIgnoreOwnAnnouncement(t *testing.T) { } // Now do the local channelannouncement, node announcement, and channel - // update. No messages should be brodcasted yet, since we don't have + // update. No messages should be broadcast yet, since we don't have // the announcement signatures. select { case err = <-ctx.gossiper.ProcessLocalAnnouncement(batch.chanAnn): diff --git a/docs/release-notes/release-notes-0.19.0.md b/docs/release-notes/release-notes-0.19.0.md index 12049b40c2..227a3587ea 100644 --- a/docs/release-notes/release-notes-0.19.0.md +++ b/docs/release-notes/release-notes-0.19.0.md @@ -194,6 +194,10 @@ The underlying functionality between those two options remain the same. by replacing the word `argument` with `input` in the command description, clarifying that the command requires interactive inputs rather than arguments. +- [Fixed a few misspellings](https://github.com/lightningnetwork/lnd/pull/9290) + of "broadcast" in the code base, specifically the `lncli peers updatenodeannouncement` + command documentation. + # Contributors (Alphabetical Order) * Animesh Bilthare diff --git a/itest/lnd_channel_graph_test.go b/itest/lnd_channel_graph_test.go index 54ddd2ca21..0cd5fcf2e2 100644 --- a/itest/lnd_channel_graph_test.go +++ b/itest/lnd_channel_graph_test.go @@ -431,7 +431,7 @@ func testNodeAnnouncement(ht *lntest.HarnessTest) { } // testUpdateNodeAnnouncement ensures that the RPC endpoint validates -// the requests correctly and that the new node announcement is brodcasted +// the requests correctly and that the new node announcement is broadcast // with the right information after updating our node. func testUpdateNodeAnnouncement(ht *lntest.HarnessTest) { alice, bob := ht.Alice, ht.Bob @@ -477,7 +477,7 @@ func testUpdateNodeAnnouncement(ht *lntest.HarnessTest) { } // Get dave default information so we can compare it lately with the - // brodcasted updates. + // broadcast updates. resp := dave.RPC.GetInfo() defaultAddrs := make([]*lnrpc.NodeAddress, 0, len(resp.Uris)) for _, uri := range resp.GetUris() { diff --git a/rpcserver.go b/rpcserver.go index efb6cf54ff..fec0381b47 100644 --- a/rpcserver.go +++ b/rpcserver.go @@ -787,7 +787,7 @@ func (r *rpcServer) addDeps(s *server, macService *macaroons.Service, routerBackend, s.nodeSigner, s.graphDB, s.chanStateDB, s.sweeper, tower, s.towerClientMgr, r.cfg.net.ResolveTCPAddr, genInvoiceFeatures, genAmpInvoiceFeatures, - s.getNodeAnnouncement, s.updateAndBrodcastSelfNode, parseAddr, + s.getNodeAnnouncement, s.updateAndBroadcastSelfNode, parseAddr, rpcsLog, s.aliasMgr, r.implCfg.AuxDataParser, invoiceHtlcModifier, ) diff --git a/server.go b/server.go index c46c1a5f9e..f2deeede63 100644 --- a/server.go +++ b/server.go @@ -3250,11 +3250,11 @@ func (s *server) genNodeAnnouncement(features *lnwire.RawFeatureVector, return *s.currentNodeAnn, nil } -// updateAndBrodcastSelfNode generates a new node announcement +// updateAndBroadcastSelfNode generates a new node announcement // applying the giving modifiers and updating the time stamp -// to ensure it propagates through the network. Then it brodcasts +// to ensure it propagates through the network. Then it broadcasts // it to the network. -func (s *server) updateAndBrodcastSelfNode(features *lnwire.RawFeatureVector, +func (s *server) updateAndBroadcastSelfNode(features *lnwire.RawFeatureVector, modifiers ...netann.NodeAnnModifier) error { newNodeAnn, err := s.genNodeAnnouncement(features, modifiers...)