From afe1c54cafe727a948f9a3756a7b595f064ccbec Mon Sep 17 00:00:00 2001 From: thephez Date: Mon, 18 Dec 2017 12:22:17 -0500 Subject: [PATCH] Glossary - add some Dash terms --- _data/glossary/en/instantsend.yaml | 29 +++++++++++++++++++++ _data/glossary/en/masternode.yaml | 32 +++++++++++++++++++++++ _data/glossary/en/privatesend.yaml | 29 +++++++++++++++++++++ _data/glossary/en/spork.yaml | 34 +++++++++++++++++++++++++ _includes/devdoc/guide_dash_features.md | 4 +-- 5 files changed, 126 insertions(+), 2 deletions(-) create mode 100644 _data/glossary/en/instantsend.yaml create mode 100644 _data/glossary/en/masternode.yaml create mode 100644 _data/glossary/en/privatesend.yaml create mode 100644 _data/glossary/en/spork.yaml diff --git a/_data/glossary/en/instantsend.yaml b/_data/glossary/en/instantsend.yaml new file mode 100644 index 00000000..0bf2b2d2 --- /dev/null +++ b/_data/glossary/en/instantsend.yaml @@ -0,0 +1,29 @@ +--- +# 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: InstantSend + + summary_max_255_characters_no_formatting: > + InstantSend is a service that allows for near-instant transactions. + Through this system, inputs can be locked to specific transactions + and verified by consensus of the masternode network. + + synonyms_shown_in_glossary_capitalize_first_letter: + - InstantSend + - InstantX + - Transaction Lock + +optional: + synonyms_and_pluralizations_not_shown_in_glossary: + + not_to_be_confused_with_capitalize_first_letter: + + links_html_or_markdown_style_capitalize_first_letter: + - "[InstantSend](/en/developer-guide#instantsend) --- Developer Guide" + - "[InstantSend messages](/en/developer-reference#instantsend-messages) --- Developer Reference" + - "[InstantSend](https://dashpay.atlassian.net/wiki/spaces/DOC/pages/1146928/InstantSend) --- Official Wiki" + +--- diff --git a/_data/glossary/en/masternode.yaml b/_data/glossary/en/masternode.yaml new file mode 100644 index 00000000..3a6b4400 --- /dev/null +++ b/_data/glossary/en/masternode.yaml @@ -0,0 +1,32 @@ +--- +# 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: Masternode + + summary_max_255_characters_no_formatting: > + A computer that provides second-tier Dash functionality (InstantSend, + PrivateSend, decentralized governance). Masternodes are incentivized by + receiving part of the block reward, but must hold 1000 Dash as + collateral to prevent sybil attacks. + + synonyms_shown_in_glossary_capitalize_first_letter: + - Masternode + +optional: + synonyms_and_pluralizations_not_shown_in_glossary: + - Masternodes + - masternodes + + not_to_be_confused_with_capitalize_first_letter: + + links_html_or_markdown_style_capitalize_first_letter: + - "[Masternode Payment](/en/developer-guide#masternode-payment) --- Developer Guide" + - "[Masternode Sync](/en/developer-guide#masternode-sync) --- Developer Guide" + - "[Governance](/en/developer-guide#governance) --- Developer Guide" + - "[Masternode messages](/en/developer-reference#masternode-messages) --- Developer Reference" + - "[Masternode](https://dashpay.atlassian.net/wiki/spaces/DOC/pages/1146920/Masternode+Network) --- Official Wiki" + +--- diff --git a/_data/glossary/en/privatesend.yaml b/_data/glossary/en/privatesend.yaml new file mode 100644 index 00000000..e91eb4e5 --- /dev/null +++ b/_data/glossary/en/privatesend.yaml @@ -0,0 +1,29 @@ +--- +# 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: PrivateSend + + summary_max_255_characters_no_formatting: > + PrivateSend is a masternode managage, decentralized mixer for creating + an on-demand system of removing the history from coins on the network. + PrivateSend mixes inputs while allowing each participant to retain + control of their coins at all times so the process can be done without + trusting a third party. + + synonyms_shown_in_glossary_capitalize_first_letter: + - PrivateSend + +optional: + synonyms_and_pluralizations_not_shown_in_glossary: + + not_to_be_confused_with_capitalize_first_letter: + + links_html_or_markdown_style_capitalize_first_letter: + - "[PrivateSend](/en/developer-guide#privatesend) --- Developer Guide" + - "[PrivateSend messages](/en/developer-reference#privatesend-messages) --- Developer Reference" + - "[PrivateSend](https://dashpay.atlassian.net/wiki/spaces/DOC/pages/1146924/PrivateSend) --- Official Wiki" + +--- diff --git a/_data/glossary/en/spork.yaml b/_data/glossary/en/spork.yaml new file mode 100644 index 00000000..e98976a2 --- /dev/null +++ b/_data/glossary/en/spork.yaml @@ -0,0 +1,34 @@ +--- +# 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: Spork, Multi-Phased Fork + + summary_max_255_characters_no_formatting: > + A spork is a mechanism unique to Dash used to safely deploy + new features to the network through network-level variables + to avoid the risk of unintended network forking during upgrades. + + synonyms_shown_in_glossary_capitalize_first_letter: + - Spork + - Multi-Phased fork + +optional: + synonyms_and_pluralizations_not_shown_in_glossary: + - sporks + - multi-phased fork + + not_to_be_confused_with_capitalize_first_letter: + - 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) + - Software fork (when one or more developers permanently develops a codebase separately from other developers) + - Git fork (when one or more developers temporarily develops a codebase separately from other developers + + links_html_or_markdown_style_capitalize_first_letter: + - "[Spork message](/en/developer-reference#spork) --- Developer Reference" + - "[Multi-Phased Fork (Spork)](https://dashpay.atlassian.net/wiki/spaces/DOC/pages/19169298/Multi-Phased+Fork+Spork) --- Official Wiki" + - "[Understanding Sporks](https://dashpay.atlassian.net/wiki/spaces/DOC/pages/128319489/Understanding+Sporks) --- Official Wiki" + +--- diff --git a/_includes/devdoc/guide_dash_features.md b/_includes/devdoc/guide_dash_features.md index f001906d..4ac0766c 100644 --- a/_includes/devdoc/guide_dash_features.md +++ b/_includes/devdoc/guide_dash_features.md @@ -222,7 +222,7 @@ sync. The following tables detail the timing of various functions used to keep the masternodes in sync with each other. This information is derived from -`ThreadCheckPrivateSend` in `src/privatesend.cpp`. +`ThreadCheckPrivateSend` in `src/privatesend.cpp`. | **Period (seconds)** | **Action** | **Description** | | 6 | MN Sync | Synchronizes sporks, masternode list, masternode payments, and governance objects | @@ -234,7 +234,7 @@ The following actions only run when the masternode sync is past `MASTERNODE_SYNC | 60 | Process MN Connections | Disconnects some masternodes | | 60 | MN Check/Remove | Remove spent masternodes and check the state of inactive ones | | 60 | MN Payment Check/Remove | Remove old masternode payment votes/blocks | -| 60 | InstantSend Check/Remove | Remove expired/orphaned/invalid InstantSend candidates and votes | +| 60 | InstantSend Check/Remove | Remove expired/orphaned/invalid InstantSend candidates and votes | | 300 | Full verification | Verify masternodes via direct requests (`mnv` messages - note time constraints in the Developer Reference section) | | 300 | Maintenance | Check/remove/reprocess governance objects | | 600 | Manage State | Sends masternode pings (`mnp` message). Also sends initial masternode broadcast (`mnb` message) for local masternodes. |