feat: Kintsugi docs, restructuring & other additions

docs/README.md

@@ -1,46 +1,49 @@
-# InterBTC
+# InterBTC & Kintsugi Documentation
 
-## Financially Trustless Bitcoin on Polkadot
+## Radically Open Bitcoin for Decentralized Finance 
 
-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.
+
+**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. 
+
+**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. 
 
 ![Cryptocurrency-backed Assets](_assets/img/CbA.jpg)
 
 ### Issue, Trade, and Redeem
 
 The life-cycle of interBTC follows the three main protocols:
 
-- **Issue:** Users create interBTC by locking BTC with Vaults — non-trusted and collateralized intermediaries on Bitcoin.
-- **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.
-- **Redeem:** Users burn interBTC on the interBTC bridge to receive the equivalent amount of BTC from Vaults on Bitcoin.
-
-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).
+- **Issue:** Lock your BTC with a Vault. Pick one, or run your own. Your BTC is always safe and insured by Vault collateral. 
+- **Mint:** Get interBTC at a 1:1 ration to your locked BTC.
+- **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. 
+- **Redeem:** Redeem interBTC for actual BTC on Bitcoin - trustless and anytime you want.
 
-### Secure, Open, Efficient.
+### Radically Open & Secured by Insurance
 
-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:
+What makes interBTC unique is the strict dedication to being trustless and decentralized. Users
 
-- **Financially Secure:** Vaults (intermediaries) pledge collateral and cryptographically prove correct behavior. Any attempt of theft is automatically punished and users are reimbursed.
+- **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. 
 
-- **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.
+- **Radically Open**. Anyone can become a Vault and help secure interBTC, anytime. Yes, you can run your own Vault!
 
-- **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.
 
-- **Fast and Efficient:** XCLAIM is on average 95% faster than using classic HTLC atomic swaps with Bitcoin.
 
 ## Guides
 
-###### [1. Get a detailed overview of interBTC](start/overview.md)
+###### [1 Learn about Kintsugi, the canary network on Kusama - going live NOW](kintsugi/overview.md)
+
+
+###### [2. Get a detailed overview of interBTC](start/overview.md)
 
-###### [2. Issue your first interBTC](start/issue.md)
+###### [3. Issue your first interBTC](start/issue.md)
 
-###### [3. Redeem interBTC for BTC](start/redeem.md)
+###### [4. Redeem interBTC for BTC](start/redeem.md)
 
-###### [4. Understand how a Vault works](vault/overview.md)
+###### [5. Understand how a Vault works](vault/overview.md)
 
-###### [5. Operate your own Vault](vault/guide.md)
+###### [6. Operate your own Vault](vault/guide.md)
 
-###### [6. Build your own Dapps with interBTC](developers/integration.md)
+###### [7. Build your own Dapps with interBTC](developers/integration.md)
 
 ## Contributions
 

docs/_sidebar.md

@@ -1,5 +1,16 @@
 <!-- docs/_sidebar.md -->
 
+
+* **Kintsugi (Kusama)**
+
+  * [Overview](kintsugi/overview.md)
+  * [Crowdloans](kintsugi/crowdloans.md)
+  * [Tokenomics](kintsugi/tokenomics.md)
+  * [Governance](kintsugi/governance.md)
+---
+
+* **interBTC (Testnet)**
+
 * Getting Started
 
   * [Overview](start/overview.md)
@@ -27,6 +38,7 @@
   * [Interacting with interBTC](developers/integration.md)
   * [Documentation](developers/documentation.md)
 
-* About interBTC
 
-  * [Roadmap](about/roadmap.md)
+* [Roadmap](about/roadmap.md)
+
+* [Glossary](glossary/glossary.md)

docs/about/roadmap.md

@@ -1,11 +1,18 @@
 # Roadmap
 
-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.
 
-[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/).
+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.
 
