Skip to content

Commit

Permalink
Merge pull request #147 from zama-ai/docs/readme-update
Browse files Browse the repository at this point in the history
doc(README): minor changes
  • Loading branch information
immortal-tofu authored Sep 20, 2023
2 parents a70b19f + e08de68 commit 5f36be8
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,22 +24,22 @@ Thanks to a breakthrough in homomorphic encryption, Zama’s fhEVM makes it poss

### Zama’s fhEVM enables confidential smart contracts using fully homomorphic encryption (FHE)

- **End-to-end encryption of transactions and state:** Data included in transactions is encrypted and never visible to anynone.
- **End-to-end encryption of transactions and state:** Data included in transactions is encrypted and never visible to anyone.
- **Composability and data availability on-chain:** States are updated while remaining encrypted at all times.
- **No impact on existing dapps and state:** Data stored on-chain remains encrypted end-to-end.

### Developers can write confidential smart contracts without learning cryptography

- **Solidity Integration:** fhEVM contracts are simple solidity contracts that are built using traditional solidity toolchains.
- **Simple DevX:** Developers can use the euint data types to mark which part of their contracts should be private.
- **Simple DevX:** Developers can use the `euint` data types to mark which part of their contracts should be private.
- **SC-defined ACL:** All the logic for access control of encrypted states is defined by developers in their smart contracts.

You can take a look at our list of [examples](/examples).

### Powerful features available out of the box

- **High Precision Integers -** Up to 256 bits of precision for integers
- **Full range of Operators -** All typical operators are available: +,-,\*,/,<,>.==,...
- **Full range of Operators -** All typical operators are available: `+`, `-`, `*`, `/`, `<`, `>`, `==`, …
- **Encrypted If-Else Conditionals -** Check conditions on encrypted states
- **On-chain Secure Randomness -** Generate randomness without using oracles
- **Configurable Decryption -** Threshold, centralized or KMS decryption
Expand Down Expand Up @@ -114,7 +114,7 @@ test/tfheOperations/tfheOperations.ts

### Tests

The easiest way to understand how to write/dev smart contract and interact with them using **fhevmjs** is to read and explore the few tests available in this repository.
The easiest way to understand how to write/dev smart contract and interact with them using **fhevmjs** is to read and explore the available tests in this repository.

#### Fast start

Expand Down Expand Up @@ -143,7 +143,8 @@ npm run fhevm:stop

#### Faucet

To use a ready to use test (only for dev) wallet first, prepare the .env file that contains the mnemonic.
For development purpose, we provide a ready to use wallet. In order to use
it, prepare the .env file that contains the mnemonic.

```bash
cp .env.example .env
Expand Down

0 comments on commit 5f36be8

Please sign in to comment.