Add NatSpec and Documentation Generation

.gitignore

@@ -1 +1,269 @@
-bin
+/**/.vscode
+/**/spa/**/style.css
+
+docs/md-build
+docs/tmp
+
+# Created by https://www.toptal.com/developers/gitignore/api/python,solidity,visualstudiocode,react
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,solidity,visualstudiocode,react
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+pytestdebug.log
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+doc/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+### react ###
+.DS_*
+logs
+**/*.backup.*
+**/*.back.*
+
+node_modules
+bower_components
+
+*.sublime*
+
+psd
+thumb
+sketch
+
+### Solidity ###
+# Logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+
+# End of https://www.toptal.com/developers/gitignore/api/python,solidity,visualstudiocode,react

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/build"]
+	path = docs/build
+	url = [email protected]:b-u-i-d-l/dfo-protocol-docs.git

.prettierrc

@@ -0,0 +1,15 @@
+{
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "printWidth": 100,
+        "tabWidth": 4,
+        "useTabs": false,
+        "singleQuote": false,
+        "bracketSpacing": false,
+        "explicitTypes": "always"
+      }
+    }
+  ]
+}

CONTRIBUTING.md

@@ -0,0 +1,67 @@
+# Contributing guidelines
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Coding Style](#coding-style)
+  - [Solidity](#solidity)
+  - [JavaScript](#javascript)
+  - [Python](#python)
+- [Documentation](#documentation)
+  - [mkdocs](#mkdocs)
+
+## Coding Style
+
+### Solidity
+
+* Solidity portions of the codebase adhere follow the official [Solidity Styleguide]
+
+### JavaScript
+
+### Python
+
+* Python portions of the codebase follow standard PEP8 best practices.
+* Python code must be formatted using the Black formatter using the provided settings.
+
+## Documentation
+
+New addition to the codebase must be fully documented.
+
+- JavaScript portions of the code should be annotated using JSDoc style docstrings.
+- Solidity portions of the code should be fully annotated using [NatSpec].
+
+Documentation is generated using [py-solidity-docgen] and rendered via [mkdocs].
+[py-solidity-docgen] parses NatSpec and outputs `.md` files inside `docs/md-build` according
+to a pre-specified Jinja2 template.
+
+**NOTE:** Each `.sol` file should contain only one `Interface` or `Contract`.
+
+To build the documentation:
+
+```console
+yarn docs:build
+```
+
+To serve the documentation
+
+```console
+yarn docs:serve
+```
+
+### mkdocs
+
+To install [mkdocs] and [py-solidity-docgen] Python must be installed in the system.
+
+```
+pip install docs/requirements.in
+```
+
+**NOTE:** Working inside a virtual environment is highly recommended!
+
+---
+
+[Solidity Styleguide]: https://solidity.readthedocs.io/en/v0.7.0/style-guide.html
+[NatSpec]: https://solidity.readthedocs.io/en/v0.7.0/style-guide.html#natspec
+[Write the Docs!]: docs/source/write_the_docs.rst
+[py-solidity-docgen]: https://github.com/b-u-i-d-l/py-solidity-docgen
+[mkdocs]: https://www.mkdocs.org/