Giter Club home page Giter Club logo

diagrams's Introduction

Diagrams for Solidity contracts

Why Diagrams

Effective way to get information into brain

  • Use more senses
  • Reduce load on short term memory
  • Remember the protocol when revisiting it later
  • Reduce initial information overload

Overview of protocol

  • See complexity
  • Recognize patterns
  • Spot inconsistencies

Flexible

  • Start with incomplete code
  • Print and write on paper
  • Develop top down

How to use

Start by downloading and opening the template in Powerpoint.

  • copy a (blue) box for each smart contract;
  • in multi chain protocols (e.g. bridges) copy purple boxes for each chain;
  • add nested blue boxed, with increasingly darker blue for inherited contracts and used libraries;
  • copy yellow boxes for each external (dark yellow) / internal (dotted line) / view (light yellow ) function;
  • draw arrows from each function to all contracts/functions it calls;
  • use yellow/transparant boxes to cluster/group functions, for example with the same modifier;
  • simplify and reduce crossing lines by connecting arrows to clusters and by rearranging boxes;
  • optionally add dark purple boxes for storage variables;
  • optionally add fat dotted lines for token flows;
  • create as many pages as useful.

Template image

DiagramTemplate V1 0

diagrams's People

Contributors

gpersoon avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.