Dash Core

Dash Core Developer Documentation

Welcome to the Dash Core developer documentation. You'll find guides and documentation to help you start working with Dash Core as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Guides

Removed RPCs

EstimatePriority

❗️

Warning: Removed in Dash Core 0.14.0.

The estimatepriority RPC was removed in Dash Core 0.14.0. This should not to be confused with the prioritisetransaction RPC which will remain supported for adding fee deltas to transactions.

Parameter #1---how many blocks the transaction may wait before being included as a free high-priority transaction

NameTypePresenceDescription
Blocksnumber (int)Required
(exactly 1)
The maximum number of blocks a transaction should have to wait before it is predicted to be included in a block based purely on its priority

Result---the priority a transaction needs

NameTypePresenceDescription
resultnumber (real)Required
(exactly 1)
The estimated priority the transaction should have in order to be included within the specified number of blocks. If the node doesn't have enough information to make an estimate, the value -1 will be returned

Examples from Dash Core 0.12.2

dash-cli estimatepriority 6

Result:

718158904.10958910

Requesting data the node can't calculate yet:

dash-cli estimatepriority 100

Result:

-1

See also

  • EstimateFee: estimates the transaction fee per kilobyte that needs to be paid for a transaction to begin confirmation within a certain number of blocks.

EstimateSmartPriority

❗️

Warning: Removed in Dash Core 0.14.0.

The estimatesmartpriority RPC was removed in Dash Core 0.14.0. This should not to be confused with the prioritisetransaction RPC which will remain supported for adding fee deltas to transactions.

Parameter #1---how many blocks the transaction may wait before being included as a free high-priority transaction

NameTypePresenceDescription
Blocksnumber (int)Required
(exactly 1)
The maximum number of blocks a transaction should have to wait before it is predicted to be included in a block based purely on its priority

Result---the priority a transaction needs

NameTypePresenceDescription
resultobjectRequired
(exactly 1)
JSON Object containing estimate information

priority
numberRequired
(exactly 1)
The estimated priority the transaction should be in order to be included within the specified number of blocks. If the node doesn't have enough information to make an estimate, the value -1 will be returned

blocks
numberRequired
(exactly 1)
Block number where the estimate was found

Examples from Dash Core 0.12.2

dash-cli estimatesmartpriority 6

Result:

{
  "priority": 718158904
  "blocks": 25
}

Requesting data the node can't calculate yet:

dash-cli estimatesmartpriority 100

Result:

{
  "priority": -1,
  "blocks": 100
}

See also

GetInfo

❗️

Warning: Removed in Dash Core 0.16.0.

The getinfo RPC prints various information about the node and the network.

Parameters: none

Result---information about the node and network

NameTypePresenceDescription
resultobjectRequired
(exactly 1)
Information about this node and the network

deprecation-warning
stringRequired
(exactly 1)
Warning that the getinfo command is deprecated and will be removed in a future version

version
number (int)Required
(exactly 1)
This node's version of Bitcoin Core in its internal integer format. For example, Dash Core 0.12.2 has the integer version number 120200

protocolversion
number (int)Required
(exactly 1)
The protocol version number used by this node. See the protocol versions section for more information

walletversion
number (int)Optional
(0 or 1)
The version number of the wallet. Only returned if wallet support is enabled

balance
number (duffs)Optional
(0 or 1)
The total balance of the wallet in duffs. Only returned if wallet support is enabled

privatesend_balance
number (duffs)Optional
(0 or 1)
The PrivateSend balance of the wallet in duffs. Only returned if wallet support is enabled (Added in Dash Core 0.11.0)

blocks
number (int)Required
(exactly 1)
The number of blocks in the local best block chain. A new node with only the hardcoded genesis block will return 0

timeoffset
number (int)Required
(exactly 1)
The offset of the node's clock from the computer's clock (both in UTC) in seconds. The offset may be up to 4200 seconds (70 minutes)

connections
number (int)Required
(exactly 1)
The total number of open connections (both outgoing and incoming) between this node and other nodes

proxy
stringRequired
(exactly 1)
The hostname/IP address and port number of the proxy, if set, or an empty string if unset

difficulty
number (real)Required
(exactly 1)
The difficulty of the highest-height block in the local best block chain

testnet
boolRequired
(exactly 1)
Set to true if this node is on testnet; set to false if this node is on mainnet or a regtest

keypoololdest
number (int)Optional
(0 or 1)
The date as Unix epoch time when the oldest key in the wallet key pool was created; useful for only scanning blocks created since this date for transactions. Only returned if wallet support is enabled

keypoolsize
number (int)Optional
(0 or 1)
The number of keys in the wallet keypool. Only returned if wallet support is enabled

