fixup! onionmessage: add BFS pathfinding for onion messages

Author: Abdulkbk

onionmessage/pathfind.go

@@ -150,8 +150,13 @@ func FindPath(ctx context.Context, graph graphdb.NodeTraverser, source,
 // ForEachNodeDirectedChannel callback when the destination is found.
 var errBFSDone = &bfsDoneError{}
 
+// bfsDoneError is a custom error type that acts as a sentinel value to signal
+// that BFS traversal has reached the destination node. Using a distinct type
+// allows callers to identify this specific condition with errors.Is.
 type bfsDoneError struct{}
 
+// Error satisfies the error interface, which is required for errBFSDone to be
+// used as a sentinel error value.
 func (e *bfsDoneError) Error() string { return "bfs done" }
 
 // reconstructPath rebuilds the path from destination back to source using the

onionmessage/pathfind_test.go

@@ -28,7 +28,7 @@ func newMockNodeTraverser() *mockNodeTraverser {
 	}
 }
 
-// addNode adds a node with the given features.
+// addNode adds a node with the given features to the mock graph.
 func (m *mockNodeTraverser) addNode(v route.Vertex,
 	features *lnwire.FeatureVector) {