Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 1.34 KB

README.md

File metadata and controls

42 lines (27 loc) · 1.34 KB
Raw

etf-sdk

This is an SDK to build protocols on top of the EtF network. Specifically, it contains cryptographic primitives used by the etf network, as well as implements timelock encryption via AES-GCM with SSS, where shares are encrypted for futures slots using IBE. It is wasm-compilable and so able to be called from both rust and javascript contexts.

It consists of two packages:

  • etf-crypto-primitives contains implementations in arkworks
    • contains README with instructions on setting up Linux environment
  • etf-sdk is an API to expose timelock encryption and DLEQ proof verification, and make compilable to wasm

⚠️ This library is a WIP and should not be considered safe for production use.

Setup

This code is only guaranteed to work in Linux environments. If you have a windows OS, use WSL and install Ubuntu.

Install rust and build-essentials:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
. "$HOME/.cargo/env"
sudo apt-get update
sudo apt install build-essential

Testing

We aim for a minimum of 85% coverage on all lines. To check coverage, we use tarpaulin with opt-level=0:

cargo tarpaulin --rustflags="-C opt-level=0"

Benchmarks

Navigate to the etf-crypto-primitives directory and run:

cargo bench

See the benches dir for more info.