unlocked_until
number (int)Optional
(0 or 1)
The Unix epoch time when the wallet will automatically re-lock. Only displayed if wallet encryption is enabled. Set to 0 if wallet is currently locked

paytxfee
number (duffs)Optional
(0 or 1)
The minimum fee to pay per kilobyte of transaction; may be 0. Only returned if wallet support is enabled

relayfee
number (duffs)Required
(exactly 1)
The minimum fee per kilobyte a transaction must pay in order for this node to accept it into its memory pool

errors
stringRequired
(exactly 1)
A plain-text description of any errors this node has encountered or detected. If there are no errors, an empty string will be returned. This is not related to the JSON-RPC error field

Example from Dash Core 0.15.0 with wallet support enabled

dash-cli -testnet getinfo

Result:

{
  "deprecation-warning": "WARNING: getinfo is deprecated and will be fully removed in a future version. Projects should transition to using getblockchaininfo, getnetworkinfo, and getwalletinfo.",
  "version": 140100,
  "protocolversion": 70215,
  "walletversion": 61000,
  "balance": 0.00000000,
  "privatesend_balance": 0.00000000,
  "blocks": 0,
  "timeoffset": 0,
  "connections": 0,
  "proxy": "",
  "difficulty": 0.000244140625,
  "testnet": true,
  "keypoololdest": 1507579068,
  "keypoolsize": 617,
  "unlocked_until": 0,
  "paytxfee": 0.00000000,
  "relayfee": 0.00010000,
  "errors": ""
}

See also

  • GetBlockChainInfo: provides information about the current state of the block chain.
  • GetMemPoolInfo: returns information about the node's current transaction memory pool.
  • GetMiningInfo: returns various mining-related information.
  • GetNetworkInfo: returns information about the node's connection to the network.
  • GetWalletInfo: provides information about the wallet.

MasternodeBroadcast

❗️

Warning: Removed in Dash Core 0.14.0.

The masternodebroadcast RPC was removed in Dash Core 0.14.0.

Parameter #1---masternode broadcast command

NameTypePresenceDescription
commandstring (hex)Required
(exactly 1)
The command to use:
create-alias
create-all
decode
relay

MNB create-alias

The masternodebroadcast create-alias RPC creates single remote masternode broadcast message by assigned alias configured in masternode.conf.

Parameter #2---masternode alias

NameTypePresenceDescription
aliasstringRequired
(exactly 1)
The masternode alias for creating the broadcast message

Result---broadcast message

NameTypePresenceDescription
ResultobjectRequired
(exactly 1)
Object containing result data

alias
stringRequired
(exactly 1)
Alias of the masternode

result
stringRequired
(exactly 1)
Result of broadcast message create attempt

hex
string (hex)Required
(exactly 1)
Masternode broadcast data

Example from Dash Core 0.12.2

dash-cli -testnet masternodebroadcast create-alias MN01

Result:

{
  "alias": "MN01",
  "result": "successful",
  "hex": "010fab7e86a6d7c483b836fe862c8a23f69aebadce7c58c48778a4fa6bd93fc8f60100000000ffffffff00000000000000000000ffff2d20ed4c4e1f210267fae84ef6aa6ab3d877b47932915a9b406566c873ea025986fc7e15a15fd2f24104341ab0d26ae967856213df205bf172418422a847f3a63941d8031234a64a143f5570a6010d2b5e1dff163c91316a65667f0ee1bfb0ff38edd0a695bea75de731411f8a9bf1e7818c7352c8a02bd31a4da1bb8d88e91c8a9c7151afc076b6a68f54c9087a981a780e6279e9d7b73940ee7aad65c28e4846573bffa74518443380dfde4d3c145a00000000401201000fab7e86a6d7c483b836fe862c8a23f69aebadce7c58c48778a4fa6bd93fc8f60100000000ffffffff69fc28f4772eaefd17cd1bab575aac752b5944ee3e7221df204b4d04000000004d3c145a00000000411bef1bdf25a500ae2af4052e8504e2f93ec365d5ed9d42e3c52b84714136060f9766068553c450a4b1c0b3d72740580f097f7e62c098addc55f71f016cfda24d7a0001000100"
}

MNB create-all

The masternodebroadcast create-all RPC creates remote masternode broadcast messages for all masternodes configured in masternode.conf.

Result---broadcast message(s)

NameTypePresenceDescription
ResultobjectRequired
(exactly 1)
Object containing result data

overall
stringRequired
(exactly 1)
Summary of broadcast message creation success/failure

detail
objectRequired
(exactly 1)
Object containing status details
→ →
status
objectRequired
(1 or more)
Object containing status for each each masternode broadcast message creation attempt
→ → →
alias
stringRequired
(exactly 1)
Alias of the masternode
→ → →
result
stringRequired
(exactly 1)
Result - successful or failed
→ → →
error
stringOptionalError message if failed

