implement submitpackage call

remove venv

implement submitpackage call

add test, format log messages, improve docs

implement submitpackage method

fix linter error

implement submitpackage call

Author: f321x

.gitignore

@@ -10,6 +10,7 @@ docs/_build
 /dist
 /electrumx.egg-info
 /e_x.egg-info
+/venv
 .vscode/
 .mypy_cache/
 .idea/

docs/protocol-changes.rst

@@ -175,3 +175,12 @@ New methods
 -----------
 
   * :func:`blockchain.name.get_value_proof` to resolve a name (with proof).  Name index coins (e.g. Namecoin) only.
+
+
+Version 1.4.4
+=============
+
+New methods
+-----------
+
+  * :func:`blockchain.transaction.broadcast_package` to broadcast a package of transactions (submitpackage).

docs/protocol-methods.rst

@@ -537,6 +537,53 @@ Protocol version 1.0 returning an error as the result:
 
   "258: txn-mempool-conflict"
 
+blockchain.transaction.broadcast_package
+========================================
+
+Broadcast a package of transactions to the network (submitpackage). The package must consist of a child with its parents,
+and none of the parents may depend on one another.
+
+**Signature**
+
+  .. function:: blockchain.transaction.broadcast_package([raw_txs])
+
+  *[raw_txs]*
+
+    An array of raw transactions as hexadecimal strings.
+
+**Result**
+
+  The Bitcoin Core daemon result according to its RPC API documentation.
+
+**Result Example**
+
+::
+
+    {                                   (json object)
+      "package_msg" : "str",            (string) The transaction package result message. "success" indicates all transactions were accepted into or are already in the mempool.
+      "tx-results" : {                  (json object) transaction results keyed by wtxid
+        "wtxid" : {                     (json object) transaction wtxid
+          "txid" : "hex",               (string) The transaction hash in hex
+          "other-wtxid" : "hex",        (string, optional) The wtxid of a different transaction with the same txid but different witness found in the mempool. This means the submitted transaction was ignored.
+          "vsize" : n,                  (numeric, optional) Sigops-adjusted virtual transaction size.
+          "fees" : {                    (json object, optional) Transaction fees
+            "base" : n,                 (numeric) transaction fee in BTC
+            "effective-feerate" : n,    (numeric, optional) if the transaction was not already in the mempool, the effective feerate in BTC per KvB. For example, the package feerate and/or feerate with modified fees from prioritisetransaction.
+            "effective-includes" : [    (json array, optional) if effective-feerate is provided, the wtxids of the transactions whose fees and vsizes are included in effective-feerate.
+              "hex",                    (string) transaction wtxid in hex
+              ...
+            ]
+          },
+          "error" : "str"               (string, optional) The transaction error string, if it was rejected by the mempool
+        },
+        ...
+      },
+      "replaced-transactions" : [       (json array, optional) List of txids of replaced transactions
+        "hex",                          (string) The transaction id
+        ...
+      ]
+    }
+
 blockchain.transaction.get
 ==========================
 

electrumx/server/daemon.py

@@ -13,7 +13,7 @@
 import time
 from calendar import timegm
 from struct import pack
-from typing import TYPE_CHECKING, Type
+from typing import TYPE_CHECKING, Type, List
 
 import aiohttp
 from aiorpcx import JSONRPC
@@ -310,6 +310,10 @@ async def broadcast_transaction(self, raw_tx):
         '''Broadcast a transaction to the network.'''
         return await self._send_single('sendrawtransaction', (raw_tx, ))
 
+    async def broadcast_package(self, raw_txs: List[str]):
+        """Broadcast a package of transactions to the network using 'submitpackage'."""
+        return await self._send_single('submitpackage', (raw_txs, ))
+
     async def height(self):
         '''Query the daemon for its current height.'''
         self._height = await self._send_single('getblockcount')

electrumx/server/session.py

@@ -15,10 +15,11 @@
 import os
 import ssl
 import time
