Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: integration docs update #337

Merged
merged 3 commits into from
Jan 23, 2024
Merged

docs: integration docs update #337

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b8d23f1
docs: update zmq notifications link
thephez Jan 23, 2024
0c039e6
docs: minor rewording
thephez Jan 23, 2024
201437f
docs: add chainlock wallet notification section
thephez Jan 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions docs/user/developers/integration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,9 +178,10 @@ Receiving an InstantSend Transaction introduces two requirements:
2. The ability to adjust “Confirmation Status” independently of block
confirmation.

InstantSend Status is typically determined through direct connection
with the dash daemon, `ZMQ notification <https://github.com/dashpay/dash/blob/master/doc/instantsend.md#zmq>`__,
or through the usage of an external wallet notification script.
InstantSend Status is provided by the dash daemon, typically through a direct
connection (e.g. RPC), :ref:`ZMQ notification
<core:examples-receiving-zmq-notifications>`, or through the usage of an
external wallet notification script.

Direct Connection
^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -301,9 +302,9 @@ Receiving a ChainLock introduces two requirements:
2. The ability to adjust “Confirmation Status” independently of block
confirmation.

ChainLock status is typically determined through direct connection with the Dash
daemon or by a `ZMQ notification
<https://github.com/dashpay/dash/blob/master/doc/zmq.md#usage>`__.
ChainLock status is provided by the dash daemon, typically through a direct
connection (e.g. RPC) or by a :ref:`ZMQ notification
<core:examples-receiving-zmq-notifications>`.

Direct Connection
^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -364,6 +365,15 @@ notifications and return the hash of blocks that receive a ChainLock.
});
})();

Wallet Notification
^^^^^^^^^^^^^^^^^^^

The Dash Core daemon can be configured to execute an external script whenever a
ChainLock is received. This is configured by adding the following line to the
dash.conf file::

chainlocknotify=/path/to/concurrent/safe/handler %s

Additional Resources
--------------------

Expand Down