Skip to content

Commit bb7768b

Browse files
committed
chore(docs): explain what the project is about
1 parent c8d8fe9 commit bb7768b

File tree

1 file changed

+3
-20
lines changed

1 file changed

+3
-20
lines changed

README.md

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
# Mezcal
44

5-
Mezcal (Nahuatl: mexcalli) - agave booze.
5+
Mezcal (Nahuatl: mexcalli - agave booze) - on-chain dark pool implementation using [Noir](https://noir-lang.org) and [Taceo coNoir](https://taceo.io). Hides EVERYTHING about orders and traders(tokens, amounts and addresses of traders are completely hidden). Trades settled on an EVM chain using a very simplified version of [Aztec Protocol](https://aztec.network).
6+
7+
The code is highly experimental. The core code is located in `packages/contracts`.
68

79
## TODO
810

@@ -21,22 +23,3 @@ Mezcal (Nahuatl: mexcalli) - agave booze.
2123
- [ ] deploy as proxy
2224
- [ ] test contracts with larger token amounts
2325
- [ ] TODO(security): parse inputs to circuits instead of assuming they are correct. Same applies to types returned from `unconstrained` functions. <https://github.com/noir-lang/noir/issues/7181> <https://github.com/noir-lang/noir/issues/4218>
24-
25-
### Backend
26-
27-
- [x] prove using native bb
28-
- [ ] persist merkle trees
29-
- [ ] return pending tree roots
30-
31-
### UI
32-
33-
- [x] shield
34-
- [x] transfer
35-
- [ ] join (maybe behind the scenes, multicall)
36-
- [ ] unshield
37-
38-
### compliance
39-
40-
- [ ] unshield only mode
41-
- [ ] set shield limit to 10 USDC
42-
- [ ] disclaimer that the rollup is not audited

0 commit comments

Comments
 (0)