[docs]: add SCALE codec troubleshooting section (#428) #429
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6r1d
requested review from
outoftardis,
WRRicht3r and
appetrosyan
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Signed-off-by: 6r1d <[email protected]>
6r1d
force-pushed
the
scale_troubleshooting
branch
from
a471213 to
711d914
Compare
WRRicht3r
requested changes
Nov 9, 2023
Co-authored-by: William Richter <[email protected]> Signed-off-by: Victor <[email protected]>
Co-authored-by: William Richter <[email protected]> Signed-off-by: Victor <[email protected]>
Co-authored-by: William Richter <[email protected]> Signed-off-by: Victor <[email protected]>
Co-authored-by: William Richter <[email protected]> Signed-off-by: Victor <[email protected]>
Co-authored-by: William Richter <[email protected]> Signed-off-by: Victor <[email protected]>
outoftardis
reviewed
Nov 10, 2023
Comment on lines
+110
to
+111
| * `rm ./target/debug/iroha_client_cli ./target/release/iroha_client_cli` | ||
| * `cargo build -p iroha_client_cli` |
There was a problem hiding this comment.
this should be a code block, not a list
0x009922
requested changes
Nov 13, 2023
|
|
||
| Alternatively, please compare the output of | ||
| `/target/debug/iroha_client_cli --version` with a version in the Iroha log. | ||
| You need to view the part where the Iroha peer starts. |
There was a problem hiding this comment.
You need to view the part where the Iroha peer starts.
Which part? Provide an example.
| You need to view the part where the Iroha peer starts. | ||
| 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. |
There was a problem hiding this comment.
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.
| project directory root, use these commands: | ||
|
|
||
| * `rm ./target/debug/iroha_client_cli ./target/release/iroha_client_cli` | ||
| * `cargo build -p iroha_client_cli` |
There was a problem hiding this comment.
Suggested change
| * `cargo build -p iroha_client_cli` | |
| * `cargo build -p iroha_client_cli --release` |
| * `cargo build -p iroha_client_cli` | ||
|
|
||
| Alternatively, please compare the output of | ||
| `/target/debug/iroha_client_cli --version` with a version in the Iroha log. |
There was a problem hiding this comment.
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. |
Comment on lines
+102
to
+103
| You may encounter SCALE codec errors when there's a discrepancy | ||
| between the data structure on the client and the peer sides. |
There was a problem hiding this comment.
I would rephrase. SCALE codec errors appear when the versions of the data structures differ between the client and the peer sides.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As discussed with @mversic, we need to add a SCALE codec-related troubleshooting section.