laantungir
/
bitcoin
mirror of https://github.com/bitcoin/bitcoin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: Remove section about RPC alias via function pointer 

This is no longer possible with RPCHelpMan.
This commit is contained in:
MarcoFalke 2025-05-20 18:36:13 +02:00
parent 2222d61e1c
commit faaf34ad72
No known key found for this signature in database
1 changed files with 0 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/developer-notes.md
View File

@ -1429,17 +1429,6 @@ A few guidelines for introducing and reviewing new RPC interfaces:
until the wallet is caught up to the chainstate as of the RPC call's entry. until the wallet is caught up to the chainstate as of the RPC call's entry.
This also makes the API much easier for RPC clients to reason about. This also makes the API much easier for RPC clients to reason about.
- Be aware of RPC method aliases and generally avoid registering the same
callback function pointer for different RPCs.
- *Rationale*: RPC methods registered with the same function pointer will be
considered aliases and only the first method name will show up in the
`help` RPC command list.
- *Exception*: Using RPC method aliases may be appropriate in cases where a
new RPC is replacing a deprecated RPC, to avoid both RPCs confusingly
showing up in the command list.
- Use *invalid* bech32 addresses (e.g. in the constant array `EXAMPLE_ADDRESS`) for - Use *invalid* bech32 addresses (e.g. in the constant array `EXAMPLE_ADDRESS`) for
`RPCExamples` help documentation. `RPCExamples` help documentation.