rpc: rename getdeploymentinfo status-next to status_next #24528

pull jonatack wants to merge 1 commits into bitcoin:master from jonatack:getdeploymentinfo-rename-status-next-to-status_next changing 2 files +4 −4
  1. jonatack commented at 9:26 am on March 11, 2022: member

    Rename the status-next field to status_next in getdeploymentinfo before the RPC is released in v23.

    Before

     0Result:
     1{                                       (json object)
     2  "hash" : "str",                       (string) requested block hash (or tip)
     3  "height" : n,                         (numeric) requested block height (or tip)
     4  "deployments" : {                     (json object)
     5    "xxxx" : {                          (json object) name of the deployment
     6      "type" : "str",                   (string) one of "buried", "bip9"
     7      "height" : n,                     (numeric, optional) height of the first block which the rules are or will be enforced (only for "buried" type, or "bip9" type with "active" status)
     8      "active" : true|false,            (boolean) true if the rules are enforced for the mempool and the next block
     9      "bip9" : {                        (json object, optional) status of bip9 softforks (only for "bip9" type)
    10        "bit" : n,                      (numeric, optional) the bit (0-28) in the block version field used to signal this softfork (only for "started" and "locked_in" status)
    11        "start_time" : xxx,             (numeric) the minimum median time past of a block at which the bit gains its meaning
    12        "timeout" : xxx,                (numeric) the median time past of a block at which the deployment is considered failed if not yet locked in
    13        "min_activation_height" : n,    (numeric) minimum height of blocks for which the rules may be enforced
    14        "status" : "str",               (string) status of deployment at specified block (one of "defined", "started", "locked_in", "active", "failed")
    15        "since" : n,                    (numeric) height of the first block to which the status applies
    16        "status-next" : "str",          (string) status of deployment at the next block
    17        "statistics" : {                (json object, optional) numeric statistics about signalling for a softfork (only for "started" and "locked_in" status)
    18          "period" : n,                 (numeric) the length in blocks of the signalling period
    19          "threshold" : n,              (numeric, optional) the number of blocks with the version bit set required to activate the feature (only for "started" status)
    20          "elapsed" : n,                (numeric) the number of blocks elapsed since the beginning of the current period
    21          "count" : n,                  (numeric) the number of blocks with the version bit set in the current period
    22          "possible" : true|false       (boolean, optional) returns false if there are not enough blocks left in this period to pass activation threshold (only for "started" status)
    23        },
    24        "signalling" : "str"            (string) indicates blocks that signalled with a # and blocks that did not with a -
    25      }
    26    }
    27  }
    28}
    

    After

     0Result:
     1{                                       (json object)
     2  "hash" : "str",                       (string) requested block hash (or tip)
     3  "height" : n,                         (numeric) requested block height (or tip)
     4  "deployments" : {                     (json object)
     5    "xxxx" : {                          (json object) name of the deployment
     6      "type" : "str",                   (string) one of "buried", "bip9"
     7      "height" : n,                     (numeric, optional) height of the first block which the rules are or will be enforced (only for "buried" type, or "bip9" type with "active" status)
     8      "active" : true|false,            (boolean) true if the rules are enforced for the mempool and the next block
     9      "bip9" : {                        (json object, optional) status of bip9 softforks (only for "bip9" type)
    10        "bit" : n,                      (numeric, optional) the bit (0-28) in the block version field used to signal this softfork (only for "started" and "locked_in" status)
    11        "start_time" : xxx,             (numeric) the minimum median time past of a block at which the bit gains its meaning
    12        "timeout" : xxx,                (numeric) the median time past of a block at which the deployment is considered failed if not yet locked in
    13        "min_activation_height" : n,    (numeric) minimum height of blocks for which the rules may be enforced
    14        "status" : "str",               (string) status of deployment at specified block (one of "defined", "started", "locked_in", "active", "failed")
    15        "since" : n,                    (numeric) height of the first block to which the status applies
    16        "status_next" : "str",          (string) status of deployment at the next block
    17        "statistics" : {                (json object, optional) numeric statistics about signalling for a softfork (only for "started" and "locked_in" status)
    18          "period" : n,                 (numeric) the length in blocks of the signalling period
    19          "threshold" : n,              (numeric, optional) the number of blocks with the version bit set required to activate the feature (only for "started" status)
    20          "elapsed" : n,                (numeric) the number of blocks elapsed since the beginning of the current period
    21          "count" : n,                  (numeric) the number of blocks with the version bit set in the current period
    22          "possible" : true|false       (boolean, optional) returns false if there are not enough blocks left in this period to pass activation threshold (only for "started" status)
    23        },
    24        "signalling" : "str"            (string) indicates blocks that signalled with a # and blocks that did not with a -
    25      }
    26    }
    27  }
    28}
    
  2. rpc: rename getdeploymentinfo status-next to status_next 5d7c69b887
  3. fanquake added the label RPC/REST/ZMQ on Mar 11, 2022
  4. jonatack commented at 9:33 am on March 11, 2022: member
    Hm, this field is in getblockchaininfo too, so it may break the existing API.
  5. jonatack closed this on Mar 11, 2022

  6. ajtowns commented at 9:43 am on March 11, 2022: member
    It was introduced into getblockchaininfo at the same time getdeploymentinfo was added, so it’s not an additional break to the existing API.
  7. jonatack commented at 9:59 am on March 11, 2022: member
    Thanks @ajtowns, re-opening.
  8. jonatack reopened this on Mar 11, 2022

  9. ajtowns commented at 2:17 pm on March 11, 2022: member
    ACK if it can make it into 23.0
  10. MarcoFalke added this to the milestone 23.0 on Mar 11, 2022
  11. MarcoFalke added the label Needs backport (23.x) on Mar 11, 2022
  12. MarcoFalke commented at 9:23 am on March 13, 2022: member
    ACK. Looks like we prefer underscore over dash everywhere else.
  13. MarcoFalke merged this on Mar 13, 2022
  14. MarcoFalke closed this on Mar 13, 2022

  15. jonatack deleted the branch on Mar 13, 2022
  16. jonatack commented at 12:23 pm on March 13, 2022: member
    Added this commit to #24512.
  17. fanquake removed the label Needs backport (23.x) on Mar 13, 2022
  18. jonatack referenced this in commit ef6a37b7c4 on Mar 13, 2022
  19. sidhujag referenced this in commit cc4f5d8476 on Mar 13, 2022
  20. hebasto referenced this in commit d27fb2b831 on Mar 31, 2022
  21. fanquake referenced this in commit c243e08351 on Mar 31, 2022
  22. DrahtBot locked this on Mar 13, 2023


jonatack ajtowns MarcoFalke

Labels
RPC/REST/ZMQ

Milestone
23.0


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-12-19 09:12 UTC

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