Ecosystem/serai
Ecosystem/serai
1
0
Fork 0
mirror of https://github.com/serai-dex/serai.git synced 2024-12-23 03:59:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Correct table formatting and clarify network docs

Browse source
This commit is contained in:
Luke Parker 2022-07-20 02:56:58 -04:00
parent 4186bc93a8
commit 375967b165
1 changed files with 29 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
docs/protocol/Constants.md
View file

@ -5,14 +5,14 @@
These are the list of types used to represent various properties within the These are the list of types used to represent various properties within the
protocol. protocol.
Alias | Shorthand | Type | | Alias | Shorthand | Type |
----------------------------------------------- |-------------------------|-----------|---------|
Amount | Amount | u64 | | Amount | Amount | u64 |
Curve | Curve | u16 | | Curve | Curve | u16 |
Coin | Coin | u32 | | Coin | Coin | u32 |
Global Validator Set ID | GVSID | u32 | | Global Validator Set ID | GVSID | u32 |
Validator Set Index | VS | u8 | | Validator Set Index | VS | u8 |
Key | Key | Vec<u8> | | Key | Key | Vec<u8> |
### Curves ### Curves
@ -21,31 +21,34 @@ yet have distinct IDs due to having different basepoints, and accordingly
different keys. For such cases, the processor is expected to create one secret different keys. For such cases, the processor is expected to create one secret
per curve, and then use DLEq proofs to port keys to other basepoints as needed. per curve, and then use DLEq proofs to port keys to other basepoints as needed.
Curve | ID | | Curve | ID |
---------------- |-----------|----|
Secp256k1 | 0 | | Secp256k1 | 0 |
Ed25519 | 1 | | Ed25519 | 1 |
### Networks ### Networks
Every network connected to Serai has a curve and a string ID. While the Every network connected to Serai operates over a specific curve. While the
processor generates keys for curves, these keys are bound to specific networks processor generates keys for curves, these keys are bound to specific networks
via an additive offset created by hashing the network's string ID. via an additive offset created by hashing the network's name (among other
things). The network's key is used for all coins on that network.
Network | String ID | Curve | Networks are not acknowledged by the Serai network, solely by the processor.
-------------------------------
Bitcoin | "bitcoin" | 0 | | Network | Curve |
Ethereum | "ethereum" | 0 | |----------|-------|
Monero | "monero" | 1 | | Bitcoin | 0 |
| Ethereum | 0 |
| Monero | 1 |
### Coins ### Coins
Coins exist over a network and have a distinct integer ID. Coins exist over a network and have a distinct integer ID.
Coin | Network | ID | | Coin | Network | ID |
-------------------------- |----------|----------|----|
Bitcoin | Bitcoin | 0 | | Bitcoin | Bitcoin | 0 |
Ethereum | Ethereum | 1 | | Ethereum | Ethereum | 1 |
USDC | Ethereum | 2 | | USDC | Ethereum | 2 |
DAI | Ethereum | 3 | | DAI | Ethereum | 3 |
Monero | Monero | 4 | | Monero | Monero | 4 |