RPC - Add getspecialtxes RPC

Related to dashpay/dash#2688

_autocrossref.yaml

@@ -398,6 +398,8 @@ DIP1:
 '`getreceivedbyaccount` RPC': rpc getreceivedbyaccount
 '`getreceivedbyaddress`': rpc getreceivedbyaddress
 '`getreceivedbyaddress` RPC': rpc getreceivedbyaddress
+'`getspecialtxes`': rpc getspecialtxes
+'`getspecialtxes` RPC': rpc getspecialtxes
 '`getspentinfo`': rpc getspentinfo
 '`getspentinfo` RPC': rpc getspentinfo
 '`getsuperblockbudget`': rpc getsuperblockbudget

_config.yml

@@ -250,6 +250,7 @@ devsearches:
     - 'GetRawTransaction': "/en/developer-reference#getrawtransaction"
     - 'GetReceivedByAccount': "/en/developer-reference#getreceivedbyaccount"
     - 'GetReceivedByAddress': "/en/developer-reference#getreceivedbyaddress"
+    - 'GetSpecialTxes': "/en/developer-reference#getspecialtxes"    
     - 'GetSpentInfo': "/en/developer-reference#getspentinfo"
     - 'GetSuperblockBudget': "/en/developer-reference#getsuperblockbudget"
     - 'GetTransaction': "/en/developer-reference#gettransaction"

_includes/devdoc/dash-core/rpcs/quick-reference.md

@@ -19,7 +19,11 @@ Use v0.n.n in abbreviation title to prevent autocrossrefing.
 <!-- Dash - Not Implemented -->
 {% assign DASH_NOT_IMPLEMENTED='**<abbr title="Not Implemented in Dash">Not Implemented</abbr>**' %}
 
-<!-- Dash Core 0.13.0.0 Nov 2018 -->
+<!-- Dash Core 0.13.0.0 Feb 2019 -->
+{% assign DASH_NEW0_13_1='**<abbr title="New in Dash Core v0.13.1">New in Dash Core 0.13.1</abbr>**' %}
+{% assign DASH_UPDATED0_13_1='**<abbr title="Updated in Dash Core v0.13.1">Updated in Dash Core 0.13.1</abbr>**' %}
+
+<!-- Dash Core 0.13.0.0 Jan 2019 -->
 {% assign DASH_NEW0_13_0='**<abbr title="New in Dash Core v0.13.0">New in Dash Core 0.13.0</abbr>**' %}
 {% assign DASH_UPDATED0_13_0='**<abbr title="Updated in Dash Core v0.13.0">Updated in Dash Core 0.13.0</abbr>**' %}
 
@@ -115,6 +119,7 @@ These RPCs are all Dash-specific and not found in Bitcoin Core
 * [GetMemPoolEntry][rpc  getmempoolentry]: {{summary_getMemPoolEntry}} {{DASH_NEW0_12_3}} {{NEW0_13_0}}
 * [GetMemPoolInfo][rpc getmempoolinfo]: {{summary_getMemPoolInfo}} {{UPDATED0_12_0}}
 * [GetRawMemPool][rpc getrawmempool]: {{summary_getRawMemPool}} {{DASH_UPDATED0_12_3}} {{UPDATED0_13_0}}
+* [GetSpecialTxes][rpc getspecialtxes]: {{summary_getSpecialTxes}} {{DASH_NEW0_13_1}}
 * [GetSpentInfo][rpc getspentinfo]: {{summary_getSpentInfo}} {{DASH_NEW0_12_1}}
 * [GetTxOut][rpc gettxout]: {{summary_getTxOut}}
 * [GetTxOutProof][rpc gettxoutproof]: {{summary_getTxOutProof}} {{NEW0_11_0}}

_includes/devdoc/dash-core/rpcs/rpcs/getrawtransaction.md

@@ -284,6 +284,7 @@ Result:
 
 *See also*
 
+* [GetSpecialTxes][rpc getspecialtxes]: {{summary_getSpecialTxes}}
 * [GetTransaction][rpc gettransaction]: {{summary_getTransaction}}
 
 {% endautocrossref %}

_includes/devdoc/dash-core/rpcs/rpcs/getspecialtxes.md

