-
Notifications
You must be signed in to change notification settings - Fork 276
-
Notifications
You must be signed in to change notification settings - Fork 276
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[suggestion] Separate validator
and swarm
from Kagami
#3833
Labels
iroha2-dev
The re-implementation of a BFT hyperledger in RUST
QA-confirmed
This bug is reproduced and needs a fix
Comments
5 tasks
Excluding validator compilation from
|
3 tasks
3 tasks
0x009922
added a commit
that referenced
this issue
Sep 4, 2023
* [refactor]: remove Swarm from Kagami; introduce refactored `iroha_swarm` Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [refactor]: remove validator from Kagami; cleanup Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [misc]: fix workspace info, introduce `wasm_builder_cli` Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [ci]: update Genesis and Swarm cmds in scripts Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [feat]: produce workable `iroha_wasm_builder_cli` Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [feat]: enhance CLI UI with spinners Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [build]: remove `iroha_wasm_builder` dep from Kagami Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [build]: tree-shake unused spinners Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [test]: fix swarm tests Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [docs]: add README for `iroha_swarm` Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [refactor]: remove `UserInterface` struct Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [feat]: add `--outfile` arg for wasm cli Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [docs]: document how to build the default validator Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [chore]: unused imports Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [docs]: link the directory to the cli Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [docs]: enhance warning about an inlined validator Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [chore]: use stdout Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [refactor]: move `wasm_builder_cli` to `./tools/` Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> --------- Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Closed by #3841 |
Actually, it should be verified first. |
mversic
pushed a commit
that referenced
this issue
Oct 17, 2023
* [refactor]: remove Swarm from Kagami; introduce refactored `iroha_swarm` Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [refactor]: remove validator from Kagami; cleanup Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [misc]: fix workspace info, introduce `wasm_builder_cli` Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [ci]: update Genesis and Swarm cmds in scripts Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [feat]: produce workable `iroha_wasm_builder_cli` Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [feat]: enhance CLI UI with spinners Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [build]: remove `iroha_wasm_builder` dep from Kagami Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [build]: tree-shake unused spinners Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [test]: fix swarm tests Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [docs]: add README for `iroha_swarm` Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [refactor]: remove `UserInterface` struct Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [feat]: add `--outfile` arg for wasm cli Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [docs]: document how to build the default validator Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [chore]: unused imports Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [docs]: link the directory to the cli Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [docs]: enhance warning about an inlined validator Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [chore]: use stdout Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> * [refactor]: move `wasm_builder_cli` to `./tools/` Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com> --------- Signed-off-by: Dmitry Balashov <a.marcius26@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
iroha2-dev
The re-implementation of a BFT hyperledger in RUST
QA-confirmed
This bug is reproduced and needs a fix
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 seedschema
: Generate the schema for code generation in Iroha SDKsgenesis
: Generate the genesis block that is used in testsconfig
: Generate the default client/peer configurationdocs
: Generate a Markdown reference of configuration parametersvalidator
: Generate the default validatorswarm
: Generate Docker Compose configurationWhile most commands are self-contained,
validator
andswarm
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 thatkagami validator
is runnable as standalone #3700).kagami swarm
shares the same limitations as it reuseskagami validator
.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
andswarm
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
andswarm
, they could likely become separate binaries. The naming, location, and CLI for these new binaries is up to discussion.Related
The text was updated successfully, but these errors were encountered: