massalabs / massalabs/docs

Describe custom serializers format

Open
#175 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
18
Forks
66
PR merge metrics
No merged PRs in 30d

Description

Actually, the only way to see how custom serializers works is to read the Rust code source.

It could be very interesting to add a documentation which describe how to serialize data.

It's useful for clients who don't use any SDK and builders who write SDKs in non supported languages.

E.g [OperationSerialiozer](https://massalabs.github.io/massa/src/massa_models/operation.rs.html#530-584)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the OperationSerialiozer implementation in massa_models/operation.rs, linked in the issue, to understand the custom serialization format. Document how to serialize data for clients without an SDK and builders writing SDKs in unsupported languages; done means the format can be followed without reading the Rust source.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.