feat: rename iroha_parity_scale_cli to iroha_codec

Signed-off-by: Nurzhan Sakén <[email protected]>
hyperledger-iroha · Aug 14, 2024 · 0738615 · 0738615
1 parent 70fa00d
commit 0738615
Show file tree

Hide file tree

Showing 14 changed files with 36 additions and 40 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -229,7 +229,7 @@ members = [
     "iroha_swarm",
     "iroha_kagami",
     "kura_inspector",
-    "iroha_parity_scale_cli",
+    "iroha_codec",
     "iroha_wasm_test_runner",
     "iroha_torii",
     "iroha_torii/const",

diff --git a/docs/README.md b/docs/README.md
@@ -13,7 +13,7 @@ Documentation for Iroha 2 tools:
 
 - [Kagami](../iroha_kagami/README.md)
 - [Kura Inspector](../kura_inspector/README.md)
-- [Parity Scale Decoder Tool](../iroha_parity_scale_cli/README.md)
+- [Parity Scale Decoder Tool](../iroha_codec/README.md)
 
 ## Development
 

diff --git a/flake.nix b/flake.nix
@@ -49,7 +49,7 @@
         "iroha"
         "kagami"
         "kura_inspector"
-        "parity_scale_cli"
+        "iroha_codec"
       ];
 
       # HACK: A hook to filter out darwin-specific flags when cross-compiling.

diff --git a/iroha_parity_scale_cli/Cargo.toml → iroha_codec/Cargo.toml b/iroha_parity_scale_cli/Cargo.toml → iroha_codec/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "iroha_parity_scale_cli"
+name = "iroha_codec"
 
 edition.workspace = true
 version.workspace = true
@@ -38,7 +38,3 @@ eyre = { workspace = true }
 
 [dev-dependencies]
 iroha_test_samples = { workspace = true }
-
-[[bin]]
-name = "parity_scale_cli"
-path = "src/main.rs"
diff --git a/iroha_parity_scale_cli/README.md → iroha_codec/README.md b/iroha_parity_scale_cli/README.md → iroha_codec/README.md
@@ -7,15 +7,15 @@ This tool helps you decode **Iroha 2** data types from binaries using [Parity Sc
 To build the tool, run:
 
 ```bash
-cargo build --bin parity_scale_cli
+cargo build --bin iroha_codec
 ```
 
 ## Usage
 
 Run Parity Scale Decoder Tool:
 
 ```bash
-parity_scale_cli <SUBCOMMAND>
+iroha_codec <SUBCOMMAND>
 ```
 
 ### Subcommands
@@ -33,7 +33,7 @@ parity_scale_cli <SUBCOMMAND>
 To list all supported data types, run from the project main directory:
 
 ```bash
-./target/debug/parity_scale_cli list-types
+./target/debug/iroha_codec list-types
 ```
 
 <details> <summary> Expand to see expected output</summary>
@@ -66,21 +66,21 @@ These commands require `--type` argument. If data type is not known, [`scale-to-
 * Decode the specified data type from a binary:
 
   ```bash
-  ./target/debug/parity_scale_cli scale-to-json --input <path_to_binary> --type <type>
+  ./target/debug/iroha_codec scale-to-json --input <path_to_binary> --type <type>
   ```
 
 ### `scale-to-json` and `json-to-scale` usage examples
 
 * Decode the `NewAccount` data type from the `samples/account.bin` binary:
 
   ```bash
-  ./target/debug/parity_scale_cli scale-to-json --input iroha_parity_scale_cli/samples/account.bin --type NewAccount
+  ./target/debug/iroha_codec scale-to-json --input iroha_codec/samples/account.bin --type NewAccount
   ```
 
 * Encode the `NewAccount` data type from the `samples/account.json`:
 
   ```bash
-  ./target/debug/parity_scale_cli json-to-scale --input iroha_parity_scale_cli/samples/account.json --output result.bin --type NewAccount
+  ./target/debug/iroha_codec json-to-scale --input iroha_codec/samples/account.json --output result.bin --type NewAccount
   ```
 
 ## `scale-to-rust`
@@ -95,25 +95,25 @@ Decode the data type from a given binary.
 * Decode the specified data type from a binary:
 
   ```bash
-  ./target/debug/parity_scale_cli scale-to-rust <path_to_binary> --type <type>
+  ./target/debug/iroha_codec scale-to-rust <path_to_binary> --type <type>
   ```
 
 * If you are not sure which data type is encoded in the binary, run the tool without the `--type` option:
 
   ```bash
-    ./target/debug/parity_scale_cli scale-to-rust <path_to_binary>
+    ./target/debug/iroha_codec scale-to-rust <path_to_binary>
   ```
 
 ### `scale-to-rust` usage examples
 
 * Decode the `NewAccount` data type from the `samples/account.bin` binary:
 
   ```bash
-  ./target/debug/parity_scale_cli scale-to-rust iroha_parity_scale_cli/samples/account.bin --type NewAccount
+  ./target/debug/iroha_codec scale-to-rust iroha_codec/samples/account.bin --type NewAccount
   ```
 
 * Decode the `NewDomain` data type from the `samples/domain.bin` binary:
 
   ```bash
-  ./target/debug/parity_scale_cli scale-to-rust iroha_parity_scale_cli/samples/domain.bin --type NewDomain
+  ./target/debug/iroha_codec scale-to-rust iroha_codec/samples/domain.bin --type NewDomain
   ```
diff --git a/iroha_parity_scale_cli/build.rs → iroha_codec/build.rs b/iroha_parity_scale_cli/build.rs → iroha_codec/build.rs
diff --git a/iroha_parity_scale_cli/samples/account.bin → iroha_codec/samples/account.bin b/iroha_parity_scale_cli/samples/account.bin → iroha_codec/samples/account.bin
diff --git a/iroha_parity_scale_cli/samples/account.json → iroha_codec/samples/account.json b/iroha_parity_scale_cli/samples/account.json → iroha_codec/samples/account.json
diff --git a/iroha_parity_scale_cli/samples/domain.bin → iroha_codec/samples/domain.bin b/iroha_parity_scale_cli/samples/domain.bin → iroha_codec/samples/domain.bin
diff --git a/iroha_parity_scale_cli/samples/domain.json → iroha_codec/samples/domain.json b/iroha_parity_scale_cli/samples/domain.json → iroha_codec/samples/domain.json
diff --git a/iroha_parity_scale_cli/samples/trigger.bin → iroha_codec/samples/trigger.bin b/iroha_parity_scale_cli/samples/trigger.bin → iroha_codec/samples/trigger.bin
diff --git a/iroha_parity_scale_cli/samples/trigger.json → iroha_codec/samples/trigger.json b/iroha_parity_scale_cli/samples/trigger.json → iroha_codec/samples/trigger.json
diff --git a/iroha_parity_scale_cli/src/main.rs → iroha_codec/src/main.rs b/iroha_parity_scale_cli/src/main.rs → iroha_codec/src/main.rs