Clementine is Citrea's BitVM based trust-minimized two-way peg program. You can check Clementine whitepaper at citrea.xyz/clementine_whitepaper.pdf.
The repository includes:
- A library for bridge operators, verifiers, aggregators, and watchtowers
- Circuits that will be optimistically verified with BitVM
High-level documentation is in docs/. This documentation explains the design, architecture and usage of Clementine.
To start using Clementine, see the docs/usage.md documentation.
Code documentation is also present and can be viewed at chainwayxyz.github.io/clementine/clementine_core.
It can also be generated locally:
cargo doc --no-depsDocumentation will be available at target/doc/clementine_core/index.html after
that.