A trust-minimized bridge from Bitcoin to Polkadot.
Explore the specification »
Report Bug
·
Request Feature
This repository is hosted on GitLab: https://gitlab.com/interlay/btc-parachain with a mirror on GitHub.
This project is currently under active development.
This is a proof of concept implementation of a BTC Parachain to bring Bitcoin into the Polkadot universe. It allows the creation of PolkaBTC, a fungible token that represents Bitcoin in the Polkadot ecosystem. PolkaBTC is backed by Bitcoin 1:1 and allows redeeming of the equivalent amount of Bitcoins by relying on a collateralized third-party.
The project uses the concept of Cryptocurrency-backed Assets to lock Bitcoin on the Bitcoin blockchain and issue BTC-backed tokens on the BTC Parachain. The implementation is based on the BTC Parachain specification.
The BTC-Parachain is built with:
- Alpha - November 2020
- Beta - February 2021
- Rococo - Feburary 2021
- Kusama - TBD
- Polkadot - TBD
The Substrate runtime makes use of various custom pallets that are found in the crates folder.
- bitcoin: [Beta] Library for Bitcoin type, parsing and verification functions.
- btc-relay: [Beta] Stateful SPV client for Bitcoin. Stores Bitcoin main chain, tracks forks, verifies Merkle proofs and validates specific transaction formats.
- collateral [Beta] Handles locking, releasing and slashing of collateral (e.g. DOT).
- exchange-rate-oracle: [Beta] Exchange rate oracle. Integration with external provider pending.
- fee: [Beta] Participant reward calculation and distribution.
- issue: [Beta] Handles issuing of PolkaBTC.
- redeem [Beta] Handles redeeming of PolkaBTC for BTC on Bitcoin.
- refund [Beta] Handles refunds for when a vault receives more BTC than it can cover.
- replace [Beta] Handles replacing vaults.
- security: [Beta] Handles BTC Parachain status and error changes.
- sla: [Beta] Participant scoring for reward & slashing calculations.
- staked-relayers: [Beta] Handles registration and stake of Staked Relayers, as well as voting on Parachain status changes.
- treasury: [Beta] Exposes functions related to handling of the PolkaBTC currency (mint, lock, burn)
- vault-registry: [Beta] Handles registration, collateral and liquidation of vaults.
curl https://sh.rustup.rs -sSf | sh
Building requires nightly. Run the following commands to set it up:
rustup toolchain install nightly-2021-01-25
rustup default nightly-2021-01-25
rustup component add rustfmt
rustup component add rls
rustup toolchain install nightly
rustup target add wasm32-unknown-unknown --toolchain nightly-2021-01-25
To build, run:
cargo build
For more detailed development instructions see here.
cargo test
To run with coverage, using cargo-cov:
cargo install cargo-cov
# clean up previous coverage result
cargo cov clean
# test the code
cargo cov test
# open the coverage report
cargo cov report --open
To run a local development node, use the dev chain spec.
cargo run --release -- --devClear the database using the purge-chain command.
cargo run --release -- purge-chain --devTo disable all btc-relay block inclusion checks, use the special dev-no-btc chain spec.
This is useful for testing without the overhead of running a block relayer.
cargo run --release -- --alice --chain dev-no-btc --rpc-cors all --validator --force-authoring --tmpAdditional CLI usage options are available and may be shown by running cargo run -- --help.
By default, the btc-parachain builds in standalone mode with the aura-grandpa feature.
To build with "parachain" support use the cumulus-polkadot feature:
cargo build --manifest-path parachain/Cargo.toml --release --no-default-features --features cumulus-polkadotTo connect with a local relay-chain follow these instructions.
Test coverage reports available under docs/testcoverage.html
The Substrate runtime configuration is in the parachain folder.
When interacting via polkadot{.js} you will need to use our custom types. Please also checkout polkabtc-js for a more complete (strongly-typed) library with bitcoinjs-lib integration.
If you would like to contribute, please file an issue on GitLab or reach out to us.
We are hiring!
(C) Copyright 2020 Interlay Ltd
BTC-Parachain is currently licensed under the terms of the Apache License (Version 2.0). See LICENSE
Website: Interlay.io
Twitter: @interlayHQ
Email: [email protected]
This project is supported by a Web3 Foundation grant.
We would also like to thank the following teams for their continuous support:
