bitcoind_request/command/
mod.rs

1pub mod get_best_block_hash;
2pub mod get_block;
3pub mod get_block_count;
4pub mod get_block_hash;
5pub mod get_block_header;
6pub mod get_block_stats;
7pub mod get_blockchain_info;
8pub mod get_chain_tips;
9pub mod get_chain_tx_stats;
10pub mod get_connection_count;
11pub mod get_difficulty;
12pub mod get_mempool_entry;
13pub mod get_mempool_info;
14pub mod get_mining_info;
15pub mod get_network_hash_ps;
16pub mod get_network_info;
17pub mod get_node_addresses;
18pub mod get_peer_info;
19pub mod get_raw_mempool;
20pub mod get_raw_transaction;
21pub mod get_tx_out;
22pub mod get_tx_out_set_info;
23pub mod request;
24
25mod callable_command;
26pub use callable_command::CallableCommand;
27
28/*
29= Blockchain ==
30> getbestblockhash
31> getblock "blockhash" ( verbosity )
32> getblockchaininfo
33> getblockcount
34getblockfilter "blockhash" ( "filtertype" )
35> getblockhash height
36> getblockheader "blockhash" ( verbose )
37> getblockstats hash_or_height ( stats )
38> getchaintips
39> getchaintxstats ( nblocks "blockhash" )
40> getdifficulty
41getmempoolancestors "txid" ( verbose )
42getmempooldescendants "txid" ( verbose )
43> getmempoolentry "txid"
44> getmempoolinfo
45> getrawmempool ( verbose mempool_sequence )
46> gettxout "txid" n ( include_mempool )
47gettxoutproof ["txid",...] ( "blockhash" )
48> gettxoutsetinfo ( "hash_type" hash_or_height use_index )
49preciousblock "blockhash"
50pruneblockchain height
51savemempool
52scantxoutset "action" ( [scanobjects,...] )
53verifychain ( checklevel nblocks )
54verifytxoutproof "proof"
55
56== Control ==
57getmemoryinfo ( "mode" )
58getrpcinfo
59help ( "command" )
60logging ( ["include_category",...] ["exclude_category",...] )
61stop
62uptime
63
64== Generating ==
65generateblock "output" ["rawtx/txid",...]
66generatetoaddress nblocks "address" ( maxtries )
67generatetodescriptor num_blocks "descriptor" ( maxtries )
68
69== Mining ==
70getblocktemplate ( "template_request" )
71> getmininginfo
72> getnetworkhashps ( nblocks height )
73prioritisetransaction "txid" ( dummy ) fee_delta
74submitblock "hexdata" ( "dummy" )
75submitheader "hexdata"
76
77== Network ==
78addnode "node" "command"
79clearbanned
80disconnectnode ( "address" nodeid )
81* getaddednodeinfo ( "node" )
82> getconnectioncount
83* getnettotals
84> getnetworkinfo
85> getnodeaddresses ( count "network" )
86> getpeerinfo
87* listbanned
88ping
89setban "subnet" "command" ( bantime absolute )
90setnetworkactive state
91
92== Rawtransactions ==
93analyzepsbt "psbt"
94combinepsbt ["psbt",...]
95combinerawtransaction ["hexstring",...]
96converttopsbt "hexstring" ( permitsigdata iswitness )
97createpsbt [{"txid":"hex","vout":n,"sequence":n},...] [{"address":amount,...},{"data":"hex"},...] ( locktime replaceable )
98createrawtransaction [{"txid":"hex","vout":n,"sequence":n},...] [{"address":amount,...},{"data":"hex"},...] ( locktime replaceable )
99decodepsbt "psbt"
100decoderawtransaction "hexstring" ( iswitness )
101decodescript "hexstring"
102finalizepsbt "psbt" ( extract )
103fundrawtransaction "hexstring" ( options iswitness )
104> getrawtransaction "txid" ( verbose "blockhash" )
105joinpsbts ["psbt",...]
106sendrawtransaction "hexstring" ( maxfeerate )
107signrawtransactionwithkey "hexstring" ["privatekey",...] ( [{"txid":"hex","vout":n,"scriptPubKey":"hex","redeemScript":"hex","witnessScript":"hex","amount":amount},...] "sighashtype" )
108testmempoolaccept ["rawtx",...] ( maxfeerate )
109utxoupdatepsbt "psbt" ( ["",{"desc":"str","range":n or [n,n]},...] )
110
111== Signer ==
112enumeratesigners
113
114== Util ==
115createmultisig nrequired ["key",...] ( "address_type" )
116deriveaddresses "descriptor" ( range )
117estimatesmartfee conf_target ( "estimate_mode" )
118getdescriptorinfo "descriptor"
119getindexinfo ( "index_name" )
120signmessagewithprivkey "privkey" "message"
121validateaddress "address"
122verifymessage "address" "signature" "message"
123
124== Wallet ==
125abandontransaction "txid"
126abortrescan
127addmultisigaddress nrequired ["key",...] ( "label" "address_type" )
128backupwallet "destination"
129bumpfee "txid" ( options )
130createwallet "wallet_name" ( disable_private_keys blank "passphrase" avoid_reuse descriptors load_on_startup external_signer )
131dumpprivkey "address"
132dumpwallet "filename"
133encryptwallet "passphrase"
134getaddressesbylabel "label"
135getaddressinfo "address"
136getbalance ( "dummy" minconf include_watchonly avoid_reuse )
137getbalances
138getnewaddress ( "label" "address_type" )
139getrawchangeaddress ( "address_type" )
140getreceivedbyaddress "address" ( minconf )
141getreceivedbylabel "label" ( minconf )
142gettransaction "txid" ( include_watchonly verbose )
143getunconfirmedbalance
144getwalletinfo
145importaddress "address" ( "label" rescan p2sh )
146importdescriptors "requests"
147importmulti "requests" ( "options" )
148importprivkey "privkey" ( "label" rescan )
149importprunedfunds "rawtransaction" "txoutproof"
150importpubkey "pubkey" ( "label" rescan )
151importwallet "filename"
152keypoolrefill ( newsize )
153listaddressgroupings
154listdescriptors
155listlabels ( "purpose" )
156listlockunspent
157listreceivedbyaddress ( minconf include_empty include_watchonly "address_filter" )
158listreceivedbylabel ( minconf include_empty include_watchonly )
159listsinceblock ( "blockhash" target_confirmations include_watchonly include_removed )
160listtransactions ( "label" count skip include_watchonly )
161listunspent ( minconf maxconf ["address",...] include_unsafe query_options )
162listwalletdir
163listwallets
164loadwallet "filename" ( load_on_startup )
165lockunspent unlock ( [{"txid":"hex","vout":n},...] )
166psbtbumpfee "txid" ( options )
167removeprunedfunds "txid"
168rescanblockchain ( start_height stop_height )
169send [{"address":amount,...},{"data":"hex"},...] ( conf_target "estimate_mode" fee_rate options )
170sendmany "" {"address":amount,...} ( minconf "comment" ["address",...] replaceable conf_target "estimate_mode" fee_rate verbose )
171sendtoaddress "address" amount ( "comment" "comment_to" subtractfeefromamount replaceable conf_target "estimate_mode" avoid_reuse fee_rate verbose )
172sethdseed ( newkeypool "seed" )
173setlabel "address" "label"
174settxfee amount
175setwalletflag "flag" ( value )
176signmessage "address" "message"
177signrawtransactionwithwallet "hexstring" ( [{"txid":"hex","vout":n,"scriptPubKey":"hex","redeemScript":"hex","witnessScript":"hex","amount":amount},...] "sighashtype" )
178unloadwallet ( "wallet_name" load_on_startup )
179upgradewallet ( version )
180walletcreatefundedpsbt ( [{"txid":"hex","vout":n,"sequence":n},...] ) [{"address":amount,...},{"data":"hex"},...] ( locktime options bip32derivs )
181walletdisplayaddress bitcoin address to display
182walletlock
183walletpassphrase "passphrase" timeout
184walletpassphrasechange "oldpassphrase" "newpassphrase"
185walletprocesspsbt "psbt" ( sign "sighashtype" bip32derivs )
186
187== Zmq ==
188getzmqnotifications
189*/