aboutsummaryrefslogtreecommitdiff
path: root/test/functional/test_framework/p2p.py
diff options
context:
space:
mode:
authorJohn Newbery <john@johnnewbery.com>2020-08-17 10:10:44 +0100
committerJohn Newbery <john@johnnewbery.com>2020-08-25 10:04:25 +0100
commitd5800da5199527a366024bc80cad7fcca17d5c4a (patch)
treeb74bc29618771f17ef0f67c1e54aae38186056c1 /test/functional/test_framework/p2p.py
parent5e8df3312e47a73e747ee892face55ed9ababeea (diff)
downloadbitcoin-d5800da5199527a366024bc80cad7fcca17d5c4a.tar.xz
[test] Remove final references to mininode
Diffstat (limited to 'test/functional/test_framework/p2p.py')
-rwxr-xr-xtest/functional/test_framework/p2p.py12
1 files changed, 8 insertions, 4 deletions
diff --git a/test/functional/test_framework/p2p.py b/test/functional/test_framework/p2p.py
index 38c3c5551a..57c77e60b5 100755
--- a/test/functional/test_framework/p2p.py
+++ b/test/functional/test_framework/p2p.py
@@ -4,10 +4,14 @@
# Copyright (c) 2010-2020 The Bitcoin Core developers
# Distributed under the MIT software license, see the accompanying
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
-"""Bitcoin P2P network half-a-node.
-
-This python code was modified from ArtForz' public domain half-a-node, as
-found in the mini-node branch of http://github.com/jgarzik/pynode.
+"""Test objects for interacting with a bitcoind node over the p2p protocol.
+
+The P2PInterface objects interact with the bitcoind nodes under test using the
+node's p2p interface. They can be used to send messages to the node, and
+callbacks can be registered that execute when messages are received from the
+node. Messages are sent to/received from the node on an asyncio event loop.
+State held inside the objects must be guarded by the p2p_lock to avoid data
+races between the main testing thread and the event loop.
P2PConnection: A low-level connection object to a node's P2P interface
P2PInterface: A high-level interface object for communicating to a node over P2P