From 00345003b99adc9ac7dddf0ed1589952d55b4f62 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 12 Jan 2023 08:30:38 +0100 Subject: [PATCH 1/8] doc: make clearer that other resources are available for programming on Tezos --- docs/index.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 6268fabbeb17..297446886354 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -110,14 +110,14 @@ If you want to know more about the Tezos *technology*, there are several section Tezos is an open platform. As any programmable blockchain, its value lies in the increasing base of smart contracts and distributed applications covering various domains, but also in the tools that make the ecosystem easier to use and more efficient, such as wallets, indexers, and many others. -For Tezos developers, this website mostly provides API documentation, but also some guidelines, including: +If you are looking for an accessible and pedagogical exposition on how to write smart contracts or Dapps, there are many great resources out there for developing on Tezos, such as the `Tezos Developer Portal `__ and `Open Tezos `__. + +For Tezos developers, this website mostly provides reference and API documentation, but also some guidelines, including: - A complete reference of :doc:`active/michelson` - Important API concepts such as the :doc:`developer/rpc` - API references such as :doc:`shell/rpc`, :doc:`api/openapi`, or :doc:`api/errors` -- Guidelines for writing smart contracts, such as :doc:`developer/michelson_anti_patterns`. - -If you are looking for a more accessible and pedagogical exposition on how to write smart contracts or Dapps, there are many great resources out there for developing on Tezos, such as the `Tezos Developer Portal `__ and `Open Tezos `__. +- Guidelines for writing smart contracts in Michelson, such as :doc:`developer/michelson_anti_patterns`. .. raw:: html -- GitLab From 5c375a883c9b1667aae813d84c17e728bce3e339 Mon Sep 17 00:00:00 2001 From: Eugen Zalinescu Date: Mon, 16 Jan 2023 20:41:00 +0100 Subject: [PATCH 2/8] Docs/Alpha: mention empty deposit consequences --- docs/alpha/consensus.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/alpha/consensus.rst b/docs/alpha/consensus.rst index 629f1ab4f459..a69ed810393d 100644 --- a/docs/alpha/consensus.rst +++ b/docs/alpha/consensus.rst @@ -272,7 +272,9 @@ behavior. Notable changes however are as follows: obtain a quorum, is rewarded with a bonus. * Endorsing rewards are shared equally among all validators. Participation above a minimal threshold per cycle is however required. -* Deposits are no longer frozen and unfrozen, instead a percentage of the active stake is always locked. +* Deposits are no longer frozen and unfrozen, instead a percentage of the active + stake is always locked. A delegate with an empty deposit cannot bake nor + (pre)endorse. * Validators are rewarded instantaneously for baking blocks and including extra endorsements, and not at the end of the cycle like in Emmy*. * At the end of a cycle ``c``, the following actions happen: @@ -390,6 +392,10 @@ The evidence for double signing at a given level can be collected by any :ref:`accuser` and included as an *accusation* operation in a block for a period of ``MAX_SLASHING_PERIOD``. +If a delegates' deposit is smaller than the slashed amount, the deposit is +simply emptied, which leads to the delegate losing its baking and endorsing +rights for the rest of the cycle. + We note that selfish baking is not an issue in Tenderbake: say we are at round ``r`` and the validator which is proposer at round ``r+1`` does not (pre)endorse at round ``r`` in the hope that the block at round ``r`` is not agreed upon and -- GitLab From d477158ae427daecddfac72fbbf24736f086abbe Mon Sep 17 00:00:00 2001 From: Eugen Zalinescu Date: Mon, 16 Jan 2023 20:41:29 +0100 Subject: [PATCH 3/8] Docs/Alpha: clarify what the accuser is --- docs/alpha/glossary.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/alpha/glossary.rst b/docs/alpha/glossary.rst index 8e8ac948dfb9..76c2e36b6bfa 100644 --- a/docs/alpha/glossary.rst +++ b/docs/alpha/glossary.rst @@ -16,12 +16,12 @@ Protocol _`Accuser` When a delegate_ attempts `double signing`_ (or when it tries to abuse the network in another similar way), another delegate_ can make an - accusation, by providing evidence of the offense. The delegate_ making the accusation is called the accuser.\ + accusation, by providing evidence of the offense. The delegate_ injecting the accusation in a newly baked block is called the accuser.\ The accuser is awarded some funds from the security deposit of the accused. - When using :ref:`Octez `, accusations are handled by the - accuser daemon. + When using :ref:`Octez `, accusation operations are emitted by the + accuser daemon. Note that this daemon is not associated to a delegate: accusation operations are anonymous, and any delegate can include them in a block. _`Account` An account is an address managed by the protocol. -- GitLab From 6abbd61cd15e83a9e25b4b1c010c1423c42318cd Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 16 Jan 2023 20:58:09 +0100 Subject: [PATCH 4/8] doc: include protocol name in baker executable name --- docs/introduction/howtorun.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/introduction/howtorun.rst b/docs/introduction/howtorun.rst index d197deee9624..2b056c782e88 100644 --- a/docs/introduction/howtorun.rst +++ b/docs/introduction/howtorun.rst @@ -169,7 +169,9 @@ accounts have the necessary rights. Let's launch the daemon pointing to the standard node directory and baking for user *bob*:: - octez-baker-alpha run with local node ~/.tezos-node bob --liquidity-baking-toggle-vote pass + octez-baker- run with local node ~/.tezos-node bob --liquidity-baking-toggle-vote pass + +where ``PROTO_HASH`` is the short hash of the current protocol of the network you want to bake on. Note that the baker needs direct access to the node data directory for performance reasons (to reduce the number of RPC calls to the node). @@ -183,6 +185,8 @@ Note that ``--liquidity-baking-toggle-vote`` must be placed If you are worried about the availability of your node when it is its turn to bake/endorse, there are other ways than duplicating your credentials (see the discussion in section :ref:`inactive_delegates`). **Never** use the same account on two daemons. +However, it is safe (and actually necessary) to temporarily run two bakers just before a protocol activation: the baker for the protocol being replaced and the baker for the protocol to be activated. + .. note:: -- GitLab From 0a295158e0f08f0301e3a1e49dbcf527783ac1a2 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 30 Jan 2023 14:51:08 +0100 Subject: [PATCH 5/8] doc: fix redirected link to developers.tezos.com --- docs/index.rst | 2 +- docs/introduction/tezos.rst | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 297446886354..a656c7245f0b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -110,7 +110,7 @@ If you want to know more about the Tezos *technology*, there are several section Tezos is an open platform. As any programmable blockchain, its value lies in the increasing base of smart contracts and distributed applications covering various domains, but also in the tools that make the ecosystem easier to use and more efficient, such as wallets, indexers, and many others. -If you are looking for an accessible and pedagogical exposition on how to write smart contracts or Dapps, there are many great resources out there for developing on Tezos, such as the `Tezos Developer Portal `__ and `Open Tezos `__. +If you are looking for an accessible and pedagogical exposition on how to write smart contracts or Dapps, there are many great resources out there for developing on Tezos, such as the `Tezos Developer Portal `__ and `Open Tezos `__. For Tezos developers, this website mostly provides reference and API documentation, but also some guidelines, including: diff --git a/docs/introduction/tezos.rst b/docs/introduction/tezos.rst index 5ae96e7523ff..2efab10cb5b6 100644 --- a/docs/introduction/tezos.rst +++ b/docs/introduction/tezos.rst @@ -39,8 +39,9 @@ The Community - A few community-run websites collect useful Tezos links: - - https://www.tezos.help - - https://tezoscommons.org/ + - https://www.tezos.help (resources classified by their kind: organisations, block explorers, wallets, etc.) + - https://tezoscommons.org/ (featured resources classified by approach: technology, developing, contributing, etc.) + - https://tezos.com/developer-portal/ (resources for developers of applications built on Tezos) - More resources can be found in the :doc:`support` page. -- GitLab From 89fac35c3b60be93c7b60ad2602c4b3e62818d2b Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 31 Jan 2023 12:26:43 +0100 Subject: [PATCH 6/8] doc: apply the README checklist by D.D.Beck --- docs/introduction/tezos.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/introduction/tezos.rst b/docs/introduction/tezos.rst index 2efab10cb5b6..01f5d144021d 100644 --- a/docs/introduction/tezos.rst +++ b/docs/introduction/tezos.rst @@ -16,11 +16,13 @@ Octez ~~~~~ Octez is an implementation of Tezos software, including a node, a client, a baker, an accuser, and other tools, distributed with the Tezos economic protocols of Mainnet for convenience. -This implementation is available at https://gitlab.com/tezos/tezos. -The source code is placed under the MIT Open Source License. +The source code is placed under the MIT Open Source License, and +is available at https://gitlab.com/tezos/tezos. The current release of Octez is :doc:`../releases/version-15`. +For installing instructions, see :doc:`./howtoget`. + .. _tezos_community: The Community @@ -76,4 +78,4 @@ This website This website (https://tezos.gitlab.io/) provides online technical documentation. This documentation is about :ref:`octez`, although it also documents Tezos in general. -The technical documentation is automatically generated from the master branch of the :ref:`Octez ` repository. +The technical documentation is an integral part of the :ref:`Octez ` repository, and is automatically generated from the master branch, following `Docs as Code `_ best practices. -- GitLab From 1a3861f0bb80324d83fd9e94cc1ffd6fc03443c4 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 31 Jan 2023 12:28:01 +0100 Subject: [PATCH 7/8] doc: factorize community links from root README and tezos.rst intro --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index e40130bb607c..4353a5dc633b 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,4 @@ to study and to maximize the throughput of the voting procedure. ## Community -Links to community websites are gathered in the following community portals: -- https://www.tezos.help/ -- https://developers.tezos.com/ (for developers of applications built on Tezos) +Links to community websites are gathered at . -- GitLab From 0d8b695e06641c39d9a3a601cad9421a312a136b Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 1 Feb 2023 11:58:20 +0100 Subject: [PATCH 8/8] doc: fix RST syntax in gitlab roles --- docs/protocols/016_mumbai.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/protocols/016_mumbai.rst b/docs/protocols/016_mumbai.rst index 4f1a564029b4..a542a8ffd3e5 100644 --- a/docs/protocols/016_mumbai.rst +++ b/docs/protocols/016_mumbai.rst @@ -73,7 +73,7 @@ Breaking Changes Ticket User-experience ---------------------- -- Allow implicit accounts to receive and send tickets. (MR :gl: `!6108`, :gl: `!6490`) +- Allow implicit accounts to receive and send tickets. (MR :gl:`!6108`, :gl:`!6490`) RPC Changes ----------- -- GitLab