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

Fix guide commands #2585

Merged
merged 4 commits into from
Aug 24, 2022
Merged

Fix guide commands #2585

merged 4 commits into from
Aug 24, 2022

Conversation

AlianBenabdallah
Copy link
Contributor

@AlianBenabdallah AlianBenabdallah commented Aug 22, 2022

Status

Work in progress

Description

  • Some guide commands are fixed.

  • In section Identifiers, hermes tx conn-init --dst-chain ibc-1 --src-chain ibc-0 --dst-client 07-tendermint-0 --src-client 07-tendermint-0 can be confusing because we are using a real identifier (07-tendermint-0 on src) for a dummy client which does not even exist. I propose to change this identifier to dummyclientname.

  • gm key does not exist and should be replaced by gm keys.

  • I added a troubleshooting paragraph after the first commands using gm to make sure everything works.


PR author checklist:

  • Added changelog entry, using unclog.
  • Added tests: integration (for Hermes) or unit/mock tests (for modules).
  • Linked to GitHub issue.
  • Updated code comments and documentation (e.g., docs/).
  • Tagged one reviewer who will be the one responsible for shepherding this PR.

Reviewer checklist:

  • Reviewed Files changed in the GitHub PR explorer.
  • Manually tested (in case integration/unit/mock tests are absent).

@AlianBenabdallah AlianBenabdallah requested a review from romac August 22, 2022 15:59
@AlianBenabdallah
Copy link
Contributor Author

@romac I think there is an issue with the instructions given at 6.1.3. Chains need to be started before doing gm hermes config, otherwise, the command will output an error because some files don't exist :
stat $HOME/.gm/ibc-0/wallet_seed.json: no such file or directory.

I will fix it in the guide new design. Should I leave it as it is for this PR ?

@romac
Copy link
Member

romac commented Aug 23, 2022

@romac I think there is an issue with the instructions given at 6.1.3. Chains need to be started before doing gm hermes config, otherwise, the command will output an error because some files don't exist : stat $HOME/.gm/ibc-0/wallet_seed.json: no such file or directory.

I will fix it in the guide new design. Should I leave it as it is for this PR ?

Good catch! If it's just a matter of re-ordering the commands, can we please fix it in this PR?

@AlianBenabdallah
Copy link
Contributor Author

It's solved. I did not go through every command in section 7 but at least the tutorial should be fixed. I think this PR can be merged now.

@romac romac merged commit 8b2399c into master Aug 24, 2022
@romac romac deleted the ali/fix_guide_release_1.0.0 branch August 24, 2022 07:23
hu55a1n1 pushed a commit to hu55a1n1/hermes that referenced this pull request Sep 13, 2022
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 this pull request may close these issues.

2 participants