Skip to content

Commit b269a8f

Browse files
committed
broadcast_package RPC: explicitly state verbose=true is not stable
1 parent e54c0e4 commit b269a8f

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

docs/protocol-methods.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -583,9 +583,14 @@ with the child being the last element in the array.
583583

584584
If *verbose* is :const:`true`:
585585

586-
The bitcoind response according to its RPC API documentation.
587-
Note that the exact structure and semantics can depend on the bitcoind version,
588-
and hence the electrum protocol can make no guarantees about it.
586+
The result is a bitcoind-specific dictionary -- whatever bitcoind
587+
returns as response to the submitpackage (or equivalent) RPC.
588+
(`example docs <https://bitcoincore.org/en/doc/30.0.0/rpc/rawtransactions/submitpackage/>`_ for Bitcoin Core)
589+
590+
As the exact structure and semantics depend on the bitcoind version (or alternative bitcoind, e.g. btcd),
591+
the electrum protocol can make no guarantees about it.
592+
Unlike the `verbose=False` result, which is guaranteed to be stable and can be relied upon,
593+
the `verbose=True` result should be considered experimental and better-suited for debugging.
589594

590595
.. note:: The exact relay behaviour might depend on the bitcoind version of the server.
591596

@@ -614,7 +619,7 @@ When *verbose* is :const:`false`::
614619
]
615620
}
616621

617-
When *verbose* is :const:`true`::
622+
When *verbose* is :const:`true` (exact structure depends on bitcoind impl and version, and should not be relied upon)::
618623

619624
{ (json object)
620625
"package_msg" : "str", (string) The transaction package result message. "success" indicates all transactions were accepted into or are already in the mempool.

0 commit comments

Comments
 (0)