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

Make the relayer CLI and library top-level folders #180

Closed
4 tasks
greg-szabo opened this issue Jul 29, 2020 · 3 comments · Fixed by #183
Closed
4 tasks

Make the relayer CLI and library top-level folders #180

greg-szabo opened this issue Jul 29, 2020 · 3 comments · Fixed by #183

Comments

@greg-szabo
Copy link
Member

Summary

It's a bit confusing that the relayer and the modules are top-level libraries and although modules is a crate in its own right, the relayer has a cli subfolder and a relay subfolder which are their own crates.

Also cosmos/ibc-rs#125 the name of the modules crate is weird.

Proposal

All crates should be top-level folders in the repo. Namely:

modules
relayer-cli
relayer
(ibc-proto as of cosmos/ibc-proto-rs#23 )

Alternatively (and in line with cosmos/ibc-proto-rs#23) all should have the ibc- prefix. That would make the naming for the crates (#167) also clear.


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@andynog
Copy link
Contributor

andynog commented Jul 29, 2020

I like the suggested re-org of the folders. More inline with tendermint-rs that has the crates as top-level. But we should just to plan it accordingly since this is a major refactoring just need to bear in mind what the best workflow for this concerning merges and PRs. The work effort here is not big but has to be the least disruptive as possible to parallel development. Maybe integrate this just before the next release?

@greg-szabo
Copy link
Member Author

I wouldn't wait until the next release, since we didn't release this library yet, as far as I know.

The sweet spot is when there is no ongoing soon-to-be-merged work in the repo. I'm aware of Andy's work on connections that is soon-to-be-merged, but everything else we work on right now seems fairly experimental and higher-level. And most importantly, full of new files. My proposal is that we do this right after Andy's client query work is done, to try to minimize the pain for any other ongoing work.

@greg-szabo
Copy link
Member Author

Ok, this is happening after Andy's PR. Here's the proposed naming:

modules
relayer-cli
relayer
(proto)

I suggest cosmos/ibc-rs#125 use the ibc- prefix for crate names but we can discuss it there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants