Skip to content

Commit 0e623a1

Browse files
feat: Kintsugi docs, restructuring & other additions (#104)
* feat: added kintsugi to docs, re-organized sidebar, updated roadmap, added glossary, updated landing-page/README * chore: fixed typos & wrong numbering
1 parent 62c97a2 commit 0e623a1

13 files changed

Lines changed: 223 additions & 27 deletions

docs/README.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,49 @@
1-
# InterBTC
1+
# InterBTC & Kintsugi Documentation
22

3-
## Financially Trustless Bitcoin on Polkadot
3+
## Radically Open Bitcoin for Decentralized Finance
44

5-
At the core, interBTC leverages the concept of cryptocurrency-back assets introduced in the XCLAIM protocol. 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. Moreover, interBTC can be transferred to other ecosystems like Cosmos and Ethereum making it truly interoperable.
5+
6+
**interBTC** is Bitcoin on any blockchain. A 1:1 Bitcoin-backed asset, fully collateralized, interoperable, and censorship-resistant. interBTC will be hosted as a Polkadot parachain and connected to Cosmos, Ethereum and other major DeFi networks.
7+
8+
**Kintsugi** is Interlay’s canary network for interBTC, a testnet with real economic value deployed on Kusama (Polkadot’s canary network). Kintsugi and interBTC share the same code base - with the difference that Kintsugi will be 2-3 releases ahead of interBTC with more experimental features.
69

710
![Cryptocurrency-backed Assets](_assets/img/CbA.jpg)
811

912
### Issue, Trade, and Redeem
1013

1114
The life-cycle of interBTC follows the three main protocols:
1215

13-
- **Issue:** Users create interBTC by locking BTC with Vaults — non-trusted and collateralized intermediaries on Bitcoin.
14-
- **Transfer:** Users transfer interBTC to other users or use their interBTC within the Polkadot, Ethereum, and Cosmos ecosystems, integrating with stablecoins, decentralized exchanges, and lending protocols.
15-
- **Redeem:** Users burn interBTC on the interBTC bridge to receive the equivalent amount of BTC from Vaults on Bitcoin.
16-
17-
interBTC can remain on Polkadot and other networks 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).
16+
- **Issue:** Lock your BTC with a Vault. Pick one, or run your own. Your BTC is always safe and insured by Vault collateral.
17+
- **Mint:** Get interBTC at a 1:1 ration to your locked BTC.
18+
- **BTC DeFi:** Earn on your Bitcoin. Use interBTC as collateral, for lending, yield farming and more. On Polkadot, Kusama, Cosmos, Ethereum and other major DeFi platforms.
19+
- **Redeem:** Redeem interBTC for actual BTC on Bitcoin - trustless and anytime you want.
1820

19-
### Secure, Open, Efficient.
21+
### Radically Open & Secured by Insurance
2022

21-
XCLAIM guarantees users can redeem interBTC tokens for the corresponding amount of BTC or be reimbursed in the DOT at any point in time. To summarize, XCLAIM is:
23+
What makes interBTC unique is the strict dedication to being trustless and decentralized. Users
2224

23-
- **Financially Secure:** Vaults (intermediaries) pledge collateral and cryptographically prove correct behavior. Any attempt of theft is automatically punished and users are reimbursed.
25+
- **Secured by Insurance**. Vaults lock collateral on the interBTC parachain in various digital assets - in a MakerDAO-inspired multi-collateral system. If Vaults misbehave, their collateral is slashed and users reimbursed. As a user, you only trust that Bitcoin and the DeFi platform you use are secure.
2426

25-
- **Dynamic and Permissionless:** any user can become a Vault — simply, anytime, and without asking for permission. No need to rely on someone else, or any special hardware. You can even run your own Vault for issuing interBTC.
27+
- **Radically Open**. Anyone can become a Vault and help secure interBTC, anytime. Yes, you can run your own Vault!
2628

