Skip to content

cloak-compiler is an implementation of Cloak Language.

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

OxHainan/cloak-compiler

Repository files navigation

cloak-logo

Cloak Compiler

Cloak TEE is released under the Apache license. Current CircleCI build status. CodeFactor. PRs welcome!

Cloak-compiler is an implementation of Cloak Language.

What is Cloak?

Cloak is a pluggable and configurable framework for developing and deploying confidential smart contracts. To this end, Cloak allows users to specify privacy invariants (what is private data and to who is the data private) in a declarative way. Then, it automatically generate runtime with verifiably enforced privacy and deploy it to the existing EVM-enabled platforms (e.g., Ethereum) and TEE devices to enable the confidential smart contract.

The key capability of Cloak is to allow developers to implement and deploy practical solutions to Multi-Party Transaction (MPT) problems, i.e., to transact with secret functions parameters and states owned by different parties by simply specifying it.

In our evaluation on both examples and real-world applications, developers manage to deploy business services on blockchain in a concise manner by only developing Cloak smart contracts, whose size is less than 30% of the deployed ones, and the gas cost of deployed MPTs reduced by 19%.

The Cloak is an ongoing project aiming to become a chain-agnostic privacy infrastructure of the blockchain ecology. We are always calling for talented, self-motivated developers, researchers or students excited about our vision. Let us make it together.

❗️ Warning

This is a prototype implementation not intended for use in production.

📖 Usage

📖 Documentation

The full documentation for Cloak can found on our Cloak documentation

👏 How to Contribute

The main purpose of this repository is to continue evolving Cloak TEE core. We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving Cloak TEE.

Cloak TEE has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Read our Call for Contributions to learn about our development process, how to propose bugfixed and improvements, and how to build and test your changes to Cloak.

You can learn more about our vision for Cloak Networks in the Roadmap.

Submit Issues

If you find a bug or have some new idea, please submit it to issues. This is a great place to get started, gain experience, and get familiar with our contribution process.

Related works

cloak is implemented based on a research work, zkay.