massalabs / massalabs/docs

write Smart contract documentation

Open
#353 0 comments 1 reaction 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

Copy pasta from user feedback:

I've started the process of learning about MASSA and evaluating strategies for the POC. Some feedback on the MASSA Smart Contract docs:

  • I suggest adding a section titled something like "Migrating from Solidity".. or "Comparison with Solidity" that goes through a non-trivial Solidity example and how to do something similar with MASSA.

The majority of devs with smart contract experience are most likely coming from a Solidity background and may not have used WASM before.

  • A section that outlines how to structure a smart contract and basic features like:

    • What determines visibility of a function? (i.e. public, internal, private in Solidity)
    • How to pass constructor arguments
    • Functions with multiple args and types
    • Sending value (i.e. payable in Solidity)
    • Error handling, throwing errors
    • Inheritance, interfaces
    • Imports
    • etc.

Perhaps this is all in the WASM docs and it's the same, but it would be worthwhile to repeat the basics and describe where things are different.

I was pretty confused after looking at the docs. The Trading Bot video was helpful but it's over an hour of content and and not structured like a tutorial. It's also a year old and I'm sure much has changed since.

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

Review the existing Smart Contract and WASM documentation, using the Trading Bot video as background and the listed Solidity comparison topics as the scope. Done means the documentation explains a non-trivial Solidity migration and core contract concepts, including visibility, constructors, arguments, value transfer, errors, inheritance, interfaces, and imports.

Written by the indexing model from the issue text.

Assessment

Tech stack
solidity, wasm
Domain
blockchain, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.