doc: add missing “testnet4” network string in RPC/init help texts #30642

pull theStack wants to merge 1 commits into bitcoin:master from theStack:202408-doc-add_missing_testnet4_in_rpc/init_help changing 3 files +3 −3
  1. theStack commented at 9:04 pm on August 12, 2024: contributor

    The following bitcoind parameters / RPC calls still missed the “testnet4” network string: - -chain= parameter - getblockchaininfo RPC, "chain" result - getmininginfo RPC, "chain" result

    The occurences were found via $ git grep \".*main.*test.*\".

  2. doc: add missing "testnet4" network string in RPC/init help texts
    The following bitcoind parameters / RPC calls missed the "testnet4"
    network string:
        - `-chain=` parameter
        - `getblockchaininfo` RPC, "chain" result
        - `getmininginfo` RPC, "chain" result
    7015300455
  3. DrahtBot commented at 9:04 pm on August 12, 2024: contributor

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    Code Coverage

    For detailed information about the code coverage, see the test coverage report.

    Reviews

    See the guideline for information on the review process.

    If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

  4. DrahtBot added the label Docs on Aug 12, 2024
  5. achow101 added this to the milestone 28.0 on Aug 12, 2024
  6. in src/rpc/blockchain.cpp:1276 in 7015300455
    1272@@ -1273,7 +1273,7 @@ RPCHelpMan getblockchaininfo()
    1273         RPCResult{
    1274             RPCResult::Type::OBJ, "", "",
    1275             {
    1276-                {RPCResult::Type::STR, "chain", "current network name (main, test, signet, regtest)"},
    1277+                {RPCResult::Type::STR, "chain", "current network name (main, test, testnet4, signet, regtest)"},
    


    maflcko commented at 6:03 am on August 13, 2024:

    Would it make sense to have a #define LIST_CHAIN_NAMES "main, test, testnet4, signet, regtest" in src/chainparamsbase.h? Otherwise, the lines of code will have to be touched again when testnet3 is removed.

    0                {RPCResult::Type::STR, "chain", "current network name (" LIST_CHAIN_NAMES ")"},
    

    tdb3 commented at 12:17 pm on August 13, 2024:
    Yes, this list of chain names could be de-duplicated as a macro as maflcko suggested or something like a std::string ListChainTypes() (perhaps in src/util/chaintypes.h/cpp, src/chainparamsbase.h/cpp, src/common/messages.h/cpp, etc. or where appropriate).
  7. maflcko approved
  8. maflcko commented at 6:04 am on August 13, 2024: member
    review ACK 701530045553f2b9671a3fffea301bf4dc954514
  9. glozow commented at 9:24 am on August 13, 2024: member
    ACK 701530045553f2b9671a3fffea301bf4dc954514
  10. tdb3 approved
  11. tdb3 commented at 12:19 pm on August 13, 2024: contributor

    ACK 701530045553f2b9671a3fffea301bf4dc954514

    Good finds.

    Ran bitcoin-cli help getblockchaininfo and help getmininginfo and confirmed presence of testnet4.

    Left a non-blocking comment. Would be beneficial to de-deplicate.

  12. BrandonOdiwuor approved
  13. BrandonOdiwuor commented at 2:08 pm on August 13, 2024: contributor
    ACK 701530045553f2b9671a3fffea301bf4dc954514
  14. danielabrozzoni approved
  15. danielabrozzoni commented at 2:23 pm on August 13, 2024: contributor
    ACK 701530045553f2b9671a3fffea301bf4dc954514
  16. theStack commented at 2:58 pm on August 13, 2024: contributor
    Thanks for the reviews! Deduplicating the chain list seems to be a good idea, I opened a good first issue for that: https://github.com/bitcoin/bitcoin/issues/30645
  17. glozow merged this on Aug 13, 2024
  18. glozow closed this on Aug 13, 2024

  19. theStack deleted the branch on Aug 13, 2024

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2024-11-21 15:12 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me