Skip to content

FriendlyUser/solidity-smart-contracts

Repository files navigation

Build Status DOI

Solidity-smart contracts

Since the solidity programming language is used in multiple blockchain platform including

  • Ethereum
  • Hedera

learning solidity is invaluable as blockchain technologies and smart contracts will be eseential in the future.

Disclaimer Getting contracts to compile on solidity *4.2x and 5 is quite difficult in addition to the rapid changes to the openzeppelin framework.

I think I'll end up flattener all open zeppelin contracts just to be save in the future and may rely on other ways to generic solidity documentation.

Documentation

A statically generated site via vuepress and the soldoc solidity documentation which produces markdown.

To generate markdown documentation make sure soldoc is installed.

soldoc -o ./docs/contracts --log ./docs/contracts/Soldoc.md

References