2022-07-08 16:23:26 -04:00
|
|
|
# Serai
|
|
|
|
|
|
|
|
|
|
Serai is a new DEX, built from the ground up, initially planning on listing
|
2023-01-04 06:17:00 -05:00
|
|
|
Bitcoin, Ethereum, DAI, and Monero, offering a liquidity-pool-based trading
|
2023-01-04 06:07:58 -05:00
|
|
|
experience. Funds are stored in an economically secured threshold-multisig
|
|
|
|
|
wallet.
|
2022-07-08 16:23:26 -04:00
|
|
|
|
2024-03-11 20:00:01 -04:00
|
|
|
[Getting Started](spec/Getting%20Started.md)
|
2022-10-31 11:34:53 -05:00
|
|
|
|
2022-07-08 16:23:26 -04:00
|
|
|
### Layout
|
|
|
|
|
|
2023-03-16 18:46:48 -04:00
|
|
|
- `audits`: Audits for various parts of Serai.
|
|
|
|
|
|
2024-03-11 17:55:27 -04:00
|
|
|
- `spec`: The specification of the Serai protocol, both internally and as
|
|
|
|
|
networked.
|
|
|
|
|
|
|
|
|
|
- `docs`: User-facing documentation on the Serai protocol.
|
2022-07-08 16:23:26 -04:00
|
|
|
|
2023-01-04 06:07:58 -05:00
|
|
|
- `common`: Crates containing utilities common to a variety of areas under
|
|
|
|
|
Serai, none neatly fitting under another category.
|
|
|
|
|
|
2022-08-25 04:02:13 -04:00
|
|
|
- `crypto`: A series of composable cryptographic libraries built around the
|
2023-07-27 03:19:35 -04:00
|
|
|
`ff`/`group` APIs, achieving a variety of tasks. These range from generic
|
2022-07-08 16:23:26 -04:00
|
|
|
infrastructure, to our IETF-compliant FROST implementation, to a DLEq proof as
|
|
|
|
|
needed for Bitcoin-Monero atomic swaps.
|
|
|
|
|
|
2024-07-18 12:16:45 -07:00
|
|
|
- `networks`: Various libraries intended for usage in Serai yet also by the
|
2022-08-25 04:02:13 -04:00
|
|
|
wider community. This means they will always support the functionality Serai
|
|
|
|
|
needs, yet won't disadvantage other use cases when possible.
|
|
|
|
|
|
2023-07-27 03:19:35 -04:00
|
|
|
- `message-queue`: An ordered message server so services can talk to each other,
|
|
|
|
|
even when the other is offline.
|
|
|
|
|
|
2022-08-25 04:02:13 -04:00
|
|
|
- `processor`: A generic chain processor to process data for Serai and process
|
2022-07-08 16:23:26 -04:00
|
|
|
events from Serai, executing transactions as expected and needed.
|
2022-07-23 05:20:36 -04:00
|
|
|
|
2023-04-13 21:05:18 -04:00
|
|
|
- `coordinator`: A service to manage processors and communicate over a P2P
|
|
|
|
|
network with other validators.
|
2023-03-26 08:43:01 -04:00
|
|
|
|
2022-08-25 04:02:13 -04:00
|
|
|
- `substrate`: Substrate crates used to instantiate the Serai network.
|
|
|
|
|
|
2023-07-27 03:19:35 -04:00
|
|
|
- `orchestration`: Dockerfiles and scripts to deploy a Serai node/test
|
|
|
|
|
environment.
|
|
|
|
|
|
|
|
|
|
- `tests`: Tests for various crates. Generally, `crate/src/tests` is used, or
|
|
|
|
|
`crate/tests`, yet any tests requiring crates' binaries are placed here.
|
2023-01-04 06:07:58 -05:00
|
|
|
|
2023-08-04 12:28:15 -04:00
|
|
|
### Security
|
|
|
|
|
|
|
|
|
|
Serai hosts a bug bounty program via
|
|
|
|
|
[Immunefi](https://immunefi.com/bounty/serai/). For in-scope critical
|
|
|
|
|
vulnerabilities, we will reward whitehats with up to $30,000.
|
|
|
|
|
|
|
|
|
|
Anything not in-scope should still be submitted through Immunefi, with rewards
|
|
|
|
|
issued at the discretion of the Immunefi program managers.
|
|
|
|
|
|
2022-07-23 05:20:36 -04:00
|
|
|
### Links
|
|
|
|
|
|
2023-07-16 10:44:06 +10:00
|
|
|
- [Website](https://serai.exchange/): https://serai.exchange/
|
|
|
|
|
- [Immunefi](https://immunefi.com/bounty/serai/): https://immunefi.com/bounty/serai/
|
|
|
|
|
- [Twitter](https://twitter.com/SeraiDEX): https://twitter.com/SeraiDEX
|
|
|
|
|
- [Discord](https://discord.gg/mpEUtJR3vz): https://discord.gg/mpEUtJR3vz
|
|
|
|
|
- [Matrix](https://matrix.to/#/#serai:matrix.org): https://matrix.to/#/#serai:matrix.org
|
|
|
|
|
- [Reddit](https://www.reddit.com/r/SeraiDEX/): https://www.reddit.com/r/SeraiDEX/
|
|
|
|
|
- [Telegram](https://t.me/SeraiDEX): https://t.me/SeraiDEX
|
