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

[docs]: add SCALE codec troubleshooting section (#428) #429

Closed
wants to merge 6 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions src/guide/troubleshooting/configuration-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,23 @@ account_ either, unless you submit an instruction.
These sorts of subtle mistakes can be avoided, for example, by
deserialising directly from string literals, or by generating a fresh
key-pair in places where it makes sense.

## SCALE codec errors

You may encounter SCALE codec errors when there's a discrepancy
between the data structure on the client and the peer sides.
Comment on lines +102 to +103
Copy link
Contributor

Choose a reason for hiding this comment

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

I would rephrase. SCALE codec errors appear when the versions of the data structures differ between the client and the peer sides.


It's easy to confuse the builds in the `debug` and `release` directories,
and keep using an old build due to this.
In case you're using the `iroha_client_cli` and rebuild it inside the Iroha
project directory root, use these commands:

* `rm ./target/debug/iroha_client_cli ./target/release/iroha_client_cli`
* `cargo build -p iroha_client_cli`
Comment on lines +110 to +111
Copy link
Contributor

Choose a reason for hiding this comment

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

this should be a code block, not a list

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* `cargo build -p iroha_client_cli`
* `cargo build -p iroha_client_cli --release`


Alternatively, please compare the output of
`/target/debug/iroha_client_cli --version` with a version in the Iroha log.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
`/target/debug/iroha_client_cli --version` with a version in the Iroha log.
`cargo run -p iroha_client_cli --release -- --version` with a version in the Iroha log.

You need to view the part where the Iroha peer starts.
Copy link
Contributor

Choose a reason for hiding this comment

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

You need to view the part where the Iroha peer starts.

Which part? Provide an example.

This will allow you to see whether the versions match.

If you are using one of our SDKs, please make sure it is up to date.
Copy link
Contributor

Choose a reason for hiding this comment

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

It should be not necessarily up to date, but the version of SDK should be compatible with the version of Iroha. In order to check it, it is generally recommended to check for the version in the SDKs readme.