Skip to content

Commit aaf20d3

Browse files
authored
docs(core): v22.1 rpc updates, 1 (#478)
* docs(rpc): update debug logging categories * docs(rpc): update getbestchainlock Related to dashpay/dash#6455 * docs(rpc): update v2transport default for masternode connect * docs(rpc): update walletprocesspsbt Related to dashpay/dash#6503 * docs(rpc): add param to lockunspent Related to dashpay/dash#6530 * docs(rpc): add getislocks Related to dashpay/dash#6455
1 parent dcb9d5a commit aaf20d3

6 files changed

+98
-25
lines changed

docs/core/api/remote-procedure-call-quick-reference.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ These RPCs are all Dash-specific and not found in Bitcoin Core
2121

2222
* [GetBestBlockHash](../api/remote-procedure-calls-blockchain.md#getbestblockhash): returns the header hash of the most recent block on the best block chain.
2323
* [DumpTxOutset](../api/remote-procedure-calls-blockchain.md#dumptxoutset): Write the serialized UTXO set to disk. _New in Dash Core 18.1.0_
24-
* [GetBestChainLock](../api/remote-procedure-calls-blockchain.md#getbestchainlock): returns the block hash of the best chainlock. _New in Dash Core 0.15.0_
24+
* [GetBestChainLock](../api/remote-procedure-calls-blockchain.md#getbestchainlock): returns the block hash of the best chainlock. **Updated in Dash Core 22.1.0**
2525
* [GetBlock](../api/remote-procedure-calls-blockchain.md#getblock): gets a block with a particular header hash from the local block database either as a JSON object or as a serialized block. **_Updated in Dash Core 21.0.0_**
2626
* [GetBlockChainInfo](../api/remote-procedure-calls-blockchain.md#getblockchaininfo): provides information about the current state of the block chain. **_Updated in Dash Core 21.0.0_**
2727
* [GetBlockCount](../api/remote-procedure-calls-blockchain.md#getblockcount): returns the number of blocks in the local best block chain.
@@ -133,6 +133,7 @@ These RPCs are all Dash-specific and not found in Bitcoin Core
133133
* [DecodeScript](../api/remote-procedure-calls-raw-transactions.md#decodescript): decodes a hex-encoded P2SH redeem script. **_Updated in Dash Core 21.0.0_**
134134
* [FinalizePSBT](../api/remote-procedure-calls-raw-transactions.md#finalizepsbt): finalizes the inputs of a PSBT. The PSBT produces a network serialized transaction if the transaction is fully signed. _New in Dash Core 18.0.0_
135135
* [FundRawTransaction](../api/remote-procedure-calls-raw-transactions.md#fundrawtransaction): adds inputs to a transaction until it has enough in value to meet its out value. **_Updated in Dash Core 21.0.0_**
136+
* [GetISLocks](../api/remote-procedure-calls-raw-transactions.md#getislocks): returns the raw InstantSend lock data for each provided transaction ID. **New in Dash Core 22.1.0**
136137
* [GetRawTransaction](../api/remote-procedure-calls-raw-transactions.md#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. **_Updated in Dash Core 21.0.0_**
137138
* [GetRawTransactionMulti](../api/remote-procedure-calls-raw-transactions.md#getrawtransactionmulti): gets hex-encoded serialized transactions or a JSON object describing the multiple transactions. _New in Dash Core 20.1.0_
138139
* [GetTxChainlocks](../api/remote-procedure-calls-raw-transactions.md#gettxchainlocks): returns the block height each transaction was mined at and whether it is ChainLocked or not. _Updated in Dash Core 20.1.0_
@@ -199,7 +200,7 @@ These RPCs are all Dash-specific and not found in Bitcoin Core
199200
* [ListWalletDir](../api/remote-procedure-calls-wallet.md#listwalletdir): returns a list of wallets in the wallet directory. _New in Dash Core 18.0.0_
200201
* [ListWallets](../api/remote-procedure-calls-wallet.md#listwallets): returns a list of currently loaded wallets. _New in Dash Core 0.15.0_
201202
* [LoadWallet](../api/remote-procedure-calls-wallet.md#loadwallet): loads a wallet from a wallet file or directory. _Updated in Dash Core 18.1.0_
202-
* [LockUnspent](../api/remote-procedure-calls-wallet.md#lockunspent): temporarily locks or unlocks specified transaction outputs. A locked transaction output will not be chosen by automatic coin selection when spending dash. Locks are stored in memory only, so nodes start with zero locked outputs and the locked output list is always cleared when a node stops or fails.
203+
* [LockUnspent](../api/remote-procedure-calls-wallet.md#lockunspent): temporarily locks or unlocks specified transaction outputs. A locked transaction output will not be chosen by automatic coin selection when spending dash. Locks are stored in memory only, so nodes start with zero locked outputs and the locked output list is always cleared when a node stops or fails. **Updated in Dash Core 22.1.0**
203204
* [RemovePrunedFunds](../api/remote-procedure-calls-wallet.md#removeprunedfunds): deletes the specified transaction from the wallet. Meant for use with pruned wallets and as a companion to importprunedfunds. _New in Dash Core 0.12.3_
204205
* [RescanBlockChain](../api/remote-procedure-calls-wallet.md#rescanblockchain): rescans the local blockchain for wallet related transactions. _New in Dash Core 0.16.0_
205206
* [ScanTxOutset](../api/remote-procedure-calls-wallet.md#scantxoutset): scans the unspent transaction output set for entries that match certain output descriptors. _New in Dash Core 18.0.0_
@@ -221,7 +222,7 @@ These RPCs are all Dash-specific and not found in Bitcoin Core
221222
* [WalletLock](../api/remote-procedure-calls-wallet.md#walletlock): removes the wallet encryption key from memory, locking the wallet. After calling this method, you will need to call `walletpassphrase` again before being able to call any methods which require the wallet to be unlocked.
222223
* [WalletPassphrase](../api/remote-procedure-calls-wallet.md#walletpassphrase): stores the wallet decryption key in memory for the indicated number of seconds. Issuing the `walletpassphrase` command while the wallet is already unlocked will set a new unlock time that overrides the old one.
223224
* [WalletPassphraseChange](../api/remote-procedure-calls-wallet.md#walletpassphrasechange): changes the wallet passphrase from 'old passphrase' to 'new passphrase'.
224-
* [WalletProcessPSBT](../api/remote-procedure-calls-wallet.md#walletprocesspsbt): updates a PSBT with input information from a wallet and then allows the signing of inputs. _Updated in Dash Core 18.2.0_
225+
* [WalletProcessPSBT](../api/remote-procedure-calls-wallet.md#walletprocesspsbt): updates a PSBT with input information from a wallet and then allows the signing of inputs. **Updated in Dash Core 22.1.0**
225226
* [WipeWalletTxes](../api/remote-procedure-calls-wallet.md#wipewallettxes): wipes wallet transactions. _New in Dash Core 19.3.0_
226227

227228
## [Wallet RPCs (Deprecated)](../api/remote-procedure-calls-wallet-deprecated.md)

docs/core/api/remote-procedure-calls-blockchain.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,9 @@ Name | Type | Presence | Description
8787
→<br>`height` | number (int) | Required<br>(exactly 1) | The height of this block on its block chain
8888
→<br>`signature` | string (hex) | Required<br>(exactly 1) | The BLS signature of the ChainLock
8989
→<br>`known_block` | boolean | Required<br>(exactly 1) | True if the block is known by this node
90+
→<br>`hex` | string (hex) | Required<br>(exactly 1) | The serialized, hex-encoded data for the best ChainLock
9091

91-
*Example from Dash Core 0.17.0*
92+
*Example from Dash Core 22.1.0*
9293

9394
``` bash
9495
dash-cli -testnet getbestchainlock
@@ -98,10 +99,11 @@ Result:
9899

99100
``` json
100101
{
101-
"blockhash": "00000c0e7a866e67444813858b976886d839aff28f56dc178c92ed1390c97f4e",
102-
"height": 405044,
103-
"signature": "960ead08adcc3fcf5e576f9e6ad290251325db900d19d961f5ece398b5389390b8a44e8986199c201ac348a89bc8534a0f7153c61c54157a241c521131025e5054b7c4298065069e478abdaea4d6c861848061e32c0d903ddeb5ee6036e8ddcf",
104-
"known_block": true
102+
"blockhash": "0000013e0738becaef5da03b0352ffa3d50e6dc6591246bca06357b50ee50927",
103+
"height": 1186861,
104+
"signature": "854e63822a53b0e53eb0aaceed554c104172cacb252450d60bfb353eb78ff107e22275236b895ac3a049718c68da840319a0efda8524c0ca39ebead5abe65d1e4b58e55856b25895a1d0bff1eaa483f0cca4b5d015661cf0003bf50a39b6da01",
105+
"known_block": true,
106+
"hex": "2d1c12002709e50eb55763a0bc461259c66d0ed5a3ff52033ba05defcabe38073e010000854e63822a53b0e53eb0aaceed554c104172cacb252450d60bfb353eb78ff107e22275236b895ac3a049718c68da840319a0efda8524c0ca39ebead5abe65d1e4b58e55856b25895a1d0bff1eaa483f0cca4b5d015661cf0003bf50a39b6da01"
105107
}
106108
```
107109

docs/core/api/remote-procedure-calls-control.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Debug category | string | Required<br>(1 or more) | The debug category to activa
2121
| Type | Category |
2222
| - | - |
2323
| Special |`0` or `none` - Disables all categories <br>• `1` or `all` - Enables all categories <br>• `dash` - Enables/disables all Dash categories |
24-
| Standard | `addrman`, `bench`, `cmpctblock`, `coindb`, `estimatefee`, `http`, `i2p`, `ipc`, `leveldb`, `libevent`, `lock`, `mempool`, `mempoolrej`, `net`, `netconn`, `proxy`, `prune`, `qt`, `rand`, `reindex`, `rpc`, `selectcoins`, `tor`, `validation`, `walletdb`, `zmq`|
24+
| Standard | `addrman`, `bench`, `blockstorage`, `cmpctblock`, `coindb`, `estimatefee`, `http`, `i2p`, `ipc`, `leveldb`, `libevent`, `lock`, `mempool`, `mempoolrej`, `net`, `netconn`, `proxy`, `prune`, `qt`, `rand`, `reindex`, `rpc`, `selectcoins`, `tor`, `validation`, `walletdb`, `zmq`|
2525
| Dash | `chainlocks`, `coinjoin`, `creditpool`, `ehf`, `gobject`, `instantsend`, `llmq`, `llmq-dkg`, `llmq-sigs`, `mnpayments`, `mnsync`, `spork` |
2626

2727
Note: `libevent` logging is configured on startup and cannot be modified by this RPC during runtime.
@@ -206,7 +206,7 @@ The categories are:
206206
| Type | Category |
207207
| - | - |
208208
| Special |`0` or `none` - Disables all categories <br>• `1` or `all` - Enables all categories <br>• `dash` - Enables/disables all Dash categories |
209-
| Standard | `addrman`, `bench`, `cmpctblock`, `coindb`, `estimatefee`, `http`, `i2p`, `ipc`, `leveldb`, `libevent`, `lock`, `mempool`, `mempoolrej`, `net`, `netconn`, `proxy`, `prune`, `qt`, `rand`, `reindex`, `rpc`, `selectcoins`, `tor`, `validation`, `walletdb`, `zmq`|
209+
| Standard | `addrman`, `bench`, `blockstorage`, `cmpctblock`, `coindb`, `estimatefee`, `http`, `i2p`, `ipc`, `leveldb`, `libevent`, `lock`, `mempool`, `mempoolrej`, `net`, `netconn`, `proxy`, `prune`, `qt`, `rand`, `reindex`, `rpc`, `selectcoins`, `tor`, `validation`, `walletdb`, `zmq`|
210210
| Dash | `chainlocks`, `coinjoin`, `creditpool`, `ehf`, `gobject`, `instantsend`, `llmq`, `llmq-dkg`, `llmq-sigs`, `mnpayments`, `mnsync`, `spork` |
211211

212212
*Result---a list of the logging categories that are active*

docs/core/api/remote-procedure-calls-dash.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1207,7 +1207,7 @@ _Parameter #2---transport protocol options_
12071207

12081208
| Name | Type | Presence | Description |
12091209
| ------------ | ------- | -------------------- | ----------- |
1210-
| v2transport | bool | Optional<br>(0 or 1) | Set to `true` to attempt connection using the BIP324 v2 transport protocol. Defaults to `false`. |
1210+
| v2transport | bool | Optional<br>(0 or 1) | Set to `true` to attempt connection using the BIP324 v2 transport protocol. Defaults to `true` since Dash Core 22.1. Set by `-v2transport`. |
12111211

12121212
_Result---connection status_
12131213

docs/core/api/remote-procedure-calls-raw-transactions.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -884,6 +884,66 @@ Result:
884884

885885
_See also: none_
886886

887+
## GetISLocks
888+
889+
Returns the raw InstantSend lock data for each provided transaction ID. Returns `"None"` if there is no known InstantSend lock for a transaction.
890+
891+
_Parameter #1—list of transaction IDs_
892+
893+
| Name | Type | Presence | Description |
894+
| ---- | ---------- | ---------------------- | ----------- |
895+
| txids | array | Required<br>(exactly 1) | An array of up to 100 transaction IDs (strings). Each element must be a valid transaction hash in hexadecimal form. |
896+
897+
_Result—execution result_
898+
899+
The RPC returns an array of the same size as the input array. Each element in the result array is either a JSON object with the following fields or the string `"None"` if no InstantSend lock is known for the corresponding transaction ID.
900+
901+
| Name | Type | Presence | Description |
902+
| ------------------- | --------------- | ----------------------- | ----------- |
903+
| Result | array | Required<br>(exactly 1) | An array of JSON objects with results for each requested TXID |
904+
| → <br>TXID data | object | Required | Data for a requested TXID. One object for each requested TXID |
905+
| → → <br>`txid` | string (hex) | Required<br>(exactly 1) | The transaction ID |
906+
| → → <br>`inputs` | array | Required<br>(exactly 1) | An array of JSON objects describing the transaction inputs in the InstantSend lock |
907+
| → → → <br> `txid` | string (hex) | Required<br>(exactly 1) | The transaction ID of the input |
908+
| → → → <br> `vout` | number (int) | Required<br>(exactly 1) | The output index of the referenced transaction |
909+
| → → <br>`cycleHash` | string (hex) | Required<br>(exactly 1) | The cycle hash associated with this InstantSend lock |
910+
| → → <br>`signature` | string (hex) | Required<br>(exactly 1) | The BLS signature associated with this InstantSend lock |
911+
| → → <br>`hex` | string (hex) | Required<br>(exactly 1) | The serialized, hex-encoded InstantSend lock data for the transaction |
912+
913+
_Example from Dash Core 22.1.0_
914+
915+
Query InstantSend lock information for two transaction IDs:
916+
917+
```bash
918+
dash-cli getislocks '["58cf87162f74e2ae72721184643bc320155ca8ad5068ea005d47cb0c516a0730", "b251095eef8efd3b6840f13b4d8ff714ddff3db5775dc799610989586dc47cca"]'
919+
```
920+
921+
Result:
922+
923+
```json
924+
[
925+
{
926+
"txid": "58cf87162f74e2ae72721184643bc320155ca8ad5068ea005d47cb0c516a0730",
927+
"inputs": [
928+
{
929+
"txid": "29a4f10cf3a9d169eb84579800db8625032cd27f5479ac2b5057de9242411de2",
930+
"vout": 10
931+
},
932+
{
933+
"txid": "c1a525857a91649e8f97ae4a4ad103c6992349b7616d2ab1f9e46278de17d29c",
934+
"vout": 0
935+
}
936+
],
937+
"cycleHash": "000000963cc2a39af8b4ab3f5f8651c5f704d3e5f258758a33f8e86edd6c01f0",
938+
"signature": "a20e74296fcd3fb73f938680bdbfa8fa313b8d8bdf3f76657d7efac568e847f5f73093fe41f4a086a99cebb54b4a077a101b680e4f73055fe3bde78ce620545444a4e5ef22a51bfd29cc456b52d08d04c9e0d60ded435713dcd2df0edfe62f6b",
939+
"hex": "0102e21d414292de57502bac79547fd22c032586db00985784eb69d1a9f30cf1a4290a0000009cd217de7862e4f9b12a6d61b7492399c603d14a4aae978f9e64917a8525a5c10000000030076a510ccb475d00ea6850ada85c1520c33b6484117272aee2742f1687cf58f0016cdd6ee8f8338a7558f2e5d304f7c551865f3fabb4f89aa3c23c96000000a20e74296fcd3fb73f938680bdbfa8fa313b8d8bdf3f76657d7efac568e847f5f73093fe41f4a086a99cebb54b4a077a101b680e4f73055fe3bde78ce620545444a4e5ef22a51bfd29cc456b52d08d04c9e0d60ded435713dcd2df0edfe62f6b"
940+
},
941+
"None"
942+
]
943+
```
944+
945+
_See also: none_
946+
887947
```{eval-rst}
888948
.. _api-rpc-raw-transactions-getrawtransaction:
889949
```

0 commit comments

Comments
 (0)