.cargo/config.toml

+[build]
+rustdocflags = ["--html-in-header", "katex.html"]

.env.dockerfile

+FROM rust:latest
+
+# Suppress prompts during package installation
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt update --yes && apt upgrade --yes
+RUN apt install --yes protobuf-compiler
+
+COPY rust-toolchain.toml /
+RUN rustup show && cargo --version
+
+RUN cargo install cargo-script
+
+RUN apt clean && rm -rf /var/lib/apt/lists/*

.env.nu

+const MODULES = [
+    "benchmarks/",
+]
+
+def log-load [m: string] {
+    print $"[(ansi cyan_bold).env.nu(ansi reset)] loading (ansi purple)($m)(ansi reset)"
+}
+
+log-load $MODULES.0
+use $MODULES.0

.github/workflows/ci.yml

+name: Rust CI
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  fmt:
+    runs-on: ubuntu-latest
+    container:
+      image: "ghcr.io/dragoon-rs/dragoon/komodo:bcb0e6b5f73420762f6208700a43291e0066c2c3"
+    if: "!contains(github.event.head_commit.message, 'draft:') && !contains(github.event.head_commit.message, 'no-ci:')"
+    steps:
+      - uses: actions/checkout@v3
+      - run: ./make.rs ci --fmt
+
+  test:
+    runs-on: ubuntu-latest
+    container:
+      image: "ghcr.io/dragoon-rs/dragoon/komodo:bcb0e6b5f73420762f6208700a43291e0066c2c3"
+    needs: fmt
+    if: "!contains(github.event.head_commit.message, 'draft:') && !contains(github.event.head_commit.message, 'no-ci:')"
+    steps:
+      - uses: actions/checkout@v3
+      - run: ./make.rs ci --test

.gitignore

+# Rust
 target/
 Cargo.lock
 
 *.ndjson
+*.png
+
+# IDEs
+.idea
+.vscode

.gitlab-ci.yml

-image: "rust:latest"
+image: "gitlab-registry.isae-supaero.fr/dragoon/komodo:bcb0e6b5f73420762f6208700a43291e0066c2c3"
 
 stages:
   - fmt
   - test
 
-variables:
-  NUSHELL_ARCH: "x86_64-unknown-linux-musl"
-  NUSHELL_VERSION: "0.93.0"
-
 workflow:
   rules:
     - if: $CI_COMMIT_MESSAGE =~ /^(draft|no-ci):/
@@ -19,28 +15,12 @@ workflow:
 
 fmt:
   stage: fmt
-
   script:
-    - make fmt-check
+    - ./make.rs ci --fmt
 
 test:
   stage: test
   needs:
     - fmt
-  before_script:
-    - apt update --yes
-    - apt upgrade --yes
-    - apt install protobuf-compiler --yes
-
-    - export NUSHELL_BUILD="nu-$NUSHELL_VERSION-$NUSHELL_ARCH"
-    - export PATH="/tmp/:$PATH"
-
-    # install Nushell
-    - curl -fLo /tmp/nu.tar.gz "https://github.com/nushell/nushell/releases/download/$NUSHELL_VERSION/$NUSHELL_BUILD.tar.gz"
-    - tar xvf /tmp/nu.tar.gz --directory /tmp
-    - cp "/tmp/$NUSHELL_BUILD/nu" /tmp/nu
-
-    - make show
-
   script:
-    - make check clippy test example
+    - ./make.rs ci --test

.nu.cfg

+REVISION: 1aa2ed1947a0b891398558fcf4e4289849cc5a1d
+VERSION: 0.102.0

.nushell/binary.nu

-# decode a list of integer bytes into the underlying encoded string
-export def "bytes decode" [encoding: string = "utf-8"]: list<int> -> string {
-    each { into binary | bytes at 0..1 } | bytes collect | decode $encoding
-}
-
-# encode an encoded string into the underlying list of integer bytes
-export def "bytes encode" [encoding: string = "utf-8"]: string -> list<int> {
-    let bytes = $in | encode $encoding
-    seq 1 ($bytes | bytes length) | each {|i|
-        $bytes | bytes at ($i - 1)..($i) | into int
-    }
-}
-
-export def "bytes from_int" []: [int -> binary, list<int> -> binary] {
-    each { into binary --compact } | bytes collect
-}
-
-export def "bytes to_int" []: binary -> list<int> {
-    let bytes = $in
-    seq 1 ($bytes | bytes length) | each {|i|
-        $bytes | bytes at ($i - 1)..($i) | get 0
-    }
-}

.nushell/color.nu

-use error.nu "error throw"
-
-export const WHITE = { r: 1.0, g: 1.0, b: 1.0 }
-export const BLACK = { r: 0.0, g: 0.0, b: 0.0 }
-export const RED = { r: 1.0, g: 0.0, b: 0.0 }
-export const GREEN = { r: 0.0, g: 1.0, b: 0.0 }
-export const BLUE = { r: 0.0, g: 0.0, b: 1.0 }
-
-export def "color from-floats" [
-    r: float,
-    g: float,
-    b: float
-]: nothing -> record<r: float, g: float, b: float> {
-    if $r < 0.0 or $r > 1.0 {
-        error throw {
-            err: "invalid RGB channel",
-            label: $"should be between 0 and 1, found ($r)",
-            span: (metadata $r).span,
-        }
-    }
-    if $g < 0.0 or $g > 1.0 {
-        error throw {
-            err: "invalid RGB channel",
-            label: $"should be between 0 and 1, found ($g)",
-            span: (metadata $g).span,
-        }
-    }
-    if $b < 0.0 or $b > 1.0 {
-        error throw {
-            err: "invalid RGB channel",
-            label: $"should be between 0 and 1, found ($b)",
-            span: (metadata $b).span,
-        }
-    }
-
-    { r: $r, g: $g, b: $b }
-}
-
-export def "color from-ints" [
-    r: int,
-    g: int,
-    b: int
-]: nothing -> record<r: float, g: float, b: float> {
-    if $r < 0 or $r > 255 {
-        error throw {
-            err: "invalid RGB channel",
-            label: $"should be between 0 and 255, found ($r)",
-            span: (metadata $r).span,
-        }
-    }
-    if $g < 0 or $g > 255 {
-        error throw {
-            err: "invalid RGB channel",
-            label: $"should be between 0 and 255, found ($g)",
-            span: (metadata $g).span,
-        }
-    }
-    if $b < 0 or $b > 255 {
-        error throw {
-            err: "invalid RGB channel",
-            label: $"should be between 0 and 255, found ($b)",
-            span: (metadata $b).span,
-        }
-    }
-
-    { r: ($r / 255 | into float), g: ($g / 255 | into float), b: ($b / 255 | into float) }
-}
-
-def try-string-to-int []: string -> int {
-    let s = $in
-    try {
-        $"0x($s)" | into int
-    } catch { |e|
-        let err = $e.debug
-            | parse --regex 'CantConvert { to_type: "(?<to>.*)", from_type: "(?<from>.*)", span: Span { (?<span>.*) }, help: Some\("(?<help>.*)"\) }'
-            | into record
-
-        let msg = $err.help | str replace --all '\"' '"'
-        error make --unspanned { msg: $"($msg), found ($s)" }
-    }
-}
-
-export def "color from-string" [s: string]: nothing -> record<r: float, g: float, b: float> {
-    let res = $s
-        | parse --regex '^#(?<r>..)(?<g>..)(?<b>..)$'
-        | into record
-
-    if $res == {} {
-        error throw {
-            err: "invalid HEX color format",
-            label: $"format should be '#RRGGBB', found ($s)",
-            span: (metadata $s).span,
-        }
-    }
-
-    {
-        r: ($res.r | try-string-to-int | $in / 255),
-        g: ($res.g | try-string-to-int | $in / 255),
-        b: ($res.b | try-string-to-int | $in / 255),
-    }
-}
-
-export def "color mix" [
-    c1: record<r: float, g: float, b: float>,
-    c2: record<r: float, g: float, b: float>,
-    c: float,
-]: nothing -> record<r: float, g: float, b: float> {
-    {
-        r: ($c * $c1.r + (1 - $c) * $c2.r),
-        g: ($c * $c1.g + (1 - $c) * $c2.g),
-        b: ($c * $c1.b + (1 - $c) * $c2.b),
-    }
-}
-
-def float-to-u8-hex []: float -> string {
-    $in * 255
-        | math round --precision 0
-        | into int
-        | fmt
-        | get lowerhex
-        | parse "0x{n}"
-        | into record
-        | get n
-        | into string
-        | fill --alignment "right" --character '0' --width 2
-}
-
-export def "color to-hex" []: record<r: float, g: float, b: float> -> string {
-    $"#($in.r | float-to-u8-hex)($in.g | float-to-u8-hex)($in.b | float-to-u8-hex)"
-}
-

.nushell/error.nu

-export def "error throw" [err: record<
-    err: string,
-    label: string,
-    span: record<start: int, end: int>,
-    # help: string?,
->] {
-    error make {
-        msg: $"(ansi red_bold)($err.err)(ansi reset)",
-        label: {
-            text: $err.label,
-            span: $err.span,
-        },
-        help: $err.help?,
-    }
-}

Cargo.toml

 [package]
 name = "komodo"
-version = "0.3.0"
+version = "1.0.1"
 edition = "2021"
+description = "Komodo: cryptographically-proven erasure coding for distributed systems"
+repository = "https://gitlab.isae-supaero.fr/dragoon/komodo"
+readme = "README.md"
+license = "MIT"
+authors = [
+    "Antoine Stevan <antoine.stevan@isae-supaero.fr>",
+    "Jonathan Detchart <jonathan.detchart@isae-supaero.fr>",
+]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
@@ -16,9 +24,9 @@ rs_merkle = "1.4.1"
 thiserror = "1.0.50"
 tracing = "0.1.40"
 tracing-subscriber = "0.3.17"
-# `main.rs` dependencies
-ark-bls12-381 = "0.4.0"
-rand = "0.8.5"
+ark-poly-commit = { git = "https://gitlab.isae-supaero.fr/a.stevan/poly-commit", version = "0.4.0", rev = "19fc0d4", optional = true }
+dragoonfri = { version = "0.1.0", optional = true}
+simple-mermaid = "0.2.0"
 
 [workspace]
 members = [
@@ -27,4 +35,35 @@ members = [
 ]
 
 [dev-dependencies]
+ark-bls12-381 = "0.4.0"
+clap = { version = "4.5.17", features = ["derive"] }
 itertools = "0.13.0"
+rand = "0.8.5"
+dragoonfri-test-utils = "0.1.0"
+hex = "0.4.3"
+
+[features]
+kzg = ["dep:ark-poly-commit"]
+aplonk = ["dep:ark-poly-commit"]
+fri = ["dep:dragoonfri"]
+fs = []
+
+[package.metadata.docs.rs]
+features = ["kzg", "aplonk"]
+rustdoc-args = [ "--html-in-header", "katex.html" ]
+
+[[example]]
+name = "kzg"
+required-features = ["kzg"]
+
+[[example]]
+name = "aplonk"
+required-features = ["aplonk"]
+
+[[example]]
+name = "fri"
+required-features = ["fri"]
+
+[[example]]
+name = "fec"
+required-features = ["fri"]

LICENSE

+MIT License
+
+Copyright (c) 2024 ISAE-SUPAERO
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

-.PHONY: fmt fmt-check check clippy test example show build-examples
-
-DEFAULT_GOAL: fmt-check check clippy test
-
-fmt-check:
-	cargo fmt --all -- --check
-
-fmt:
-	cargo fmt --all
-
-check:
-	cargo check --workspace --all-targets
-
-clippy:
-	cargo clippy --workspace --all-targets -- -D warnings
-
-test:
-	cargo test --workspace --verbose
-	cargo test --examples --verbose
-	nu tests/cli.nu
-	nu tests/binary.nu
-	nu tests/color.nu
-
-example:
-	nu examples/cli.nu
-
-show:
-	rustup --version
-	rustup show --verbose
-	rustc --version
-	cargo --version
-	cargo clippy --version
-	nu --version
-
-doc:
-	cargo doc --document-private-items --no-deps --open
-
-build-examples:
-	cargo build --examples --release

README.md

 # Komodo: Cryptographically-proven Erasure Coding
 
-## Usage
-Komodo can either be used as a library or as a binary application.
+[![release](https://gitlab.isae-supaero.fr/dragoon/komodo/-/badges/release.svg)](https://gitlab.isae-supaero.fr/dragoon/komodo/-/releases)
+[![crate](https://img.shields.io/crates/v/komodo)](https://crates.io/crates/komodo)
+[![docs](https://img.shields.io/docsrs/komodo)](https://docs.rs/komodo/latest/komodo/)
+[![source](https://gitlab.isae-supaero.fr/dragoon/komodo/badges/main/pipeline.svg?key_text=GitLab%20CI)](https://gitlab.isae-supaero.fr/dragoon/komodo/-/pipelines)
+[![mirror](https://github.com/dragoon-rs/komodo/actions/workflows/ci.yml/badge.svg)](https://github.com/dragoon-rs/komodo/actions)
+
+Komodo uses a build system entirely writen in Rust.
+- [`cargo-script`](https://crates.io/crates/cargo-script) to build the script
+- [`nob.rs`](https://gitlab.isae-supaero.fr/a.stevan/nob.rs) to run commands
+- [`clap`](https://crates.io/crates/clap) to provide a nice and complete build API
+
+First, [install `cargo-script`](https://github.com/DanielKeep/cargo-script#installation).
+
+Then, run the script with `./make.rs --help`
 
 ## the library
-see `cargo doc`
+```shell
+./make.rs doc
+```
 
-## the binary application
-below is an example of how to use the binary application with Nushell:
-```bash
-./examples/cli.nu
+## the tests
+```shell
+./make.rs check
+./make.rs clippy
+./make.rs test
 ```
 
-> **Note**  
-> requires Nushell 0.93.0 or later
+Other examples that showcase the Komodo API are available in [`examples/`](examples/).
 
-tests for the binary application can also be run with
-```bash
-nu tests/cli.nu
-```
+## the benchmarks
+see [`benchmarks/`](benchmarks/README.md)
+
+the results can be found in [`dragoon/komodo-benchmark-results`](https://gitlab.isae-supaero.fr/dragoon/komodo-benchmark-results).
+
+## development
 
-## other binaries
-Komodo provides a bunch of other binaries that might be interesting of useful to use.
+Komodo uses a Docker image as the base of the GitLab pipelines.
 
-The easiest is to use the `cargo.nu` Nushell module as follows
-```bash
-use .nushell cargo "cargo bin"
-help cargo bin
+That means that there is nothing to build apart from the source code of Komodo itself when running jobs.
+
+When the development environment needs to change, e.g. when the version of Rust is bumped in
+[`rust-toolchain.toml`](./rust-toolchain.toml), one shall run the following commands to push the new
+Docker image to the [_container registry_][gitlab.isae-supaero.fr:dragoon/komodo@containers].
+
+```shell
+./make.rs container --login
+```
+```shell
+./make.rs container
+```
+```shell
+./make.rs container --push
 ```
 
-## the benchmarks
-see [the `README`](benchmarks/README.md)
+## contributors
+
+Because the code for this project has been originally extracted from
+[`dragoon/pcs-fec-id`][pcs-fec-id] by @a.stevan, some contributors might be
+missing from the Git tree.
+
+Please consult the original Git tree from [`dragoon/pcs-fec-id`][pcs-fec-id] or
+note that the following people have contributed to this code base:
+- @a.stevan
+- @j.detchart
+
+[pcs-fec-id]: https://gitlab.isae-supaero.fr/dragoon/pcs-fec-id
+[gitlab.isae-supaero.fr:dragoon/komodo@containers]: https://gitlab.isae-supaero.fr/dragoon/komodo/container_registry/42

benchmarks/.nushell/commit/plot.nu

-use ../../../.nushell math *
-use ../../../.nushell fs check-file
-use ../../../.nushell plot [ into-axis-options, COMMON_OPTIONS, gplt ]
-
-export def main [data: path, --save: path] {
-    check-file $data --span (metadata $data).span
-
-    let graphs = open $data
-        | where name !~ '^SEC'
-        | ns-to-ms $.times
-        | compute-stats $.times
-        | insert degree { get label | parse "degree {d}" | into record | get d | into int }
-        | rename --column { degree: "x", mean: "y", stddev: "e" }
-        | select name x y e
-        | group-by name --to-table
-        | reject items.name
-        | rename --column { group: "name", items: "points" }
-        | sort-by name
-
-    let options = [
-        # --title "time to create trusted setups for certain curves"
-        --x-label "degree"
-        --y-label "time (in ms)"
-        ...($graphs.points | flatten | into-axis-options -x "plain" -y "duration")
-        ...$COMMON_OPTIONS
-        (if $save != null { [ --save $save ] })
-    ]
-
-    gplt plot ($graphs | to json) ...($options | flatten | compact)
-}

benchmarks/.nushell/commit/run.nu

-export def main [
-    --output: path = "./commit.ndjson",
-    --nb-measurements: int = 10,
-    --curves: list<string>,
-]: list<int> -> nothing {
-    let input = $in
-
-    if ($input | is-empty) or ($curves | is-empty) {
-        print "nothing to do"
-        return
-    }
-
-    cargo run --release --package benchmarks --bin commit -- ...[
-        --nb-measurements $nb_measurements
-        ...$input
-        --curves ...$curves
-    ] out> $output
-
-    print $"results saved to `($output)`"
-}