interBTC: Bitcoin Anywhere
A modular and programmable layer for Bitcoin and the multi-chain ecosystem.
Explore the docs »
Report Bug
·
Request Feature
The interBTC project is a modular and programmable layer to bring Bitcoin to the multi-chain ecosystem. It includes:
The interBTC project is built with:
The Substrate runtime configuration is in the parachain folder.
Test networks are build from the mainnet runtimes and have no dedicated runtimes.
The chain makes use of various custom pallets that are found in the crates folder.
pallet-democracy
.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-parachain -- --dev
To connect with a local relay-chain follow these instructions.
Running a development can be achieved without compiling the node with docker and instant-seal
. Replace the release version with one of the available tags:
docker run --network=host interlayhq/interbtc:RELEASE_TAG --dev --instant-seal
# Example
docker run --network=host interlayhq/interbtc:1.25.0-rc5 --dev --instant-seal
Test coverage reports available under docs/testcoverage.html
Either use the polkadot.js API or checkout interbtc-api for a TypeScript SDK.
If you would like to contribute, please file an issue on GitHub or reach out to us.
interBTC is licensed under the terms of the Apache License (Version 2.0). See LICENSE
Linktree: Linktree
Website: interlay.io
Twitter: @interlayHQ
Discord: Discord
Telegram: Telegram
This project is supported by a Web3 Foundation grant and the Substrate Builders Program.