# crates.io Registration

This crate is registered with crates.io to establish an eventual namespace per
this [Rust RFC](https://github.com/rust-lang/rfcs/pull/3243).  This is not
squatting as disallowed by the crates.io policies due to the amount of
development activity in the corresponding repository.

Serai has had several cryptographic libraries, cryptocurrency libraries, and
internal services developed since 2022. As these crates are marked ready for
release, they are audited pending their proper release.

Please note various `serai-*` crates are currently registered. Per
kayabaNerve's communications with the crates.io team, owners of a top-level
crate (`serai`) are generally allowed to reserve such prefixed crates.

The following README is a copy of the Serai README at the time of this crate
update. Please see https://github.com/serai-dex/serai for the current project,
and for the relative links to work.

# 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](spec/Getting%20Started.md)

### 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](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.

### Links

- [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
- [Mastodon](https://cryptodon.lol/@serai): https://cryptodon.lol/@serai
- [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