From 233164cefd70b362752cbcc673f08865f9d3aabb Mon Sep 17 00:00:00 2001 From: Luke Parker Date: Mon, 11 Mar 2024 23:51:44 -0400 Subject: [PATCH] Flesh out docs more --- docs/_config.yml | 9 +++++++ docs/amm/index.md | 2 ++ docs/cross_chain/index.md | 2 ++ docs/economics/index.md | 39 ++++++++++++++++++++++++++++ docs/evolutions/index.md | 6 +++++ docs/index.md | 29 ++++++++++++++++++--- docs/infrastructure/coordinator.md | 2 ++ docs/infrastructure/index.md | 2 +- docs/infrastructure/message_queue.md | 4 +++ docs/infrastructure/processor.md | 12 +++++---- docs/integrating/index.md | 2 +- docs/validator/index.md | 2 +- 12 files changed, 99 insertions(+), 12 deletions(-) create mode 100644 docs/evolutions/index.md diff --git a/docs/_config.yml b/docs/_config.yml index 4db467205..75c8f131e 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -3,3 +3,12 @@ description: Documentation for the Serai protocol. theme: just-the-docs url: https://docs.serai.exchange + +callouts: + warning: + title: Warning + color: red + + definition: + title: Definition + color: blue diff --git a/docs/amm/index.md b/docs/amm/index.md index ef48ceead..678f6ee95 100644 --- a/docs/amm/index.md +++ b/docs/amm/index.md @@ -4,6 +4,8 @@ layout: default nav_order: 2 --- +# Automatic Market Makers + *text on how AMMs work* Serai uses a symmetric liquidity pool with the `xy=k` formula. diff --git a/docs/cross_chain/index.md b/docs/cross_chain/index.md index 212aa5b55..a7b6a480f 100644 --- a/docs/cross_chain/index.md +++ b/docs/cross_chain/index.md @@ -3,3 +3,5 @@ title: Cross-Chain Architecture layout: default nav_order: 3 --- + +# Cross-Chain Architecture diff --git a/docs/economics/index.md b/docs/economics/index.md index a77ed2c32..c8d3bde4b 100644 --- a/docs/economics/index.md +++ b/docs/economics/index.md @@ -4,3 +4,42 @@ layout: default nav_order: 4 has_children: true --- + +# Economics + +Serai's economics change depending on which of three eras is currently +occurring. + +## Genesis Era + +The network starts with the "Genesis" era, where the goal of the network is to +attract the liquidity necessary to facilitate swaps. This period will last for +30 days and will let anyone add liquidity to the protocol. Only with its +conclusion will SRI start being distributed. + +After the Genesis era, the network enters the "Pre-Economic Security" era. + +## Pre-Economic Security + +{: .definition-title } +> Definition: Economic Security +> +> Economic security is derived from it being unprofitable to misbehave. +> This is by the economic penalty which is presumed to occur upon misbehavior +> exceeding the value which would presumably be gained. +> Accordingly, rational actors would behave properly, causing the protocol to +> maintain its integrity. +> +> For Serai specifically, the stake required to produce unintended signatures +> must exceed the value accessible via producing unintended signatures. + +With liquidity provided, and swaps enabled, the goal is to have validators stake +sufficiently for economic security to be achieved. This is primarily via +offering freshly minted, staked SRI to would-be validators who decide to swap +external coins for their stake. + +## Post-Economic Security + +Having achieved economic security, the protocol changes its economics one last +time (barring future upgrades to the protocol) to a 'normal' state of +operations. diff --git a/docs/evolutions/index.md b/docs/evolutions/index.md new file mode 100644 index 000000000..f24d634f7 --- /dev/null +++ b/docs/evolutions/index.md @@ -0,0 +1,6 @@ +--- +title: Evolutions +layout: default +nav_order: 5 +has_children: true +--- diff --git a/docs/index.md b/docs/index.md index 2246e51c9..c7685d13f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,8 +4,29 @@ layout: home nav_order: 1 --- -Serai is a cross-chain decentralized exchange, integrating Bitcoin, Ethereum, -and Monero. - +{: .warning } This documentation site is still under active development and may have missing -sections, errors, and typos. +sections, errors, and typos. Even once this documentation site is 'complete', it +may become out-of-date (as Serai is an evolving protocol yet to release) or have +minor errors. + +# Serai + +Serai is a fairly launched cross-chain decentralized exchange, integrating +Bitcoin (BTC), Ethereum (ETH, DAI), and Monero (XMR). + +The Serai mainnet has yet to launch, and until then, all details are subject to +change. + +Prior to the Serai mainnet launching, SRI, Serai's native coin, will not +exist. As a fairly launched project, SRI will have no ICO, no IEO, no presale, +no developers' tax/fund, and no airdrop for out-of-mainnet activity. + +Out-of-mainnet activity includes: + +- Being a community member (such as on Discord or on Twitter) +- Participating in testnets +- Contributing to the GitHub + +None of these will be awarded any airdrop. All distributions of SRI will happen +on-chain per the protocols' defined rules, based on on-chain activity. diff --git a/docs/infrastructure/coordinator.md b/docs/infrastructure/coordinator.md index 2d69e0965..cf6acacab 100644 --- a/docs/infrastructure/coordinator.md +++ b/docs/infrastructure/coordinator.md @@ -5,6 +5,8 @@ nav_order: 3 parent: Infrastructure --- +# Coordinator + The coordinator is a local service which communicates with other validators' coordinators. It provides a verifiable broadcast layer for various consensus messages, such as agreement on external blockchains, key generation and signing diff --git a/docs/infrastructure/index.md b/docs/infrastructure/index.md index acb2be9f8..2db1a7913 100644 --- a/docs/infrastructure/index.md +++ b/docs/infrastructure/index.md @@ -1,6 +1,6 @@ --- title: Infrastructure layout: default -nav_order: 5 +nav_order: 6 has_children: true --- diff --git a/docs/infrastructure/message_queue.md b/docs/infrastructure/message_queue.md index fa8e0f8ef..4ce21277f 100644 --- a/docs/infrastructure/message_queue.md +++ b/docs/infrastructure/message_queue.md @@ -5,11 +5,15 @@ nav_order: 1 parent: Infrastructure --- +# Message Queue + The Message Queue is a microservice to authenticate and relay messages between services. It offers just three functions: 1) Queue a message. + 2) Receive the next message. + 3) Acknowledge a message, removing it from the queue. This ensures messages are delivered between services, with their order diff --git a/docs/infrastructure/processor.md b/docs/infrastructure/processor.md index fb542cad1..ca49120e5 100644 --- a/docs/infrastructure/processor.md +++ b/docs/infrastructure/processor.md @@ -5,15 +5,17 @@ nav_order: 2 parent: Infrastructure --- +# Processor + The processor performs several important tasks with regards to the external network. Each of them are documented in the following sections. -# Key Generation +## Key Generation -# Scanning +## Scanning -# Signing Batches +## Signing Batches -# Planning Transactions +## Planning Transactions -# Cosigning +## Cosigning diff --git a/docs/integrating/index.md b/docs/integrating/index.md index 764441e25..58a6ea067 100644 --- a/docs/integrating/index.md +++ b/docs/integrating/index.md @@ -1,6 +1,6 @@ --- title: Integrating with Serai layout: default -nav_order: 6 +nav_order: 7 has_children: true --- diff --git a/docs/validator/index.md b/docs/validator/index.md index a652fd16b..753d5976b 100644 --- a/docs/validator/index.md +++ b/docs/validator/index.md @@ -1,6 +1,6 @@ --- title: Running a Validator layout: default -nav_order: 7 +nav_order: 8 has_children: true ---