interBTC Specification

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:

1. XCLAIM(BTC,DOT) Bitcoin-backed tokens: The protocols and functions required to issue and redeem tokens as well as management of vaults.
2. BTC-Relay: The component that is used to verify Bitcoin transactions on the Polkadot parachain.

Specification Documents

• Web Version
• PDF

Contributing

See CONTRIBUTING.md for details.

You can contribute to this project. The following instructions will get you started with a local development environment.

Requirements

The project is built with Sphinx. Install the requirements with:

pip install -r requirements.txt

Autobuild

To have Sphinx automatically detect changes to .rst files and serve the latest changes in the browser, run:

autobuild.sh

The specification is served at http://127.0.0.1:9000/

LaTeX

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