[suggestion] Separate validator and swarm from Kagami

[0x009922]

Description

Kagami was originally designed as an accompanying tool for the Iroha codebase. It was used to generate configuration, cryptographic keys, and more. Mentioned extensively in Iroha 2 documentation, it instructs users on deploying Iroha 2. However, some added functionalities have now limited its usability in some scenarios.

Commands overview

Kagami currently supports the following commands:

• crypto: Generate cryptographic key pairs using the given algorithm and either a private key or seed
• schema: Generate the schema for code generation in Iroha SDKs
• genesis: Generate the genesis block that is used in tests
• config: Generate the default client/peer configuration
• docs: Generate a Markdown reference of configuration parameters
• validator: Generate the default validator
• swarm: Generate Docker Compose configuration

While most commands are self-contained, validator and swarm are exceptions with specific dependencies.

Issues

• kagami validator only functions when CWD is the Iroha repo, leading to problems (e.g., [BUG] Kagami cannot access the cloned repo in the tmp dir #3741, [ci] Check that kagami validator is runnable as standalone  #3700).
• kagami swarm shares the same limitations as it reuses kagami validator.
• Because of the complexity which kagami validator brought, we discussed that it is probably good to keep Kagami as a fully internal utility. However, we benefit from the ability to mention it in public documentation.

Proposed solution

To address these challenges, I propose to remove validator and swarm subcommands from Kagami. Thus, Kagami will remain a lightweight tool for both internal and external usage with ability to mention it in the documentation.

As for the validator and swarm, they could likely become separate binaries. The naming, location, and CLI for these new binaries is up to discussion.

Related

• Add an Iroha swarm analogue to Iroha 2 #2373

[0x009922]

Excluding validator compilation from kagami genesis

Currently kagami genesis has the following mutually exclusive options:

• --inlined-validator: Generates the validator and includes it in the JSON.
• --compiled-validator-path <PATH>: Inserts the specified path into the JSON as is.

Since our goal is to remove validator compilation from Kagami, it needs to be refactored.

I propose the following options instead:

• --inline-validator-from-file <PATH>: Reads the validator from the file at <PATH> (relative to CWD) and includes the content into the genesis.
• --validator-path-in-genesis <PATH>: Specifies the <PATH> that will be directly inserted into the genesis JSON as-is. Essentially is the same as --compiled-validator-path, but I think the new naming is less confusing.

These options are still mutually exclusive.

[0x009922]

Closed by #3841

[0x009922]

Actually, it should be verified first.