mirror of https://github.com/hyperledger/besu
Ibft tracks validating peers for multicasting (#101)
The Ibft consensus mechanism is responsible for sending a variety of messages to other validating nodes in the network (provided they have a point-to-point connection to them). This change tracks which nodes have connected to the IBFT subprotocol, and provides the functionality to only transmit messages to nodes which are also validators. Signed-off-by: Adrian Sutton <adrian.sutton@consensys.net>pull/2/head
tmohay
6 years ago
committed by
GitHub
parent
35bfbd7563
commit
494f7b573c
@ -0,0 +1,81 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
package tech.pegasys.pantheon.consensus.ibft.network; |
||||
|
||||
import tech.pegasys.pantheon.consensus.common.ValidatorProvider; |
||||
import tech.pegasys.pantheon.crypto.SECP256K1.PublicKey; |
||||
import tech.pegasys.pantheon.ethereum.core.Address; |
||||
import tech.pegasys.pantheon.ethereum.core.Util; |
||||
import tech.pegasys.pantheon.ethereum.p2p.api.MessageData; |
||||
import tech.pegasys.pantheon.ethereum.p2p.api.PeerConnection; |
||||
import tech.pegasys.pantheon.ethereum.p2p.api.PeerConnection.PeerNotConnected; |
||||
import tech.pegasys.pantheon.util.bytes.BytesValue; |
||||
|
||||
import java.util.Collection; |
||||
import java.util.Map; |
||||
import java.util.Objects; |
||||
|
||||
import com.google.common.collect.Maps; |
||||
import org.apache.logging.log4j.LogManager; |
||||
import org.apache.logging.log4j.Logger; |
||||
|
||||
public class IbftNetworkPeers { |
||||
|
||||
private static final Logger LOG = LogManager.getLogger(); |
||||
|
||||
private static final String PROTOCOL_NAME = "IBF"; |
||||
|
||||
private final Map<Address, PeerConnection> peerConnections = Maps.newConcurrentMap(); |
||||
private final ValidatorProvider validatorProvider; |
||||
|
||||
public IbftNetworkPeers(final ValidatorProvider validatorProvider) { |
||||
this.validatorProvider = validatorProvider; |
||||
} |
||||
|
||||
public void peerAdded(final PeerConnection newConnection) { |
||||
final Address peerAddress = getAddressFrom(newConnection); |
||||
peerConnections.put(peerAddress, newConnection); |
||||
} |
||||
|
||||
public void peerRemoved(final PeerConnection removedConnection) { |
||||
final Address peerAddress = getAddressFrom(removedConnection); |
||||
peerConnections.remove(peerAddress); |
||||
} |
||||
|
||||
public void multicastToValidators(final MessageData message) { |
||||
Collection<Address> validators = validatorProvider.getCurrentValidators(); |
||||
sendMessageToSpecificAddresses(validators, message); |
||||
} |
||||
|
||||
private void sendMessageToSpecificAddresses( |
||||
final Collection<Address> recipients, final MessageData message) { |
||||
recipients |
||||
.stream() |
||||
.map(peerConnections::get) |
||||
.filter(Objects::nonNull) |
||||
.forEach( |
||||
connection -> { |
||||
try { |
||||
connection.sendForProtocol(PROTOCOL_NAME, message); |
||||
} catch (PeerNotConnected peerNotConnected) { |
||||
LOG.trace("Lost connection to a validator."); |
||||
} |
||||
}); |
||||
} |
||||
|
||||
private Address getAddressFrom(final PeerConnection connection) { |
||||
final BytesValue peerNodeId = connection.getPeer().getNodeId(); |
||||
final PublicKey remotePublicKey = PublicKey.create(peerNodeId); |
||||
return Util.publicKeyToAddress(remotePublicKey); |
||||
} |
||||
} |
||||
@ -0,0 +1,106 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
package tech.pegasys.pantheon.consensus.ibft.network; |
||||
|
||||
import static io.netty.buffer.Unpooled.EMPTY_BUFFER; |
||||
import static org.mockito.ArgumentMatchers.any; |
||||
import static org.mockito.Mockito.mock; |
||||
import static org.mockito.Mockito.never; |
||||
import static org.mockito.Mockito.times; |
||||
import static org.mockito.Mockito.verify; |
||||
import static org.mockito.Mockito.when; |
||||
|
||||
import tech.pegasys.pantheon.consensus.common.ValidatorProvider; |
||||
import tech.pegasys.pantheon.crypto.SECP256K1.PublicKey; |
||||
import tech.pegasys.pantheon.ethereum.core.Address; |
||||
import tech.pegasys.pantheon.ethereum.core.Util; |
||||
import tech.pegasys.pantheon.ethereum.p2p.api.MessageData; |
||||
import tech.pegasys.pantheon.ethereum.p2p.api.PeerConnection; |
||||
import tech.pegasys.pantheon.ethereum.p2p.api.PeerConnection.PeerNotConnected; |
||||
import tech.pegasys.pantheon.ethereum.p2p.wire.PeerInfo; |
||||
import tech.pegasys.pantheon.ethereum.p2p.wire.RawMessage; |
||||
|
||||
import java.math.BigInteger; |
||||
import java.util.List; |
||||
|
||||
import com.google.common.collect.Lists; |
||||
import org.junit.Before; |
||||
import org.junit.Test; |
||||
import org.junit.runner.RunWith; |
||||
import org.mockito.junit.MockitoJUnitRunner; |
||||
|
||||
@RunWith(MockitoJUnitRunner.class) |
||||
public class IbftNetworkPeersTest { |
||||
|
||||
private final List<Address> validators = Lists.newArrayList(); |
||||
private final List<PublicKey> publicKeys = Lists.newArrayList(); |
||||
|
||||
private final List<PeerConnection> peerConnections = Lists.newArrayList(); |
||||
|
||||
@Before |
||||
public void setup() { |
||||
for (int i = 0; i < 4; i++) { |
||||
PublicKey pubKey = PublicKey.create(BigInteger.valueOf(i)); |
||||
publicKeys.add(pubKey); |
||||
|
||||
final PeerInfo peerInfo = mock(PeerInfo.class); |
||||
final PeerConnection peerConnection = mock(PeerConnection.class); |
||||
when(peerConnection.getPeer()).thenReturn(peerInfo); |
||||
when(peerInfo.getNodeId()).thenReturn(pubKey.getEncodedBytes()); |
||||
|
||||
peerConnections.add(peerConnection); |
||||
} |
||||
} |
||||
|
||||
@Test |
||||
public void onlyValidatorsAreSentAMessage() throws PeerNotConnected { |
||||
// Only add the first Peer's address to the validators.
|
||||
validators.add(Util.publicKeyToAddress(publicKeys.get(0))); |
||||
ValidatorProvider validatorProvider = mock(ValidatorProvider.class); |
||||
when(validatorProvider.getCurrentValidators()).thenReturn(validators); |
||||
|
||||
IbftNetworkPeers peers = new IbftNetworkPeers(validatorProvider); |
||||
for (PeerConnection peer : peerConnections) { |
||||
peers.peerAdded(peer); |
||||
} |
||||
|
||||
MessageData messageToSend = new RawMessage(1, EMPTY_BUFFER); |
||||
peers.multicastToValidators(messageToSend); |
||||
|
||||
verify(peerConnections.get(0), times(1)).sendForProtocol("IBF", messageToSend); |
||||
verify(peerConnections.get(1), never()).sendForProtocol(any(), any()); |
||||
verify(peerConnections.get(2), never()).sendForProtocol(any(), any()); |
||||
verify(peerConnections.get(3), never()).sendForProtocol(any(), any()); |
||||
} |
||||
|
||||
@Test |
||||
public void doesntSendToValidatorsWhichAreNotDirectlyConnected() throws PeerNotConnected { |
||||
validators.add(Util.publicKeyToAddress(publicKeys.get(0))); |
||||
|
||||
ValidatorProvider validatorProvider = mock(ValidatorProvider.class); |
||||
when(validatorProvider.getCurrentValidators()).thenReturn(validators); |
||||
|
||||
IbftNetworkPeers peers = new IbftNetworkPeers(validatorProvider); |
||||
|
||||
// only add peer connections 1, 2 & 3, none of which should be invoked.
|
||||
Lists.newArrayList(1, 2, 3).stream().forEach(i -> peers.peerAdded(peerConnections.get(i))); |
||||
|
||||
MessageData messageToSend = new RawMessage(1, EMPTY_BUFFER); |
||||
peers.multicastToValidators(messageToSend); |
||||
|
||||
verify(peerConnections.get(0), never()).sendForProtocol(any(), any()); |
||||
verify(peerConnections.get(1), never()).sendForProtocol(any(), any()); |
||||
verify(peerConnections.get(2), never()).sendForProtocol(any(), any()); |
||||
verify(peerConnections.get(3), never()).sendForProtocol(any(), any()); |
||||
} |
||||
} |
||||
Loading…
Reference in new issue