hex
string (hex)Optional
(exactly 1)
Masternode broadcast data (if message(s) created successfully)

Example from Dash Core 0.12.2

dash-cli -testnet masternodebroadcast create-all

Result:

{
  "overall": "Successfully created broadcast messages for 1 masternodes, failed to create 0, total 1",
  "detail": {
    "status": {
      "alias": "MN01",
      "result": "successful"
    }
  },
  "hex": "010fab7e86a6d7c483b836fe862c8a23f69aebadce7c58c48778a4fa6bd93fc8f60100000000ffffffff00000000000000000000ffff2d20ed4c4e1f210267fae84ef6aa6ab3d877b47932915a9b406566c873ea025986fc7e15a15fd2f24104341ab0d26ae967856213df205bf172418422a847f3a63941d8031234a64a143f5570a6010d2b5e1dff163c91316a65667f0ee1bfb0ff38edd0a695bea75de731411f555444bd95d98b8407ff1b8cc595a3d284c30b9bbaca488a949bc53be08ca1021724527f9a15e9307c7391d9ad563dcc9ced6ae621ae7d6fe3e3c3ba81dce795d143145a00000000401201000fab7e86a6d7c483b836fe862c8a23f69aebadce7c58c48778a4fa6bd93fc8f60100000000ffffffff914dff1cc3dfc0729bb1f4e3f070d65d1fa41072da5290a54d472d0400000000d143145a00000000411c628109c911ef330aaa789bd621f8c7975290d196beef3ecdaa1133302daccdaa3df82b1f16d753fef884ce3a3eb28a7b621233c14496a010bb49f247190651100001000100"
}

MNB decode

The masternodebroadcast decode RPC decodes a masternode broadcast message (deserializes from a hex string to JSON).

Parameter #2---object data (hex)

NameTypePresenceDescription
data-hexstring (hex)Required
(exactly 1)
The data (hex) of the masternode broadcast to decode

Result---broadcast message(s)

NameTypePresenceDescription
ResultobjectRequired
(exactly 1)
Object containing result data

outpoint
string (hex)Required
(exactly 1)
Masternode outpoint

addr
stringRequired
(exactly 1)
Masternode IP address and port

pubKeyCollateralAddress
string (hex)Required
(1 or more)
Masternode collateral public key address

pubKeyMasternode
string (hex)Required
(exactly 1)
Masternode public key

vchSig
string (base64)Required
(exactly 1)
Masternode signature

sigTime
int64_tRequired
(exactly 1)
Signature time as a Unix epoch

protocolVersion
intRequired
(exactly 1)
Dash protocol version

nLastDsq
int64_tRequired
(exactly 1)
Dsq count from the last dsq message from this node

lastPing
objectRequired
(exactly 1)
Ping object (mnp message)
→ →
outpoint
string (hex)Required
(exactly 1)
Masternode outpoint
→ →
blockHash
string (hex)Required
(exactly 1)
Block hash from 12 blocks prior to the current tip
→ →
sigTime
int64_tRequired
(exactly 1)
Signature time as a Unix epoch
→ →
vchSig
string (base64)Required
(exactly 1)
Masternode signature

overall
stringRequired
(exactly 1)
Summary of broadcast message creation success/failure

Example from Dash Core 0.12.2

masternodebroadcast decode 010fab7e86a6d7c483b836fe862c8a23f69aebadce7c58c4\
8778a4fa6bd93fc8f60100000000ffffffff00000000000000000000ffff2d20ed4c4e1f2102\
67fae84ef6aa6ab3d877b47932915a9b406566c873ea025986fc7e15a15fd2f24104341ab0d2\
6ae967856213df205bf172418422a847f3a63941d8031234a64a143f5570a6010d2b5e1dff16\
3c91316a65667f0ee1bfb0ff38edd0a695bea75de731411f8a9bf1e7818c7352c8a02bd31a4d\
a1bb8d88e91c8a9c7151afc076b6a68f54c9087a981a780e6279e9d7b73940ee7aad65c28e48\
46573bffa74518443380dfde4d3c145a00000000401201000fab7e86a6d7c483b836fe862c8a\
23f69aebadce7c58c48778a4fa6bd93fc8f60100000000ffffffff69fc28f4772eaefd17cd1b\
ab575aac752b5944ee3e7221df204b4d04000000004d3c145a00000000411bef1bdf25a500ae\
2af4052e8504e2f93ec365d5ed9d42e3c52b84714136060f9766068553c450a4b1c0b3d72740\
580f097f7e62c098addc55f71f016cfda24d7a0001000100

Result:

