Skip to content

Files

Latest commit

2aee7f1 · Sep 11, 2022

History

History
75 lines (57 loc) · 2.55 KB

README.md

File metadata and controls

75 lines (57 loc) · 2.55 KB

Graphene-Python-Gateway

An Open Source Gateway for BitShares/Graphene Blockchains

╔══════════════════════════╗
║ ╔═╗┬─┐┌─┐┌─┐┬ ┬┌─┐┌┐┌┌─┐ ║
║ ║ ╦├┬┘├─┤├─┘├─┤├┤ │││├┤  ║
║ ╚═╝┴└─┴ ┴┴  ┴ ┴└─┘┘└┘└─┘ ║
║ ╔═╗┬ ┬┌┬┐┬ ┬┌─┐┌┐┌       ║
║ ╠═╝└┬┘ │ ├─┤│ ││││       ║
║ ╩   ┴  ┴ ┴ ┴└─┘┘└┘       ║
║ ╔═╗┌─┐┌┬┐┌─┐┬ ┬┌─┐┬ ┬    ║
║ ║ ╦├─┤ │ ├┤ │││├─┤└┬┘    ║
║ ╚═╝┴ ┴ ┴ └─┘└┴┘┴ ┴ ┴     ║
╚══════════════════════════╝

The deposit gateway is a 24/7 www.falconframework.org API server, which the client will approach via JSON. Upon request for a deposit address, it launches an foreign chain block operation listener. The listener will await an incoming transfer of foreign chain coins from the client, until timeout. Upon "hearing" the transfer, the BitShares/Graphene side auto issues a respective UIA.

The withdrawal side is a 24/7 BitShares/Graphene block operation listener, which upon hearing an incoming UIA deposit - with a memo containing a withdrawal address, it automatically withdraws the matching foreign chain asset to the client's account.

Both Deposit and Withdrawal functions for all gateway assets run concurrently in a single terminal leveraging python multiprocessing and are thus built to handle multiple clients simultaneously.

Currently gateway tokenization of the following coins are supported:

  • EOSIO - EOS
  • Ripple - XRP

This project has been sponsored by www.bitshares.org

and peer reviewed by BitShares core developer Dr. Christopher Sanborn


Installation

  1. Clone repository
git clone https://github.com/litepresence/Graphene-Python-Gateway
  1. cd to repository
cd Graphene-Python-Gateway
  1. Create and activate virtual environment
python3 -m venv venv
source venv/bin/activate
  1. Install Graphene Python Gateway in editable mode
pip install -e .

Deploying

Read deploy_manual.txt


Be advised, although this gateway has been live tested on chain and peer reviewed, it should be considered beta software and has not yet been deployed live to the public.

License: www.wtfpl.net

litepresence Jan 2021