27-
- **Censorship Resistant:** By design, Vaults have no influence over the Issue process. That is, no Vault can prevent a user from minting or obtaining interBTC.
2829

29-
- **Fast and Efficient:** XCLAIM is on average 95% faster than using classic HTLC atomic swaps with Bitcoin.
3030

3131
## Guides
3232

33-
###### [1. Get a detailed overview of interBTC](start/overview.md)
33+
###### [1 Learn about Kintsugi, the canary network on Kusama - going live NOW](kintsugi/overview.md)
34+
35+
36+
###### [2. Get a detailed overview of interBTC](start/overview.md)
3437

35-
###### [2. Issue your first interBTC](start/issue.md)
38+
###### [3. Issue your first interBTC](start/issue.md)
3639

37-
###### [3. Redeem interBTC for BTC](start/redeem.md)
40+
###### [4. Redeem interBTC for BTC](start/redeem.md)
3841

39-
###### [4. Understand how a Vault works](vault/overview.md)
42+
###### [5. Understand how a Vault works](vault/overview.md)
4043

41-
###### [5. Operate your own Vault](vault/guide.md)
44+
###### [6. Operate your own Vault](vault/guide.md)
4245

43-
###### [6. Build your own Dapps with interBTC](developers/integration.md)
46+
###### [7. Build your own Dapps with interBTC](developers/integration.md)
4447

4548
## Contributions
4649

82.4 KB
Loading
90.3 KB
Loading
23.3 KB
Loading
37.2 KB
Loading
105 KB
Loading

docs/_sidebar.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
<!-- docs/_sidebar.md -->
22

3+
4+
* **Kintsugi (Kusama)**
5+
6+
* [Overview](kintsugi/overview.md)
7+
* [Crowdloans](kintsugi/crowdloans.md)
8+
* [Tokenomics](kintsugi/tokenomics.md)
9+
* [Governance](kintsugi/governance.md)
10+
---
11+
12+
* **interBTC (Testnet)**
13+
314
* Getting Started
415

516
* [Overview](start/overview.md)
@@ -27,6 +38,7 @@
2738
* [Interacting with interBTC](developers/integration.md)
2839
* [Documentation](developers/documentation.md)
2940

30-
* About interBTC
3141

32-
* [Roadmap](about/roadmap.md)
42+
* [Roadmap](about/roadmap.md)
43+
44+
* [Glossary](glossary/glossary.md)

docs/about/roadmap.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
# Roadmap
22

3-
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.
43

