1. Clone the repository:

   git clone https://github.com/soteria-tools/soteria.git
   cd soteria

2. Create a global opam switch and install:

   make glob-switch && make install

   This creates a global opam switch called soteria-install, switches to it, and installs Soteria.

3. Activate the switch:

   eval $(opam env --switch=soteria-install)

   Add this line to your shell profile (.bashrc, .zshrc, etc.) to make it permanent, or run opam switch soteria-install to switch to it in your current shell.

1. Clone the repository:

   git clone https://github.com/soteria-tools/soteria.git
   cd soteria

2. Create a local opam switch and install dependencies:

   make switch

   This creates an isolated OCaml environment with all required dependencies.

   Alternatively, if you already have a switch you want to use:

   make ocaml-deps

3. Build the project:

   dune build

4. Verify the installation by running the test suite:

   dune test

   Note: Running dune test requires both Rust frontends (Obol and Charon) to be installed. To run only the core Soteria or Soteria-C tests without Rust frontends:

   dune test soteria      # Core library tests only
   dune test soteria-c    # Soteria-C tests only

We support two frontends: Obol and Charon.

Quick Setup: Use the versionsync script to automatically install both frontends:

./scripts/versionsync.py pull all --init

This will clone and build both Obol and Charon at the correct commits.

Obol is the default frontend (recommended for most use cases).

Using the versionsync script (recommended):

./scripts/versionsync.py pull obol --init

Manual installation:

1. Clone Obol at the correct commit:

   cd ..
   git clone https://github.com/soteria-tools/obol.git
   cd obol
   git checkout 745a7e8f59596f4e656169e5b1b4f9e834c4c671

   Note: The required commit hash can always be found in scripts/versions.json under OBOL_COMMIT_HASH.

2. Build Obol:

   make build

3. Add Obol to your PATH:

   export PATH="$PATH:$(pwd)/bin"

   Add this line to your shell profile (.bashrc, .zshrc, etc.) to make it permanent.

Charon is an alternative frontend. To use it, pass --frontend charon to soteria-rust.

Using the versionsync script (recommended):

./scripts/versionsync.py pull charon --init

Manual installation:

1. Clone Charon at the correct commit:

   cd ..
   git clone https://github.com/soteria-tools/charon.git
   cd charon
   git checkout 6aee301e2c0365f48f27194c50df1398f9d5647c

   Note: The required commit hash can always be found in scripts/versions.json under CHARON_COMMIT_HASH.

2. Build Charon:

   make build-charon-rust

3. Add Charon to your PATH:

   export PATH="$PATH:$(pwd)/bin"

   Add this line to your shell profile (.bashrc, .zshrc, etc.) to make it permanent.