Skip to content

Commit

Permalink
docs: initial copy of spec to interbtc repo
Browse files Browse the repository at this point in the history
  • Loading branch information
nud3l committed Jul 27, 2022
1 parent 6a3e19d commit 1cb5c33
Show file tree
Hide file tree
Showing 73 changed files with 11,306 additions and 2 deletions.
8 changes: 6 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
.idea
/target/*
*/launch.json
.vscode
*.vscode

## Rococo
genesis-state*
Expand All @@ -22,4 +22,8 @@ rococo-local-raw.json
*.log

### Testdata
standalone/runtime/tests/data/bitcoin-testdata.json
standalone/runtime/tests/data/bitcoin-testdata.json

### Specification
docs/spec/book
*.rst
9 changes: 9 additions & 0 deletions docs/spec/book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[book]
authors = ["Interlay"]
language = "en"
multilingual = false
src = "src"
title = "interBTC Technical Specification"

[output.html]
mathjax-support = true
52 changes: 52 additions & 0 deletions docs/spec/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Summary

[interBTC at a Glance](intro/at-a-glance.md)

# Introduction

- [Cryptocurrency-backed Assets](intro/cba.md)
- [Architecture](intro/architecture.md)
- [Polkadot, Kusama, and Substrate](intro/polkadot.md)
- [Bitcoin Data Model](intro/bitcoin.md)
- [Accepted Bitcoin Transaction Format](intro/accepted-format.md)
- [How to Read This Specification](intro/introduction.md)

# Specification

- [BTC-Relay](./spec/btc-relay/index.md)
- [Collateral](./spec/collateral.md)
- [Currency](./spec/currency.md)
- [Fee](./spec/fee.md)
- [Oracle](./spec/oracle.md)
- [Issue](./spec/issue.md)
- [Refund](./spec/refund.md)
- [Redeem](./spec/redeem.md)
- [Replace](./spec/replace.md)
- [Security](./spec/security.md)
- [Relay](./spec/relay.md)
- [Treasury](./spec/treasury.md)
- [Vault Registry](./spec/vault-registry.md)
- [Vault Nomination](./spec/nomination.md)
- [Reward](./spec/reward.md)
- [Staking](./spec/staking.md)
- [Escrow](./spec/escrow.md)
- [Governance](./spec/governance.md)

# Security and Performance

- [Vault Liquidations](./security-performance/liquidations.md)
- [XCLAIM Security Analysis](./security-performance/xclaim-security.md)
- [BTC-Relay Security Analysis](./security-performance/btcrelay-security.md)
- [Performance Analysis](./security-performance/performance.md)

# Economics

- [Econnomic Incentives](./economics/incentives.md)
- [Fee Model](./economics/fees.md)

---

# All the Rest

- [License](./other/license.md)
- [Interlay](./other/interlay.md)
Loading

0 comments on commit 1cb5c33

Please sign in to comment.