[go: up one dir, main page]

Draft: Agnostic_baker: Add configuration file and commands

What

Parent MR: !17440 (merged)

Closes #7853.

This is a work in progress effort which aims to achieve the following:

  • create an config init command for the agnostic baker, which will create a separate baker.json configuration file in the client data directory, which will store information about the flags used by the bakers (like liquidity vote, DAL information etc.) (done)
  • create a run function which would use the configuration file to decide in which mode the baker will run (local with node directory or remote), to ease the use of the agnostic baker (the workflow will become config init [OPTIONS] -> run) (WIP)
  • separate clearly the functionalities which need to connect to a node (and get a plugin), like run functions, from those that do not, like help, man, or config functions (WIP)

The effort presented here resembles a lot the strategy used for the smart rollup node.

Why

How

Config init syntax:

./octez-experimental-agnostic-baker [GLOBAL_OPTIONS] config init [--local <path>] [--remote] [--bakers [baker ...]] [COMMAND_OPTIONS]

Run syntax: TBD

Manually testing the MR

Currently, the MR is work in progress, as it introduces a lot of new functionalities (and therefore code) and needs to be properly tested, as well. As the matter is a UX improvement that is not crucial (for now), the next steps will follow soon.

Checklist

  • Document the interface of any function added or modified (see the coding guidelines)
  • Document any change to the user interface, including configuration parameters (see node configuration)
  • Provide automatic testing (see the testing guide).
  • For new features and bug fixes, add an item in the appropriate changelog (docs/protocols/alpha.rst for the protocol and the environment, CHANGES.rst at the root of the repository for everything else).
  • Select suitable reviewers using the Reviewers field below.
  • Select as Assignee the next person who should take action on that MR
Edited by Gabriel Moise

Merge request reports

Loading