Skip to content

Commit 57e4806

Browse files
MarcoFalkeRandyMcMillan
authored andcommitted
doc: Remove section about RPC alias via function pointer
This is no longer possible with RPCHelpMan.
1 parent 2c56cdb commit 57e4806

File tree

1 file changed

+0
-11
lines changed

1 file changed

+0
-11
lines changed

doc/developer-notes.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1416,17 +1416,6 @@ A few guidelines for introducing and reviewing new RPC interfaces:
14161416
until the wallet is caught up to the chainstate as of the RPC call's entry.
14171417
This also makes the API much easier for RPC clients to reason about.
14181418

1419-
- Be aware of RPC method aliases and generally avoid registering the same
1420-
callback function pointer for different RPCs.
1421-
1422-
- *Rationale*: RPC methods registered with the same function pointer will be
1423-
considered aliases and only the first method name will show up in the
1424-
`help` RPC command list.
1425-
1426-
- *Exception*: Using RPC method aliases may be appropriate in cases where a
1427-
new RPC is replacing a deprecated RPC, to avoid both RPCs confusingly
1428-
showing up in the command list.
1429-
14301419
- Use *invalid* bech32 addresses (e.g. in the constant array `EXAMPLE_ADDRESS`) for
14311420
`RPCExamples` help documentation.
14321421

0 commit comments

Comments
 (0)