-
Notifications
You must be signed in to change notification settings - Fork 88
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: update the docs to fhevm06 #612
Conversation
To simplify matters, a number of functions automatically generate temporary access (using `TFHE.allowTransient` under the hood) for the contract that calls the function. This applies to: | ||
- **`allow`**: Grants permanent access to an address. | ||
- **`allowThis`**: Grants the current contract access to manipulate the ciphertext. | ||
- **`allowTransient`**: Grants temporary access to an address for the current transaction. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be useful to link to the explanation of what is transient storage https://eips.ethereum.org/EIPS/eip-1153
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's mentioned a bit above (line 41)
| Transient | Temporary access during a transaction. | Transient storage (EIP-1153) | Calling external functions or computations with ciphertexts. Use when wanting to save on gas costs. |
Regarding whitepaper, we agree on keeping the previous whitepaper and adding |
Run |
@yuxizama ready for your review :) |
docs: update readme
Closes #531
Closes #523
Closes #529
Closes #533
Closes #497
Closes #527
Closes #528
Closes #243
Closes #521
Closes #520
Closes #522
Closes #625
This PR significantly improves the developer documentation to make it more developer-friendly by addressing gaps, adding clarity, and enhancing usability. The following changes have been introduced:
Key Improvements
Section Updates
Welcome to fhEVM
Getting Started
Quick Overview:
Get Started:
Create a Smart Contract:
fhEVM v0.6
.Fundamentals
Focuses on explaining core concepts and critical features with clear explanations and examples.
Architecture Overview:
Encryption, Decryption, Re-encryption, and Computation:
Access Control List (ACL):
Configuration
Practical guidance on setting up and configuring smart contracts for encrypted operations.
First Smart Contract:
Supported Types:
Operations on Encrypted Types:
Encryption:
Decryption:
Decryption in Depth:
Re-encryption:
ACL Examples:
Guides
Focuses on supplemental concepts and best practices for smart contract development.
Smart Contracts:
Frontend:
Tutorials
References
Smart Contracts - fhEVM API:
Frontend - fhevmjs Library:
Developer
Contributing:
Development Roadmap:
Feature Request and Bug Report:
Release Notes:
Future TODOs