neobytes/doc/instantsend.md

## InstantSend Technical Information

InstantSend has been integrated into the Core Daemon in two ways:
* "push" notifications (ZMQ and `-instantsendnotify` cmd-line/config option);
* RPC commands.

#### ZMQ

When a "Transaction Lock" occurs the hash of the related transaction is broadcasted through ZMQ using both the `zmqpubrawtxlock` and `zmqpubhashtxlock` channels.

* `zmqpubrawtxlock`: publishes the raw transaction when locked via InstantSend
* `zmqpubhashtxlock`: publishes the transaction hash when locked via InstantSend

This mechanism has been integrated into Bitcore-Node-Dash which allows for notification to be broadcast through Insight API in one of two ways:
* WebSocket: [https://github.com/dashpay/insight-api-dash#web-socket-api](https://github.com/dashpay/insight-api-dash#web-socket-api)
* API: [https://github.com/dashpay/insight-api-dash#instantsend-transactions](https://github.com/dashpay/insight-api-dash#instantsend-transactions)

#### Command line option

When a wallet InstantSend transaction is successfully locked a shell command provided in this option is executed (`%s` in `<cmd>` is replaced by TxID):

```
-instantsendnotify=<cmd>
```

#### RPC

Details pertaining to an observed "Transaction Lock" can also be retrieved through RPC. There is a boolean field named `instantlock` which indicates whether a given transaction is locked via InstantSend. This field is present in the output of some wallet RPC commands e.g. `listsinceblock`, `gettransaction` etc. as well as in the output of some mempool RPC commands e.g. `getmempoolentry` and a couple of others like `getrawmempool` (for `verbose=true` only). For blockchain based RPC commands `instantlock` will also say `true` if this transaction was locked via LLMQ based ChainLocks (for backwards compatibility reasons).
Doc: fix broken formatting in markdown #headers (#1462) * Doc: fix broken formatting in markdown #headers Insert a space in markdown headers between the #'s and the header text. (It appears that the space is required since a github update a year ago https://github.com/blog/2100-github-pages-now-faster-and-simpler-with-jekyll-3-0) * Update REST-interface.md * Update guide-startmany.md * Update instantsend.md * Update keepass.md * Update release-process.md 2017-05-05 13:28:08 +02:00			`## InstantSend Technical Information`
fix docs (#1404) - fix info about files - add info about InstantSend 2017-03-20 02:21:04 +01:00
			`InstantSend has been integrated into the Core Daemon in two ways:`
			* "push" notifications (ZMQ and `-instantsendnotify` cmd-line/config option);
			`* RPC commands.`

Doc: fix broken formatting in markdown #headers (#1462) * Doc: fix broken formatting in markdown #headers Insert a space in markdown headers between the #'s and the header text. (It appears that the space is required since a github update a year ago https://github.com/blog/2100-github-pages-now-faster-and-simpler-with-jekyll-3-0) * Update REST-interface.md * Update guide-startmany.md * Update instantsend.md * Update keepass.md * Update release-process.md 2017-05-05 13:28:08 +02:00			`#### ZMQ`
fix docs (#1404) - fix info about files - add info about InstantSend 2017-03-20 02:21:04 +01:00
			When a "Transaction Lock" occurs the hash of the related transaction is broadcasted through ZMQ using both the `zmqpubrawtxlock` and `zmqpubhashtxlock` channels.

			* `zmqpubrawtxlock`: publishes the raw transaction when locked via InstantSend
			* `zmqpubhashtxlock`: publishes the transaction hash when locked via InstantSend

			`This mechanism has been integrated into Bitcore-Node-Dash which allows for notification to be broadcast through Insight API in one of two ways:`
Update `instantsend.md` according to PR#1628 changes (#1663) * fix instantsend.md according to PR#1628 * split examples and add an example for `listreceivedbyaddress 0` command 2017-10-04 21:34:00 +02:00			`* WebSocket: [https://github.com/dashpay/insight-api-dash#web-socket-api](https://github.com/dashpay/insight-api-dash#web-socket-api)`
			`* API: [https://github.com/dashpay/insight-api-dash#instantsend-transactions](https://github.com/dashpay/insight-api-dash#instantsend-transactions)`
fix docs (#1404) - fix info about files - add info about InstantSend 2017-03-20 02:21:04 +01:00
Doc: fix broken formatting in markdown #headers (#1462) * Doc: fix broken formatting in markdown #headers Insert a space in markdown headers between the #'s and the header text. (It appears that the space is required since a github update a year ago https://github.com/blog/2100-github-pages-now-faster-and-simpler-with-jekyll-3-0) * Update REST-interface.md * Update guide-startmany.md * Update instantsend.md * Update keepass.md * Update release-process.md 2017-05-05 13:28:08 +02:00			`#### Command line option`
fix docs (#1404) - fix info about files - add info about InstantSend 2017-03-20 02:21:04 +01:00
			When a wallet InstantSend transaction is successfully locked a shell command provided in this option is executed (`%s` in `<cmd>` is replaced by TxID):

			```
			`-instantsendnotify=<cmd>`
			```

Doc: fix broken formatting in markdown #headers (#1462) * Doc: fix broken formatting in markdown #headers Insert a space in markdown headers between the #'s and the header text. (It appears that the space is required since a github update a year ago https://github.com/blog/2100-github-pages-now-faster-and-simpler-with-jekyll-3-0) * Update REST-interface.md * Update guide-startmany.md * Update instantsend.md * Update keepass.md * Update release-process.md 2017-05-05 13:28:08 +02:00			`#### RPC`
fix docs (#1404) - fix info about files - add info about InstantSend 2017-03-20 02:21:04 +01:00
Report `instantlock: true` for transactions locked via ChainLocks (#2877) * Report `instantlock: true` for transactions locked via ChainLocks Also introduce `instantlock_internal` to show the actual lock state. * Always show instantlock_internal 2019-04-25 17:38:26 +02:00			Details pertaining to an observed "Transaction Lock" can also be retrieved through RPC. There is a boolean field named `instantlock` which indicates whether a given transaction is locked via InstantSend. This field is present in the output of some wallet RPC commands e.g. `listsinceblock`, `gettransaction` etc. as well as in the output of some mempool RPC commands e.g. `getmempoolentry` and a couple of others like `getrawmempool` (for `verbose=true` only). For blockchain based RPC commands `instantlock` will also say `true` if this transaction was locked via LLMQ based ChainLocks (for backwards compatibility reasons).