RPC Implementation Tracker

[luisschwab]

I've made this issue so we can keep track of implemented and missing RPCs.

Whenever a new RPC is implemented, documented¹ and/or we verify it is compliant² with Bitcoin Core, ping me or Davidson so this can be updated.

I'll split the different RPC groups into separate comments.

Let's keep any discussion outside of this issue. This is here just so we can keep track of what needs to be done.

Footnotes

1. Documented means we have a documentation markdown file under doc/rpc. ↩

2. Compliant means that Floresta's RPC is a superset of Bitcoin Core's RPC. It can be a superset because Floresta can return extra information on the RPC in addition to what Bitcoin Core returns (e.g. Floresta returns root_hashes on getblockchaininfo) ↩

[jaoleal]

#453

[luisschwab]

Blockchain RPCs

RPC	Implemented	Documented	Core Compliant	Notes
dumptxoutset	-	-	-	Impossible: Floresta doesn't have an UTXO set
getbestblockhash	TRUE	TRUE	TRUE
getblock	TRUE	TRUE	FALSE
getblockchaininfo	TRUE	TRUE	FALSE
getblockcount	TRUE	TRUE	TRUE
getblockfilter
getblockfrompeer
getblockhash	TRUE	TRUE	TRUE
getblockheader	TRUE	TRUE	TRUE
getblockstats
getchainstates
getchaintips
getchaintxstats
getdeploymentinfo
getdescriptoractivity
getdifficulty
getmempoolaancestors
getmempoolentry
getmempoolinfo
getrawmempool
gettxout	TRUE	TRUE
gettxoutproof	TRUE	TRUE	TRUE
gettxoutsetinfo	-	-	-	Impossible: Floresta doesn't have an UTXO set
gettxspendingprevout
importmempool
loadtxoutset	-	-	-	Impossible: Floresta doesn't have an UTXO set
preciousblock
pruneblockchain	-	-	-	Impossible: Floresta's blockchain is already pruned
savemempool
scanblocks
scantxoutset	-	-	-	Impossible: Floresta doesn't have an UTXO set
verifychain
verifytxoutproof
waitforblock
waitforblockheight
waitfornewblock

[luisschwab]

Control RPCs

RPC	Implemented	Documented	Core Compliant	Notes
getmemoryinfo	TRUE	TRUE	TRUE
getrpcinfo	TRUE	TRUE	TRUE
help	TRUE	TRUE	TRUE
logging	TRUE	TRUE	TRUE
stop	TRUE	TRUE	TRUE
uptime	TRUE	FALSE	TRUE

[luisschwab]

Mining RPCs

RPC	Implemented	Documented	Core Compliant	Notes
getblocktemplate
getmininginfo
getnetworkhashps
getprioritisedtransactions
prioritisetransaction
submitblock
submitheader

[luisschwab]

Network RPCs

RPC	Implemented	Documented	Core Compliant	Notes
addnode	TRUE	TRUE	TRUE
clearbanned
disconnectnode	TRUE	TRUE	TRUE
getaddednodeinfo
getaddmaninfo
connectioncount
getnettotals
getnetworkinfo
getnodeaddresses
getpeerinfo	TRUE	TRUE	FALSE
listbanned
ping	TRUE	TRUE	TRUE
setban

[luisschwab]

Raw Transaction RPCs

RPC	Implemented	Documented	Core Compliant	Notes
analyzepsbt
combinepsbt
combinerawtransaction
converttopsbt
createpsbt
createrawtransaction
decodepsbt
decoderawtransaction
decodescript
descriptorprocesspsbt
finalizepsbt
fundrawtransaction
getrawtransaction
joinpsbts
sendrawtransaction	TRUE	TRUE	TRUE
signrawtransaction
signrawtransactionwithkey
submitpackage
testmempoolaccept
utxoupdatepsbt

[luisschwab]

Signer RPCs

RPC	Implemented	Documented	Core Compliant	Notes
enumeratesigners

[luisschwab]

Util RPCs

RPC	Implemented	Documented	Core Compliant	Notes
createmultisig
deriveaddresses
estimatesmartfee
getdescriptorinfo
getindexinfo
signmessagewithprivkey
validateaddress
verifymessage

[luisschwab]

Wallet RPCs

RPC	Implemented	Documented	Core Compliant	Notes
abandontransaction
abortrescan
backupwallet
bumpfee
createwallet
avoid_reuse
createwalletdescriptor
encryptwallet
getaddressbylabel
getaddressinfo
getbalance
getbalances
gethdkeys
getnewaddress
getrawchangeaddress
getreceivedbyaddress
getreceivedbylabel
gettransaction	TRUE	TRUE	?
getwalletinfo
importdescriptors
importprunedfunds
keypoolrefill
listaddressgroupings
listdescriptors	TRUE	TRUE	TRUE
listlabels
listlockunspent
listreceivedbyaddress
listreceivedbylabel
listsinceblock
listtransactions
listunspent
listwalletdir
listwallets
loadwallet
lockunspent
migratewallet
psbtbumpfee
removeprunedfunds
rescanblockchain	TRUE	TRUE	TRUE
restorewallet
send
sendall
sendmany
sendtoaddress
setlabel
settxfee
setwalletflag
signmessage
signrawtransactionwithwallet
simulaterawtransaction
unloadwallet
walletcreatefundedpsbt
walletdisplayaddress
walletlock
walletpassphrase
walletpassphrasechange
walletprocesspsbt

[luisschwab]

ZMQ RPCs

RPC	Implemented	Documented	Core Compliant	Notes
getzmqnotifications

[luisschwab]

Floresta-specific RPCs

RPC	Implemented	Documented	Notes
getroots	TRUE	FALSE

[moisesPompilio]

"gettransaction" is not implemented; we have it in floresta-rpc and floresta-cli, but it was not implemented in floresta-node, so it is not present in Floresta.

[luisschwab]

Why is it implemented in RPC if it doesn't work?

Floresta % floresta-cli -n signet gettransaction --help
Returns the transaction, assuming it is cached by our watch only wallet

Usage:

Arguments:
  <TXID>
  [VERBOSE]  [possible values: true, false]

Options:
  -h, --help  Print help

[moisesPompilio]

Our "loaddescriptor" would be "importdescriptors". It needs an adjustment to the request parameters: currently we only accept the descriptor as a single item, so we need to change the request to accept multiple descriptors. Also, some things about range and label need handling, which the code doesn't implement today.