Skip to content

Commit c8808e0

Browse files
committed
docs(rpc): update quick ref and add include_immature_coinbase
Related to dashpay/dash#6601
1 parent 4abcfe1 commit c8808e0

File tree

2 files changed

+29
-5
lines changed

2 files changed

+29
-5
lines changed

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

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

8282
* [BLS](../api/remote-procedure-calls-evo.md#bls): provides a set of commands to execute BLS-related actions. _Updated in Dash Core 19.0.0_
8383
* [ProTx](../api/remote-procedure-calls-evo.md#protx): provides a set of commands to execute ProTx related actions. **Updated in Dash Core 23.0.0**
84-
* [Quorum](../api/remote-procedure-calls-evo.md#quorum): provides a set of commands for quorums (LLMQs). **Updated in Dash Core 22.0.0**
84+
* [Quorum](../api/remote-procedure-calls-evo.md#quorum): provides a set of commands for quorums (LLMQs). **Updated in Dash Core 23.0.0**
8585
* [SubmitChainLock](../api/remote-procedure-calls-evo.md#submitchainlock): allows the submission of a ChainLock signature. _New in Dash Core 20.1.0_
8686
* [VerifyChainLock](../api/remote-procedure-calls-evo.md#verifychainlock): tests if a quorum signature is valid for a ChainLock. _New in Dash Core 0.17.0_
8787
* [VerifyISLock](../api/remote-procedure-calls-evo.md#verifyislock): tests if a quorum signature is valid for an InstantSend lock. _New in Dash Core 0.17.0_
@@ -173,8 +173,8 @@ These RPCs are all Dash-specific and not found in Bitcoin Core
173173
* [GetBalances](../api/remote-procedure-calls-wallet.md#getbalances): returns an object with all balances denominated in DASH. _Updated in Dash Core 18.2.0_
174174
* [GetNewAddress](../api/remote-procedure-calls-wallet.md#getnewaddress): returns a new Dash address for receiving payments. If an account is specified, payments received with the address will be credited to that account. _Updated in Dash Core 0.17.0_
175175
* [GetRawChangeAddress](../api/remote-procedure-calls-wallet.md#getrawchangeaddress): returns a new Dash address for receiving change. This is for use with raw transactions, not normal use.
176-
* [GetReceivedByAddress](../api/remote-procedure-calls-wallet.md#getreceivedbyaddress): returns the total amount received by the specified address in transactions with the specified number of confirmations. It does not count coinbase transactions. _Updated in Dash Core 0.13.0_
177-
* [GetReceivedByLabel](../api/remote-procedure-calls-wallet.md#getreceivedbylabel): returns the list of addresses assigned the specified label. _New in Dash Core 0.17.0_
176+
* [GetReceivedByAddress](../api/remote-procedure-calls-wallet.md#getreceivedbyaddress): returns the total amount received by the specified address in transactions with the specified number of confirmations. It does not count coinbase transactions. **Updated in Dash Core 23.0.0**
177+
* [GetReceivedByLabel](../api/remote-procedure-calls-wallet.md#getreceivedbylabel): returns the list of addresses assigned the specified label. **Updated in Dash Core 23.0.0**
178178
* [GetTransaction](../api/remote-procedure-calls-wallet.md#gettransaction): gets detailed information about an in-wallet transaction. _Updated in Dash Core 20.0.0_
179179
* [GetUnconfirmedBalance](../api/remote-procedure-calls-wallet.md#getunconfirmedbalance): returns the wallet's total unconfirmed balance.
180180
* [GetWalletInfo](../api/remote-procedure-calls-wallet.md#getwalletinfo): provides information about the wallet. _Updated in Dash Core 20.0.0_
@@ -192,8 +192,8 @@ These RPCs are all Dash-specific and not found in Bitcoin Core
192192
* [ListDescriptors](../api/remote-procedure-calls-wallet.md#listdescriptors): lists descriptors imported into a descriptor-enabled wallet. **_New in Dash Core 21.0.0_**
193193
* [ListLabels](../api/remote-procedure-calls-wallet.md#listlabels): returns the list of all labels, or labels that are assigned to addresses with a specific purpose. _New in Dash Core 0.17.0_
194194
* [ListLockUnspent](../api/remote-procedure-calls-wallet.md#listlockunspent): returns a list of temporarily unspendable (locked) outputs.
195-
* [ListReceivedByAddress](../api/remote-procedure-calls-wallet.md#listreceivedbyaddress): lists the total number of dash received by each address. _Updated in Dash Core 0.17.0_
196-
* [ListReceivedByLabel](../api/remote-procedure-calls-wallet.md#listreceivedbylabel): lists the total number of dash received by each label. _New in Dash Core 0.17.0_
195+
* [ListReceivedByAddress](../api/remote-procedure-calls-wallet.md#listreceivedbyaddress): lists the total number of dash received by each address. **Updated in Dash Core 23.0.0**
196+
* [ListReceivedByLabel](../api/remote-procedure-calls-wallet.md#listreceivedbylabel): lists the total number of dash received by each label. **Updated in Dash Core 23.0.0**
197197
* [ListSinceBlock](../api/remote-procedure-calls-wallet.md#listsinceblock): gets all transactions affecting the wallet which have occurred since a particular block, plus the header hash of a block at a particular depth. _Updated in Dash Core 20.0.0_
198198
* [ListTransactions](../api/remote-procedure-calls-wallet.md#listtransactions): returns the most recent transactions that affect the wallet. _Updated in Dash Core 20.0.0_
199199
* [ListUnspent](../api/remote-procedure-calls-wallet.md#listunspent): returns an array of unspent transaction outputs belonging to this wallet. _Updated in Dash Core 18.1.0_

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

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -804,6 +804,12 @@ _Parameter #3---whether to include transactions locked via InstantSend_
804804
| --------- | ---- | ----------------------- | ---------------------------------------------------- |
805805
| addlocked | bool | Optional<br>(exactly 1) | Add the balance from InstantSend locked transactions |
806806

807+
_Parameter #4---whether to include immature coinbase transactions_
808+
809+
| Name | Type | Presence | Description |
810+
| -------------------------- | ---- | -------------------- | ----------------------------------------------------------------------------------------- |
811+
| include_immature_coinbase | bool | Optional<br>(0 or 1) | **Added in Dash Core 23.0.0**<br>Include immature coinbase transactions. Default is `false` |
812+
807813
_Result---the amount of dash received_
808814

809815
| Name | Type | Presence | Description |
@@ -866,6 +872,12 @@ _Parameter #3---whether to include transactions locked via InstantSend_
866872
| --------- | ---- | ----------------------- | -------------------------------------------------------------------- |
867873
| addlocked | bool | Optional<br>(exactly 1) | Add the balance from InstantSend locked transactions (default=false) |
868874

875+
_Parameter #4---whether to include immature coinbase transactions_
876+
877+
| Name | Type | Presence | Description |
878+
| -------------------------- | ---- | -------------------- | ----------------------------------------------------------------------------------------- |
879+
| include_immature_coinbase | bool | Optional<br>(0 or 1) | **Added in Dash Core 23.0.0**<br>Include immature coinbase transactions. Default is `false` |
880+
869881
_Result---the number of DASH received_
870882

871883
| Name | Type | Presence | Description |
@@ -1849,6 +1861,12 @@ _Parameter #5---limit returned information to a specific address_
18491861
| -------------- | ------ | -------------------- | ---------------------------------------------------- |
18501862
| Address Filter | string | Optional<br>(0 or 1) | If present, only return information for this address |
18511863

1864+
_Parameter #6---whether to include immature coinbase transactions_
1865+
1866+
| Name | Type | Presence | Description |
1867+
| -------------------------- | ---- | -------------------- | ----------------------------------------------------------------------------------------- |
1868+
| include_immature_coinbase | bool | Optional<br>(0 or 1) | **Added in Dash Core 22.0.0**<br>Include immature coinbase transactions. Default is `false` |
1869+
18521870
_Result---addresses, account names, balances, and minimum confirmations_
18531871

18541872
| Name | Type | Presence | Description |
@@ -1935,6 +1953,12 @@ _Parameter #4---whether to include watch-only addresses in results_
19351953
| ------------------ | ---- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
19361954
| Include Watch-Only | bool | Optional<br>(0 or 1) | If set to `true`, include watch-only addresses in details and calculations as if they were regular addresses belonging to the wallet. If set to `false` (the default for non-watching only wallets), treat watch-only addresses as if they didn't belong to this wallet.<br>As of Dash Core 18.1, `true` is the default for watching-only wallets. |
19371955

1956+
_Parameter #5---whether to include immature coinbase transactions_
1957+
1958+
| Name | Type | Presence | Description |
1959+
| -------------------------- | ---- | -------------------- | ----------------------------------------------------------------------------------------- |
1960+
| include_immature_coinbase | bool | Optional<br>(0 or 1) | **Added in Dash Core 22.0.0**<br>Include immature coinbase transactions. Default is `false` |
1961+
19381962
_Result---account names, balances, and minimum confirmations_
19391963

19401964
| Name | Type | Presence | Description |

0 commit comments

Comments
 (0)