Update pkg/retriever/directcandidatesource.go

Co-authored-by: Rod Vagg <rod@vagg.org>
filecoin-project · Jan 27, 2024 · bf83e4b · bf83e4b
1 parent 1c606ed
commit bf83e4b
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/pkg/retriever/directcandidatesource.go b/pkg/retriever/directcandidatesource.go
@@ -25,6 +25,9 @@ type DirectCandidateSource struct {
 
 type Option func(*DirectCandidateSource)
 
+// WithLibp2pCandidateDiscovery sets a libp2p Host for the DirectCandidateFinder.
+// If a Host is set, the providers will be queried to discover available protocols, otherwise
+// all protocols will be assumed by default.
 func WithLibp2pCandidateDiscovery(h host.Host) Option {
 	return func(d *DirectCandidateSource) {
 		d.h = h