more explicit name for option to disable signed addrs

libp2p · Nov 27, 2019 · cf1cdad · cf1cdad
1 parent 028fe98
commit cf1cdad
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/p2p/protocol/identify/id_test.go b/p2p/protocol/identify/id_test.go
@@ -446,7 +446,7 @@ func TestCompatibilityWithPeersThatDoNotSupportSignedAddrs(t *testing.T) {
 	h1p := h1.ID()
 	h2p := h2.ID()
 	ids1 := identify.NewIDService(ctx, h1)
-	ids2 := identify.NewIDService(ctx, h2, identify.DisableSignedAddrSupport())
+	ids2 := identify.NewIDService(ctx, h2, identify.DisableSignedAddrSupportForTesting())
 
 	h2pi := h2.Peerstore().PeerInfo(h2p)
 	if err := h1.Connect(ctx, h2pi); err != nil {

diff --git a/p2p/protocol/identify/opts.go b/p2p/protocol/identify/opts.go
@@ -15,10 +15,11 @@ func UserAgent(ua string) Option {
 	}
 }
 
-// DisableSignedAddrSupport prevents the identify service from sending or parsing
+// DisableSignedAddrSupportForTesting prevents the identify service from sending or parsing
 // routing.SignedRoutingState messages during the exchange. Used for testing
 // compatibility with older versions that do not support signed addresses.
-func DisableSignedAddrSupport() Option {
+// Do not use in production!
+func DisableSignedAddrSupportForTesting() Option {
 	return func(cfg *config) {
 		cfg.disableSignedAddrSupport = true
 	}