dorucioclea / interbtc Goto Github PK

A trust-minimized bridge from Bitcoin to Anywhere.
Explore the specification »

Report Bug · Request Feature

This repository is hosted on GitHub: https://github.com/interlay/interbtc with a mirror on GitLab and radicle.

• About the Project
  • Built With
• Roadmap
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• License
• Contact
• Acknowledgements

The interBTC runtime allows the creation of interBTC, a fungible token that represents Bitcoin on the Interlay network. Interlay in turn is connected to other blockchains via XCM and will be connected to even more blockchians via IBC. Each interBTC 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 Interlay network. The implementation is based on the interBTC specification.

The interBTC project is built with:

• Rust

• Substrate

  

The Substrate runtime makes use of various custom pallets that are found in the crates folder.

• annuity: Block rewards for stake-to-vote and vaults.
• bitcoin: Library for Bitcoin type, parsing and verification functions.
• btc-relay: Stateful SPV client for Bitcoin. Stores Bitcoin main chain, tracks forks, verifies Merkle proofs and validates specific transaction formats.
• currency Handles currencies used as backing collateral (e.g. DOT/KSM) and issued tokens (e.g. interBTC).
• democracy: Optimistic governance fork of pallet-democracy.
• escrow: Rust implementation of Curve's Voting Escrow contract.
• fee: Participant reward calculation and distribution.
• issue: Handles issuing of interBTC for BTC on Bitcoin.
• nomination: Interface for vault nomination.
• oracle: Trusted providers use this to set exchange rates and Bitcoin fee estimates.
• redeem: Handles redeeming of interBTC for BTC on Bitcoin.
• refund: Handles refunds for when a vault receives more BTC than it can cover.
• replace: Handles replacing vaults.
• reward: Scalable reward distribution.
• security: Handles status and error changes.
• staking: Core logic for vault nomination and slashing.
• supply: Token minting and inflation.
• vault-registry: Handles registration, collateral and liquidation of vaults.

curl https://sh.rustup.rs -sSf | sh

Please also install the following dependencies:

• cmake
• clang (>=10.0.0)
• clang-dev
• libc6-dev
• libssl-dev

Building requires a specific rust toolchain and nightly compiler version. The requirements are specified in the ./rust-toolchain.toml override file.

Running rustup show from the root directory of this repo should be enough to set up the toolchain and you can inspect the output to verify that it matches the version specified in the override file.

To build, run:

cargo build

For more detailed development instructions see here.

cargo test --features runtime-benchmarks

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 --bin interbtc-standalone -- --dev

Clear the database using the purge-chain command.

cargo run --release --bin interbtc-standalone -- purge-chain --dev

Additional CLI usage options are available and may be shown by running cargo run --bin interbtc-standalone -- --help.

To run a local development node, use the dev chain spec.

cargo run --release --bin interbtc-parachain -- --dev

To 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 interbtc-js for a more complete (strongly-typed) library.

If you would like to contribute, please file an issue on GitHub or reach out to us.

• Discord
• Telegram

interBTC 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:

• Parity Technologies