From 64a160198bfb6f9d01ce929721ab645e1fcead55 Mon Sep 17 00:00:00 2001
From: thephez <thephez@users.noreply.github.com>
Date: Wed, 11 Oct 2017 14:08:19 -0400
Subject: [PATCH] Add result detail and example to GetBlockTemplate

---
 .../dash-core/rpcs/rpcs/getblocktemplate.md   | 310 ++++++++++++++++++
 1 file changed, 310 insertions(+)

diff --git a/_includes/devdoc/dash-core/rpcs/rpcs/getblocktemplate.md b/_includes/devdoc/dash-core/rpcs/rpcs/getblocktemplate.md
index 83575a3b..73df5c9d 100644
--- a/_includes/devdoc/dash-core/rpcs/rpcs/getblocktemplate.md
+++ b/_includes/devdoc/dash-core/rpcs/rpcs/getblocktemplate.md
@@ -18,6 +18,316 @@ information, please see the following resources:
 * [BIP22][]
 * [BIP23][]
 
+*Parameters: none*
+
+*Result---block template*
+
+{% itemplate ntpd1 %}
+- n: "`result`"
+  t: "object"
+  p: "Required<br>(exactly 1)"
+  d: "A object containing a block template"
+
+- n: "→<br>`capabilities`"
+  t: "array (string)"
+  p: "Required<br>(1 or more)"
+  d: "The client side supported features"
+
+- n: "→ →<br>Capability"
+  t: "string"
+  p: "Optional<br>(0 or more)"
+  d: "A client side supported feature"
+
+- n: "→<br>`version`"
+  t: "number (int)"
+  p: "Required<br>(exactly 1)"
+  d: "The block version"
+
+- n: "→<br>`rules`"
+  t: "array (string)"
+  p: "Required<br>(1 or more)"
+  d: "The specific block rules that are to be enforced"
+
+- n: "→ →<br>Block Rule"
+  t: "string"
+  p: "Optional<br>(0 or more)"
+  d: "A specific block rule to be enforced"
+
+- n: "→<br>`vbavailable`"
+  t: "object"
+  p: "Required<br>(exactly 1)"
+  d: "Contains the set of pending, supported versionbit (BIP 9) softfork deployments"
+
+- n: "→ →<br>Bit Number"
+  t: "number"
+  p: "Required<br>(0 or more)"
+  d: "The bit number the named softfork rule"
+
+- n: "→<br>`vbrequired`"
+  t: "number"
+  p: "Required<br>(exactly 1)"
+  d: "The bit mask of versionbits the server requires set in submissions"
+
+- n: "→<br>`previousblockhash`"
+  t: "string (hex)"
+  p: "Required<br>(exactly 1)"
+  d: "The hash of current highest block"
+
+- n: "→<br>`transactions`"
+  t: "array (objects)"
+  p: "Optional<br>(0 or more)"
+  d: "The contents of non-coinbase transactions that should be included in the next block"
+
+- n: "→ →<br>Transaction"
+  t: "object"
+  p: "Optional (0 or more)"
+  d: "Object containing a non-coinbase transaction to include in the next block"
+
+- n: "→ → →<br>`data`"
+  t: "string (hex)"
+  p: "Optional (0 or more)"
+  d: "The transaction data encoded in hexadecimal (byte-for-byte)"
+
+- n: "→ → →<br>`hash`"
+  t: "string (hex)"
+  p: "Optional (0 or more)"
+  d: "The hash/id encoded in little-endian hexadecimal"
+
+- n: "→ → →<br>`depends`"
+  t: "array (numbers)"
+  p: "Required<br>(0 or more)"
+  d: "An array holding TXIDs of unconfirmed transactions this transaction depends upon (parent transactions)."
+
+- n: "→ → → →<br>Transaction number"
+  t: "number"
+  p: "Optional<br>(1 or more)"
+  d: "The transactions before this one (by 1-based index in 'transactions' list) that must be present in the final block if this one is"
+
+- n: "→ → →<br>`fee`"
+  t: "number"
+  p: "Required<br>(exactly 1)"
+  d: "The difference in value between transaction inputs and outputs (in duffs). For coinbase transactions, this is a negative number of the total collected block fees (ie., not including the block subsidy); if key is not present, fee is unknown and clients MUST NOT assume there isn't one"
+
+- n: "→ → →<br>`sigops`"
+  t: "number"
+  p: "Required<br>(exactly 1)"
+  d: "The total number of SigOps. If key not present, the count is unknown and clients MUST NOT assume there aren't any"
+
+- n: "→ → →<br>`required`"
+  t: "boolean"
+  p: "Optional<br>(exactly 1)"
+  d: "If provided and true, this transaction must be in the final block"
+
+- n: "→<br>`coinbaseaux`"
+  t: "object"
+  p: "Required<br>(exactly 1)"
+  d: "A object containing data that should be included in the coinbase scriptSig content"
+
+- n: "→ →<br>Flags"
+  t: "string"
+  p: "Required<br>(0 or more)"
+  d: ""
+
+- n: "→<br>`coinbasevalue`"
+  t: "number"
+  p: "Required<br>(exactly 1)"
+  d: "The maximum allowable input to coinbase transaction, including the generation award and transaction fees (in duffs)"
+
+- n: "→<br>`coinbasetxn`"
+  t: "object"
+  p: "Required<br>(exactly 1)"
+  d: "Information for the coinbase transaction)"
+
+- n: "→<br>`target`"
+  t: "string"
+  p: "Required<br>(exactly 1)"
+  d: "The hash target"
+
+- n: "→<br>`mintime`"
+  t: "number"
+  p: "Required<br>(exactly 1)"
+  d: "The minimum timestamp appropriate for next block time in seconds since epoch"
+
+- n: "→<br>`mutable`"
+  t: "array (string)"
+  p: "Required<br>(exactly 1)"
+  d: "The list of ways the block template may be changed"
+
+- n: "→ →<br>Value"
+  t: "string"
+  p: "Required<br>(0 or more)"
+  d: "A way the block template may be changed, e.g. 'time', 'transactions', 'prevblock'"
+
+- n: "→<br>`noncerange`"
+  t: "string"
+  p: "Required<br>(exactly 1)"
+  d: "A range of valid nonces"
+
+- n: "→<br>`sigoplimit`"
+  t: "number"
+  p: "Required<br>(exactly 1)"
+  d: "The limit of sigops in blocks"
+
+- n: "→<br>`sizelimit`"
+  t: "number"
+  p: "Required<br>(exactly 1)"
+  d: "The limit of block size"
+
+- n: "→<br>`curtime`"
+  t: "number"
+  p: "Required<br>(exactly 1)"
+  d: "The current timestamp in seconds since epoch"
+
+- n: "→<br>`bits`"
+  t: "string"
+  p: "Required<br>(exactly 1)"
+  d: "The compressed target of next block"
+
+- n: "→<br>`height`"
+  t: "number"
+  p: "Required<br>(exactly 1)"
+  d: "The height of the next block"
+
+- n: "→<br>`masternode`"
+  t: "object"
+  p: "Required<br>(exactly 1)"
+  d: "The masternode payee that must be included in the next block"
+
+- n: "→ →<br>`payee`"
+  t: "string"
+  p: "Required<br>(exactly 1)"
+  d: "Payee address"
+
+- n: "→ →<br>`script`"
+  t: "string"
+  p: "Required<br>(exactly 1)"
+  d: "Payee scriptPubKey"
+
+- n: "→ →<br>`amount`"
+  t: "number"
+  p: "Required<br>(exactly 1)"
+  d: "Required amount to pay"
+
+- n: "→<br>`masternode_payments_started`"
+  t: "boolean"
+  p: "Required<br>(exactly 1)"
+  d: "True if masternode payments started"
+
+- n: "→<br>`masternode_payments_enforced`"
+  t: "boolean"
+  p: "Required<br>(exactly 1)"
+  d: "True if masternode payments enforced"
+
+- n: "→<br>`superblock`"
+  t: "array (objects)"
+  p: "Required<br>(0 or more)"
+  d: "The superblock payees that must be included in the next block"
+
+- n: "→ →<br>Superblock Payee"
+  t: "object"
+  p: "Optional (0 or more)"
+  d: "Object containing a superblock payee's information"
+
+- n: "→ → →<br>`payee`"
+  t: "string"
+  p: "Required<br>(exactly 1)"
+  d: "Payee address"
+
+- n: "→ → →<br>`script`"
+  t: "string"
+  p: "Required<br>(exactly 1)"
+  d: "Payee scriptPubKey"
+
+- n: "→ → →<br>`amount`"
+  t: "number"
+  p: "Required<br>(exactly 1)"
+  d: "Required amount to pay"
+
+- n: "→<br>`superblocks_started`"
+  t: "boolean"
+  p: "Required<br>(exactly 1)"
+  d: "True if superblock payments started"
+
+- n: "→<br>`superblocks_enabled`"
+  t: "boolean"
+  p: "Required<br>(exactly 1)"
+  d: "True if superblock payments enabled"
+
+{% enditemplate %}
+
+*Example from Dash Core 0.12.2*
+
+{% highlight bash %}
+dash-cli -testnet getblocktemplate
+{% endhighlight %}
+
+Result:
+
+{% highlight json %}
+{
+  "capabilities": [
+    "proposal"
+  ],
+  "version": 536870913,
+  "rules": [
+    "dip0001"
+  ],
+  "vbavailable": {
+    "csv": 0
+  },
+  "vbrequired": 0,
+  "previousblockhash": "000000003d5c325259275fbf51a5dd623a13aade887cf83e5fdc3b\
+                        11898a71ce",
+  "transactions": [
+    {
+      "data": "01000000013e9e7e2116d8546a54d8531092d50e2da705a6f229f91a6d129f\
+               3f3e529d2bdb010000006a473044022044569ec727012e06bd4fa853fdcb2d\
+               c268f193ca00b68649f3dee0c0ca3207ff02206dc8656025c2f503e58779e6\
+               8a14ed18a7134f2c7d2c4235269bd70a3d6d5bd301210226d4ce54b37c1886\
+               92844201edbfb19e37cdbe7138a133b92b7d3d43ec157da6feffffff02a00b\
+               d100000000001976a914d7b47d4b40a23c389f5a17754d7f60f511c7d0ec88\
+               ac43321005140000001976a914616fdfd6eae0548f0b0f51bef165974abc10\
+               511688ac1e1f0000",
+      "hash": "9fd01aafcb4c59741ddfef41da2ec0eb3e1cc5b740150320b29534abdcd67e77",
+      "depends": [
+      ],
+      "fee": 226,
+      "sigops": 2
+    }
+  ],
+  "coinbaseaux": {
+    "flags": ""
+  },
+  "coinbasevalue": 13230000226,
+  "longpollid": "000000003d5c325259275fbf51a5dd623a13aade887cf83e5fdc3b11898a\
+                 71ce316",
+  "target": "00000001231e0000000000000000000000000000000000000000000000000000",
+  "mintime": 1507737402,
+  "mutable": [
+    "time",
+    "transactions",
+    "prevblock"
+  ],
+  "noncerange": "00000000ffffffff",
+  "sigoplimit": 40000,
+  "sizelimit": 2000000,
+  "curtime": 1507738818,
+  "bits": "1d01231e",
+  "height": 7967,
+  "masternode": {
+    "payee": "yaJc6tADbEjxQBAC69ugWNoTFpzxqkcgWd",
+    "script": "76a914996911b133d83de25d1f169c7046d74b728a757b88ac",
+    "amount": 6615000108
+  },
+  "masternode_payments_started": true,
+  "masternode_payments_enforced": true,
+  "superblock": [
+  ],
+  "superblocks_started": true,
+  "superblocks_enabled": true
+}
+{% endhighlight %}
+
 *See also*
 
 * [SetGenerate][rpc setgenerate]: {{summary_setGenerate}}