@@ -0,0 +1,222 @@
+{% comment %}
+This file is licensed under the MIT License (MIT) available on
+http://opensource.org/licenses/MIT.
+{% endcomment %}
+{% assign filename="_includes/devdoc/dash-core/rpcs/rpcs/getspecialtxes.md" %}
+
+##### GetSpecialTxes
+{% include helpers/subhead-links.md %}
+
+{% assign summary_getSpecialTxes="returns an array of special transactions found in the specified block" %}
+
+{% autocrossref %}
+
+*Added in Dash Core 0.13.1*
+
+The `getspecialtxes` RPC {{summary_getSpecialTxes}}
+
+*Parameter #1---Block hash*
+
+{% itemplate ntpd1 %}
+- n: "`blockhash`"
+  t: "string"
+  p: "Required<br>(exactly 1)"
+  d: "The block hash."
+{% enditemplate %}
+
+*Parameter #2---Special transaction type*
+
+{% itemplate ntpd1 %}
+- n: "type"
+  t: "int"
+  p: "Optional<br>(0 or 1)"
+  d: "Filter special txes by type, -1 means all types (default: -1)"
+
+{% enditemplate %}
+
+*Parameter #3---Result limit*
+
+{% itemplate ntpd1 %}
+- n: "count"
+  t: "int"
+  p: "Optional<br>(0 or 1)"
+  d: "The number of transactions to return (default: 10)"
+
+{% enditemplate %}
+
+*Parameter #4---Results to skip*
+
+{% itemplate ntpd1 %}
+- n: "skip"
+  t: "int"
+  p: "Optional<br>(0 or 1)"
+  d: "The number of transactions to skip (default: 0)"
+
+{% enditemplate %}
+
+*Parameter #5---Verbosity*
+
+{% itemplate ntpd1 %}
+- n: "verbosity"
+  t: "int"
+  p: "Optional<br>(0 or 1)"
+  d: "0 for hashes, 1 for hex-encoded data, and 2 for JSON object
+ (default: 0)"
+
+{% enditemplate %}
+
+*Result (if `verbosity` was `0`)---An array of transaction IDs*
+
+{% itemplate ntpd1 %}
+- n: "`result`"
+  t: "string (hex): array"
+  p: "Required<br>(exactly 1)"
+  d: "Array of special transaction hashes"
+{% enditemplate %}
+
+
+*Result (if `verbosity` was `1`)---An array of serialized transactions*
+
+{% itemplate ntpd1 %}
+- n: "`result`"
+  t: "string (hex): array"
+  p: "Required<br>(exactly 1)"
+  d: "Array of serialized, hex-encoded data for the special transaction(s)"
+{% enditemplate %}
+
+*Result (if `verbosity` was `2`)---An array of JSON objects*
+
+{% itemplate ntpd1 %}
+- n: "`result`"
+  t: "string (hex): array of ojbects"
+  p: "Required<br>(exactly 1)"
+  d: "Array of special transaction objects in the format of the `getrawtransaction` RPC"
+{% enditemplate %}
+
+*Example from Dash Core 0.13.1*
+
+List of Special Transactions hashes.
+
+{% highlight bash %}
+dash-cli -testnet getspecialtxes \
+0000003db0006ecaccdf5ae2cfa9d94406ef40ff65b9ec34668b87fca3da9226
+{% endhighlight %}
+
+Result:
+{% highlight json %}
+[
+  "1572a15f56307e413afe3cb7ea0017a1a3fd6d89c6c5f258cc17b2888a8e7fff",
+  "89a6dc42063e4a792ec225db64dd9426742a5d1738e8821625d2ab920a6187b2",
+  "fa3b3b0d3522becb02ddd15dd075f3d6ecc6a5a50b43c6c9f6d4703a9a8509d5"
+]
+{% endhighlight %}
+
+List of Provider Registration Special Transactions (type: 1) in serialized, hex-encoded format.
+
+{% highlight bash %}
+dash-cli -testnet getspecialtxes \
+0000003db0006ecaccdf5ae2cfa9d94406ef40ff65b9ec34668b87fca3da9226 1 10 0 1
+{% endhighlight %}
+
+Result:
+{% highlight json %}
+[
+  "0300010001ea721d7420a9b58025894d08f9fecc73b7b87ed09277fa99dad5aa028ea357e1000000006b48304502210093c409672eed335f80630d7108c108d0b85ebe4d8be0758f8a3745f617c4b57302203175063605552c89f6de7f3dadc1773d5ef773b7cc0ccf98e6c5555ea75ba307012102b21d19fec95d9863c5b12fafeb60530e1cfc51d83f49ea9bca7192abb8b83e46feffffff01c4bb609a010000001976a9142efe9f9d3b36b133364d3cccbd27db75a0fbdcb788ac00000000fd120101000000000031567fbaf591ae9d2d0e9050bebce6a311cfd900616f851a3a630aa65e53f6940000000000000000000000000000ffffad3d1ee74a43c1ad3af209f75deaeb9216fc8339fd48d376f9b007ffa44583c9908f4aaca8dd97990c56043e475723f90940ef5fd7d493152540f25f58fb8c965ee5e1be4f850a661476c1ad3af209f75deaeb9216fc8339fd48d376f9b0e8031976a91454bbd7bd7c21553612d60ab16579e51efbcb135288acc281e8bf5a0dd22dfc9f1edeef9ef248f965a79210d997da37fb3e1dec76d1a4412096809bc005c860a0215cb008e3044b972688443b0b7a31ac5a04b728e63b1b5c5489e33dd666435f93c646523ad8a1d935a58957026749cbd0a9bf7e09a77388",
+  "03000100012354b77c0f261f3d5b8424cbe67c2f27130f01c531732a08b8ae3f28aaa1b1fb000000006a473044022058323d3d9114492a7a7d350d5e3127d2dc550563968319987079c98f19ed519202204160cfe81adf1f41301136a3cbe03697baa1b14c3103b66bd839ace503dbf2630121026f83a8dad6b4695b136c399405b31d4031fd6631c469673d71eda479157ef9dcfeffffff0106b8609a010000001976a9142a855dc127bfdd5cc0ab73b71ff126e49aa409c488ac00000000fd1201010000000000b60dcb8bab5aba47435942c36ca4ee74ea5b662f4d7c7b528ce341915b2d5aec0100000000000000000000000000ffffad3d1ee74a428d3433cb6b9a1a29fdf07613172bbfdab744889689e308c9d2d8a3cb35f9d7bb7220b1eca82c952b82111119670dacae18a509628c775287e4e796128cd6379b80dffd7d8d3433cb6b9a1a29fdf07613172bbfdab744889610271976a91454bbd7bd7c21553612d60ab16579e51efbcb135288ac512010a2b992d7d5c1e1f999852855cc55162800025cfdf3b56c74e4734a2d97411f858532607cbd8848452dab1f216650def1d11a5abf3fa464c9ffcc7fec894a012a4b70ee5d3b983b5fe640f04a7f3e4fe67fbb5b7cccb71afa37888ad6cca48e"
+]
+{% endhighlight %}
+
+List of Coinbase Special Transactions (type: 5) in JSON format.
+
+{% highlight bash %}
+dash-cli -testnet getspecialtxes \
+0000003db0006ecaccdf5ae2cfa9d94406ef40ff65b9ec34668b87fca3da9226 5 10 0 2
+{% endhighlight %}
+
+Result:
+{% highlight json %}
+[
+  {
+    "txid": "1572a15f56307e413afe3cb7ea0017a1a3fd6d89c6c5f258cc17b2888a8e7fff",
+    "size": 303,
+    "version": 3,
+    "type": 5,
+    "locktime": 0,
+    "vin": [
+      {
+        "coinbase": "02051c0e2f5032506f6f6c2d74444153482f",
+        "sequence": 4294967295
+      }
+    ],
+    "vout": [
+      {
+        "value": 68.17463792,
+        "valueSat": 6817463792,
+        "n": 0,
+        "scriptPubKey": {
+          "asm": "OP_DUP OP_HASH160 4f79c383bc5d3e9d4d81b98f87337cedfa789536 OP_EQUALVERIFY OP_CHECKSIG",
+          "hex": "76a9144f79c383bc5d3e9d4d81b98f87337cedfa78953688ac",
+          "reqSigs": 1,
+          "type": "pubkeyhash",
+          "addresses": [
+            "yTZg6eePKxbJZyoaC93bVrTUq5vjhFrbst"
+          ]
+        }
+      },
+      {
+        "value": 68.85000588,
+        "valueSat": 6885000588,
+        "n": 1,
+        "scriptPubKey": {
+          "asm": "OP_DUP OP_HASH160 a472d798c41ccb2890b1b932a2b8786c150cf440 OP_EQUALVERIFY OP_CHECKSIG",
+          "hex": "76a914a472d798c41ccb2890b1b932a2b8786c150cf44088ac",
+          "reqSigs": 1,
+          "type": "pubkeyhash",
+          "addresses": [
+            "ybJyF38BxTqKKL7C6VeHqbFRgViRgAfsvC"
+          ]
+        }
+      },
+      {
+        "value": 0.67536809,
+        "valueSat": 67536809,
+        "n": 2,
+        "scriptPubKey": {
+          "asm": "047559d13c3f81b1fadbd8dd03e4b5a1c73b05e2b980e00d467aa9440b29c7de23664dde6428d75cafed22ae4f0d302e26c5c5a5dd4d3e1b796d7281bdc9430f35 OP_CHECKSIG",
+          "hex": "41047559d13c3f81b1fadbd8dd03e4b5a1c73b05e2b980e00d467aa9440b29c7de23664dde6428d75cafed22ae4f0d302e26c5c5a5dd4d3e1b796d7281bdc9430f35ac",
+          "reqSigs": 1,
+          "type": "pubkey",
+          "addresses": [
+            "yb21342iADyqAotjwcn4imqjvAcdYhnzeH"
+          ]
+        }
+      },
+      {
+        "value": 0.00000000,
+        "valueSat": 0,
+        "n": 3,
+        "scriptPubKey": {
+          "asm": "OP_RETURN 81b990d34ff599e8f472241357f565e6662ee8694b6ecc2fdbba384a5a08bc1e000000001e000000",
+          "hex": "6a2881b990d34ff599e8f472241357f565e6662ee8694b6ecc2fdbba384a5a08bc1e000000001e000000",
+          "type": "nulldata"
+        }
+      }
+    ],
+    "extraPayloadSize": 38,
+    "extraPayload": "0100051c0000f258bbb41563f0badab6c2dd47b0d8e73f1b1d88036855223ab0455a750b3ceb",
+    "cbTx": {
+      "version": 1,
+      "height": 7173,
+      "merkleRootMNList": "eb3c0b755a45b03a22556803881d1b3fe7d8b047ddc2b6dabaf06315b4bb58f2"
+    },
+    "instantlock": false,
+    "chainlock": false
+  }
+]
+{% endhighlight %}
+
+*See also:*
+
+* [GetRawTransaction][rpc getrawtransaction]: {{summary_getRawTransaction}}
+
+{% endautocrossref %}

