https://github.com/interlay/interbtc-spec

interBTC specification for a trust-minimized Bitcoin to Polkadot (and beyond) bridge
https://github.com/interlay/interbtc-spec

bitcoin bridge btc-parachain documentation interbtc

Last synced: 1 day ago
JSON representation

interBTC specification for a trust-minimized Bitcoin to Polkadot (and beyond) bridge

• Host: GitHub
• URL: https://github.com/interlay/interbtc-spec
• Owner: interlay
• License: apache-2.0
• Created: 2020-03-11T19:53:13.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-05-18T07:55:48.000Z (over 2 years ago)
• Last Synced: 2023-03-03T20:10:25.303Z (over 1 year ago)
• Topics: bitcoin, bridge, btc-parachain, documentation, interbtc
• Language: Makefile
• Homepage: https://spec.interlay.io
• Size: 20.5 MB
• Stars: 16
• Watchers: 2
• Forks: 13
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: docs/security_performance/btcrelay-security.rst

Awesome Lists containing this project

README

        
# 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](https://medium.com/polkadot-network/polkadot-the-parachain-3808040a769a).

The concept of Bitcoin-backed tokens is based on [Cryptocurrency-backed Assets](https://www.xclaim.io/).

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](https://spec.interlay.io)

- [PDF](https://interlay.gitlab.io/interbtc-spec/interbtc-spec.pdf)

## Contributing

See [CONTRIBUTING.md](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](https://www.sphinx-doc.org/en/master/).

Install the requirements with:

```sh

pip install -r requirements.txt

```

### Autobuild

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

```sh

autobuild.sh

```

The specification is served at [http://127.0.0.1:9000/](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:

```sh

latexbuild.sh

```