diff --git a/README.md b/README.md index e8615e6..303a675 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,9 @@ # fhEVM Contracts -
- π Read white paper | π Documentation | π Community support | π FHE resources by Zama -
+## Description - - -fhEVM contracts is a library for encrypted smart contract development on fhEVM. +fhEVM contracts is a Solidity library for secure smart-contract development using +[fhEVM](https://github.com/zama-ai/fhevm) and TFHE. ## Getting Started @@ -39,7 +32,8 @@ import "fhevm-contracts/contracts/token/ERC20/EncryptedERC20.sol"; contract MyERC20 is EncryptedERC20 { constructor() EncryptedERC20("MyToken", "MYTOKEN") { - _mint(1000000, msg.sender); + TFHE.setFHEVM(FHEVMConfig.defaultConfig()); + _unsafeMint(1000000, msg.sender); } } ``` @@ -48,31 +42,7 @@ contract MyERC20 is EncryptedERC20 { ### Documentation -Full, comprehensive documentation is available here: [https://docs.zama.ai/fhevm](https://docs.zama.ai/fhevm). - -### Citations - -To cite fhEVM or the whitepaper in academic papers, please use the following entries: - -```text -@Misc{fhEVM, -title={{Private smart contracts on the EVM using homomorphic encryption}}, -author={Zama}, -year={2023}, -note={\url{https://github.com/zama-ai/fhevm}}, -} -``` - -```text -@techreport{fhEVM, -author = "Morten Dahl, ClΓ©ment Danjou, Daniel Demmler, Tore Frederiksen, Petar Ivanov, -Marc Joye, Dragos Rotaru, Nigel Smart, Louis Tremblay Thibault -", -title = "Confidential EVM Smart Contracts using Fully Homomorphic Encryption", -institution = "Zama", -year = "2023" -} -``` +The full documentation is available [there](https://docs.zama.ai/fhevm). ### Contributing @@ -82,27 +52,10 @@ There are two ways to contribute to the Zama fhEVM contracts: new ideas - Request to become an official contributor by emailing hello@zama.ai. -Becoming an approved contributor involves signing our Contributor License Agreement (CLA)). Only approved contributors -can send pull requests, so please make sure to get in touch before you do!- β Back to top -
- -## Support - - - - - -π If you find this project helpful or interesting, please consider giving it a star on GitHub! Your support helps to -grow the community and motivates further development. - -- β Back to top -
+This software is distributed under the **BSD-3-Clause-Clear** license. If you have any question about the license, +please contact us at hello@zama.ai.