_includes/helpers/summaries.md

@@ -69,6 +69,7 @@ This file is licensed under the terms of its source texts{%endcomment%}
 {% assign summary_getRawTransaction="gets a hex-encoded serialized transaction or a JSON object describing the transaction. By default, Dash Core only stores complete transaction data for UTXOs and your own transactions, so the RPC may fail on historic transactions unless you use the non-default `txindex=1` in your Dash Core startup settings." %}
 {% assign summary_getReceivedByAccount="returns the total amount received by addresses in a particular account from transactions with the specified number of confirmations.  It does not count coinbase transactions." %}
 {% assign summary_getReceivedByAddress="returns the total amount received by the specified address in transactions with the specified number of confirmations. It does not count coinbase transactions." %}
+{% assign summary_getSpecialTxes="returns an array of special transactions found in the specified block" %}
 {% assign summary_getSpentInfo="returns the txid and index where an output is spent (requires `spentindex` to be enabled)." %}
 {% assign summary_getSuperblockBudget="returns the absolute maximum sum of superblock payments allowed." %}
 {% assign summary_getTransaction="gets detailed information about an in-wallet transaction." %}

_includes/references.md

@@ -128,6 +128,7 @@ http://opensource.org/licenses/MIT.
 [rpc getrawtransaction]: /en/developer-reference#getrawtransaction
 [rpc getreceivedbyaccount]: /en/developer-reference#getreceivedbyaccount
 [rpc getreceivedbyaddress]: /en/developer-reference#getreceivedbyaddress
+[rpc getspecialtxes]: /en/developer-reference#getspecialtxes
 [rpc getspentinfo]: /en/developer-reference#getspentinfo
 [rpc getsuperblockbudget]: /en/developer-reference#getsuperblockbudget
 [rpc gettransaction]: /en/developer-reference#gettransaction

en/developer-reference.md

@@ -206,6 +206,8 @@ untrusted source.
 
 {% include devdoc/dash-core/rpcs/rpcs/getreceivedbyaddress.md %}
 
+{% include devdoc/dash-core/rpcs/rpcs/getspecialtxes.md %}
+
 {% include devdoc/dash-core/rpcs/rpcs/getspentinfo.md %}
 
 {% include devdoc/dash-core/rpcs/rpcs/getsuperblockbudget.md %}