serai/README.md

47 lines
1.8 KiB
Markdown
Raw Normal View History

2022-07-08 20:23:26 +00:00
# Serai
Serai is a new DEX, built from the ground up, initially planning on listing
2023-01-04 11:17:00 +00:00
Bitcoin, Ethereum, DAI, and Monero, offering a liquidity-pool-based trading
2023-01-04 11:07:58 +00:00
experience. Funds are stored in an economically secured threshold-multisig
wallet.
2022-07-08 20:23:26 +00:00
[Getting Started](docs/Getting%20Started.md)
2022-07-08 20:23:26 +00:00
### Layout
- `audits`: Audits for various parts of Serai.
- `docs`: Documentation on the Serai protocol.
2022-07-08 20:23:26 +00:00
2023-01-04 11:07:58 +00:00
- `common`: Crates containing utilities common to a variety of areas under
Serai, none neatly fitting under another category.
- `crypto`: A series of composable cryptographic libraries built around the
2022-07-08 20:23:26 +00:00
`ff`/`group` APIs achieving a variety of tasks. These range from generic
infrastructure, to our IETF-compliant FROST implementation, to a DLEq proof as
needed for Bitcoin-Monero atomic swaps.
- `coins`: Various coin libraries intended for usage in Serai yet also by the
wider community. This means they will always support the functionality Serai
needs, yet won't disadvantage other use cases when possible.
- `processor`: A generic chain processor to process data for Serai and process
2022-07-08 20:23:26 +00:00
events from Serai, executing transactions as expected and needed.
2022-07-23 09:20:36 +00:00
- `tendermint`: An abstracted implementation of the Tendermint BFT algorithm,
planned to be used in our own micro-blockchain for temporal data needed to
coordinate the Serai validators, yet irrelevant to the Serai network as a
whole.
- `substrate`: Substrate crates used to instantiate the Serai network.
2023-01-04 11:07:58 +00:00
- `deploy`: Scripts to deploy a Serai node/test environment.
2022-07-23 09:20:36 +00:00
### Links
- [Twitter](https://twitter.com/SeraiDEX): https://twitter.com/SeraiDEX
2023-01-04 11:07:58 +00:00
- [Mastodon](https://cryptodon.lol/@serai): https://cryptodon.lol/@serai
2022-07-23 09:20:36 +00:00
- [Discord](https://discord.gg/mpEUtJR3vz): https://discord.gg/mpEUtJR3vz
- [Matrix](https://matrix.to/#/#serai:matrix.org):
https://matrix.to/#/#serai:matrix.org