Add root level README.md

This commit is contained in:
hu55a1n1 2023-11-06 02:22:21 -08:00
parent 4f2eec1f2a
commit 5d0ebdee66

18
README.md Normal file
View file

@ -0,0 +1,18 @@
# The Tendermint light client enclave
This enclave runs tendermint/CometBFT light client verification on a given 'verification trace' using a user specified
root-of-trust. It outputs the new root-of-trust to a sealed file so that it can be used for future instantiations.
## Execution on an SGX machine
This is tested on a local SGX machine, not Azure
```bash
docker build . --tag tmdocker build . --tag tm \
docker run -it --device /dev/sgx_enclave \
-v /var/run/aesmd/aesm.socket:/var/run/aesmd/aesm.socket \
-v ./tests:/workdir/tests \
tm bash
is-sgx-available
gramine-sgx ./tm
```