cycles-quartz/README.md

53 lines
1.5 KiB
Markdown
Raw Normal View History

# cycles-quartz
2023-11-06 10:22:21 +00:00
A Rust implementation of the cycles protocol and the Quartz app framework.
2023-11-06 10:22:21 +00:00
This repository contains the following components -
2023-11-06 10:22:21 +00:00
### Apps
2023-11-06 10:22:21 +00:00
Quartz applications, each consisting of CosmWasm smart contracts, Gramine based sidecar enclaves and accompanying ZK
proofs.
Currently implemented apps -
* [MTCS](apps/mtcs) - The default app which implements Multilateral Trade Credit Set-off.
### Core
The Quartz core implementation including -
* Core handlers and types for Quartz
* Intel SGX remote attestation (RA) primitives
* Light client and merkle proofs for CosmWasm storage
### CosmWasm packages
CosmWasm packages for the core Quartz framework and remote attestation verification.
### Utils
Utilities for supporting Quartz development and -
* [cw-prover](utils/cw-prover) - Retrieve a merkle-proof for CosmWasm state
* [cycles-sync](utils/cycles-sync) - Sync obligations and setoffs
with [Obligato](https://github.com/informalsystems/obligato)
* [mtcs-intent](utils/mtcs-intent) - CLI for keygen, encrypting/decrypting obligations/setoffs, etc.
* [tm-prover](utils/tm-prover) - Generate light client and merkle proofs for CosmWasm storage in a format that Quartz
understands
## Contributing
If you're interested in contributing, please comment on a relevant issue (if there is one) or open a new one!
See [CONTRIBUTING.md](CONTRIBUTING.md).
## Resources
* [Cycles website](https://cycles.money/)
* [Cycles Spec](docs/spec)
* [Quartz protobuf definitions](core/quartz-proto)
## License
TBD