You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/about/roadmap.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
4
4
The Interlay team is building a customized Substrate environment for interBTC, optimized to verify Bitcoin payments. The BTC Parachain includes a Bitcoin cross-chain SPV client (BTC-Relay), integrations with secure price oracles and XCMP, as well as support for hardware wallets. In addition, Interlay is also building client software for Vaults, Relayers (who make sure BTC-Relay is up to date), as well as an easy-to-use web interface.
5
5
6
-
[Interlay](https://interlay.io/) has previously released a [detailed technical specification](https://interlay.gitlab.io/interbtc-spec/) and a [working PoC implementation](https://github.com/interlay/BTC-Parachain). After the successful pilot project, Interlay won a second [Web3 Foundation grant](https://web3.foundation/grants/) to complete the BTC Parachain - the core milestones of this project were completed in March 2021.
6
+
[Interlay](https://interlay.io/) has previously released a [detailed technical specification](https://interlay.gitlab.io/interbtc-spec/) and a [working PoC implementation](https://github.com/interlay/interbtc). After the successful pilot project, Interlay won a second [Web3 Foundation grant](https://web3.foundation/grants/) to complete the BTC Parachain - the core milestones of this project were completed in March 2021.
7
7
8
8
### Timeline So Far
9
9
-**1st Web3 Foundation grant** (Spec & PoC) started in January 2020
@@ -15,4 +15,4 @@ The Interlay team is building a customized Substrate environment for interBTC, o
15
15
-**(soon) interBTC on Polkadot** is expected in late 2021 / early 2022.
16
16
17
17
---
18
-
A more detailed roadmap for Kinstugi Kusama launch and towards interBTC launch on Polkadot will be published here shortly.
18
+
A more detailed roadmap for Kinstugi Kusama launch and towards interBTC launch on Polkadot will be published here shortly.
Copy file name to clipboardExpand all lines: docs/start/faq.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
### How does interBTC maintain its peg?
4
4
5
-
The BTC-Parachain ensures that for each minted interBTC: (1) there is an equivalent amount of BTC physically locked on Bitcoin, and (2) there is sufficient DOT collateral locked to economically back minted interBTC in case vaults attempt theft. As such, interBTC is a hybrid peg, with supply determined by both locked BTC and DOT.
5
+
The interBTC bridge ensures that for each minted interBTC: (1) there is an equivalent amount of BTC physically locked on Bitcoin, and (2) there is sufficient DOT collateral locked to economically back minted interBTC in case vaults attempt theft. As such, interBTC is a hybrid peg, with supply determined by both locked BTC and DOT.
6
6
7
7
### Who are the vaults? Can anyone become a vault?
Copy file name to clipboardExpand all lines: docs/start/overview.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,27 +2,27 @@
2
2
3
3
In 2016, the [Polkadot whitepaper](https://polkadot.network/PolkaDotPaper.pdf) identified secure interoperability with Bitcoin as a critical and also challenging feature. In January 2020, with the launch of Polkadot on the horizon, the [Web3 Foundation](https://web3.foundation/in) commissioned [Interlay](https://www.interlay.io/) to design a trustless bridge from Bitcoin to Polkadot based on [XCLAIM](https://www.xclaim.io/) — a carefully designed, open and trustless system that guarantees the security of user’s funds.
4
4
5
-
The BTC-Parachain allows users to mint 1:1 Bitcoin-backed assets onto Polkadot - interBTC - and use these across a wide range of applications, including decentralized exchanges, stablecoins, and lending protocols.
5
+
The interBTC bridge allows users to mint 1:1 Bitcoin-backed assets onto Polkadot - interBTC - and use these across a wide range of applications, including decentralized exchanges, stablecoins, and lending protocols.
6
6
7
-
Funded by a [Web3 Foundation grant](https://web3.foundation/grants/), the BTC-Parachain is implemented in [Rust](https://www.rust-lang.org/) using [Parity](https://www.parity.io/)'s [Substrate framework](https://substrate.dev/).
7
+
Funded by a [Web3 Foundation grant](https://web3.foundation/grants/), the interBTC bridge is implemented in [Rust](https://www.rust-lang.org/) using [Parity](https://www.parity.io/)'s [Substrate framework](https://substrate.dev/).
8
8
9
9
### Helpful Links
10
10
11
11
-[Polkadot's blog post explaining interBTC](https://polkadot.network/bitcoin-is-coming-to-polkadot/)
## Security Guarantees: Trustless and Fully Decentralized
22
22
23
-
What makes the BTC-Parachain unique is the strict dedication to being trustless and decentralized:
23
+
What makes the interBTC bridge unique is the strict dedication to being trustless and decentralized:
24
24
25
-
-**Trustless**. The bridge has no central authority. Right from the start, the BTC-Parachain will be run by a decentralized network of individuals, community members, and companies.
25
+
-**Trustless**. The bridge has no central authority. Right from the start, the interBTC bridge will be run by a decentralized network of individuals, community members, and companies.
26
26
-**Decentralized**. In the spirit of permissionless systems like Bitcoin, anyone can participate in operating the bridge: contrary to other approaches, you do not need permission or any additional token to become a maintainer and start earning fees.
27
27
28
28
As a holder of interBTC, you have the following guarantee:
@@ -40,19 +40,19 @@ Summarizing, to trust the bridge, you only need to:
40
40
41
41
### Cryptocurrency-Backed Assets
42
42
43
-
At the core, XCLAIM - the framework underlying the BTC-Parachain - introduces the concept of cryptocurrency-back assets. Assets are locked on Bitcoin and unlocked on Polkadot in form of 1:1 BTC backed-assets (interBTC). interBTC can be used just like any native asset within the Polkadot ecosystem, meaning: they can be easily transferred and integrated into other Parachains and applications.
43
+
At the core, XCLAIM - the framework underlying the interBTC bridge - introduces the concept of cryptocurrency-back assets. Assets are locked on Bitcoin and unlocked on Polkadot in form of 1:1 BTC backed-assets (interBTC). interBTC can be used just like any native asset within the Polkadot ecosystem, meaning: they can be easily transferred and integrated into other Parachains and applications.
[XCLAIM](https://xclaim.io) consists of three main protocols, which also resemble the life-cycle of interBTC:
50
50
51
-
-**Issue**: Users create interBTC on the BTC-Parachain by locking BTC with Vaults — non-trusted and collateralized intermediaries on Bitcoin (see below).
51
+
-**Issue**: Users create interBTC on the interBTC bridge by locking BTC with Vaults — non-trusted and collateralized intermediaries on Bitcoin (see below).
52
52
53
53
-**Transfer**: Users transfer interBTC to other users or migrate to other Parachains within the Polkadot ecosystem, integrating with stablecoins, decentralized exchanges, lending protocols etc.
54
54
55
-
-**Redeem**: Users burn interBTC on the BTC-Parachain to receive the *equivalent* amount of BTC from Vaults on Bitcoin.
55
+
-**Redeem**: Users burn interBTC on the interBTC bridge to receive the *equivalent* amount of BTC from Vaults on Bitcoin.
56
56
57
57
interBTC can remain on Polkadot indefinitely (no expiry date) and can be redeemed at any point in time. Users who obtain interBTC on Polkadot do not need a BTC wallet, until they decide to redeem the tokens for BTC (if at all).
58
58
@@ -90,7 +90,7 @@ Both can redeem owned interBTC for BTC at any time (requires BTC wallet).
90
90
91
91
All roles are coordinated through the **Parachain Execution Environment**, which encodes the functionality to issue, transfer and redeem interBTC, and enforce correct behavior of Vaults. Thereby, the Parachain implements a multi-stage collateralization scheme, to protect against exchange rate fluctuations. The Parachain also verifies the correct execution of payments on Bitcoin via BTC-Relay, a Substrate Bitcoin SPV client. To transfer interBTC to other Parachains, an integration with Polkadot’s Cross-Chain Message Passing (XCMP) will be provided.
92
92
93
-
*The BTC-Parachain is Polkadot’s trustless gateway for Bitcoin.*
93
+
*The interBTC bridge is Polkadot’s trustless gateway for Bitcoin.*
Copy file name to clipboardExpand all lines: docs/vault/overview.md
+33-24Lines changed: 33 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,57 +1,60 @@
1
1
# Vaults
2
2
3
-
Vaults are the heart of the interBTC bridge. They are responsible for maintaining the physical 1:1 peg between BTC and interBTC.
4
-
Vaults receive BTC for safekeeping from users and ensure BTC remains locked while interBTC exists
3
+
Vaults are the heart of the interBTC and Kintsugi bridge. They are responsible for maintaining the physical 1:1 peg between BTC and interBTC/kBTC.
4
+
Vaults receive BTC for safekeeping from users and ensure BTC remains locked while interBTC/kBTC exists
5
5
6
-
Vaults are **non-trusted** and **collateralized** and **any user can become a Vault** by providing DOT collateral. This means: as a user, you can freely choose any Vault you like or be your own Vault. You don’t have to trust anyone else if you want to be extra cautious.
6
+
Vaults are **non-trusted** and **collateralized** and **any user can become a Vault** by providing collateral. This means: as a user, you can freely choose any Vault you like or be your own Vault. You don’t have to trust anyone else if you want to be extra cautious.
7
7
8
-
The correct behavior of Vaults is enforced by the interBTC bridge parachain. Specifically, Vaults must prove correct behavior to the BTC-Relay component - a Bitcoin SPV client implemented directly on top of Polkadot. If a Vault tries to steal BTC, this will be automatically detected and the Vault will lose its collateral - and users will be reimbursed using this collateral (at a beneficial rate).
8
+
The correct behavior of Vaults is enforced by the bridge. Specifically, Vaults must prove correct behavior to the BTC-Relay component - a Bitcoin SPV client implemented directly on top of the bridge. If a Vault tries to steal BTC, this will be automatically detected and the Vault will lose its collateral - and users will be reimbursed using this collateral (at a beneficial rate).
9
9
10
-
The secondary responsibility of a Vault is to monitor both Bitcoin and the interBTC bridge to ensure that the BTC-Relay (Bitcoin light/SPV client deployed on Polkadot) stays up to date with the Bitcoin mainchain by relaying Bitcoin block headers.
11
-
12
-
Note: BTC-Relay is self healing and automatically detects and recovers from Bitcoin forks.
10
+
The secondary responsibility of a Vault is to monitor both Bitcoin and the bridge to ensure that the BTC-Relay stays up to date with the Bitcoin mainchain by relaying Bitcoin block headers. BTC-Relay is self-healing and automatically detects and recovers from Bitcoin forks.
13
11
14
12
### What do Vaults do?
15
13
16
-
1.**Provide DOT Collateral** and upload their Bitcoin public key to the interBTC bridge. The amount of collateral provided determines how much BTC the Vault can accept for safekeeping / how many interBTC this Vault can secure.
17
-
2.**Issue**: Vaults receive BTC from users for safekeeping. This locks the Vault's DOT collateral until BTC is redeemed again.
18
-
3.**Redeem**: Vaults monitor the interBTC bridge for redeem requests. When a user requests to redeem interBTC, Vaults release BTC to the user and prove that they behaved correctly to the interBTC bridge (via the BTC-Relay). Only if this proof is correct, the Vault's collateral is unlocked again.
14
+
1.**Provide Collateral** and upload their Bitcoin public key to the bridge. The amount of collateral provided determines how much BTC the Vault can accept for safekeeping. Collateral can initially be provided in KSM (on Kintsugi) and DOT (on interBTC).
15
+
2.**Issue**: Vaults receive BTC from users for safekeeping. This locks the Vault's collateral until BTC is redeemed again.
16
+
3.**Redeem**: Vaults monitor the interBTC/Kintsugi bridge for redeem requests. When a user requests to redeem interBTC/kBTC, Vaults release BTC to the user and prove that they behaved correctly via the BTC-Relay. Only if this proof is correct, the Vault's collateral is unlocked.
17
+
18
+
To support the integrity of the bridge, Vaults are also able to assume the role of a Relayer:
19
+
20
+
1.**Maintain BTC-Relay**: submit Bitcoin block headers to BTC-Relay and make sure the bridge stays up to date with the Bitcoin mainchain.
21
+
2.**Report Vault Theft**: monitor Vault Bitcoin addresses and BTC holdings and report theft to the bridge (providing an SPV proof to BTC-Relay)
19
22
20
-
To support the integrity of the parachain, Vaults are also able to assume the role of a Relayer:
23
+
### Why operating a Vault?
21
24
22
-
1.**Maintain BTC-Relay**: submit Bitcoin block headers to interBTC's BTC-Relay and make sure the bridge stays up to date with the Bitcoin mainchain.
23
-
2.**Report Vault Theft**: monitor Vault Bitcoin addresses and BTC holdings and report theft to the interBTC bridge (providing an SPV proof to BTC-Relay)
25
+
1.**Earning potential:**
24
26
25
-
### Why would I want to become a Vault?
27
+
-*interBTC/kBTC*: All Vaults are part of a fee pool and earn fees in interBTC/kBTC when any user issues or redeems interBTC/kBTC.
28
+
-*KINT* (Kintsugi-only): Vaults receive a KINT block reward.
29
+
-*KSM/DOT* (planned feature): Subject to governance, Vaults are able to provide collateral in liquid staked assets like LKSM or LDOT to receive both staking rewards from the relay chain and the rewards form the Kintsugi/interBTC bridge.
26
30
27
-
1.**Yield farming:** Vaults earn fees in interBTC and receive a subsidy in DOT. As such, Vaults earn yield on their DOT collateral and have **exposure to both DOT and (Polka)BTC**.
28
31
2.**Self-custody:** Vaults hold BTC of users in custody. If you are a large liquidity provider, you can be your own vault and retain custody over your BTC holdings until you sell interBTC.
4. Some DOTs to provide as collateral and pay for transaction fees
38
+
4. Some KSM/DOT to provide as collateral and pay for transaction fees
36
39
37
40
Head over to ["Installation"](/vault/installation) for a detailed setup guide.
38
41
39
42
## Fee Model
40
43
41
-
Vaults earn fees on issue and redeem, based on the interBTC volume.
44
+
Vaults earn fees on issue and redeem, based on the BTC volume.
42
45
43
46
### Pool-based Fee Distribution
44
47
45
-
Vaults earn fees based on the issued and redeemed interBTC volume. To reduce variance of payouts, the interBTC bridge implements a **pooled fee model**.
48
+
Vaults earn fees based on the issued and redeemed BTC volume. To reduce variance of payouts, the bridge implements a **pooled fee model**.
46
49
47
-
Each time a user issues or redeems interBTC, they pay the following fees to a **global fee pool**:
50
+
Each time a user issues or redeems interBTC/kBTC, they pay the following fees to a **global fee pool**:
48
51
49
-
-**Issue Fee**: `0.5%` of the Issue volume, paid in *interBTC*
50
-
-**Redeem**: `0.5%` of the redeem volume, paid in *interBTC*
52
+
-**Issue Fee**: `0.5%` of the Issue volume, paid in *interBTC/kBTC*
53
+
-**Redeem**: `0.5%` of the redeem volume, paid in *interBTC/kBTC*
51
54
52
55
From this fee pool, `100%` is distributed among all active Vaults based on the following factor:
53
56
54
-
- 100% based on the Vault's **BTC in custody** ( = issued interBTC) in proportion to the total locked BTC (= issued interBTC) across all Vaults
57
+
- 100% based on the Vault's **BTC in custody** ( = issued interBTC/kBTC) in proportion to the total locked BTC (= issued interBTC/kBTC) across all Vaults
55
58
56
59
Specifically, each Vault's fee is calculated according to the following formula:
57
60
@@ -60,10 +63,16 @@ Specifically, each Vault's fee is calculated according to the following formula:
60
63
61
64
The Vault fee is paid each time an Issue or Redeem request is executed.
62
65
66
+
### KINT Vault Block Rewards (Kintsugi-only)
67
+
68
+
Vaults receive KINT as fees for keeping BTC locked and providing the required insurance collateral in KSM and other assets. Early Vaults receive more rewards as they take up higher risk in terms of protocol maturity.
69
+
70
+
For the full details, see the [Kintsugi whitepaper](https://raw.githubusercontent.com/interlay/whitepapers/master/Kintsugi_Token_Economy.pdf).
71
+
63
72
## Collateral
64
73
65
-
To ensure Vaults have no incentive to steal user's BTC, Vaults provide collateral in DOT to the interBTC bridge.
66
-
To mitigate exchange rate fluctuations, the interBTC bridge employs *over-collateralization* and a *multi-level collateral balancing* scheme.
74
+
To ensure Vaults have no incentive to steal user's BTC, Vaults provide collateral in DOT to the interBTC bridge or KSM to the Kintsugi bridge.
75
+
To mitigate exchange rate fluctuations, the bridge employs *over-collateralization* and a *multi-level collateral balancing* scheme.
0 commit comments