interlay/interbtc

interBTC

A modular and programmable layer for Bitcoin and the multi-chain ecosystem.
Explore the docs »

Report Bug · Request Feature

About the Project
Getting Started
- Prerequisites
- Installation
Contributing
License
Contact
Acknowledgements

About the Project

The interBTC project is a modular and programmable layer to bring Bitcoin to the multi-chain ecosystem. It includes:

A collateralized and permissionless Bitcoin bridge based on XCLAIM
A DeFi hub with a Rust-native Uniswap v2-style AMM, Curve v1-style AMM, and a Compound v2-style money market.
EVM-compatible smart contracts and blocks.
Bridges to other smart contract chains.
A Rust smart contract layer to interact with everything above.

Built with

The interBTC project is built with:

Structure

Runtime

The Substrate runtime configuration is in the parachain folder.

Interlay: The Interlay runtime configuration.
Kintsugi: The Kintsugi canary network runtime configuration.
Common: Common runtime configuration for Interlay and Kintsugi.

Test networks are build from the mainnet runtimes and have no dedicated runtimes.

Crates

The chain 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.
clients-info: Stores current and future interbtc-client software releases.
collator-selection: Decentralized sequencers (collators) for the chain.
currency Handles currencies (e.g. DOT/KSM/IBTC).
democracy: Optimistic governance fork of pallet-democracy.
dex-general: Uniswap v2-style AMM implementation.
dex-stable: Curve v1-style AMM implementation.
dex-swap-router: Swap router for the AMMs.
escrow: Rust implementation of Curve's Voting Escrow contract.
farming: Farming module for AMM liquidity mining.
fee: Participant reward calculation and distribution.
issue: Handles issuing of interBTC for BTC on Bitcoin.
loans: Compound v2-style money market implementation.
multi-transaction-payment: Pay assets other than the native one for transaction fees.
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.
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.
tx-pause: Handles pausing of transactions.
vault-registry: Handles registration, collateral and liquidation of vaults.

Getting started

Prerequisites

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

Please also install the following dependencies:

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

Installation

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.

Testing

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

Running

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.

Development node

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

Test coverage reports available under docs/testcoverage.html

Javascript / Typescript

Either use the polkadot.js API or checkout interbtc-api for a TypeScript SDK.

Contributing

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

Discord

License

interBTC is licensed under the terms of the Apache License (Version 2.0). See LICENSE

Contact

Linktree: Linktree

Website: interlay.io

Twitter: @interlayHQ

Discord: Discord

Telegram: Telegram

Acknowledgements

This project is supported by a Web3 Foundation grant and the Substrate Builders Program.

interlay / interbtc