refactor: Rename top-level crate to lurk

.github/BENCH_REGRESSION.md

@@ -1,9 +1,9 @@
 ---
 title: "perf: Benchmark regression detected"
-labels: debt, automated-issues
+labels: debt, automated-issue
 ---
 A performance regression has occurred for the benchmarks in `tests`.
 
 {{ env.SLOW_TESTS }}
 
-See {{ env.WORKFLOW_URL }}) for details.
+See [Workflow URL]({{ env.WORKFLOW_URL }}) for details.

.github/workflows/ci.yml

@@ -1,9 +1,7 @@
 name: Tests
 
 on:
-  push:
-    branches:
-      - main
+  merge_group:
   pull_request:
 
 concurrency:
@@ -151,9 +149,9 @@ jobs:
 
             ${{ steps.regression-check.outputs.slow-tests }}
 
-            ${{ env.WORKFLOW_URL }}
+            [Workflow URL](${{ env.WORKFLOW_URL }})
       - uses: JasonEtco/create-an-issue@v2
-        if: steps.regression-check.outputs.regression == 'true' && github.event_name == 'push'
+        if: steps.regression-check.outputs.regression == 'true' && github.event_name == 'merge_group'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           WORKFLOW_URL: ${{ env.WORKFLOW_URL }}

.github/workflows/rust-version.yml

@@ -12,39 +12,32 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@nightly
-      - name: Parse rust-toolchain.toml
-        run: echo "TOOLCHAIN_VERSION=$(rustup show | grep rustc | awk -F'[()]| ' '{ print $(NF-1) }')" | tee -a $GITHUB_ENV
-      - name: Get latest nightly Rust version
-        run: |
-          echo "RUST_VERSION=$(rustup check | grep nightly | awk -F'[()]| ' '{print $(NF-1)}')" | tee -a $GITHUB_ENV
-      - name: Compare Rust versions
-        id: compare-versions
-        run: |
-          if [[ $(printf '%s\n' "$TOOLCHAIN_VERSION" "$RUST_VERSION" | sort -V | head -n 1) != "$RUST_VERSION" ]]; then
-            echo "outdated=true" | tee -a $GITHUB_OUTPUT
-          fi
-      - name: Update Cargo.toml
-        if: steps.compare-versions.outputs.outdated == 'true'
-        run: |
-          sed -i 's/channel = .*/channel = "nightly-${{ env.RUST_VERSION }}"/' rust-toolchain.toml
+      - uses: actions/checkout@v4
+        with:
+          repository: argumentcomputer/ci-workflows
+          path: ci-workflows
+      - uses: ./ci-workflows/.github/actions/rust-version
+        id: rust-version
+        with:
+          toolchain: nightly
       - uses: tibdex/github-app-token@v2
-        if: steps.compare-versions.outputs.outdated == 'true'
+        if: steps.rust-version.outputs.outdated == 'true'
         id: generate-token
         with:
           app_id: ${{ secrets.TOKEN_APP_ID }}
           private_key: ${{ secrets.TOKEN_APP_PRIVATE_KEY }}
       # Open PR if Rust version is out of date with latest nightly
       - name: Create Pull Request
-        if: steps.compare-versions.outputs.outdated == 'true'
+        if: steps.rust-version.outputs.outdated == 'true'
         uses: peter-evans/create-pull-request@v7
         with:
           token: ${{ steps.generate-token.outputs.token }}
           branch: "ci-update-rust-version"
-          title: "chore: Update Rust version to nightly-${{ env.RUST_VERSION }}"
-          commit-message: "chore: Update Rust version to nightly-${{ env.RUST_VERSION }}"
+          title: "chore: Update Rust version to `nightly-${{ steps.rust-version.outputs.new-version }}`"
+          commit-message: "chore: Update Rust version to `nightly-${{ steps.rust-version.outputs.new-version }}`"
           labels: "automated-issue"
           reviewers: "arthurpaulino, wwared, huitseeker, samuelburnham"
           body: |