-The Alpha was successfully launched in November 2020, a public feature-ready Beta launched on 2 March 2021.
+[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. 
 
-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.
+### Timeline So Far
+- **1st Web3 Foundation grant** (Spec & PoC) started in January 2020
+- **1st grant completed** in April 2020
+- **2nd Web3 Foundation grant** (Full Implementation) started in September 2020
+- **Alpha** testnet was launched in November 2020
+- **Feature-ready Beta** launched on 2 March 2021
+- **(NOW) Kintsugi on Kusama** is going to parachain auctions starting 1st September 2021
+- **(soon) interBTC on Polkadot** is expected in late 2021 / early 2022.
 
-![interBTC Roadmap](../_assets/img/interBTC_roadmap.png)
+---
+A more detailed roadmap for Kinstugi Kusama launch and towards interBTC launch on Polkadot will be published here shortly.

docs/glossary/glossary.md

@@ -0,0 +1,17 @@
+# Glossary
+
+**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.
+
+**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. 
+
+**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. 
+
+**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. 
+
+**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. 
+
+**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.
+
+**KINT** is Kintsugi’s governance token, the Kusama counterpart to INTR. 
+
+**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

@@ -0,0 +1,47 @@
+# The Kintsugi Crowdloan
+
+Kintsugi participates in the Kusama parachain auctions and supports a crowdloan to enable the community to vote.
+To participate in the crowdloan, you need to lock your KSM and vote for Kintsugi to become a parachain. 
+
+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).
+
+
+##  Hard Facts
+
+* **Target slot: 6 - 10**
+* **Lease duration: 8 periods (maximum lease duration ~48 weeks)**
+* **Max. lockup target: 200 000 KSM**
+
+#### Crowdloan Airdrop: 12%
+
+
+
+* **Crowdloan: 10% (1 million KINT)** of the initial 4-year KINT supply 
+* **Extra 2%** in-protocol airdrops for crowdloan participants who run Vaults and mint kBTC.
+
+To create a proactive crowdloan process, Kintsugi features the following **special airdrops:**
+
+
+
+* **Early**: 5% for first 3 days of crowdloan 
+* **Referral**: 5% for the referrer and referred 
+* **Success**: up to 100 000 additional KINT if specific KSM lockup targets are achieved. See table:
+
+
+![Crowdloan Bonuses](../_assets/img/kintsugi/crowdloan_bonuses.png)
+
+
+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.
+
+## Participating in the Crowdloan 
+
+The crowdloan is a fully permissionless event - you make your own judgement on if and how you would like to participate. 
+
+We recommend the following ways to participate:
+
+1. Participate via the [Kintsugi crowdloan website](https://kintsugi.interlay.io/) using the Polkadot.js browser extension.
+2. Participate via partner exchanges.
+3. Participate via partner mobile wallets.
+
+### Guides
+Step-by-step guides incl. screenshots will be posted here shortly.

docs/kintsugi/governance.md

@@ -0,0 +1,24 @@
+# Decentralized Governance
+
+Kintsugi adopts [Polkadot’s governance mechanism](https://wiki.polkadot.network/docs/learn-governance), with two modifications: (1) optimistic governance and (2) stake-to-vote.
+
+**Council**
+
+Day-to-day decisions are made by an elected Council but can be overruled by the majority of KINT holders. The Council is democratically elected by KINT holders and anyone can run for office. A **Council rules for 7 days and users can change their vote after each such period**.
+
+**Optimistic Governance**
+
+To promote a more active governance process and avoid the “lazy voter” problem, Kintsugi implements “optimistic governance”: proposals agreed on by Council pass automatically, after an “objection period”, unless KINT holders actively vote to oppose. 
+
+**Stake to Vote**
+
+To vote, users lock KINT with the Kintsugi parachain. The locking period thereby will impact the voting power: the longer KINT are locked, the more voting power they have, since the voter has a long-term stake in the health of the system. 
+
+**Technical Committee**
+
+Kintsuigi also exhibits a Technical Committee (TC) of developer teams, voted on by the Council. The TC can make emergency proposals which, if accepted by the council, are “fast-tracked” and executed quickly, e.g. in case of critical software bugs.
+
+
+
+---
+**An in-depth guide to Kintsugi's governance process will be published here soon.**

docs/kintsugi/overview.md

@@ -0,0 +1,29 @@
+# Kintsugi - interBTC’s Canary Network
+
+**Kintsugi** is interBTC's canary network, developed by Interlay under the supervision of Kintsugi Lab, a non-profit oriented organization responsible for Kintsugi's launch and the support of the decentralized network and ecosystem. 
+
+
+### kBTC - Radically Open Bitcoin on Kusama
+Kintsugi's kBTC brings radically open Bitcoin to Kusama to kickstart liquidity for parachains like Karura, Shiden and Moonriver. 
+
+**kBTC** is a 1:1 Bitcoin-backed asset on Kusama, maintained by a decentralized network of collateralized Vaults. Users must only ever trust that Bitcoin and the DeFi platform they use are secure. 
+
+
+Head over to the  [interBTC chapter](start/overview.md) of this documentation to read more about the underlying trustless and decentralized cross-chain technology (the [XCLAIM](https://eprint.iacr.org/2018/643) protocol).
+
+
+### KINT: Decentralized Governance
+Kintsugi is ruled by its community from day one - via KINT, Kintsugi's governance token.
+
+Read the [Tokenomics chapter](kintsugi/tokenomics.md) to learn about KINT's model, or read about the [Governance](kintsugi/governance.md) process. 
+
+### Parachain Auction and Crowdloans
+Kintsugi is participating in the Kusama parachain auctions to win a parachain slot. To allow to community to vote for bringing BTC to Kusama, Kintsugi is running a crowdloan. 
+
+Read the [Crowdloan chapter](kintsugi/crowdloans.md) to learn more about the KINT distribution and the auction process and events. 
+
+
+**For the interested: read the [token economy primer](https://raw.githubusercontent.com/interlay/whitepapers/master/Kintsugi_Token_Economy.pdf) released by Kintsugi Labs for an in depth understanding of the Kintsugi tokenomics and governance models.**
+
+### Kintsugi Origins
+Inspired by the ancient [Japanese tradition of embracing the flawed and imperfect](https://en.wikipedia.org/wiki/Kintsugi), Kintsugi accepts the nascent DeFi ecosystem on Kusama as chaotic while constantly being perfected by golden streaks of its community.

docs/kintsugi/tokenomics.md

@@ -0,0 +1,57 @@
+# KINT Tokenomics
+
+Kintsugi will be governed by its community from day 1 - via KINT, Kintsugi’s governance token. Kintsugi will go live via **a fair launch scheme**. 
+
+
+_KINT tokens will be distributed to network participants, builders and early backers as airdrops and block-rewards. There will be no public sale or ICO._
+
+Below is a summary of the Kintsugi token economy, as described in the [token economy whitepaper released by Kintsugi Labs](https://raw.githubusercontent.com/interlay/whitepapers/master/Kintsugi_Token_Economy.pdf).
+
+### Key Functions of KINT
+
+The KINT token’s main purposes are:
+
+* **Governance**- KINT holders vote on governance proposals and elect council members to make operational decisions. 
+* **Utility**. Mit-term, Kintsugi will support transaction fee payments in KINT and other digital assets, in addition to KSM. 
+
+### Supply and Emission
+
+KINT features an unlimited supply. The emission schedule is defined as follows: 
+
+
+
+* 10 million KINT emitted over the first 4 years (4:3:2:1 million) 
+* 2% annual inflation afterwards, indefinitely.
+
+Specifically, the emission schedule for the first 6 years looks as follows:
+
+![Crowdloan Bonuses](../_assets/img/kintsugi/emission_schedule.png)
+
+
+### Distribution
+
+KINT will be controlled by the community:
+
+* **70% is distributed to the community** as airdrops and block rewards.  
+* 30% is airdropped to the Interlay team, and early & future investors, who funded development of the protocol - subject to 1 year followed by 1 year linear vesting.
+
+Starting in year 5, only the community receives new KINT from the annual inflation.
+
+
+<table>
+  <tr>
+   <td>
+<img src="../_assets/img/kintsugi/Kintsugi_initial_distribution.jpg" width="" alt="alt_text" title="image_tooltip">
+<p>
+Distribution of the initial 4-year supply.
+   </td>
+   <td>
+<img src="../_assets/img/kintsugi/Kintsugi_5y_distribution.jpg" width="" alt="alt_text" title="image_tooltip">
+<p>
+Distribution of the 2% annual inflation starting in year 5.
+   </td>
+  </tr>
+</table>
+
+---
+**For a detailed breakdown and explanation of the KINT distribution, check out the [token economy whitepaper released by Kintsugi Labs](https://raw.githubusercontent.com/interlay/whitepapers/master/Kintsugi_Token_Economy.pdf)**