hyperledger / iroha-2-docs

https://hyperledger.github.io/iroha-2-docs/

Apache License 2.0

6 stars 26 forks source link

Create the interactive examples showing how the SCALE codec encodes data #384

Open 6r1d opened 1 year ago

6r1d commented 1 year ago

In my opinion, it may be helpful to extend https://github.com/hyperledger/iroha-2-docs/issues/367 with interactive examples that show the complete process of the encoding. While it doesn't show the whole process of encoding, it will demonstrate the peculiarities and features of this process.

6r1d commented 1 year ago

I think it is best to start with interaction between the two language SDKs: Rust and JS, where JS shows the decoding process and capabilities.

Rust side

Encoding and hex dumps are present for some simple cases

[x] Integer
[x] Enum
[x] String
[x] Vector as a top-level element?
[x] Tuple
[x] Map
[x] Basic struct wrapping an integer
[x] Struct wrapping another struct and adding a field
[x] Vector of Enum instances with values (currently wrapped in struct)
[ ] Result
[ ] Option

JS side

Decoding values from the Rust examples

[ ] Integer
[ ] Enum
[ ] String
[ ] Vector as a top-level element?
[ ] Tuple
[ ] Map
[ ] Basic struct wrapping an integer
[ ] Struct wrapping another struct and adding a field
[ ] Vector of Enum instances with values (currently wrapped in struct)
[ ] Result?
[ ] Option?