Skip to content

Commit

Permalink
Merge pull request #3 from cculianu/revert-1-master
Browse files Browse the repository at this point in the history
Revert "Add and document address and scripthash transactions subscription methods"
  • Loading branch information
cculianu committed Jul 26, 2022
2 parents e5202f7 + 73b8911 commit dc83002
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 124 deletions.
17 changes: 0 additions & 17 deletions protocol-changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -228,20 +228,3 @@ New methods
double-spent.
* :func:`blockchain.transaction.dsproof.unsubscribe` to unsubscribe from
receiving dsproof notifications for a particular transaction.

Version 1.4.6
=============

New methods
-----------

* :func:`blockchain.scripthash.transactions.subscribe` to retrieve the
notifications about new transactions involving a scripthash arriving
into the mempool.
* :func:`blockchain.scripthash.transactions.unsubscribe` to unsubscribe from a
previous subscription.
* :func:`blockchain.address.transactions.subscribe` to retrieve the
notifications about new transactions involving a cashaddr arriving
into the mempool.
* :func:`blockchain.address.transactions.unsubscribe` to unsubscribe from a
previous subscription.
107 changes: 0 additions & 107 deletions protocol-methods.rst
Original file line number Diff line number Diff line change
Expand Up @@ -190,63 +190,6 @@ its :ref:`status <status>` changes.
subscribed-to earlier, because the server can drop subscriptions in rare
circumstances.

blockchain.address.transactions.subscribe
============================

Subscribe to transactions arriving into the mempool which involve a particular
Bitcoin Cash address.

**Signature**

.. function:: blockchain.address.transactions.subscribe(address)
.. versionadded:: 1.4.6

*address*

The address as a Cash Address string (with or without prefix, case
insensitive). Some server implementations do not support Legacy (base58)
addresses and are not required to do so by this specification. However,
Fulcrum does support both Legacy and Cash Address encodings.

**Result**

The hash of the latest transaction involving this address.

**Notifications**

The client will receive a notification with address and hashes of new transactions
since last mempool synchronization. Its signature is

.. function:: blockchain.address.transactions.subscribe(address, [tx_hash])
:noindex:

.. note:: See the notes in the blockchain.address.subscribe section

blockchain.address.unsubscribe
=================================

Unsubscribe from transactions arriving into the mempool which involve a particular
Bitcoin Cash address.

**Signature**

.. function:: blockchain.address.transactions.unsubscribe(address)
.. versionadded:: 1.4.6

*address*

The address as a Cash Address string (with or without prefix, case
insensitive). Some server implementations do not support Legacy (base58)
addresses and are not required to do so by this specification. However,
Fulcrum does support both Legacy and Cash Address encodings.

**Result**

Returns :const:`true` if the address was previously subscribed-to, otherwise
:const:`false`. Note that :const:`false` might be returned even for something
subscribed-to earlier, because the server can drop subscriptions in rare
circumstances.

blockchain.block.header
=======================

Expand Down Expand Up @@ -743,56 +686,6 @@ Unsubscribe from a script hash, preventing future notifications if its :ref:`sta
subscribed-to earlier, because the server can drop subscriptions in rare
circumstances.

blockchain.scripthash.transactions.subscribe
===============================

Subscribe to transactions arriving into the mempool which involve a particular
scripthash.

**Signature**

.. function:: blockchain.scripthash.transactions.subscribe(scripthash)
.. versionadded:: 1.4.6

*scripthash*

The script hash as a hexadecimal string.

**Result**

The hash of the latest transaction involving this scripthash.

**Notifications**

The client will receive a notification with scripthash and hashes of new transactions
since last mempool synchronization. Its signature is

.. function:: blockchain.scripthash.transactions.subscribe(scripthash, [tx_hash])
:noindex:


blockchain.scripthash.transactions.unsubscribe
=================================

Unsubscribe from transactions arriving into the mempool which involve a particular
scripthash.

**Signature**

.. function:: blockchain.scripthash.transactions.unsubscribe(scripthash)
.. versionadded:: 1.4.6

*scripthash*

The script hash as a hexadecimal string.

**Result**

Returns :const:`true` if the scripthash was previously subscribed-to, otherwise
:const:`false`. Note that :const:`false` might be returned even for something
subscribed-to earlier, because the server can drop subscriptions in rare
circumstances.

blockchain.transaction.broadcast
================================

Expand Down

0 comments on commit dc83002

Please sign in to comment.