andsilver / sorrentum

Sorrentum is an open-Source DeFi protocol to build advanced financial applications

Sorrentum is an open-source Web3 / DeFi protocol to build advanced financial applications using machine learning.

Welcome

Hello!

Nice to meet you.

We are very happy that you are interested in the Sorrentum Project!

The project aims to combine open-source development, startups, and brilliant students. We’ve seen this mixture of ingredients work exceptionally well at Stanford / Berkeley / MIT / etc, where every student seems to be trying to start a company on the side. Our goal is to bootstrap the same virtuous cycle outside Silicon Valley so that instead of just looking for a job, you create your own. We are still figuring out things as we go, and we are working with University of Maryland and other interested parties to provide internships, research assistantships, and development grants.

Besides the immediate financial benefit, this is a unique opportunity for you to:

• Work on cutting-edge problems on machine learning and Web3
• Learn about startups and how to start your own project
• Write academic papers
• Get internships and full-time positions at companies working on Sorrentum applications or from our network

Most importantly, this is a unique way to be part of a community of individuals interested in building innovative products.

Commitment to contribute

This is our only request to you.

We understand that due to your commitments (e.g., classes, life), you might not be able to work on Sorrentum consistently. That’s ok. At the same time, please be aware that taking on a task means that:

1. The same task might not be available to your colleagues; and

2. We spend time helping, training, and mentoring you. So the energy we put into helping you will be taken away from your colleagues. If you drop out of the project, our effort could have been used for other teammates that committed more firmly to making progress

In other words, if you are not sure you can commit a meaningful amount of time to Sorrentum (e.g., 20 hours / week), it is wise to wait to be sure you can do it. If you are excited and want to start, go for it, do your best, and we’ll make this experience the best possible for you.

On-boarding

• Signing up for Sorrentum

How to start developing

This contains the absolute minimal amount of info to start developing

• How to organize your work

• General Rules of Collaboration

• Quick start for developing

• First Review Process

• Sorrentum Python coding style guide

• Jupyter notebook best practices

• Unit tests

Project management

• Code review

  • PR review workflow from the code author and code reviewer points of view

• Development workflow

  • Extended instructions on how to deploy your working environment and interact with it

• GitHub/ZenHub workflows

  • How to use GitHub and ZenHub, file a PR, review GitHub/ZenHub workflows

• Git workflow and best practices

  • git workflows, branch management, troubleshooting, common procedures

• Documentation about guidelines

  • How to write guidelines, format documentation, convert Gdocs to markdown files and vice versa

Learn how to become efficient at developing

This contains a set of resources that over time will make 10x more productive

• Docker

• Reading List

• Design Philosophy

Technologies used

• UMD DATA605 Big Data Systems contains lectures and tutorials about most of the technologies we use in Sorrentum, e.g., Dask, Docker, Docker Compose, Git, github, Jupyter, MongoDB, Pandas, Postgres, Apache Spark
• You can go through the lectures and tutorials on a per-need basis, depending on what it's useful for you to develop
• As an additional resource, you can refer to The Missing Semester of Your CS Education

In-depth docs

• Code organization

DeFi: start developing

• DeFi README

• From 0 to Web3

DeFi: in-depth docs

Arbitrage / Modeling: start developing

Arbitrage / Modeling: in-depth docs

Payment

How to receive a crypto transfer

• Receive crypto payment