From 2bef290f73822a4a1527623a00f2bae820617032 Mon Sep 17 00:00:00 2001 From: Albin Coquereau Date: Thu, 8 Feb 2024 11:12:21 +0100 Subject: [PATCH] docs: update renaming endorsement breaking changes page --- docs/introduction/breaking_changes.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/introduction/breaking_changes.rst b/docs/introduction/breaking_changes.rst index 4c0c65795e3a..a1b5554bf8ee 100644 --- a/docs/introduction/breaking_changes.rst +++ b/docs/introduction/breaking_changes.rst @@ -16,7 +16,7 @@ Attestations ------------ Starting with the Oxford protocol proposal and the Octez -``v18`` the legacy attestation name ``endorsement`` is now deprecated and +``v19`` the legacy attestation name ``endorsement`` is now deprecated and ``attestation`` should be used everywhere. Then, ``preendorsement`` is renamed to ``preattestation``, ``double_preendorsement_evidence`` to ``double_preattestation_evidence``, and ``double_endorsement_evidence`` to @@ -24,14 +24,14 @@ to ``preattestation``, ``double_preendorsement_evidence`` to ``lost endorsing rewards``, which are renamed to ``lost attesting rewards``. To allow a smooth transition we implemented a deprecation mechanism that will -start with Oxford and Octez ``v18`` and should end in two protocols and two +start with Oxford and Octez ``v19`` and should end in two protocols and two Octez releases. We were not able to version everything so some changes, detailed below, are breaking. Deprecation ~~~~~~~~~~~ -For the Oxford and Octez ``v18`` we introduced a new :doc:`version argument +For the Oxford and Octez ``v19`` we introduced a new :doc:`version argument <../introduction/versioning>` ``?version=`` for the following RPCs that can output ``attestation`` (and legacy ``endorsement``): @@ -49,20 +49,20 @@ For the Oxford and Octez ``v18`` we introduced a new :doc:`version argument See :doc:`changelog<../CHANGES>` for more details. -For protocol ``O`` and version ``v18``, using the version ``0``, which is the +For protocol ``O`` and version ``v19``, using the version ``0``, which is the default value, will still output the legacy attestation name. Version ``1`` allows the RPCs to output ``attestation`` instead of the legacy name. For a protocol upgrade proposal to succeed Oxford, i.e. for protocol ``P``, and -the next major release of Octez, v19.0, the default value of these RPCs will be +the next major release of Octez, ``v20.0``, the default value of these RPCs will be ``1`` but the version ``0`` will still be usable. Version ``0`` and support for legacy name ("endorsement") will be removed in the subsequent protocol and major Octez versions -- that is, protocol upgrade -proposal ``Q`` and Octez v20.0 +proposal ``Q`` and Octez ``v21.0`` As an exception, for the ``GET /chains//mempool/pending_operations`` RPC, -in protocol ``O`` and version ``v18``, due to previous versioning of this RPC, +in protocol ``O`` and version ``v19`, due to previous versioning of this RPC, the legacy version is already ``1`` (currently the default) and you should use version ``2`` to output ``attestation``. -- GitLab