-            This is an automated PR updating the Rust version from `nightly-${{ env.TOOLCHAIN_VERSION }}` to `nightly-${{ env.RUST_VERSION }}`
+            This is an automated PR updating the Rust version from `nightly-${{ steps.rust-version.outputs.old-version }}` to `nightly-${{ steps.rust-version.outputs.new-version }}`
 
             Workflow run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
-name = "loam"
-version = "0.1.0"
+name = "lurk"
+version = "0.5.0"
 edition.workspace = true
 repository.workspace = true
 
@@ -11,7 +11,7 @@ path = "src/main.rs"
 [workspace.package]
 authors = ["Argument Engineering <[email protected]>"]
 edition = "2021"
-repository = "https://github.com/argumentcomputer/loam"
+repository = "https://github.com/argumentcomputer/lurk"
 license = "MIT"
 
 

benches/fib.rs

@@ -9,7 +9,11 @@ use sphinx_core::{
 };
 use std::time::Duration;
 
-use loam::{
+use lurk::{
+    core::{
+        eval_direct::build_lurk_toplevel_native,
+        zstore::{lurk_zstore, ZPtr},
+    },
     lair::{
         chipset::{Chipset, NoChip},
         execute::{QueryRecord, Shard},
@@ -18,10 +22,6 @@ use loam::{
         toplevel::Toplevel,
         List,
     },
-    lurk::{
-        eval_direct::build_lurk_toplevel_native,
-        zstore::{lurk_zstore, ZPtr},
-    },
 };
 
 const DEFAULT_FIB_ARG: usize = 100000;

benches/lcs.rs

@@ -9,7 +9,11 @@ use sphinx_core::{
 };
 use std::time::Duration;
 
-use loam::{
+use lurk::{
+    core::{
+        eval_direct::build_lurk_toplevel_native,
+        zstore::{lurk_zstore, ZPtr},
+    },
     lair::{
         chipset::{Chipset, NoChip},
         execute::{QueryRecord, Shard},
@@ -18,10 +22,6 @@ use loam::{
         toplevel::Toplevel,
         List,
     },
-    lurk::{
-        eval_direct::build_lurk_toplevel_native,
-        zstore::{lurk_zstore, ZPtr},
-    },
 };
 
 fn get_lcs_args() -> (&'static str, &'static str) {

benches/lurk.rs

@@ -1,7 +1,7 @@
 use criterion::{criterion_group, criterion_main, Criterion};
 use std::time::Duration;
 
-use loam::lurk::eval_direct::build_lurk_toplevel_native;
+use lurk::core::eval_direct::build_lurk_toplevel_native;
 
 fn toplevel(c: &mut Criterion) {
     c.bench_function("toplevel", |b| {

benches/sum.rs

@@ -9,7 +9,11 @@ use sphinx_core::{
 };
 use std::time::Duration;
 
-use loam::{
+use lurk::{
+    core::{
+        eval_direct::build_lurk_toplevel_native,
+        zstore::{lurk_zstore, ZPtr},
+    },
     lair::{
         chipset::{Chipset, NoChip},
         execute::{QueryRecord, Shard},
@@ -18,10 +22,6 @@ use loam::{
         toplevel::Toplevel,
         List,
     },
-    lurk::{
-        eval_direct::build_lurk_toplevel_native,
-        zstore::{lurk_zstore, ZPtr},
-    },
 };
 
 const DEFAULT_SUM_ARG: usize = 100000;

examples/byte_lookup/Cargo.toml

@@ -6,7 +6,7 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-loam = { path = "../.." }
+lurk = { path = "../.." }
 p3-air = { workspace = true }
 p3-baby-bear = { workspace = true }
 p3-field = { workspace = true }
@@ -15,4 +15,4 @@ p3-maybe-rayon = { workspace = true }
 sphinx-core = { workspace = true }
 sphinx-derive = { workspace = true }
 rand =  { workspace = true }
-rand_chacha =  { workspace = true }
+rand_chacha =  { workspace = true }

examples/byte_lookup/src/main.rs

@@ -2,8 +2,8 @@
 pub mod memoset;
 
 use crate::memoset::DemoChip;
-use loam::air::builder::{LookupBuilder, ProvideRecord, RequireRecord};
-use loam::air::debug::{debug_constraints_collecting_queries, TraceQueries};
+use lurk::air::builder::{LookupBuilder, ProvideRecord, RequireRecord};
+use lurk::air::debug::{debug_constraints_collecting_queries, TraceQueries};
 use p3_air::{Air, AirBuilder, BaseAir, PairBuilder};
 use p3_baby_bear::BabyBear;
 use p3_field::{AbstractField, Field, PrimeField32};

examples/byte_lookup/src/memoset.rs

@@ -1,4 +1,4 @@
-use loam::air::builder::{LookupBuilder, ProvideRecord, RequireRecord};
+use lurk::air::builder::{LookupBuilder, ProvideRecord, RequireRecord};
 use p3_air::{Air, AirBuilder, BaseAir};
 use p3_field::{AbstractField, Field, PrimeField32};
 use p3_matrix::dense::RowMajorMatrix;

rust-toolchain.toml

@@ -1,4 +1,4 @@
 [toolchain]
 # The default profile includes rustc, rust-std, cargo, rust-docs, rustfmt and clippy.
 profile = "default"
-channel = "nightly-2024-08-13"
+channel = "nightly-2024-11-04"

src/air/debug.rs

@@ -215,13 +215,13 @@ pub struct DebugConstraintBuilder<'a, F> {
     queries: &'a mut TraceQueries<F>,
 }
 
-impl<'a, F: PrimeField32> PairBuilder for DebugConstraintBuilder<'a, F> {
+impl<F: PrimeField32> PairBuilder for DebugConstraintBuilder<'_, F> {
     fn preprocessed(&self) -> Self::M {
         self.preprocessed
     }
 }
 
-impl<'a, F: PrimeField32> LookupBuilder for DebugConstraintBuilder<'a, F> {
+impl<F: PrimeField32> LookupBuilder for DebugConstraintBuilder<'_, F> {
     fn receive(
         &mut self,
         relation: impl Relation<Self::Expr>,
@@ -318,7 +318,7 @@ impl<'a, F: PrimeField32> AirBuilderWithPublicValues for DebugConstraintBuilder<
     }
 }
 
-impl<'a, F: PrimeField32> LairBuilder for DebugConstraintBuilder<'a, F> {}
+impl<F: PrimeField32> LairBuilder for DebugConstraintBuilder<'_, F> {}
 
 impl<'a, F: PrimeField32> DebugConstraintBuilder<'a, F> {
     #[inline]

src/lurk/big_num.rs → src/core/big_num.rs

@@ -115,14 +115,14 @@ mod test {
 
     use crate::{
         air::debug::debug_chip_constraints_and_queries_with_sharding,
+        core::chipset::lurk_chip_map_native,
         func,
         lair::{
             execute::{QueryRecord, Shard},
             func_chip::FuncChip,
             lair_chip::{build_chip_vector, build_lair_chip_vector, LairMachineProgram},
             toplevel::Toplevel,
         },
-        lurk::chipset::lurk_chip_map_native,
     };
 
     #[test]

src/lurk/chipset.rs → src/core/chipset.rs

@@ -12,7 +12,7 @@ use crate::{
     poseidon::config::{BabyBearConfig24, BabyBearConfig32, BabyBearConfig40},
 };
 
-use crate::lurk::poseidon::PoseidonChipset;
+use crate::core::poseidon::PoseidonChipset;
 
 use super::{big_num::BigNum, u64::U64, zstore::Hasher};
 

src/lurk/cli/comm_data.rs → src/core/cli/comm_data.rs

@@ -3,11 +3,11 @@ use serde::{Deserialize, Serialize};
 use std::hash::Hash;
 
 use crate::{
-    lair::chipset::Chipset,
-    lurk::{
+    core::{
         tag::Tag,
         zstore::{ZPtr, ZStore, DIGEST_SIZE, HASH3_SIZE},
     },
+    lair::chipset::Chipset,
 };
 
 use super::zdag::ZDag;