+import traceback
 from collections import defaultdict
 from functools import partial
 from ipaddress import IPv4Address, IPv6Address, IPv4Network, IPv6Network
-from typing import Optional, TYPE_CHECKING
+from typing import Optional, TYPE_CHECKING, List
 import asyncio
 
 import attr
@@ -786,6 +787,11 @@ async def broadcast_transaction(self, raw_tx):
         self.txs_sent += 1
         return hex_hash
 
+    async def broadcast_package(self, tx_package: List[str]) -> dict:
+        result = await self.daemon.broadcast_package(tx_package)
+        self.txs_sent += len(tx_package)
+        return result
+
     async def limited_history(self, hashX):
         '''Returns a pair (history, cost).
 
@@ -978,7 +984,7 @@ class ElectrumX(SessionBase):
     '''A TCP server that handles incoming Electrum connections.'''
 
     PROTOCOL_MIN = (1, 4)
-    PROTOCOL_MAX = (1, 4, 3)
+    PROTOCOL_MAX = (1, 4, 4)
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -1468,6 +1474,40 @@ async def transaction_broadcast(self, raw_tx):
             self.logger.info(f'sent tx: {hex_hash}')
             return hex_hash
 
+    async def package_broadcast(self, tx_package: List[str]):
+        """Broadcast a package of raw transactions to the network (submitpackage).
+        The package must consist of a child with its parents,
+        and none of the parents may depend on one another.
+
+        raw_txs: a list of raw transactions as hexadecimal strings"""
+        self.bump_cost(0.25 + sum(len(tx) / 5000 for tx in tx_package))
+        try:
+            txids = [sha256(bytes.fromhex(tx)).hex() for tx in tx_package]
+            result = await self.session_mgr.broadcast_package(tx_package)
+        except ValueError:
+            self.logger.info(f"error calculating txids: {traceback.format_exc()}")
+            raise RPCError(
+                BAD_REQUEST,
+                f'not a valid hex encoded transaction package: {tx_package}')
+        except DaemonError as e:
+            error, = e.args
+            message = error['message']
+            self.logger.info(f"error submitting package: {message}")
+            raise RPCError(BAD_REQUEST, 'the tx package was rejected by '
+                           f'network rules.\n\n{message}. Package txids: {txids}')
+        else:
+            self.txs_sent += len(tx_package)
+            client_ver = util.protocol_tuple(self.client)
+            if client_ver != (0, ):
+                msg = self.coin.warn_old_client_on_tx_broadcast(client_ver)
+                if msg:
+                    self.logger.info(f'sent package: {txids}. and warned user to upgrade their '
+                                     f'client from {self.client}')
+                    return msg
+
+            self.logger.info(f'broadcasted package: {txids}')
+            return result
+
     async def transaction_get(self, tx_hash, verbose=False):
         '''Return the serialized raw transaction given its hash
 
@@ -1555,7 +1595,8 @@ def set_request_handlers(self, ptuple):
 
         if ptuple >= (1, 4, 2):
             handlers['blockchain.scripthash.unsubscribe'] = self.scripthash_unsubscribe
-
+        if ptuple >= (1, 4, 4):
+            handlers['blockchain.transaction.broadcast_package'] = self.package_broadcast
         self.request_handlers = handlers
 
 

tests/server/test_daemon.py

@@ -237,6 +237,12 @@ async def test_broadcast_transaction(daemon):
     daemon.session = ClientSessionGood(('sendrawtransaction', [raw_tx], tx_hash))
     assert await daemon.broadcast_transaction(raw_tx) == tx_hash
 
+@pytest.mark.asyncio
+async def test_broadcast_package(daemon):
+    package = ["deadbeef", "deadc0de", "facefeed"]
+    result = {"package_msg": "success"}
+    daemon.session = ClientSessionGood(('submitpackage', [package], result))
+    assert await daemon.broadcast_package(package) == result
 
 @pytest.mark.asyncio
 async def test_relayfee(daemon):