This repository includes the specification for a two-way bridge between Polkadot and Bitcoin. The bridge implements Bitcoin-backed tokens on a Polkadot parachain. The concept of Bitcoin-backed tokens is based on Cryptocurrency-backed Assets.
The specification consists of two parts:
- XCLAIM(BTC,DOT) Bitcoin-backed tokens : The protocols and functions required to issue and redeem tokens as well as management of vaults.
- BTC-Relay: The component that is used to verify Bitcoin transactions on the Polkadot parachain.
You can contribute to this project. The following instructions will get you started with a local development environment.
The project is built with Sphinx.
Install the requirements with pip install -r requirements.txt.
Change into either the btcrelay-spec or interbtc-spec folder to work on either of the two specifications.
To have Sphinx automatically detect changes to .rst files and serve the latest changes in the browser, run autobuild.sh.
- interBTC will be served at http://127.0.0.1:8000/
- BTC-Relay will be served at http://127.0.0.1:9000/
You will have to have the required LaTeX packages installed to build the LaTeX files and export the document to PDF.
You can then run latexbuild.sh [DOCUMENT] where the document is either interbtc-spec, btcrelay-spec, or blank. Blank builds both specifications.