From 3bd32bebef8a8a5126bec740af3a9e55907e711e Mon Sep 17 00:00:00 2001 From: Gabriel Moise Date: Wed, 23 Apr 2025 16:11:27 +0300 Subject: [PATCH 1/2] Agnostic_accuser: Add documentation --- CHANGES.rst | 10 +++++++++ src/bin_agnostic_accuser/README.md | 34 ++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 src/bin_agnostic_accuser/README.md diff --git a/CHANGES.rst b/CHANGES.rst index 713c7f7ada40..04e9e6368077 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -91,6 +91,9 @@ Baker Agnostic Baker -------------- +- Add ``run accuser`` command to replicate the behaviour of the accuser. + (MR :gl:`!17767`) + - Enables ``advertises_level`` in baker logs by default, logs are prefixed by the logging level. It can be disabled by setting ``"log" : { advertises_level : false }`` in the client configuration. (MR :gl:`!17737`) @@ -132,6 +135,13 @@ the README from ``src/bin_agnostic_baker``. Accuser ------- +Agnostic Accuser +---------------- + +- Add ``octez-accuser`` agnostic accuser binary. This behaves in a similar way + to the agnostic baker binary, automatically switching the underlying accuser + process at protocol migration. (MR :gl:`!17738`) + Proxy Server ------------ diff --git a/src/bin_agnostic_accuser/README.md b/src/bin_agnostic_accuser/README.md new file mode 100644 index 000000000000..63a5d25845aa --- /dev/null +++ b/src/bin_agnostic_accuser/README.md @@ -0,0 +1,34 @@ +# Agnostic Accuser + +## Overview + +Agnostic Accuser is a protocol-independent binary that dynamically selects the +appropriate denunciation process based on the active protocol. It monitors the state of +the blockchain and automatically switches to the correct process when a new +protocol is encountered (for example, during migrations, or at startup). + +It is designed in a similar fashion to the **Agnostic Baker**, meaning that users +will no longer need to use two accuser binaries for protocol migration, as this will +be performed automatically by the agnostic accuser. + +## Usage + +In the same fashion as for the agnostic baker, to run the accuser we just replace +the old `octez-accuser-` binary with `octez-accuser` and keep the +same arguments: + +```bash +octez-accuser [OCTEZ-ACCUSER-COMMANDS] +``` + +Furthermore, for the `run` command of the accuser, the agnostic baker is equipped +with a command to replicate the behaviour of the accuser binary: + +```bash +octez-baker run accuser [OCTEZ-ACCUSER-COMMANDS] +``` + +## How it works + +The mechanism behind the agnostic accuser is the same as the one for the agnostic +baker, so you can refer to that section for more in-depth information. -- GitLab From b32c8e566c8493bead75b97bf77a5df653efcea2 Mon Sep 17 00:00:00 2001 From: Gabriel Moise Date: Wed, 23 Apr 2025 18:24:53 +0300 Subject: [PATCH 2/2] Agnostic_baker: More agnostic binary call --- src/bin_agnostic_baker/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/bin_agnostic_baker/README.md b/src/bin_agnostic_baker/README.md index 184d8395a7a4..5c88519c6dbf 100644 --- a/src/bin_agnostic_baker/README.md +++ b/src/bin_agnostic_baker/README.md @@ -17,7 +17,7 @@ To run the agnostic baker, the command line syntax is similar to the one for the protocol-dependent baking binaries: ```bash -./octez-baker [OCTEZ-BAKER-COMMANDS] +octez-baker [OCTEZ-BAKER-COMMANDS] ``` The `[OCTEZ-BAKER-COMMANDS]` list consists of all the arguments that can be used @@ -25,7 +25,7 @@ for the specific protocol baking binary. To be more clear, if a user wants to us the agnostic baker to replace a baking command which would be ```bash -./octez-baker- [OCTEZ-BAKER-COMMANDS] +octez-baker- [OCTEZ-BAKER-COMMANDS] ``` they can do this by using the same `[OCTEZ-BAKER-COMMANDS]` and let the agnostic -- GitLab