1
0
mirror of https://github.com/bitcoin/bips.git synced 2025-05-12 12:03:29 +00:00

BIP 9, 22 & 145: Use simple Yes/No rather than templates (which don't work on GitHub)

This commit is contained in:
Luke Dashjr 2016-04-23 20:32:59 +00:00
parent 2e5533849e
commit 31c45b611d
3 changed files with 19 additions and 19 deletions

View File

@ -170,7 +170,7 @@ The template request Object is extended to include a new item:
|- |-
! Key !! Required !! Type !! Description ! Key !! Required !! Type !! Description
|- |-
| rules || {{No}} || Array of Strings || list of supported softfork deployments, by name | rules || No || Array of Strings || list of supported softfork deployments, by name
|} |}
The template Object is also extended: The template Object is also extended:
@ -180,11 +180,11 @@ The template Object is also extended:
|- |-
! Key !! Required !! Type !! Description ! Key !! Required !! Type !! Description
|- |-
| rules || {{Yes}} || Array of Strings || list of softfork deployments, by name, that are active state | rules || Yes || Array of Strings || list of softfork deployments, by name, that are active state
|- |-
| vbavailable || {{Yes}} || Object || set of pending, supported softfork deployments; each uses the softfork name as the key, and the softfork bit as its value | vbavailable || Yes || Object || set of pending, supported softfork deployments; each uses the softfork name as the key, and the softfork bit as its value
|- |-
| vbrequired || {{No}} || Number || bit mask of softfork deployment version bits the server requires enabled in submissions | vbrequired || No || Number || bit mask of softfork deployment version bits the server requires enabled in submissions
|} |}
The "version" key of the template is retained, and used to indicate the server's preference of deployments. The "version" key of the template is retained, and used to indicate the server's preference of deployments.

View File

@ -26,9 +26,9 @@ Block template creation can be influenced by various parameters:
|- |-
! Key !! Required !! Type !! Description ! Key !! Required !! Type !! Description
|- |-
| capabilities || {{No}} || Array of Strings || SHOULD contain a list of the following, to indicate client-side support: [[#Optional: Long Polling|"longpoll"]], "coinbasetxn", "coinbasevalue", [[bip-0023.mediawiki#Block Proposal|"proposal"]], [[bip-0023.mediawiki#Logical Services|"serverlist"]], "workid", and any of the [[bip-0023.mediawiki#Mutations|mutations]] | capabilities || No || Array of Strings || SHOULD contain a list of the following, to indicate client-side support: [[#Optional: Long Polling|"longpoll"]], "coinbasetxn", "coinbasevalue", [[bip-0023.mediawiki#Block Proposal|"proposal"]], [[bip-0023.mediawiki#Logical Services|"serverlist"]], "workid", and any of the [[bip-0023.mediawiki#Mutations|mutations]]
|- |-
| mode || {{No}} || String || MUST be "template" or omitted | mode || No || String || MUST be "template" or omitted
|} |}
getblocktemplate MUST return a JSON Object containing the following keys: getblocktemplate MUST return a JSON Object containing the following keys:
@ -37,29 +37,29 @@ getblocktemplate MUST return a JSON Object containing the following keys:
|- |-
! Key !! Required !! Type !! Description ! Key !! Required !! Type !! Description
|- |-
| bits || {{Yes}} || String || the compressed difficulty in hexadecimal | bits || Yes || String || the compressed difficulty in hexadecimal
|- |-
| curtime || {{Yes}} || Number || the current time as seen by the server (recommended for block time) - note this is not necessarily the system clock, and must fall within the mintime/maxtime rules | curtime || Yes || Number || the current time as seen by the server (recommended for block time) - note this is not necessarily the system clock, and must fall within the mintime/maxtime rules
|- |-
| height || {{Yes}} || Number || the height of the block we are looking for | height || Yes || Number || the height of the block we are looking for
|- |-
| previousblockhash || {{Yes}} || String || the hash of the previous block, in big-endian hexadecimal | previousblockhash || Yes || String || the hash of the previous block, in big-endian hexadecimal
|- |-
| sigoplimit || {{No}} || Number || number of sigops allowed in blocks | sigoplimit || No || Number || number of sigops allowed in blocks
|- |-
| sizelimit || {{No}} || Number || number of bytes allowed in blocks | sizelimit || No || Number || number of bytes allowed in blocks
|- |-
| transactions || {{Yes|Should}} || Array of Objects || Objects containing [[#Transactions Object Format|information for Bitcoin transactions]] (excluding coinbase) | transactions || Should || Array of Objects || Objects containing [[#Transactions Object Format|information for Bitcoin transactions]] (excluding coinbase)
|- |-
| version || {{Yes}} || Number || always 1 or 2 (at least for bitcoin) - clients MUST understand the implications of the version they use (eg, comply with [[bip-0034.mediawiki|BIP 0034]] for version 2) | version || Yes || Number || always 1 or 2 (at least for bitcoin) - clients MUST understand the implications of the version they use (eg, comply with [[bip-0034.mediawiki|BIP 0034]] for version 2)
|- |-
| coinbaseaux || {{No}} || Object || data that SHOULD be included in the coinbase's scriptSig content. Only the values (hexadecimal byte-for-byte) in this Object should be included, not the keys. This does not include the block height, which is required to be included in the scriptSig by [[bip-0034.mediawiki|BIP 0034]]. It is advisable to encode values inside "PUSH" opcodes, so as to not inadvertently expend SIGOPs (which are counted toward limits, despite not being executed). | coinbaseaux || No || Object || data that SHOULD be included in the coinbase's scriptSig content. Only the values (hexadecimal byte-for-byte) in this Object should be included, not the keys. This does not include the block height, which is required to be included in the scriptSig by [[bip-0034.mediawiki|BIP 0034]]. It is advisable to encode values inside "PUSH" opcodes, so as to not inadvertently expend SIGOPs (which are counted toward limits, despite not being executed).
|- |-
| coinbasetxn || {{Patch|this or ↓}} || Object || [[#Transactions Object Format|information for coinbase transaction]] | coinbasetxn || this or ↓ || Object || [[#Transactions Object Format|information for coinbase transaction]]
|- |-
| coinbasevalue || {{Patch|this or ↑}} || Number || total funds available for the coinbase (in Satoshis) | coinbasevalue || this or ↑ || Number || total funds available for the coinbase (in Satoshis)
|- |-
| workid || {{No}} || String || if provided, this value must be returned with results (see [[#Block Submission|Block Submission]]) | workid || No || String || if provided, this value must be returned with results (see [[#Block Submission|Block Submission]])
|} |}
==== Transactions Object Format ==== ==== Transactions Object Format ====

View File

@ -22,7 +22,7 @@ The template Object is revised to include a new key:
|- |-
! Key !! Required !! Type !! Description ! Key !! Required !! Type !! Description
|- |-
| costlimit || {{No}} || Number || total cost allowed in blocks | costlimit || No || Number || total cost allowed in blocks
|} |}
====Transactions Object Format==== ====Transactions Object Format====