From 375967b165c8b270eadc906deb1d77de8b7635c4 Mon Sep 17 00:00:00 2001 From: Luke Parker Date: Wed, 20 Jul 2022 02:56:58 -0400 Subject: [PATCH] Correct table formatting and clarify network docs --- docs/protocol/Constants.md | 55 ++++++++++++++++++++------------------ 1 file changed, 29 insertions(+), 26 deletions(-) diff --git a/docs/protocol/Constants.md b/docs/protocol/Constants.md index 2ab4f55e..60e7dab9 100644 --- a/docs/protocol/Constants.md +++ b/docs/protocol/Constants.md @@ -5,14 +5,14 @@ These are the list of types used to represent various properties within the protocol. -Alias | Shorthand | Type | ------------------------------------------------ -Amount | Amount | u64 | -Curve | Curve | u16 | -Coin | Coin | u32 | -Global Validator Set ID | GVSID | u32 | -Validator Set Index | VS | u8 | -Key | Key | Vec | +| Alias | Shorthand | Type | +|-------------------------|-----------|---------| +| Amount | Amount | u64 | +| Curve | Curve | u16 | +| Coin | Coin | u32 | +| Global Validator Set ID | GVSID | u32 | +| Validator Set Index | VS | u8 | +| Key | Key | Vec | ### 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 per curve, and then use DLEq proofs to port keys to other basepoints as needed. -Curve | ID | ----------------- -Secp256k1 | 0 | -Ed25519 | 1 | +| Curve | ID | +|-----------|----| +| Secp256k1 | 0 | +| Ed25519 | 1 | ### 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 -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 | -------------------------------- -Bitcoin | "bitcoin" | 0 | -Ethereum | "ethereum" | 0 | -Monero | "monero" | 1 | +Networks are not acknowledged by the Serai network, solely by the processor. + +| Network | Curve | +|----------|-------| +| Bitcoin | 0 | +| Ethereum | 0 | +| Monero | 1 | ### Coins Coins exist over a network and have a distinct integer ID. -Coin | Network | ID | --------------------------- -Bitcoin | Bitcoin | 0 | -Ethereum | Ethereum | 1 | -USDC | Ethereum | 2 | -DAI | Ethereum | 3 | -Monero | Monero | 4 | +| Coin | Network | ID | +|----------|----------|----| +| Bitcoin | Bitcoin | 0 | +| Ethereum | Ethereum | 1 | +| USDC | Ethereum | 2 | +| DAI | Ethereum | 3 | +| Monero | Monero | 4 |