The Origin bridge server connects the old world to the new.

Origin Dapps can connect to the bridge server of their choosing in order to enable the following functionality which is either impossible or impractical to do directly onchain, including:

Searching, browsing or filtering results is impractical to do either onchain or in the browser. Dapps can connect to a bridge-server to solve this problem. The bridge server will index the blockchain and related JSON content that is stored on IPFS into a quickly queriable format to make searching and filtering results possible from DApps.

We need a centralized server that can handle tasks like issuing identity attestations and decryptying data that is returned from third-party services like Civic. We also need proxies for fetching public data from services like Facebook and Twitter which require authentication keys.

There is currently no practical way to get email or text notifications when your bookings are made without a centralized monitoring service that can send you a text or an email to let you know about listings you care about.

See the README for the API

# python2
virtualenv /path/to/environment
# python3
python3 -m venv /path/to/environment

cd /path/to/environment
git clone https://github.com/OriginProtocol/bridge-server.git
cd bridge-server
source ../bin/activate
pip install -r requirements.txt

cp dev.env .env

Adjust the values in .env now and in the future to suit your local environment. In particular, set up your DATABASE_URL to point to where you local database is or will be.

You'll need to set a few API keys:

• Facebook
  • FACEBOOK_CLIENT_ID
  • FACEBOOK_CLIENT_SECRET
• Sendgrid
  • SENDGRID_API_KEY
  • SENDGRID_FROM_EMAIL
• Twilio
  • TWILIO_ACCOUNT_SID
  • TWILIO_AUTH_TOKEN
  • TWILIO_NUMBER (Can be added on this page)
• Twitter
  • TWITTER_CONSUMER_KEY
  • TWITTER_CONSUMER_SECRET

When deploying, set appropriate environment variables for production, notably

DEBUG=0
HTTPS=1
HOST=<your-prod-host>
FLASK_SECRET_KEY=<unique-key>
PROJECTPATH=/app  # For Heroku

Use a unique Flask secret key per environment. Flask suggests that python -c "import os; print(os.urandom(24))" is a perfectly reasonable way to generate a secret key.

createdb <db-name>  # Anything you want, perhaps bridge-server

Make sure the DB name you used is indicated in your DATABASE_URL.

# Applies all migrations to make the DB current. Works even on an empty database.
FLASK_APP=main.py flask db upgrade

cd /path/to/environment/project
source ../bin/activate
export PYTHONPATH=.

It's handy to save bash alias for this. Consider adding in your ~/.bash_profile:

alias myenv='cd /path/to/environment/project && source ../bin/activate && export PYTHONPATH=.'

python main.py

This starts a development server on localhost:5000 by default.

Throughout the development process and before committing or deploying, run:

pytest --flakes --codestyle

Run individual test files simply as:

pytest path/to/test.py

Run a single test case, or an individual test, using:

pytest path/to/test.py::test_case_name

Problems? Hit us up in the engineering channel on Discord if you need help.

We are using pycodestyle to enforce code formatting. The tests will throw errors when code is not formatted properly, when using the --codestyle option.

To automatically format the code:

autopep8 --in-place --recursive --a --a .

Please send your pull requests to the develop branch. Everything on master should be live at bridge.originprotocol.com

We use Flask Migrate to handle database revisions. If you make changes to the database, use

FLASK_APP=main.py flask db migrate

to generate the required migration file. Rename it to add a description of the change after the underscore. Then run

FLASK_APP=main.py flask db upgrade

to apply your migration to your local database, then test your changes before committing.

To deploy a dev server on Heroku, you'll follow the normal steps you would to deploy on Heroku.

As a minium, you must set these three Heroku config variables:

There are more optional config variables you can set. See dev.env for a full list.