{
  "36b753f9c8d328d405b8a909bbf4fd29c0d37aa48eae98fa1289b90e36e002c4": {
    "outpoint": "f6c83fd96bfaa47887c4587cceadeb9af6238a2c86fe36b883c4d7a6867eab0f-1",
    "addr": "45.32.237.76:19999",
    "pubKeyCollateralAddress": "yY6AmGopsZS31wy1JLHR9P6AC6owFaXwuh",
    "pubKeyMasternode": "yj25teTD6yjcNpQC7inq72tDgsivG6xLZM",
    "vchSig": "H4qb8eeBjHNSyKAr0xpNobuNiOkcipxxUa/Adramj1TJCHqYGngOYnnp17c5QO56rWXCjkhGVzv/p0UYRDOA394=",
    "sigTime": 1511275597,
    "protocolVersion": 70208,
    "nLastDsq": 0,
    "lastPing": {
      "outpoint": "f6c83fd96bfaa47887c4587cceadeb9af6238a2c86fe36b883c4d7a6867eab0f-1",
      "blockHash": "00000000044d4b20df21723eee44592b75ac5a57ab1bcd17fdae2e77f428fc69",
      "sigTime": 1511275597,
      "vchSig": "G+8b3yWlAK4q9AUuhQTi+T7DZdXtnULjxSuEcUE2Bg+XZgaFU8RQpLHAs9cnQFgPCX9+YsCYrdxV9x8BbP2iTXo="
    }
  },
  "overall": "Successfully decoded broadcast messages for 1 masternodes, failed to decode 0, total 1"
}

MNB relay

The masternodebroadcast relay RPC relays a masternode broadcast message to the network.

Parameter #2---object data (hex)

NameTypePresenceDescription
data-hexstring (hex)Required
(exactly 1)
The data (hex) of the masternode broadcast to relay

Result---broadcast message(s)

NameTypePresenceDescription
ResultobjectRequired
(exactly 1)
Object containing result data

Hash
string (hex)Required
(1 or more)
Masternode broadcast hash
→ →
outpoint
string (hex)Required
(exactly 1)
Masternode outpoint
→ →
addr
stringRequired
(exactly 1)
Masternode IP address and port
→ →
Result
string (hex)Required
(exactly 1)
Result - successful or failed
→ → →
error
stringOptionalError message if failed

overall
stringRequired
(exactly 1)
Summary of broadcast message creation success/failure

Example from Dash Core 0.12.2

masternodebroadcast relay 010fab7e86a6d7c483b836fe862c8a23f69aebadce7c58c4\
8778a4fa6bd93fc8f60100000000ffffffff00000000000000000000ffff2d20ed4c4e1f2102\
67fae84ef6aa6ab3d877b47932915a9b406566c873ea025986fc7e15a15fd2f24104341ab0d2\
6ae967856213df205bf172418422a847f3a63941d8031234a64a143f5570a6010d2b5e1dff16\
3c91316a65667f0ee1bfb0ff38edd0a695bea75de731411f8a9bf1e7818c7352c8a02bd31a4d\
a1bb8d88e91c8a9c7151afc076b6a68f54c9087a981a780e6279e9d7b73940ee7aad65c28e48\
46573bffa74518443380dfde4d3c145a00000000401201000fab7e86a6d7c483b836fe862c8a\
23f69aebadce7c58c48778a4fa6bd93fc8f60100000000ffffffff69fc28f4772eaefd17cd1b\
ab575aac752b5944ee3e7221df204b4d04000000004d3c145a00000000411bef1bdf25a500ae\
2af4052e8504e2f93ec365d5ed9d42e3c52b84714136060f9766068553c450a4b1c0b3d72740\
580f097f7e62c098addc55f71f016cfda24d7a0001000100

Result:

{
  "36b753f9c8d328d405b8a909bbf4fd29c0d37aa48eae98fa1289b90e36e002c4": {
    "outpoint": "f6c83fd96bfaa47887c4587cceadeb9af6238a2c86fe36b883c4d7a6867eab0f-1",
    "addr": "45.32.237.76:19999",
    "36b753f9c8d328d405b8a909bbf4fd29c0d37aa48eae98fa1289b90e36e002c4": "successful"
  },
  "overall": "Successfully relayed broadcast messages for 1 masternodes, failed to relay 0, total 1"
}

See also: none

SentinelPing

❗️

Warning: Removed in Dash Core 0.14.0.

The sentinelping RPC was removed in Dash Core 0.14.0.

Parameter #1---sentinel version

NameTypePresenceDescription
VersionstringRequired
(exactly 1)
Sentinel version in the form 'x.x.x'

Result---the message signature

NameTypePresenceDescription
ResultboolRequired
(exactly 1)
Ping result

Example from Dash Core 0.12.2

dash-cli -testnet sentinelping

Result:

true

See also: none

Updated 10 months ago


What's Next

HTTP REST

Removed RPCs


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.