Inside Bitcoin

251        blackhole_peer.send_and_ping(msg_addr())
252
253        # Confirm node has now received addr-related messages from blackhole peer
254        peerinfo = self.nodes[0].getpeerinfo()
255        assert_greater_than(self.sum_addr_messages(peerinfo[2]['bytesrecv_per_msg']), 0)
256        assert_equal(peerinfo[2]['addr_relay_enabled'], True)
257
258        msg = self.setup_addr_msg(2)
259        self.send_addr_msg(addr_source, msg, [receiver_peer, blackhole_peer])
260
261        # And that peer received addresses
262        assert_equal(blackhole_peer.num_ipv4_received, 2)
263
264        self.nodes[0].disconnect_p2ps()
265
266    def getaddr_tests(self):
267        # In the previous tests, the node answered GETADDR requests with an
268        # empty addrman. Due to GETADDR response caching (see
269        # CConnman::GetAddresses), the node would continue to provide 0 addrs
270        # in response until enough time has passed or the node is restarted.
271        self.restart_node(0)
272
273        self.log.info('Test getaddr behavior')
274        self.log.info('Check that we send a getaddr message upon connecting to an outbound-full-relay peer')
275        full_outbound_peer = self.nodes[0].add_outbound_p2p_connection(AddrReceiver(), p2p_idx=0, connection_type="outbound-full-relay")
276        full_outbound_peer.sync_with_ping()
277        assert full_outbound_peer.getaddr_received()
278
279        # to avoid the node evicting the outbound peer, protect it by announcing the most recent header to it
280        tip_header = from_hex(CBlockHeader(), self.nodes[0].getblockheader(self.nodes[0].getbestblockhash(), False))
281        full_outbound_peer.send_and_ping(msg_headers([tip_header]))
282
283        self.log.info('Check that we do not send a getaddr message to a block-relay-only, feeler or inbound peer')
284        block_relay_peer = self.nodes[0].add_outbound_p2p_connection(AddrReceiver(), p2p_idx=1, connection_type="block-relay-only")
285        block_relay_peer.sync_with_ping()
286        assert_equal(block_relay_peer.getaddr_received(), False)
287        block_relay_peer.send_and_ping(msg_headers([tip_header]))
288
289        feeler_peer = self.nodes[0].add_outbound_p2p_connection(AddrReceiver(), p2p_idx=2, connection_type="feeler")
290        # bitcoind closes feeler connections as soon as it receives a version message
291        assert_equal(feeler_peer.is_connected, False)
292        assert_equal(feeler_peer.getaddr_received(), False)
293
294        inbound_peer = self.nodes[0].add_p2p_connection(AddrReceiver(send_getaddr=False))
295        inbound_peer.sync_with_ping()
296        assert_equal(inbound_peer.getaddr_received(), False)
297        assert_equal(inbound_peer.addr_received(), False)
298
299        self.log.info('Check that we answer getaddr messages only from inbound peers')
300        # Add some addresses to addrman
301        for i in range(1000):
302            first_octet = i >> 8
303            second_octet = i % 256
304            a = f"{first_octet}.{second_octet}.1.1"
305            self.nodes[0].addpeeraddress(a, 8333)
306
307        full_outbound_peer.send_and_ping(msg_getaddr())
308        block_relay_peer.send_and_ping(msg_getaddr())
309        inbound_peer.send_and_ping(msg_getaddr())
310
311        # invoke m_next_addr_send timer, see under send_addr_msg() function for rationale
312        self.mocktime += 10 * 60
313        self.nodes[0].setmocktime(self.mocktime)
314        inbound_peer.wait_until(lambda: inbound_peer.addr_received() is True)
315
316        assert_equal(full_outbound_peer.num_ipv4_received, 0)
317        assert_equal(block_relay_peer.num_ipv4_received, 0)
318        assert inbound_peer.num_ipv4_received > 100
319
320        self.log.info('Check that we answer getaddr messages only once per connection')
321        received_addrs_before = inbound_peer.num_ipv4_received
322        with self.nodes[0].assert_debug_log(['Ignoring repeated "getaddr".']):
323            inbound_peer.send_and_ping(msg_getaddr())
324        self.mocktime += 10 * 60
325        self.nodes[0].setmocktime(self.mocktime)
326        inbound_peer.sync_with_ping()
327        received_addrs_after = inbound_peer.num_ipv4_received
328        assert_equal(received_addrs_before, received_addrs_after)
329
330        self.nodes[0].disconnect_p2ps()
331
332    def blocksonly_mode_tests(self):
333        self.log.info('Test addr relay in -blocksonly mode')
334        self.restart_node(0, ["-blocksonly", "[email protected]"])
335        self.mocktime = int(time.time())
336
337        self.log.info('Check that we send getaddr messages')
338        full_outbound_peer = self.nodes[0].add_outbound_p2p_connection(AddrReceiver(), p2p_idx=0, connection_type="outbound-full-relay")
339        full_outbound_peer.sync_with_ping()
340        assert full_outbound_peer.getaddr_received()
341
342        self.log.info('Check that we relay address messages')
343        addr_source = self.nodes[0].add_p2p_connection(P2PInterface())
344        msg = self.setup_addr_msg(2)
345        self.send_addr_msg(addr_source, msg, [full_outbound_peer])
346        assert_equal(full_outbound_peer.num_ipv4_received, 2)
347
348        self.nodes[0].disconnect_p2ps()
349
350    def send_addrs_and_test_rate_limiting(self, peer, no_relay, *, new_addrs, total_addrs):
351        """Send an addr message and check that the number of addresses processed and rate-limited is as expected"""
352
353        peer.send_and_ping(self.setup_addr_msg(new_addrs, sequential_ips=False))
354
355        peerinfo = self.nodes[0].getpeerinfo()[0]
356        addrs_processed = peerinfo['addr_processed']
357        addrs_rate_limited = peerinfo['addr_rate_limited']
358        self.log.debug(f"addrs_processed = {addrs_processed}, addrs_rate_limited = {addrs_rate_limited}")
359
360        if no_relay:
361            assert_equal(addrs_processed, 0)
362            assert_equal(addrs_rate_limited, 0)
363        else:
364            assert_equal(addrs_processed, min(total_addrs, peer.tokens))
365            assert_equal(addrs_rate_limited, max(0, total_addrs - peer.tokens))
366
367    def rate_limit_tests(self):
368        self.mocktime = int(time.time())
369        self.restart_node(0, [])
370        self.nodes[0].setmocktime(self.mocktime)
371
372        for conn_type, no_relay in [("outbound-full-relay", False), ("block-relay-only", True), ("inbound", False)]:
373            self.log.info(f'Test rate limiting of addr processing for {conn_type} peers')
374            if conn_type == "inbound":
375                peer = self.nodes[0].add_p2p_connection(AddrReceiver())
376            else:
377                peer = self.nodes[0].add_outbound_p2p_connection(AddrReceiver(), p2p_idx=0, connection_type=conn_type)
378
379            # Send 600 addresses. For all but the block-relay-only peer this should result in addresses being processed.
380            self.send_addrs_and_test_rate_limiting(peer, no_relay, new_addrs=600, total_addrs=600)
381
382            # Send 600 more addresses. For the outbound-full-relay peer (which we send a GETADDR, and thus will
383            # process up to 1001 incoming addresses), this means more addresses will be processed.
384            self.send_addrs_and_test_rate_limiting(peer, no_relay, new_addrs=600, total_addrs=1200)
385
386            # Send 10 more. As we reached the processing limit for all nodes, no more addresses should be procesesd.
387            self.send_addrs_and_test_rate_limiting(peer, no_relay, new_addrs=10, total_addrs=1210)
388
389            # Advance the time by 100 seconds, permitting the processing of 10 more addresses.
390            # Send 200 and verify that 10 are processed.
391            self.mocktime += 100
392            self.nodes[0].setmocktime(self.mocktime)
393            peer.increment_tokens(10)
394
395            self.send_addrs_and_test_rate_limiting(peer, no_relay, new_addrs=200, total_addrs=1410)
396
397            # Advance the time by 1000 seconds, permitting the processing of 100 more addresses.
398            # Send 200 and verify that 100 are processed.
399            self.mocktime += 1000
400            self.nodes[0].setmocktime(self.mocktime)
401            peer.increment_tokens(100)
402
403            self.send_addrs_and_test_rate_limiting(peer, no_relay, new_addrs=200, total_addrs=1610)
404
405            self.nodes[0].disconnect_p2ps()
406
407    def get_nodes_that_received_addr(self, peer, receiver_peer, addr_receivers,
408                                     time_interval_1, time_interval_2):
409
410        # Clean addr response related to the initial getaddr.
411        for addr_receiver in addr_receivers:
412            addr_receiver.num_ipv4_received = 0
413
414        for _ in range(10):
415            self.mocktime += time_interval_1
416            self.msg.addrs[0].time = self.mocktime + TEN_MINUTES
417            self.nodes[0].setmocktime(self.mocktime)
418            with self.nodes[0].assert_debug_log(['received: addr (31 bytes) peer=0']):
419                peer.send_and_ping(self.msg)
420                self.mocktime += time_interval_2
421                self.nodes[0].setmocktime(self.mocktime)
422                receiver_peer.sync_with_ping()
423        return [node for node in addr_receivers if node.addr_received()]
424
425    def destination_rotates_once_in_24_hours_test(self):
426        self.restart_node(0, [])
427
428        self.log.info('Test within 24 hours an addr relay destination is rotated at most once')
429        self.mocktime = int(time.time())
430        self.msg = self.setup_addr_msg(1)
431        self.addr_receivers = []
432        peer = self.nodes[0].add_p2p_connection(P2PInterface())
433        receiver_peer = self.nodes[0].add_p2p_connection(AddrReceiver())
434        addr_receivers = [self.nodes[0].add_p2p_connection(AddrReceiver()) for _ in range(20)]
435        nodes_received_addr = self.get_nodes_that_received_addr(peer, receiver_peer, addr_receivers, 0, TWO_HOURS)  # 10 intervals of 2 hours
436        # Per RelayAddress, we would announce these addrs to 2 destinations per day.
437        # Since it's at most one rotation, at most 4 nodes can receive ADDR.
438        assert_greater_than_or_equal(ADDR_DESTINATIONS_THRESHOLD, len(nodes_received_addr))
439        self.nodes[0].disconnect_p2ps()
440
441    def destination_rotates_more_than_once_over_several_days_test(self):
442        self.restart_node(0, [])
443
444        self.log.info('Test after several days an addr relay destination is rotated more than once')
445        self.msg = self.setup_addr_msg(1)
446        peer = self.nodes[0].add_p2p_connection(P2PInterface())
447        receiver_peer = self.nodes[0].add_p2p_connection(AddrReceiver())
448        addr_receivers = [self.nodes[0].add_p2p_connection(AddrReceiver()) for _ in range(20)]
449        # 10 intervals of 1 day (+ 1 hour, which should be enough to cover 30-min Poisson in most cases)
450        nodes_received_addr = self.get_nodes_that_received_addr(peer, receiver_peer, addr_receivers, ONE_DAY, ONE_HOUR)
451        # Now that there should have been more than one rotation, more than
452        # ADDR_DESTINATIONS_THRESHOLD nodes should have received ADDR.
453        assert_greater_than(len(nodes_received_addr), ADDR_DESTINATIONS_THRESHOLD)
454        self.nodes[0].disconnect_p2ps()
455
456
457if __name__ == '__main__':
458    AddrTest(__file__).main()
459