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 operator, verifiers, aggregator and watchtower
- Circuits that will be optimistically verified with BitVM
Warning
Clementine is still a work in progress. It has not been audited and should not be used in production under any circumstances. It also requires a full BitVM implementation to be run fully on-chain.
High level documentations are in docs/. These documentations explains the design, architecture and usage of Clementine.
To start using Clementine, jump 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.
