Add node glossary term and full node types in dev guide

Added a node glossary term

Added descriptions of full nodes, archival nodes, and pruned nodes to the dev guide.

Linked the term "peer" to node instead of original location.
This commit is contained in:
Andrew Chow 2017-05-21 22:48:52 -04:00
parent 582be1bf61
commit 2390680b5d
5 changed files with 38 additions and 7 deletions

View file

@ -95,8 +95,6 @@ output index:
PaymentDetails: PaymentDetails:
PaymentRequest: PaymentRequest:
PaymentRequests: paymentrequest PaymentRequests: paymentrequest
peer:
peers: peer
peer-to-peer: network peer-to-peer: network
peer-to-peer network: network peer-to-peer network: network
'`ping` message': ping message '`ping` message': ping message

View file

@ -0,0 +1,31 @@
---
# This file is licensed under the MIT License (MIT) available on
# http://opensource.org/licenses/MIT.
required:
#-------------40 characters-------------#
title_max_40_characters_no_formatting: Node
summary_max_255_characters_no_formatting: >
A computer that connects to the Bitcoin network.
synonyms_shown_in_glossary_capitalize_first_letter:
- Node
- Full node
- Archival node
- Pruned node
- Peer
optional:
synonyms_and_pluralizations_not_shown_in_glossary:
- Nodes
- Peers
not_to_be_confused_with_capitalize_first_letter:
- Lightweight node
- SPV node
links_html_or_markdown_style_capitalize_first_letter:
- "[Full node](https://en.bitcoin.it/wiki/Full_node) --- Bitcoin Wiki"
---

View file

@ -17,6 +17,7 @@ optional:
synonyms_and_pluralizations_not_shown_in_glossary: synonyms_and_pluralizations_not_shown_in_glossary:
not_to_be_confused_with_capitalize_first_letter: not_to_be_confused_with_capitalize_first_letter:
- Miner Activated Soft Fork (a soft fork activated through miner signalling)
- Fork (a regular fork where all nodes follow the same consensus rules, so the fork is resolved once one chain has more proof of work than another) - Fork (a regular fork where all nodes follow the same consensus rules, so the fork is resolved once one chain has more proof of work than another)
- Hard fork (a permanent divergence in the block chain caused by non-upgraded nodes not following new consensus rules) - Hard fork (a permanent divergence in the block chain caused by non-upgraded nodes not following new consensus rules)
- Soft fork (a temporary divergence in the block chain caused by non-upgraded nodes not following new consensus rules) - Soft fork (a temporary divergence in the block chain caused by non-upgraded nodes not following new consensus rules)

View file

@ -10,10 +10,13 @@ http://opensource.org/licenses/MIT.
{% autocrossref %} {% autocrossref %}
The Bitcoin network protocol allows full nodes The Bitcoin network protocol allows full nodes
([peers][peer]{:#term-peer}{:.term}) to collaboratively maintain a (peers) to collaboratively maintain a
[peer-to-peer network][network]{:#term-network}{:.term} for block and [peer-to-peer network][network]{:#term-network}{:.term} for block and
transaction exchange. Many SPV clients also use this protocol to connect transaction exchange. Full nodes download and verify every block and transaction
to full nodes. prior to relaying them to other nodes. Archival nodes are full nodes which
store the entire blockchain and can serve historical blocks to other nodes.
Pruned nodes are full nodes which do not store the entire blockchain. Many SPV
clients also use the Bitcoin network protocol to connect to full nodes.
Consensus rules do not cover networking, so Bitcoin programs may use Consensus rules do not cover networking, so Bitcoin programs may use
alternative networks and protocols, such as the [high-speed block relay alternative networks and protocols, such as the [high-speed block relay

View file

@ -33,8 +33,6 @@ http://opensource.org/licenses/MIT.
[PaymentDetails]: /en/developer-examples#term-paymentdetails "The PaymentDetails of the payment protocol which allows the receiver to specify the payment details to the spender" [PaymentDetails]: /en/developer-examples#term-paymentdetails "The PaymentDetails of the payment protocol which allows the receiver to specify the payment details to the spender"
[PaymentRequest]: /en/developer-examples#term-paymentrequest "The PaymentRequest of the payment protocol which contains and allows signing of the PaymentDetails" [PaymentRequest]: /en/developer-examples#term-paymentrequest "The PaymentRequest of the payment protocol which contains and allows signing of the PaymentDetails"
[PaymentRequests]: /en/developer-examples#term-paymentrequest "The PaymentRequest of the payment protocol which contains and allows signing of the PaymentDetails" [PaymentRequests]: /en/developer-examples#term-paymentrequest "The PaymentRequest of the payment protocol which contains and allows signing of the PaymentDetails"
[peer]: /en/developer-guide#term-peer "Peer on the P2P network who receives and broadcasts transactions and blocks"
[peers]: /en/developer-guide#term-peer "Peers on the P2P network who receive and broadcast transactions and blocks"
[PKI]: /en/developer-examples#term-pki "Public Key Infrastructure; usually meant to indicate the X.509 certificate system used for HTTP Secure (https)." [PKI]: /en/developer-examples#term-pki "Public Key Infrastructure; usually meant to indicate the X.509 certificate system used for HTTP Secure (https)."
[point function]: /en/developer-guide#term-point-function "The ECDSA function used to create a public key from a private key" [point function]: /en/developer-guide#term-point-function "The ECDSA function used to create a public key from a private key"
[pp amount]: /en/developer-examples#term-pp-amount "Part of the Output part of the PaymentDetails part of a payment protocol where receivers can specify the amount of satoshis they want paid to a particular pubkey script" [pp amount]: /en/developer-examples#term-pp-amount "Part of the Output part of the PaymentDetails part of a payment protocol where receivers can specify the amount of satoshis they want paid to a particular pubkey script"