diff --git a/README.md b/README.md new file mode 100644 index 00000000..9c565a77 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Serai + +Serai is a new DEX, built from the ground up, initially planning on listing +Bitcoin, Ethereum, Monero, DAI, and USDC, offering a liquidity pool trading +experience. Funds are stored in an economically secured threshold multisig +wallet. + +### Layout + +- `docs` - Documentation on the Serai protocol. + +- `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. + +- `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. + +- `processor` - A generic chain processor to process data for Serai and process + events from Serai, executing transactions as expected and needed. diff --git a/coins/monero/README.md b/coins/monero/README.md new file mode 100644 index 00000000..50fc1700 --- /dev/null +++ b/coins/monero/README.md @@ -0,0 +1,7 @@ +# monero-serai + +A modern Monero transaction library intended for usage in wallets. It prides +itself on accuracy, correctness, and removing common pit falls developers may +face. + +Threshold multisignature support is available via the `multisig` feature. diff --git a/crypto/dalek-ff-group/README.md b/crypto/dalek-ff-group/README.md index b5b600b7..730de5a7 100644 --- a/crypto/dalek-ff-group/README.md +++ b/crypto/dalek-ff-group/README.md @@ -1,5 +1,6 @@ # Dalek FF/Group -ff/group bindings around curve25519-dalek with a random function based around a more modern rand_core. +ff/group bindings around curve25519-dalek with a from_hash/random function based +around modern dependencies. Some functions currently remain unimplemented.