Module bitcoind_json_rpc_types::v17

source ·
Expand description

JSON-RPC types for bitcoind v0.17.1.

These structs model the JSON data returned by the JSON-RPC API. They use stdlib types (or custom types), for more concrete types see crate::model.

A x marks methods that are implemented and tested.

== Blockchain ==

  • getbestblockhash
  • getblock "blockhash" ( verbosity )
  • getblockchaininfo
  • getblockcount
  • getblockhash height
  • getblockheader "hash" ( verbose )
  • getblockstats hash_or_height ( stats )
  • getchaintips
  • getchaintxstats ( nblocks blockhash )
  • getdifficulty
  • getmempoolancestors txid (verbose)
  • getmempooldescendants txid (verbose)
  • getmempoolentry txid
  • getmempoolinfo
  • getrawmempool ( verbose )
  • gettxout "txid" n ( include_mempool )
  • gettxoutproof ["txid",...] ( blockhash )
  • gettxoutsetinfo
  • preciousblock "blockhash"
  • pruneblockchain
  • savemempool
  • scantxoutset <action> ( <scanobjects> )
  • verifychain ( checklevel nblocks )
  • verifytxoutproof "proof"

== Control ==

  • getmemoryinfo ("mode")
  • help ( "command" )
  • logging ( <include> <exclude> )
  • stop
  • uptime

== Generating ==

  • generate nblocks ( maxtries )
  • generatetoaddress nblocks address (maxtries)

== Mining ==

  • getblocktemplate ( TemplateRequest )
  • getmininginfo
  • getnetworkhashps ( nblocks height )
  • prioritisetransaction <txid> <dummy value> <fee delta>
  • submitblock "hexdata" ( "dummy" )

== Network ==

  • addnode "node" "add|remove|onetry"
  • clearbanned
  • disconnectnode "[address]" [nodeid]
  • getaddednodeinfo ( "node" )
  • getconnectioncount
  • getnettotals
  • getnetworkinfo
  • getpeerinfo
  • listbanned
  • ping
  • setban "subnet" "add|remove" (bantime) (absolute)
  • setnetworkactive true|false

== Rawtransactions ==

  • combinepsbt ["psbt",...]
  • combinerawtransaction ["hexstring",...]
  • converttopsbt "hexstring" ( permitsigdata iswitness )
  • createpsbt [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable )
  • createrawtransaction [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable )
  • decodepsbt "psbt"
  • decoderawtransaction "hexstring" ( iswitness )
  • decodescript "hexstring"
  • finalizepsbt "psbt" ( extract )
  • fundrawtransaction "hexstring" ( options iswitness )
  • getrawtransaction "txid" ( verbose "blockhash" )
  • sendrawtransaction "hexstring" ( allowhighfees )
  • signrawtransaction "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] ["privatekey1",...] sighashtype )
  • signrawtransactionwithkey "hexstring" ["privatekey1",...] ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] sighashtype )
  • testmempoolaccept ["rawtxs"] ( allowhighfees )

== Util ==

  • createmultisig nrequired ["key",...] ( "address_type" )
  • estimatesmartfee conf_target ("estimate_mode")
  • signmessagewithprivkey "privkey" "message"
  • validateaddress "address"
  • verifymessage "address" "signature" "message"

== Wallet ==

  • abandontransaction "txid"
  • abortrescan
  • addmultisigaddress nrequired ["key",...] ( "label" "address_type" )
  • backupwallet "destination"
  • bumpfee "txid" ( options )
  • createwallet "wallet_name" ( disable_private_keys )
  • dumpprivkey "address"
  • dumpwallet "filename"
  • encryptwallet "passphrase"
  • getaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)
  • getaccountaddress (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)
  • getaddressbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)
  • getaddressesbylabel "label"
  • getaddressinfo "address"
  • getbalance ( "(dummy)" minconf include_watchonly )
  • getnewaddress ( "label" "address_type" )
  • getrawchangeaddress ( "address_type" )
  • getreceivedbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)
  • getreceivedbyaddress "address" ( minconf )
  • gettransaction "txid" ( include_watchonly )
  • getunconfirmedbalance
  • getwalletinfo
  • importaddress "address" ( "label" rescan p2sh )
  • importmulti "requests" ( "options" )
  • importprivkey "privkey" ( "label" ) ( rescan )
  • importprunedfunds
  • importpubkey "pubkey" ( "label" rescan )
  • importwallet "filename"
  • keypoolrefill ( newsize )
  • listaccounts (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)
  • listaddressgroupings
  • listlabels ( "purpose" )
  • listlockunspent
  • listreceivedbyaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)
  • listreceivedbyaddress ( minconf include_empty include_watchonly address_filter )
  • listsinceblock ( "blockhash" target_confirmations include_watchonly include_removed )
  • listtransactions (label count skip include_watchonly)
  • listunspent ( minconf maxconf ["addresses",...] [include_unsafe] [query_options])
  • listwallets
  • loadwallet "filename"
  • lockunspent unlock ([{"txid":"txid","vout":n},...])
  • move (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)
  • removeprunedfunds "txid"
  • rescanblockchain ("start_height") ("stop_height")
  • sendfrom (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)
  • sendmany "" {"address":amount,...} ( minconf "comment" ["address",...] replaceable conf_target "estimate_mode")
  • sendtoaddress "address" amount ( "comment" "comment_to" subtractfeefromamount replaceable conf_target "estimate_mode")
  • setaccount (Deprecated, will be removed in V0.18. To use this command, start bitcoind with -deprecatedrpc=accounts)
  • sethdseed ( "newkeypool" "seed" )
  • settxfee amount
  • signmessage "address" "message"
  • signrawtransactionwithwallet "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] sighashtype )
  • unloadwallet ( "wallet_name" )
  • walletcreatefundedpsbt [{"txid":"id","vout":n},...] [{"address":amount},{"data":"hex"},...] ( locktime ) ( replaceable ) ( options bip32derivs )
  • walletlock
  • walletpassphrase "passphrase" timeout
  • walletpassphrasechange "oldpassphrase" "newpassphrase"
  • walletprocesspsbt "psbt" ( sign "sighashtype" bip32derivs )

== Zmq ==

  • getzmqnotifications

Structs§

Enums§