Skip to content

Commit

Permalink
solution and first batch integration of case sensistive or differing …
Browse files Browse the repository at this point in the history
…glossary terms
  • Loading branch information
DrDBanner committed Jan 22, 2021
1 parent b22fde0 commit 85944d0
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 30 deletions.
28 changes: 19 additions & 9 deletions glossary.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. meta::
:description lang=en: An overview of the nomenclature and terms of Particl.
:description lang=en: An overview of the terms of Particl.


=========
Expand Down Expand Up @@ -27,6 +27,8 @@ General Terms
Cryptocurrency
Cryptocurrencies are digital units of a currency that can be transferred person-to-person without requiring a third-party (payment processor) to facilitate transactions. It enables near-free, near-instant currency transactions that cannot be held up, blocked, reversed, or delayed by any party.

Tor
The Tor network is a free and open-source network that enables anonymous online communication. It protects your digital privacy by anonymizing your IP address. It does so by routing your connection through a vast and global network of volunteers. Tor's intended use is to protect your personal privacy as well as your freedom and ability to conduct confidential communication. When enabled on Particl, it makes your node's IP address entirely anonymous.

Particl Terms
-------------
Expand All @@ -40,9 +42,12 @@ Particl Terms
The Particl Project refers to all combined efforts, people, and community contributing to the development, maintenance, promotion, and adoption of the Particl decentralized network. It is often simply referred to as "Particl" as well, depending on the context.

Particl Network
A decentralized network is a distributed network that runs autonomously. The Particl Network is Particl's own decentralized network.
The Particl Network consists of two technologies:

1. The Particl Blockchain is a decentralized and immutable ledger, based on bitcoin technology but carefully enhanced by the Particl Developers with industry-leading privacy technology. The Particl Blockchain secures and testifies payments, the exchange of value in a decentralized way without the need for any banking system.


The Particl Network doesn't rely on central server or database and each participant contributes to its functioning and maintenance. Any communication, exchange of data, or trade is done directly between each Particl user and without any central authority facilitating the exchange.
2. Secondly, a data-layer named Particl SecureMessaging (SMSG protocol) which is utilized as a decentralized storage network (DSN) to transfer data between nodes in a privacy-preserving manner. Particl SecureMessaging enables a privacy-proof environment for e-commerce with Particl Marketplace and communications between users without bloating the Blockchain and leaving permanent records.

Particl Blockchain
The Particl Blockchain is a decentralized, immutable, and censorship-proof ledger. It is based on bitcoin technology and has been carefully enhanced by the Particl team to provide a more robust level of privacy through industry-leading privacy technologies. The Particl Blockchain processes and validates payments between two users without requiring any third-party such as a bank or a payment processor.
Expand All @@ -59,19 +64,24 @@ Particl Terms
The Particl Marketplace is a decentralized marketplace that allows two users to buy and sell anything from each other without the assistance of any third-party (i.e. bank, payment processor, centralized marketplace, etc). It is Particl's flagship application and provides much more privacy, security, and freedom than typical marketplaces. Since it is decentralized, it charges no sales commission and other similar types of fees.

Particl's Open Market Protocol (OMP)
The OMP is the back-end protocol that makes the Particl Marketplace possible. It is the framework that defines how marketplace transactions, orders, listings, and other key e-commerce functionalities are to be processed by the SMSG network and the Particl Blockchain. It is the "glue" that sticks everything together. If Particl Desktop is what people use to access the marketplace (the front end), the OMP is what makes it possible in the background (the back-end). To learn more about the OMP Library, head over to the `Open Market Protocol Wiki page <https://particl.wiki/learn/marketplace/open-market-protocol/>`_.
The OMP (Open Marketplace Protocol) is the back-end protocol that makes the Particl Marketplace possible. It is the framework that defines how marketplace transactions, orders, listings, and other key e-commerce functionalities are to be processed by the SMSG network and the Particl Blockchain. It is the "glue" that sticks everything together. If Particl Desktop is what people use to access the marketplace (the front end), the OMP is what makes it possible in the background (the back-end). To learn more about the OMP Library, head over to the `Open Market Protocol Wiki page <https://particl.wiki/learn/marketplace/open-market-protocol/>`_.

Particl Desktop
Particl Desktop is the main client of the Particl Project and is a user-friendly interface into the Particl network. It is the main point of access into the Particl ecosystem and lets users complete all basic activities one would expect to do on Particl. This includes making cryptocurrency transactions, using the Particl Marketplace, sending messages to other users, and so on.

