RootChain contract cleanup

omgnetwork / plasma-mvp

OmiseGO's research implementation of Minimal Viable Plasma

MIT License

561 stars 158 forks source link

RootChain contract cleanup #145

Closed smartcontracts closed 6 years ago

smartcontracts commented 6 years ago

Closes #138 and adds more comments for clarity.

Main style changes:

Switch to /* / style natspec strings.
Add some extra comments.
Add a BlockSubmitted event.
Function parameters now start with an underscore for clarity.

smartcontracts commented 6 years ago

@boolafish the underscore prefix is pretty standard for most solidity work (check out OpenZeppelin's work). I find it helps quickly distinguish between function parameters (should treat as immutable) and everything else. Some other arguments here: https://ethereum.stackexchange.com/q/1351/22130