mirror of
https://github.com/serai-dex/serai.git
synced 2024-12-22 11:39:35 +00:00
Add READMEs to Serai and Monero
This commit is contained in:
parent
f50fd76b31
commit
c5f75568cd
3 changed files with 31 additions and 1 deletions
22
README.md
Normal file
22
README.md
Normal file
|
@ -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.
|
7
coins/monero/README.md
Normal file
7
coins/monero/README.md
Normal file
|
@ -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.
|
|
@ -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.
|
||||
|
|
Loading…
Reference in a new issue