Particl SDK
The Particl Software Development Kit (SDK) is a set of tools and documentation that enables independent developers to contribute to the Particl Ecosystem (any of its software, product, or service). It's purpose is to speed up the onboarding process of independent developers and streamline all the tools and knowledge they need to acquire to get started.

Particl Bots
Particl Bots are Particl Desktop functionalities provided by third-parties. As these services are not decentralized, they are not activated by default and need to be manually enabled by the user. Particl Bots can have various purposes, most of the time related to a service, such as providing cryptocurrency exchange capabilities, providing data (i.e. cryptocurrency prices), payment integrations, and etc.

Open Market
The Open Market is the main market on Particl Marketplace. It is enabled by default and is the only market you have access to when launching Particl Desktop for the first time. The Open Market is a general purpose market where anyone can buy or sell anything with no particular theme.

Tor
The Tor network is a free and open-source network that enables anonymous online communication. It protects your digital privacy by anonymizing your IP address. It does so by routing your connection through a vast and global network of volunteers. Tor's intended use is to protect your personal privacy as well as your freedom and ability to conduct confidential communication. When enabled on Particl, it makes your node's IP address entirely anonymous.
Particl Ecosystem
It describes the whole of any value or participant within the Particl Project economic cycle. Anything or anybody contributing or utilizing Particl’s economic model (Particl Coin) or any other Particl Application is a part of it.

Particl Foundation
Describes a swiss based non-profit legal entity serving the Particl Ecosystem.

Particl Bots
Describes a standardized snap-in functionality within the Particl Desktop client software to enable 3rd parties to offer their services in exchange for PART and automating tasks within Particl Desktop client.

As these services are not decentralized, they are not activated by default and need to be manually enabled by the user. Particl Bots can have various purposes, most of the time related to a service, such as providing cryptocurrency exchange capabilities, providing data (i.e. cryptocurrency prices), payment integrations, and etc.
2 changes: 1 addition & 1 deletion guides/guide_mp_customer_understanding_buyflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Buy Process
.. meta::
:description lang=en: Learn how the buyflow works on :term:`Particl Marketplace` from a customer perspective.

The buying process of :term:`Particl Marketplace` gives you more privacy, security, and censorship resistance than any other online marketplace and is entirely free to use except for the tiny sub-cent transaction fees usually associated with :term:`cryptocurrency` transactions. The price to pay for these previously impossible benefits is that you are required to do things a bit differently than what you are used to.
The buying process of :term:`Particl Marketplace` gives you more privacy, security, and censorship resistance than any other online marketplace and is entirely free to use except for the tiny sub-cent transaction fees usually associated with :term:`cryptocurrency <Cryptocurrency>` transactions. The price to pay for these previously impossible benefits is that you are required to do things a bit differently than what you are used to.

Rest assured, it's not complicated at all. Just follow this quick user guide and you'll be up to speed in no time!

Expand Down
30 changes: 15 additions & 15 deletions guides/guide_mp_general_enable_staking.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
Staking Rewards
===============

In exchange for the work provided by your staking :term:`node`, the :term:`Particl Network` pays you an interest in dividend-like payments proportional to the number of PART coins you own on that node. This amounts to a minimum of 2% yearly interest, but in reality, it fluctuates between 2% and 5% depending on how many more people are staking on the network as well.
In exchange for the work provided by your staking :term:`node <Node>`, the :term:`Particl Network` pays you an interest in dividend-like payments proportional to the number of PART coins you own on that node. This amounts to a minimum of 2% yearly interest, but in reality, it fluctuates between 2% and 5% depending on how many more people are staking on the network as well.

When you're staking on Particl, it means your computer (referred to as a "staking :term:`node`") is helping the network by validating transactions. This task is fully automated and doesn't require you to do any manual work.
When you're staking on Particl, it means your computer (referred to as a "staking :term:`node <Node>`") is helping the network by validating transactions. This task is fully automated and doesn't require you to do any manual work.

.. seealso::

Expand All @@ -23,7 +23,7 @@ Enabling staking is generally straight-forward, but some of the staking solution
- A :term:`Particl Desktop` wallet with any number of PART coins greater than 0.
- PART coins in your :guilabel:`public` balance.
- An active internet connection.
- A separate device to convert into a staking :term:`node` (required for cold staking only).
- A separate device to convert into a staking :term:`node <Node>` (required for cold staking only).

