Skip to content

Commit

Permalink
Update README.md for building instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
dartdart26 committed Jul 21, 2023
1 parent e731793 commit 0eb0a5b
Showing 1 changed file with 10 additions and 19 deletions.
29 changes: 10 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,20 @@ The TFHE-CLI tool allows developers to use __tfhe-rs__ features through a user-f

This tool can be used locally or through a docker image.

# Quick start
# Build

If you want to generate fhe keys for your evmos node:

On x86:
```bash
$ mkdir -p res && docker run -v $PWD:/usr/local/app ghcr.io/zama-ai/fhevm-tfhe-cli:v0.1.1 fhevm-tfhe-cli generate-keys -d res
## Local
```
# for x86 CPUs
cargo build --features tfhe/x86_64-unix --release
On arm64:
```bash
$ mkdir -p res && docker run -v $PWD:/usr/local/app ghcr.io/zama-ai/fhevm-tfhe-cli:v0.1.1-arm64 fhevm-tfhe-cli generate-keys -d res
# for ARM64
cargo build --features tfhe/aarch64-unix --release
```

Typical output:
```bash
# Generating FHE keys in res
# Generated cks size: 41130 bytes
# Generated sks size: 100729006 bytes
# Generated pks size: 16553 bytes
$ ls res
# cks pks sks
# Docker
```
docker build -t fhevm-tfhe-cli:latest .
```

# Running operations
Expand All @@ -35,9 +27,8 @@ Make sure you either have Docker or the Rust toolchain installed on your host ma
Please replace `FHEVM_TFHE_CLI` with either:
* "`cargo run --features tfhe/aarch64-unix --release -- `" - for ARM CPUs when running locally on the host
* "`cargo run --features tfhe/x86_64-unix --release -- `" - for x86 CPUs when running locally on the host
* "`docker run -v $LOCAL_DIR:/usr/local/app ghcr.io/zama-ai/fhevm-tfhe-cli:$TAG fhevm-tfhe-cli`"
* "`docker run -v $LOCAL_DIR:/usr/local/app fhevm-tfhe-cli:latest fhevm-tfhe-cli`"
* replace LOCAL_DIR with a local directory of choice in order to persist output from the tool when using Docker
* replace TAG with a known tagged version

For more information on Docker, see below.

Expand Down

0 comments on commit 0eb0a5b

Please sign in to comment.