Ecosystem/serai
Ecosystem/serai
1
0
Fork 0
mirror of https://github.com/serai-dex/serai.git synced 2024-11-16 17:07:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
serai/README.md
Luke Parker 7d2d739042
Rename the coins folder to networks (#583) 
* Rename the coins folder to networks

Ethereum isn't a coin. It's a network.

Resolves #357.

* More renames of coins -> networks in orchestration

* Correct paths in tests/

* cargo fmt
2024-07-18 15:16:45 -04:00

2.7 KiB
Raw Blame History

Serai

Serai is a new DEX, built from the ground up, initially planning on listing Bitcoin, Ethereum, DAI, and Monero, offering a liquidity-pool-based trading experience. Funds are stored in an economically secured threshold-multisig wallet.

Getting Started

Layout

  • audits: Audits for various parts of Serai.

  • spec: The specification of the Serai protocol, both internally and as networked.

  • docs: User-facing documentation on the Serai protocol.

  • 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 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.

  • networks: Various 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.

  • message-queue: An ordered message server so services can talk to each other, even when the other is offline.

  • processor: A generic chain processor to process data for Serai and process events from Serai, executing transactions as expected and needed.

  • coordinator: A service to manage processors and communicate over a P2P network with other validators.

  • substrate: Substrate crates used to instantiate the Serai network.

  • 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.

Security

Serai hosts a bug bounty program via Immunefi. 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.

Links