There are multiple ways you can stake your PART coins. Each of these solutions have pros and cons as well as their own method of activation.

Expand All @@ -38,7 +38,7 @@ Activating regular staking is the fastest method to get started. All it requires

#. Launch your :term:`Particl Desktop` client and make sure you have PART coins in your :guilabel:`public` balance.

That's all. Staking is working as long as your :term:`node` is online.
That's all. Staking is working as long as your :term:`node <Node>` is online.

**Password protected client**

Expand All @@ -57,11 +57,11 @@ Cold staking is a more advanced, secure, and flexible staking option. It require

**On your staking device...**

Choose what device you want to use as a staking :term:`node` (i.e. `Raspberry Pi <https://www.raspberrypi.org/help/what-%20is-a-raspberry-pi/>`_) and install a Linux (i.e. `Raspbian <https://www.raspberrypi.org/downloads/>`_) distribution on it.
Choose what device you want to use as a staking :term:`node <Node>` (i.e. `Raspberry Pi <https://www.raspberrypi.org/help/what-%20is-a-raspberry-pi/>`_) and install a Linux (i.e. `Raspbian <https://www.raspberrypi.org/downloads/>`_) distribution on it.

.. rst-class:: bignums

#. Choose what device you want to use as a staking :term:`node` (i.e. `Raspberry Pi <https://www.raspberrypi.org/help/what-%20is-a-raspberry-pi/>`_) and install a Linux (i.e. `Raspbian <https://www.raspberrypi.org/downloads/>`_) distribution on it.
#. Choose what device you want to use as a staking :term:`node <Node>` (i.e. `Raspberry Pi <https://www.raspberrypi.org/help/what-%20is-a-raspberry-pi/>`_) and install a Linux (i.e. `Raspbian <https://www.raspberrypi.org/downloads/>`_) distribution on it.

#. Install dependencies and download Particl's cold staking app; Partyman.

