Skip to content
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

feat!: reorganize crates #4970

Merged
merged 59 commits into from
Sep 11, 2024
Merged

Conversation

nxsaken
Copy link
Contributor

@nxsaken nxsaken commented Aug 13, 2024

Description

  • closes Consider renaming the bin crates for consistency #4915
    • rename iroha_client_cli to iroha_cli
    • merge iroha_wasm_builder and iroha_wasm_builder_cli
    • rename kagami to iroha_kagami (crate only, not binary)
    • rename parity_scale_cli crate to iroha_codec
  • rename directories to match crate names
  • flatten crate structure, move all crates to /crates
  • move pytests to /pytests

Linked issue

Closes #4915, part of #2933.

Benefits

  • iroha_cli a bit more convenient to install
  • iroha_wasm_builder more convenient to install
  • kagami no longer conflicts with an existing crate
  • directories predictably match crate names
  • iroha_trigger and iroha_executor no longer hidden inside iroha_smart_contract

Checklist

  • I've read CONTRIBUTING.md
  • I've used the standard signed-off commit format (or will squash just before merging)
  • All applicable CI checks pass (or I promised to make them pass later)
  • (optional) I've written unit tests for the code changes
  • I replied to all comments after code review, marking all implemented changes with thumbs up

@nxsaken nxsaken force-pushed the feat/rename-crates branch 3 times, most recently from 59851dd to 0c265fe Compare August 13, 2024 13:42
@github-actions github-actions bot added the api-changes Changes in the API for client libraries label Aug 13, 2024
@nxsaken nxsaken marked this pull request as ready for review August 13, 2024 14:46
@mversic
Copy link
Contributor

mversic commented Aug 13, 2024

I suggest to name iroha_decode instead of iroha_parity_scale_cli. The former is implementation agnostic

@nxsaken
Copy link
Contributor Author

nxsaken commented Aug 13, 2024

iroha_codec maybe?

mversic
mversic previously approved these changes Aug 14, 2024
.github/dependabot.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@0x009922 0x009922 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would advocate to go even further with flattening: to lift crates such as iroha_config/base, iroha_schema/derive etc to the top level as well and keep the crates structure completely flat.

Also what about nesting all crates specifically into /crates directory or something?

I also don't see a good reason why pytests (for client and torii) are located next to the respective crates. I mean, yes, the crates are indeed respective, but related pytests have nothing to do with the crates - they are integrational tests interacting with bare-metal running Iroha peer. Thus, I'd advocate to put them somewhere on the top level as well and avoid their unnecessarily deep nesting.

@nxsaken nxsaken marked this pull request as draft August 19, 2024 11:39
Cargo.toml Outdated Show resolved Hide resolved
Cargo.toml Outdated Show resolved Hide resolved
Cargo.toml Outdated Show resolved Hide resolved
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
…asm_codec_derive`

Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken nxsaken merged commit 69643cd into hyperledger-iroha:main Sep 11, 2024
18 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api-changes Changes in the API for client libraries
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consider renaming the bin crates for consistency
3 participants