5-
[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 is now expediting efforts to complete the BTC Parachain in Q1 2021 - funded by a follow-up [Web3 Foundation grant](https://web3.foundation/grants/).
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.
65

7-
The Alpha was successfully launched in November 2020, a public feature-ready Beta launched on 2 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/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.
87

9-
Once the audit of the code base is completed and parachains are enabled on Polkadot and Kusama, the BTC Parachain will go live: first on Kusama, then on Polkadot mainnet.
8+
### Timeline So Far
9+
- **1st Web3 Foundation grant** (Spec & PoC) started in January 2020
10+
- **1st grant completed** in April 2020
11+
- **2nd Web3 Foundation grant** (Full Implementation) started in September 2020
12+
- **Alpha** testnet was launched in November 2020
13+
- **Feature-ready Beta** launched on 2 March 2021
14+
- **(NOW) Kintsugi on Kusama** is going to parachain auctions starting 1st September 2021
15+
- **(soon) interBTC on Polkadot** is expected in late 2021 / early 2022.
1016

11-
![interBTC Roadmap](../_assets/img/interBTC_roadmap.png)
17+
---
18+
A more detailed roadmap for Kinstugi Kusama launch and towards interBTC launch on Polkadot will be published here shortly.

docs/glossary/glossary.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Glossary
2+
3+
**Interlay** is a R&D company focusing on blockchain interoperability. Interlay envisions a future where blockchains seamlessly connect and interact. Interlay’s imminent mission is to make Bitcoin interoperable in a fully trustless and decentralized way. Founded by ex-Imperial College CS PhDs, our products are backed by top-tier scientific papers and collaborate with leading research labs and tech companies around the world.
4+
5+
**Kintsugi Labs** is a non-profit oriented organization responsible for the Kintsugi launch, whose mission is to support the development and growth of the decentralized network.
6+
7+
**interBTC** is Interlay’s flagship product - Bitcoin on any blockchain. A 1:1 Bitcoin-backed asset, fully collateralized, interoperable, and censorship-resistant. interBTC will be hosted as a Polkadot parachain and connected to Cosmos, Ethereum and other major DeFi networks.
8+
9+
**INTR** is interBTC’s governance token, distributed across network participants and used to elect council members and vote on proposals. INTR will be used to govern the interBTC parachain on Polkadot.
10+
11+
**Kintsugi** is Interlay’s canary network for interBTC, a testnet with real economic value deployed on Kusama (Polkadot’s canary network). Kintsugi and interBTC share the same code base - with the difference that Kintsugi will be 2-3 releases ahead of interBTC with more experimental features.
12+
13+
**kBTC** is a 1:1 Bitcoin-backed asset on the Kintsugi canary network, deployed on Kusama. It follows the same design as interBTC, yet may feature more experimental functions and parameterizations.
14+
15+
**KINT** is Kintsugi’s governance token, the Kusama counterpart to INTR.
16+
17+
**XCLAIM** is the protocol underlying interBTC and kBTC. XCLAIM was invented in 2018, and published as a top-tier, peer-reviewed scientific paper by Interlay founders. You can read the paper [here](https://eprint.iacr.org/2018/643).

docs/kintsugi/crowdloans.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# The Kintsugi Crowdloan
2+
3+
Kintsugi participates in the Kusama parachain auctions and supports a crowdloan to enable the community to vote.
4+
To participate in the crowdloan, you need to lock your KSM and vote for Kintsugi to become a parachain.
5+
6+
Below is a summary of the Kintsugi crowdloan details, as described in the [token economy whitepaper released by Kintsugi Labs](https://raw.githubusercontent.com/interlay/whitepapers/master/Kintsugi_Token_Economy.pdf).
7+
8+
9+
## Hard Facts
10+
11+
* **Target slot: 6 - 10**
12+
* **Lease duration: 8 periods (maximum lease duration ~48 weeks)**
13+
* **Max. lockup target: 200 000 KSM**
14+
15+
#### Crowdloan Airdrop: 12%
16+
17+
18+
19+
* **Crowdloan: 10% (1 million KINT)** of the initial 4-year KINT supply
20+
* **Extra 2%** in-protocol airdrops for crowdloan participants who run Vaults and mint kBTC.
21+
22+
To create a proactive crowdloan process, Kintsugi features the following **special airdrops:**
23+
24+
25+
26+
* **Early**: 5% for first 3 days of crowdloan
27+
* **Referral**: 5% for the referrer and referred
28+
* **Success**: up to 100 000 additional KINT if specific KSM lockup targets are achieved. See table:
29+
30+
31+
![Crowdloan Bonuses](../_assets/img/kintsugi/crowdloan_bonuses.png)
32+
33+
34+
Any KINT not used for the Core, Early, Referral and Success Airdrop will be distributed proportionally among all participants, further increasing the ratio of KINT per locked KSM.
35+
36+
## Participating in the Crowdloan
37+
38+
The crowdloan is a fully permissionless event - you make your own judgement on if and how you would like to participate.
39+
40+
We recommend the following ways to participate:
41+
42+
1. Participate via the [Kintsugi crowdloan website](https://kintsugi.interlay.io/) using the Polkadot.js browser extension.
43+
2. Participate via partner exchanges.
44+
3. Participate via partner mobile wallets.
45+
46+
### Guides
47+
Step-by-step guides incl. screenshots will be posted here shortly.

0 commit comments

Comments
 (0)