Expand Down Expand Up @@ -91,13 +91,13 @@ Choose what device you want to use as a staking :term:`node` (i.e. `Raspberry Pi
partyman/partyman restart
#. Create a new Particl wallet on your staking :term:`node`.
#. Create a new Particl wallet on your staking :term:`node <Node>`.

.. code-block:: bash
partyman/partyman stakingnode init
#. Create a new staking public key. It will let you connect your PART coins to the staking :term:`node`.
#. Create a new staking public key. It will let you connect your PART coins to the staking :term:`node <Node>`.

.. code-block:: bash
Expand All @@ -119,7 +119,7 @@ Choose what device you want to use as a staking :term:`node` (i.e. `Raspberry Pi

**A few cold staking settings...**

There are a few cold staking settings that you can set up. To do so, go back to your staking :term:`node` and enter the following commands.
There are a few cold staking settings that you can set up. To do so, go back to your staking :term:`node <Node>` and enter the following commands.

.. code-block:: bash
Expand Down Expand Up @@ -176,11 +176,11 @@ Another way to stake your PART coins is to team with other stakers and combine y
.. rst-class:: bignums

.. #. Set up your `Ledger Nano device <https://support.ledger.com/hc/en-us/articles/360007687153-Particl-PART->`_ and store funds into it.
#. Set up a :ref:`Cold staking` :term:`node` and copy its public key or copy the public key of a staking pool :ref:`Staking Pools` into your clipboard.
#. Set up a :ref:`Cold staking` :term:`node <Node>` and copy its public key or copy the public key of a staking pool :ref:`Staking Pools` into your clipboard.
#. Download and install the latest **Particl-Qt** client `here <https://particl.io/downloads>`_.
#. Open and unlock Particl-Qt, plug your Ledger Nano device into your computer and make sure it is ready to transact.
#. Open the Staking setup window by going in :guilabel:`Window` > :guilabel:`Staking Setup`.
#. Enter your staking :term:`node`'s public key in the :guilabel:`Cold staking change address` field and enable staking by clicking on the :guilabel:`Apply` button.
#. Enter your staking :term:`node <Node>`'s public key in the :guilabel:`Cold staking change address` field and enable staking by clicking on the :guilabel:`Apply` button.
.. **To fully activate hardware staking, you need to "zap" your coins.**
Expand All @@ -193,11 +193,11 @@ Another way to stake your PART coins is to team with other stakers and combine y
Enable mobile staking
---------------------

It's also possible to stake PART coins stored on a mobile wallet such as `Particl Copay <https://particl.io/downloads/>`_. Staking on your phone is completely secure and requires you to delegate the staking power of your coins to a staking :term:`node`.
It's also possible to stake PART coins stored on a mobile wallet such as `Particl Copay <https://particl.io/downloads/>`_. Staking on your phone is completely secure and requires you to delegate the staking power of your coins to a staking :term:`node <Node>`.

.. rst-class:: bignums

#. Set up a :ref:`cold staking` :term:`node` and copy its public key or copy the public key of a :ref:`Staking Pools` key into your clipboard.
#. Set up a :ref:`cold staking` :term:`node <Node>` and copy its public key or copy the public key of a :ref:`Staking Pools` key into your clipboard.
#. Download and install the `Particl Copay <https://particl.io/downloads/>`_ mobile application, open it, create a new Particl wallet, and send PART coins to it.
#. After your coins are deposited into this wallet, tap on the :guilabel:`Staking` icon at the bottom right corner of the screen followed by a tap on the :guilabel:`Setup Cold Staking` green button.
#. Enter the staking public key in the designated space and give it a label.
Expand All @@ -206,15 +206,15 @@ It's also possible to stake PART coins stored on a mobile wallet such as `Partic
Adjust Your Staking Privacy
---------------------------

If you operate your own staking :term:`node`, you can adjust your level of staking privacy. By default, the network sends your staking rewards in your :guilabel:`public` balance, meaning all your staking rewards are publicly displayed publicly on the blockchain. Particl allows you to change that for better privacy.
If you operate your own staking :term:`node <Node>`, you can adjust your level of staking privacy. By default, the network sends your staking rewards in your :guilabel:`public` balance, meaning all your staking rewards are publicly displayed publicly on the blockchain. Particl allows you to change that for better privacy.

- :guilabel:`Public` balance: Staking rewards are fully transparent and public on the blockchain.
- :guilabel:`Blind` balance: The number of PART coins contained in each reward remains confidential.
- :guilabel:`Anon` balance: The number of PART coins AND your deposit address remains entirely anonymous. This is the highest level of staking privacy possible on Particl.

.. rst-class:: bignums

#. Access your staking :term:`node` and install the Private Staking script.
#. Access your staking :term:`node <Node>` and install the Private Staking script.

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion guides/guide_mp_setup_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -469,7 +469,7 @@ Using the Tor daemon
Using Tor as a Hidden Service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

On linux, you can also run :term:`Tor` as a hidden service and connect your :term:`Particl Desktop` to it. This allows other people to use your :term:`node` as an entry or exit point, making the :term:`Tor` network more decentralized and private.
On linux, you can also run :term:`Tor` as a hidden service and connect your :term:`Particl Desktop` to it. This allows other people to use your :term:`node <Node>` as an entry or exit point, making the :term:`Tor` network more decentralized and private.

.. rst-class:: bignums

Expand Down
6 changes: 3 additions & 3 deletions intro/intro_general_functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,12 @@ In-depth details can be found at :ref:`Currency (PART) Explained`.
Particl Proof-of-Stake (Staking)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Staking is the action of keeping a :term:`node` online to support and secure Particl's distributed network. When you do so, you start receiving regular staking rewards paid by the network in exchange for your contribution.
Staking is the action of keeping a :term:`node <Node>` online to support and secure Particl's distributed network. When you do so, you start receiving regular staking rewards paid by the network in exchange for your contribution.

- Earn dividend-like staking rewards in exchange for keeping Particl :term:`nodes` online.
- Earn dividend-like staking rewards in exchange for keeping Particl :term:`nodes <Node>` online.
- Staking interest on Particl varies between 2% and 5% depending on the percentage of the supply being put up for staking.
- The network gets more secure and resilient as more people stake.
- "Cold staking" is a hyper secure staking option that lets you delegate your staking power to an online :term:`node` that contains no coin.
- "Cold staking" is a hyper secure staking option that lets you delegate your staking power to an online :term:`node <Node>` that contains no coin.
- Particl provides many different cold staking variants, each one being as secure as the other ones.
- **Cold staking:** Stake your coins stored even when stored offline such as on cold wallets, hardware devices, or even paper wallets.
- **Staking pool:** Combine your staking power with other stakers to earn more frequent payments.
Expand Down

0 comments on commit 85944d0

Please sign in to comment.