Code Monkey home page Code Monkey logo

btc-parachain-spec's Introduction

BTC Parachain 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

BTC Parachain

BTC-Relay

Contributing

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

Change into either the btcrelay-spec or polkabtc-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.

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 [DOCUMENT] where the document is either polkabtc-spec, btcrelay-spec, or blank. Blank builds both specifications.

btc-parachain-spec's People

Contributors

alexeizamyatin avatar gregdhill avatar nud3l avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.