renamed xxxWithPrivateKey/xxxWithSk to xxxUsingPrivateKey

multiversx · Aug 30, 2022 · 704702e · 704702e
1 parent 7823d6d
commit 704702e
Show file tree

Hide file tree

Showing 14 changed files with 62 additions and 62 deletions.
diff --git a/consensus/interface.go b/consensus/interface.go
@@ -73,7 +73,7 @@ type BroadcastMessenger interface {
 // P2PMessenger defines a subset of the p2p.Messenger interface
 type P2PMessenger interface {
 	Broadcast(topic string, buff []byte)
-	BroadcastWithPrivateKey(topic string, buff []byte, pid core.PeerID, skBytes []byte)
+	BroadcastUsingPrivateKey(topic string, buff []byte, pid core.PeerID, skBytes []byte)
 	IsInterfaceNil() bool
 }
 

diff --git a/consensus/mock/messengerStub.go b/consensus/mock/messengerStub.go
@@ -4,19 +4,19 @@ import "github.com/ElrondNetwork/elrond-go-core/core"
 
 // MessengerStub -
 type MessengerStub struct {
-	BroadcastWithPrivateKeyCalled func(topic string, buff []byte, pid core.PeerID, skBytes []byte)
-	BroadcastCalled               func(topic string, buff []byte)
+	BroadcastUsingPrivateKeyCalled func(topic string, buff []byte, pid core.PeerID, skBytes []byte)
+	BroadcastCalled                func(topic string, buff []byte)
 }
 
 // Broadcast -
 func (ms *MessengerStub) Broadcast(topic string, buff []byte) {
 	ms.BroadcastCalled(topic, buff)
 }
 
-// BroadcastWithPrivateKey -
-func (ms *MessengerStub) BroadcastWithPrivateKey(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
-	if ms.BroadcastWithPrivateKeyCalled != nil {
-		ms.BroadcastWithPrivateKeyCalled(topic, buff, pid, skBytes)
+// BroadcastUsingPrivateKey -
+func (ms *MessengerStub) BroadcastUsingPrivateKey(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
+	if ms.BroadcastUsingPrivateKeyCalled != nil {
+		ms.BroadcastUsingPrivateKeyCalled(topic, buff, pid, skBytes)
 	}
 }
 

diff --git a/heartbeat/interface.go b/heartbeat/interface.go
@@ -16,10 +16,10 @@ import (
 // P2PMessenger defines a subset of the p2p.Messenger interface
 type P2PMessenger interface {
 	Broadcast(topic string, buff []byte)
-	BroadcastWithPrivateKey(topic string, buff []byte, pid core.PeerID, skBytes []byte)
+	BroadcastUsingPrivateKey(topic string, buff []byte, pid core.PeerID, skBytes []byte)
 	ID() core.PeerID
 	Sign(payload []byte) ([]byte, error)
-	SignWithPrivateKey(skBytes []byte, payload []byte) ([]byte, error)
+	SignUsingPrivateKey(skBytes []byte, payload []byte) ([]byte, error)
 	IsInterfaceNil() bool
 }
 

diff --git a/heartbeat/mock/messengerStub.go b/heartbeat/mock/messengerStub.go
@@ -6,12 +6,12 @@ import (
 
 // MessengerStub -
 type MessengerStub struct {
-	IDCalled                      func() core.PeerID
-	BroadcastCalled               func(topic string, buff []byte)
-	BroadcastWithPrivateKeyCalled func(topic string, buff []byte, pid core.PeerID, skBytes []byte)
-	SignCalled                    func(payload []byte) ([]byte, error)
-	SignWithPrivateKeyCalled      func(skBytes []byte, payload []byte) ([]byte, error)
-	VerifyCalled                  func(payload []byte, pid core.PeerID, signature []byte) error
+	IDCalled                       func() core.PeerID
+	BroadcastCalled                func(topic string, buff []byte)
+	BroadcastUsingPrivateKeyCalled func(topic string, buff []byte, pid core.PeerID, skBytes []byte)
+	SignCalled                     func(payload []byte) ([]byte, error)
+	SignUsingPrivateKeyCalled      func(skBytes []byte, payload []byte) ([]byte, error)
+	VerifyCalled                   func(payload []byte, pid core.PeerID, signature []byte) error
 }
 
 // ID -
@@ -30,10 +30,10 @@ func (ms *MessengerStub) Broadcast(topic string, buff []byte) {
 	}
 }
 
-// BroadcastWithPrivateKey -
-func (ms *MessengerStub) BroadcastWithPrivateKey(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
-	if ms.BroadcastWithPrivateKeyCalled != nil {
-		ms.BroadcastWithPrivateKeyCalled(topic, buff, pid, skBytes)
+// BroadcastUsingPrivateKey -
+func (ms *MessengerStub) BroadcastUsingPrivateKey(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
+	if ms.BroadcastUsingPrivateKeyCalled != nil {
+		ms.BroadcastUsingPrivateKeyCalled(topic, buff, pid, skBytes)
 	}
 }
 
@@ -46,10 +46,10 @@ func (ms *MessengerStub) Sign(payload []byte) ([]byte, error) {
 	return make([]byte, 0), nil
 }
 
-// SignWithPrivateKey -
-func (ms *MessengerStub) SignWithPrivateKey(skBytes []byte, payload []byte) ([]byte, error) {
-	if ms.SignWithPrivateKeyCalled != nil {
-		return ms.SignWithPrivateKeyCalled(skBytes, payload)
+// SignUsingPrivateKey -
+func (ms *MessengerStub) SignUsingPrivateKey(skBytes []byte, payload []byte) ([]byte, error) {
+	if ms.SignUsingPrivateKeyCalled != nil {
+		return ms.SignUsingPrivateKeyCalled(skBytes, payload)
 	}
 
 	return make([]byte, 0), nil

diff --git a/heartbeat/sender/commonPeerAuthenticationSender.go b/heartbeat/sender/commonPeerAuthenticationSender.go
@@ -40,7 +40,7 @@ func (cpas *commonPeerAuthenticationSender) generateMessageBytes(
 	msg.Payload = payloadBytes
 
 	if p2pSkBytes != nil {
-		msg.PayloadSignature, err = cpas.messenger.SignWithPrivateKey(p2pSkBytes, payloadBytes)
+		msg.PayloadSignature, err = cpas.messenger.SignUsingPrivateKey(p2pSkBytes, payloadBytes)
 		if err != nil {
 			return nil, isTriggered, err
 		}

diff --git a/heartbeat/sender/multikeyPeerAuthenticationSender.go b/heartbeat/sender/multikeyPeerAuthenticationSender.go
@@ -195,7 +195,7 @@ func (sender *multikeyPeerAuthenticationSender) sendData(pkBytes []byte, data []
 		log.Error("could not get identity for pk", "pk", hex.EncodeToString(pkBytes), "error", err)
 		return
 	}
-	sender.messenger.BroadcastWithPrivateKey(sender.topic, data, pid, p2pSk)
+	sender.messenger.BroadcastUsingPrivateKey(sender.topic, data, pid, p2pSk)
 
 	nextTimeToCheck, err := sender.keysHolder.GetNextPeerAuthenticationTime(pkBytes)
 	if err != nil {

diff --git a/heartbeat/sender/multikeyPeerAuthenticationSender_test.go b/heartbeat/sender/multikeyPeerAuthenticationSender_test.go
@@ -131,7 +131,7 @@ func createMockMultikeyPeerAuthenticationSenderArgsSemiIntegrationTests(
 	}
 
 	messenger := &mock.MessengerStub{
-		SignWithPrivateKeyCalled: func(skBytes []byte, payload []byte) ([]byte, error) {
+		SignUsingPrivateKeyCalled: func(skBytes []byte, payload []byte) ([]byte, error) {
 			p2pSk, _ := keyGenForP2P.PrivateKeyFromByteArray(skBytes)
 
 			return signerMessenger.Sign(p2pSk, payload)
@@ -332,7 +332,7 @@ func TestNewMultikeyPeerAuthenticationSender_Execute(t *testing.T) {
 		var skBytesBroadcast [][]byte
 
 		args, messenger := createMockMultikeyPeerAuthenticationSenderArgsSemiIntegrationTests(numKeys)
-		messenger.BroadcastWithPrivateKeyCalled = func(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
+		messenger.BroadcastUsingPrivateKeyCalled = func(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
 			assert.Equal(t, args.topic, topic)
 
 			mutData.Lock()
@@ -359,7 +359,7 @@ func TestNewMultikeyPeerAuthenticationSender_Execute(t *testing.T) {
 		var skBytesBroadcast [][]byte
 
 		args, messenger := createMockMultikeyPeerAuthenticationSenderArgsSemiIntegrationTests(numKeys)
-		messenger.BroadcastWithPrivateKeyCalled = func(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
+		messenger.BroadcastUsingPrivateKeyCalled = func(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
 			assert.Equal(t, args.topic, topic)
 
 			mutData.Lock()
@@ -404,7 +404,7 @@ func TestNewMultikeyPeerAuthenticationSender_Execute(t *testing.T) {
 		var skBytesBroadcast [][]byte
 
 		args, messenger := createMockMultikeyPeerAuthenticationSenderArgsSemiIntegrationTests(numKeys)
-		messenger.BroadcastWithPrivateKeyCalled = func(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
+		messenger.BroadcastUsingPrivateKeyCalled = func(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
 			assert.Equal(t, args.topic, topic)
 
 			mutData.Lock()
@@ -463,7 +463,7 @@ func TestNewMultikeyPeerAuthenticationSender_Execute(t *testing.T) {
 		var skBytesBroadcast [][]byte
 
 		args, messenger := createMockMultikeyPeerAuthenticationSenderArgsSemiIntegrationTests(numKeys)
-		messenger.BroadcastWithPrivateKeyCalled = func(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
+		messenger.BroadcastUsingPrivateKeyCalled = func(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
 			assert.Equal(t, args.topic, topic)
 
 			mutData.Lock()
@@ -526,7 +526,7 @@ func TestNewMultikeyPeerAuthenticationSender_Execute(t *testing.T) {
 		var skBytesBroadcast [][]byte
 
 		args, messenger := createMockMultikeyPeerAuthenticationSenderArgsSemiIntegrationTests(numKeys)
-		messenger.BroadcastWithPrivateKeyCalled = func(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
+		messenger.BroadcastUsingPrivateKeyCalled = func(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
 			assert.Equal(t, args.topic, topic)
 
 			mutData.Lock()
@@ -589,7 +589,7 @@ func TestNewMultikeyPeerAuthenticationSender_Execute(t *testing.T) {
 		var skBytesBroadcast [][]byte
 
 		args, messenger := createMockMultikeyPeerAuthenticationSenderArgsSemiIntegrationTests(numKeys)
-		messenger.BroadcastWithPrivateKeyCalled = func(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
+		messenger.BroadcastUsingPrivateKeyCalled = func(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
 			assert.Equal(t, args.topic, topic)
 
 			mutData.Lock()

diff --git a/p2p/crypto/p2pSigner.go b/p2p/crypto/p2pSigner.go
@@ -52,8 +52,8 @@ func (signer *p2pSigner) Verify(payload []byte, pid core.PeerID, signature []byt
 	return nil
 }
 
-// SignWithPrivateKey will sign the payload with provided private key bytes
-func (signer *p2pSigner) SignWithPrivateKey(skBytes []byte, payload []byte) ([]byte, error) {
+// SignUsingPrivateKey will sign the payload with provided private key bytes
+func (signer *p2pSigner) SignUsingPrivateKey(skBytes []byte, payload []byte) ([]byte, error) {
 	sk, err := libp2pCrypto.UnmarshalPrivateKey(skBytes)
 	if err != nil {
 		return nil, err

diff --git a/p2p/crypto/p2pSigner_test.go b/p2p/crypto/p2pSigner_test.go
@@ -105,7 +105,7 @@ func TestP2pSigner_Verify(t *testing.T) {
 	})
 }
 
-func TestP2PSigner_SignWithPrivateKey(t *testing.T) {
+func TestP2PSigner_SignUsingPrivateKey(t *testing.T) {
 	t.Parallel()
 
 	payload := []byte("payload")
@@ -120,10 +120,10 @@ func TestP2PSigner_SignWithPrivateKey(t *testing.T) {
 
 	p2pSigner := &p2pSigner{}
 
-	sig1, err := p2pSigner.SignWithPrivateKey(skBytes1, payload)
+	sig1, err := p2pSigner.SignUsingPrivateKey(skBytes1, payload)
 	assert.Nil(t, err)
 
-	sig2, err := p2pSigner.SignWithPrivateKey(skBytes2, payload)
+	sig2, err := p2pSigner.SignUsingPrivateKey(skBytes2, payload)
 	assert.Nil(t, err)
 	assert.NotEqual(t, sig1, sig2)
 
@@ -165,7 +165,7 @@ func TestP2pSigner_ConcurrentOperations(t *testing.T) {
 				errVerify := signer.Verify(payload1, pid, sig1)
 				assert.Nil(t, errVerify)
 			case 2:
-				_, errSignWithSK := signer.SignWithPrivateKey(skBytes, payload3)
+				_, errSignWithSK := signer.SignUsingPrivateKey(skBytes, payload3)
 				assert.Nil(t, errSignWithSK)
 			}
 

diff --git a/p2p/libp2p/interface.go b/p2p/libp2p/interface.go
@@ -25,5 +25,5 @@ type PeerDiscovererWithSharder interface {
 type p2pSigner interface {
 	Sign(payload []byte) ([]byte, error)
 	Verify(payload []byte, pid core.PeerID, signature []byte) error
-	SignWithPrivateKey(skBytes []byte, payload []byte) ([]byte, error)
+	SignUsingPrivateKey(skBytes []byte, payload []byte) ([]byte, error)
 }
diff --git a/p2p/libp2p/netMessenger.go b/p2p/libp2p/netMessenger.go
@@ -926,9 +926,9 @@ func (netMes *networkMessenger) Broadcast(topic string, buff []byte) {
 	netMes.BroadcastOnChannel(topic, topic, buff)
 }
 
-// BroadcastOnChannelBlockingWithPrivateKey tries to send a byte buffer onto a topic using provided channel
+// BroadcastOnChannelBlockingUsingPrivateKey tries to send a byte buffer onto a topic using provided channel
 // It is a blocking method. It needs to be launched on a go routine
-func (netMes *networkMessenger) BroadcastOnChannelBlockingWithPrivateKey(
+func (netMes *networkMessenger) BroadcastOnChannelBlockingUsingPrivateKey(
 	channel string,
 	topic string,
 	buff []byte,
@@ -963,30 +963,30 @@ func (netMes *networkMessenger) BroadcastOnChannelBlockingWithPrivateKey(
 	return nil
 }
 
-// BroadcastOnChannelWithPrivateKey tries to send a byte buffer onto a topic using provided channel
-func (netMes *networkMessenger) BroadcastOnChannelWithPrivateKey(
+// BroadcastOnChannelUsingPrivateKey tries to send a byte buffer onto a topic using provided channel
+func (netMes *networkMessenger) BroadcastOnChannelUsingPrivateKey(
 	channel string,
 	topic string,
 	buff []byte,
 	pid core.PeerID,
 	skBytes []byte,
 ) {
 	go func() {
-		err := netMes.BroadcastOnChannelBlockingWithPrivateKey(channel, topic, buff, pid, skBytes)
+		err := netMes.BroadcastOnChannelBlockingUsingPrivateKey(channel, topic, buff, pid, skBytes)
 		if err != nil {
 			log.Warn("p2p broadcast", "error", err.Error())
 		}
 	}()
 }
 
-// BroadcastWithPrivateKey tries to send a byte buffer onto a topic using the topic name as channel
-func (netMes *networkMessenger) BroadcastWithPrivateKey(
+// BroadcastUsingPrivateKey tries to send a byte buffer onto a topic using the topic name as channel
+func (netMes *networkMessenger) BroadcastUsingPrivateKey(
 	topic string,
 	buff []byte,
 	pid core.PeerID,
 	skBytes []byte,
 ) {
-	netMes.BroadcastOnChannelWithPrivateKey(topic, topic, buff, pid, skBytes)
+	netMes.BroadcastOnChannelUsingPrivateKey(topic, topic, buff, pid, skBytes)
 }
 
 // RegisterMessageProcessor registers a message process on a topic. The function allows registering multiple handlers

diff --git a/p2p/libp2p/netMessenger_test.go b/p2p/libp2p/netMessenger_test.go
@@ -1937,7 +1937,7 @@ func TestLibp2pMessenger_ConnectionTopic(t *testing.T) {
 	})
 }
 
-func TestNetworkMessenger_BroadcastWithPrivateKey(t *testing.T) {
+func TestNetworkMessenger_BroadcastUsingPrivateKey(t *testing.T) {
 	if testing.Short() {
 		t.Skip("this is not a short test")
 	}
@@ -1969,7 +1969,7 @@ func TestNetworkMessenger_BroadcastWithPrivateKey(t *testing.T) {
 	assert.Nil(t, err)
 	fmt.Printf("new identity: %s\n", pid.Pretty())
 
-	mes1.BroadcastWithPrivateKey(topic, msg, pid, skBuff)
+	mes1.BroadcastUsingPrivateKey(topic, msg, pid, skBuff)
 
 	time.Sleep(time.Second * 2)
 

diff --git a/p2p/p2p.go b/p2p/p2p.go
@@ -149,8 +149,8 @@ type Messenger interface {
 	// through a specified channel.
 	BroadcastOnChannel(channel string, topic string, buff []byte)
 
-	// BroadcastWithPrivateKey tries to send a byte buffer onto a topic using the topic name as channel
-	BroadcastWithPrivateKey(topic string, buff []byte, pid core.PeerID, skBytes []byte)
+	// BroadcastUsingPrivateKey tries to send a byte buffer onto a topic using the topic name as channel
+	BroadcastUsingPrivateKey(topic string, buff []byte, pid core.PeerID, skBytes []byte)
 
 	// Broadcast is a convenience function that calls BroadcastOnChannelBlocking,
 	// but implicitly sets the channel to be identical to the specified topic.
@@ -172,7 +172,7 @@ type Messenger interface {
 	WaitForConnections(maxWaitingTime time.Duration, minNumOfPeers uint32)
 	Sign(payload []byte) ([]byte, error)
 	Verify(payload []byte, pid core.PeerID, signature []byte) error
-	SignWithPrivateKey(skBytes []byte, payload []byte) ([]byte, error)
+	SignUsingPrivateKey(skBytes []byte, payload []byte) ([]byte, error)
 
 	// IsInterfaceNil returns true if there is no value under the interface
 	IsInterfaceNil() bool

diff --git a/testscommon/p2pmocks/messengerStub.go b/testscommon/p2pmocks/messengerStub.go
@@ -42,8 +42,8 @@ type MessengerStub struct {
 	WaitForConnectionsCalled               func(maxWaitingTime time.Duration, minNumOfPeers uint32)
 	SignCalled                             func(payload []byte) ([]byte, error)
 	VerifyCalled                           func(payload []byte, pid core.PeerID, signature []byte) error
-	BroadcastWithPrivateKeyCalled          func(topic string, buff []byte, pid core.PeerID, skBytes []byte)
-	SignWithPrivateKeyCalled               func(skBytes []byte, payload []byte) ([]byte, error)
+	BroadcastUsingPrivateKeyCalled         func(topic string, buff []byte, pid core.PeerID, skBytes []byte)
+	SignUsingPrivateKeyCalled              func(skBytes []byte, payload []byte) ([]byte, error)
 }
 
 // ConnectedFullHistoryPeersOnTopic -
@@ -337,17 +337,17 @@ func (ms *MessengerStub) Verify(payload []byte, pid core.PeerID, signature []byt
 	return nil
 }
 
-// BroadcastWithPrivateKey -
-func (ms *MessengerStub) BroadcastWithPrivateKey(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
-	if ms.BroadcastWithPrivateKeyCalled != nil {
-		ms.BroadcastWithPrivateKeyCalled(topic, buff, pid, skBytes)
+// BroadcastUsingPrivateKey -
+func (ms *MessengerStub) BroadcastUsingPrivateKey(topic string, buff []byte, pid core.PeerID, skBytes []byte) {
+	if ms.BroadcastUsingPrivateKeyCalled != nil {
+		ms.BroadcastUsingPrivateKeyCalled(topic, buff, pid, skBytes)
 	}
 }
 
-// SignWithPrivateKey -
-func (ms *MessengerStub) SignWithPrivateKey(skBytes []byte, payload []byte) ([]byte, error) {
-	if ms.SignWithPrivateKeyCalled != nil {
-		return ms.SignWithPrivateKeyCalled(skBytes, payload)
+// SignUsingPrivateKey -
+func (ms *MessengerStub) SignUsingPrivateKey(skBytes []byte, payload []byte) ([]byte, error) {
+	if ms.SignUsingPrivateKeyCalled != nil {
+		return ms.SignUsingPrivateKeyCalled(skBytes, payload)
 	}
 
 	return make([]byte, 0), nil