ci: update version string in docs

refactor: pregen mv-lookup blinds (#900 )
chore: version mismatch warnings for artifacts (#899 )
2026-01-13 00:08:12 -05:00 · 2025-01-08 17:19:07 +00:00 · 2025-01-08 17:18:46 +00:00 · 2025-01-06 16:01:34 +00:00 · 2025-01-06 15:49:47 +00:00
11 changed files with 511 additions and 464 deletions
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -2377,7 +2377,7 @@ dependencies = [
 [[package]]
 name = "halo2_gadgets"
 version = "0.2.0"
-source = "git+https://github.com/zkonduit/halo2#0654e92bdf725fd44d849bfef3643870a8c7d50b"
+source = "git+https://github.com/zkonduit/halo2#d7ecad83c7439fa1cb450ee4a89c2d0b45604ceb"
 dependencies = [
 "arrayvec 0.7.4",
 "bitvec",
@@ -2394,7 +2394,7 @@ dependencies = [
 [[package]]
 name = "halo2_proofs"
 version = "0.3.0"
-source = "git+https://github.com/zkonduit/halo2#0654e92bdf725fd44d849bfef3643870a8c7d50b#0654e92bdf725fd44d849bfef3643870a8c7d50b"
+source = "git+https://github.com/zkonduit/halo2#ee4e1a09ebdb1f79f797685b78951c6034c430a6#ee4e1a09ebdb1f79f797685b78951c6034c430a6"
 dependencies = [
 "bincode",
 "blake2b_simd",
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -280,7 +280,10 @@ no-update = []


 [patch.'https://github.com/zkonduit/halo2']
-halo2_proofs = { git = "https://github.com/zkonduit/halo2#0654e92bdf725fd44d849bfef3643870a8c7d50b", package = "halo2_proofs" }
+halo2_proofs = { git = "https://github.com/zkonduit/halo2#ee4e1a09ebdb1f79f797685b78951c6034c430a6", package = "halo2_proofs" }
+
+[patch.'https://github.com/zkonduit/halo2#0654e92bdf725fd44d849bfef3643870a8c7d50b']
+halo2_proofs = { git = "https://github.com/zkonduit/halo2#ee4e1a09ebdb1f79f797685b78951c6034c430a6", package = "halo2_proofs" }

 [patch.crates-io]
 uniffi_testing = { git = "https://github.com/ElusAegis/uniffi-rs", branch = "feat/testing-feature-build-fix" }
--- a/docs/python/src/conf.py
+++ b/docs/python/src/conf.py
@@ -1,7 +1,7 @@
 import ezkl

 project = 'ezkl'
-release = '0.0.0'
+release = '17.0.1'
 version = release


--- a/examples/notebooks/felt_conversion_test.ipynb
+++ b/examples/notebooks/felt_conversion_test.ipynb
@@ -2,7 +2,7 @@
 "cells": [
  {
   "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
   "metadata": {},
   "outputs": [
    {
@@ -54,7 +54,7 @@
    "    gip_run_args.param_scale = 19\n",
    "    gip_run_args.logrows = 8\n",
    "    run_args = ezkl.gen_settings(py_run_args=gip_run_args)\n",
-    "    ezkl.get_srs(commitment=ezkl.PyCommitments.KZG)\n",
+    "    await ezkl.get_srs(commitment=ezkl.PyCommitments.KZG)\n",
    "    ezkl.compile_circuit()\n",
    "    res = await ezkl.gen_witness()\n",
    "    print(res)\n",
--- a/examples/notebooks/mean_postgres.ipynb
+++ b/examples/notebooks/mean_postgres.ipynb
@@ -1,456 +1,459 @@
 {
-  "cells": [
-    {
-      "cell_type": "markdown",
-      "metadata": {},
-      "source": [
-        "## Mean of ERC20 transfer amounts\n",
-        "\n",
-        "This notebook shows how to calculate the mean of ERC20 transfer amounts, pulling data in from a Postgres database. First we install and get the necessary libraries running. \n",
-        "The first of which is [shovel](https://indexsupply.com/shovel/docs/#getting-started), which is a library that allows us to pull data from the Ethereum blockchain into a Postgres database.\n",
-        "\n",
-        "Make sure you install postgres if needed https://indexsupply.com/shovel/docs/#getting-started. \n",
-        "\n"
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": null,
-      "metadata": {},
-      "outputs": [],
-      "source": [
-        "import os\n",
-        "import getpass\n",
-        "import json\n",
-        "import time\n",
-        "import subprocess\n",
-        "\n",
-        "# swap out for the relevant linux/amd64, darwin/arm64, darwin/amd64, windows/amd64\n",
-        "os.system(\"curl -LO https://indexsupply.net/bin/1.0/linux/amd64/shovel\")\n",
-        "os.system(\"chmod +x shovel\")\n",
-        "\n",
-        "\n",
-        "os.environ[\"PG_URL\"] = \"postgres://\" + getpass.getuser() + \":@localhost:5432/shovel\"\n",
-        "\n",
-        "# create a config.json file with the following contents\n",
-        "config = {\n",
-        "  \"pg_url\": \"$PG_URL\",\n",
-        "  \"eth_sources\": [\n",
-        "    {\"name\": \"mainnet\", \"chain_id\": 1, \"url\": \"https://ethereum-rpc.publicnode.com\"},\n",
-        "    {\"name\": \"base\", \"chain_id\": 8453, \"url\": \"https://base-rpc.publicnode.com\"}\n",
-        "  ],\n",
-        "  \"integrations\": [{\n",
-        "    \"name\": \"usdc_transfer\",\n",
-        "    \"enabled\": True,\n",
-        "    \"sources\": [{\"name\": \"mainnet\"}, {\"name\": \"base\"}],\n",
-        "    \"table\": {\n",
-        "      \"name\": \"usdc\",\n",
-        "      \"columns\": [\n",
-        "        {\"name\": \"log_addr\",  \"type\": \"bytea\"},\n",
-        "        {\"name\": \"block_num\", \"type\": \"numeric\"},\n",
-        "        {\"name\": \"f\",         \"type\": \"bytea\"},\n",
-        "        {\"name\": \"t\",         \"type\": \"bytea\"},\n",
-        "        {\"name\": \"v\",         \"type\": \"numeric\"}\n",
-        "      ]\n",
-        "    },\n",
-        "    \"block\": [\n",
-        "      {\"name\": \"block_num\", \"column\": \"block_num\"},\n",
-        "      {\n",
-        "        \"name\": \"log_addr\",\n",
-        "        \"column\": \"log_addr\",\n",
-        "        \"filter_op\": \"contains\",\n",
-        "        \"filter_arg\": [\n",
-        "          \"a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48\",\n",
-        "          \"833589fCD6eDb6E08f4c7C32D4f71b54bdA02913\"\n",
-        "        ]\n",
-        "      }\n",
-        "    ],\n",
-        "    \"event\": {\n",
-        "      \"name\": \"Transfer\",\n",
-        "      \"type\": \"event\",\n",
-        "      \"anonymous\": False,\n",
-        "      \"inputs\": [\n",
-        "        {\"indexed\": True,  \"name\": \"from\",  \"type\": \"address\", \"column\": \"f\"},\n",
-        "        {\"indexed\": True,  \"name\": \"to\",    \"type\": \"address\", \"column\": \"t\"},\n",
-        "        {\"indexed\": False, \"name\": \"value\", \"type\": \"uint256\", \"column\": \"v\"}\n",
-        "      ]\n",
-        "    }\n",
-        "  }]\n",
-        "}\n",
-        "\n",
-        "# write the config to a file\n",
-        "with open(\"config.json\", \"w\") as f:\n",
-        "  f.write(json.dumps(config))\n",
-        "\n",
-        "\n",
-        "# print the two env variables\n",
-        "os.system(\"echo $PG_URL\")\n",
-        "\n",
-        "os.system(\"createdb -h localhost -p 5432 shovel\")\n",
-        "\n",
-        "os.system(\"echo shovel is now installed. starting:\")\n",
-        "\n",
-        "command = [\"./shovel\", \"-config\", \"config.json\"]\n",
-        "proc = subprocess.Popen(command)\n",
-        "\n",
-        "os.system(\"echo shovel started.\")\n",
-        "\n",
-        "time.sleep(10)\n",
-        "\n",
-        "# after we've fetched some data -- kill the process\n",
-        "proc.terminate()\n",
-        "\n"
-      ]
-    },
-    {
-      "cell_type": "markdown",
-      "metadata": {
-        "id": "2wIAHwqH2_mo"
-      },
-      "source": [
-        "**Import Dependencies**"
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": null,
-      "metadata": {
-        "id": "9Byiv2Nc2MsK"
-      },
-      "outputs": [],
-      "source": [
-        "# check if notebook is in colab\n",
-        "try:\n",
-        "    # install ezkl\n",
-        "    import google.colab\n",
-        "    import subprocess\n",
-        "    import sys\n",
-        "    subprocess.check_call([sys.executable, \"-m\", \"pip\", \"install\", \"ezkl\"])\n",
-        "    subprocess.check_call([sys.executable, \"-m\", \"pip\", \"install\", \"onnx\"])\n",
-        "\n",
-        "# rely on local installation of ezkl if the notebook is not in colab\n",
-        "except:\n",
-        "    pass\n",
-        "\n",
-        "import ezkl\n",
-        "import torch\n",
-        "import datetime\n",
-        "import pandas as pd\n",
-        "import requests\n",
-        "import json\n",
-        "import os\n",
-        "\n",
-        "import logging\n",
-        "# # uncomment for more descriptive logging \n",
-        "FORMAT = '%(levelname)s %(name)s %(asctime)-15s %(filename)s:%(lineno)d %(message)s'\n",
-        "logging.basicConfig(format=FORMAT)\n",
-        "logging.getLogger().setLevel(logging.DEBUG)\n",
-        "\n",
-        "print(\"ezkl version: \", ezkl.__version__)"
-      ]
-    },
-    {
-      "cell_type": "markdown",
-      "metadata": {
-        "id": "osjj-0Ta3E8O"
-      },
-      "source": [
-        "**Create Computational Graph**"
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": null,
-      "metadata": {
-        "colab": {
-          "base_uri": "https://localhost:8080/"
-        },
-        "id": "x1vl9ZXF3EEW",
-        "outputId": "bda21d02-fe5f-4fb2-8106-f51a8e2e67aa"
-      },
-      "outputs": [],
-      "source": [
-        "from torch import nn\n",
-        "import torch\n",
-        "\n",
-        "\n",
-        "class Model(nn.Module):\n",
-        "    def __init__(self):\n",
-        "        super(Model, self).__init__()\n",
-        "\n",
-        "    # x is a time series \n",
-        "    def forward(self, x):\n",
-        "        return [torch.mean(x)]\n",
-        "\n",
-        "\n",
-        "\n",
-        "\n",
-        "circuit = Model()\n",
-        "\n",
-        "\n",
-        "\n",
-        "\n",
-        "x = 0.1*torch.rand(1,*[1,5], requires_grad=True)\n",
-        "\n",
-        "# # print(torch.__version__)\n",
-        "device = torch.device(\"cuda:0\" if torch.cuda.is_available() else \"cpu\")\n",
-        "\n",
-        "print(device)\n",
-        "\n",
-        "circuit.to(device)\n",
-        "\n",
-        "# Flips the neural net into inference mode\n",
-        "circuit.eval()\n",
-        "\n",
-        "# Export the model\n",
-        "torch.onnx.export(circuit,               # model being run\n",
-        "                      x,                   # model input (or a tuple for multiple inputs)\n",
-        "                      \"lol.onnx\",            # where to save the model (can be a file or file-like object)\n",
-        "                      export_params=True,        # store the trained parameter weights inside the model file\n",
-        "                      opset_version=11,          # the ONNX version to export the model to\n",
-        "                      do_constant_folding=True,  # whether to execute constant folding for optimization\n",
-        "                      input_names = ['input'],   # the model's input names\n",
-        "                      output_names = ['output'], # the model's output names\n",
-        "                      dynamic_axes={'input' : {0 : 'batch_size'},    # variable length axes\n",
-        "                                    'output' : {0 : 'batch_size'}})\n",
-        "\n",
-        "# export(circuit, input_shape=[1, 20])\n",
-        "\n"
-      ]
-    },
-    {
-      "cell_type": "markdown",
-      "metadata": {
-        "id": "E3qCeX-X5xqd"
-      },
-      "source": [
-        "**Set Data Source and Get Data**"
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": null,
-      "metadata": {
-        "colab": {
-          "base_uri": "https://localhost:8080/"
-        },
-        "id": "6RAMplxk5xPk",
-        "outputId": "bd2158fe-0c00-44fd-e632-6a3f70cdb7c9"
-      },
-      "outputs": [],
-      "source": [
-        "import getpass\n",
-        "# make an input.json file from the df above\n",
-        "input_filename = os.path.join('input.json')\n",
-        "\n",
-        "pg_input_file = dict(input_data = {\n",
-        "  \"host\": \"localhost\",\n",
-        "  # make sure you replace this with your own username\n",
-        "  \"user\": getpass.getuser(),\n",
-        "  \"dbname\": \"shovel\",\n",
-        "  \"password\": \"\",\n",
-        "  \"query\": \"SELECT v FROM usdc ORDER BY block_num DESC LIMIT 5\",\n",
-        "  \"port\": \"5432\",\n",
-        "})\n",
-        "\n",
-        "json_formatted_str = json.dumps(pg_input_file, indent=2)\n",
-        "print(json_formatted_str)\n",
-        "\n",
-        "\n",
-        "    # Serialize data into file:\n",
-        "json.dump(pg_input_file, open(input_filename, 'w' ))\n"
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": null,
-      "metadata": {},
-      "outputs": [],
-      "source": [
-        "# this corresponds to 4 batches\n",
-        "calibration_filename = os.path.join('calibration.json')\n",
-        "\n",
-        "pg_cal_file = dict(input_data = {\n",
-        "  \"host\": \"localhost\",\n",
-        "  # make sure you replace this with your own username\n",
-        "  \"user\": getpass.getuser(),\n",
-        "  \"dbname\": \"shovel\",\n",
-        "  \"password\": \"\",\n",
-        "  \"query\": \"SELECT v FROM usdc ORDER BY block_num DESC LIMIT 20\",\n",
-        "  \"port\": \"5432\",\n",
-        "})\n",
-        "\n",
-        "    # Serialize data into file:\n",
-        "json.dump( pg_cal_file, open(calibration_filename, 'w' ))"
-      ]
-    },
-    {
-      "cell_type": "markdown",
-      "metadata": {
-        "id": "eLJ7oirQ_HQR"
-      },
-      "source": [
-        "**EZKL Workflow**"
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": null,
-      "metadata": {
-        "id": "rNw0C9QL6W88"
-      },
-      "outputs": [],
-      "source": [
-        "import subprocess\n",
-        "import os\n",
-        "\n",
-        "onnx_filename = os.path.join('lol.onnx')\n",
-        "compiled_filename = os.path.join('lol.compiled')\n",
-        "settings_filename = os.path.join('settings.json')\n",
-        "\n",
-        "# Generate settings using ezkl\n",
-        "res = ezkl.gen_settings(onnx_filename, settings_filename)\n",
-        "\n",
-        "assert res == True\n",
-        "\n",
-        "res = await ezkl.calibrate_settings(input_filename, onnx_filename, settings_filename, \"resources\")\n",
-        "\n",
-        "assert res == True"
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": null,
-      "metadata": {},
-      "outputs": [],
-      "source": [
-        "\n",
-        "ezkl.compile_circuit(onnx_filename, compiled_filename, settings_filename)"
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": null,
-      "metadata": {
-        "colab": {
-          "base_uri": "https://localhost:8080/"
-        },
-        "id": "4MmE9SX66_Il",
-        "outputId": "16403639-66a4-4280-ac7f-6966b75de5a3"
-      },
-      "outputs": [],
-      "source": [
-        "# generate settings\n",
-        "\n",
-        "\n",
-        "# show the settings.json\n",
-        "with open(\"settings.json\") as f:\n",
-        "  data = json.load(f)\n",
-        "  json_formatted_str = json.dumps(data, indent=2)\n",
-        "\n",
-        "  print(json_formatted_str)\n",
-        "\n",
-        "assert os.path.exists(\"settings.json\")\n",
-        "assert os.path.exists(\"input.json\")\n",
-        "assert os.path.exists(\"lol.onnx\")"
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": null,
-      "metadata": {
-        "id": "fULvvnK7_CMb"
-      },
-      "outputs": [],
-      "source": [
-        "pk_path = os.path.join('test.pk')\n",
-        "vk_path = os.path.join('test.vk')\n",
-        "\n",
-        "\n",
-        "# setup the proof\n",
-        "res = ezkl.setup(\n",
-        "        compiled_filename,\n",
-        "        vk_path,\n",
-        "        pk_path\n",
-        "    )\n",
-        "\n",
-        "assert res == True\n",
-        "assert os.path.isfile(vk_path)\n",
-        "assert os.path.isfile(pk_path)\n",
-        "assert os.path.isfile(settings_filename)\n",
-        "\n"
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": null,
-      "metadata": {},
-      "outputs": [],
-      "source": [
-        "witness_path = \"witness.json\"\n",
-        "\n",
-        "# generate the witness\n",
-        "res = await ezkl.gen_witness(\n",
-        "        input_filename,\n",
-        "        compiled_filename,\n",
-        "        witness_path\n",
-        "    )\n"
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": null,
-      "metadata": {
-        "colab": {
-          "base_uri": "https://localhost:8080/"
-        },
-        "id": "Oog3j6Kd-Wed",
-        "outputId": "5839d0c1-5b43-476e-c2f8-6707de562260"
-      },
-      "outputs": [],
-      "source": [
-        "# prove the zk circuit\n",
-        "# GENERATE A PROOF\n",
-        "proof_path = os.path.join('test.pf')\n",
-        "\n",
-        "\n",
-        "proof = ezkl.prove(\n",
-        "        witness_path,\n",
-        "        compiled_filename,\n",
-        "        pk_path,\n",
-        "        proof_path,\n",
-        "        \"single\"\n",
-        "    )\n",
-        "\n",
-        "\n",
-        "print(\"proved\")\n",
-        "\n",
-        "assert os.path.isfile(proof_path)\n",
-        "\n"
-      ]
-    }
-  ],
-  "metadata": {
-    "colab": {
-      "provenance": []
-    },
-    "kernelspec": {
-      "display_name": "Python 3",
-      "name": "python3"
-    },
-    "language_info": {
-      "codemirror_mode": {
-        "name": "ipython",
-        "version": 3
-      },
-      "file_extension": ".py",
-      "mimetype": "text/x-python",
-      "name": "python",
-      "nbconvert_exporter": "python",
-      "pygments_lexer": "ipython3",
-      "version": "3.12.2"
-    }
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Mean of ERC20 transfer amounts\n",
+    "\n",
+    "This notebook shows how to calculate the mean of ERC20 transfer amounts, pulling data in from a Postgres database. First we install and get the necessary libraries running. \n",
+    "The first of which is [shovel](https://indexsupply.com/shovel/docs/#getting-started), which is a library that allows us to pull data from the Ethereum blockchain into a Postgres database.\n",
+    "\n",
+    "Make sure you install postgres if needed https://indexsupply.com/shovel/docs/#getting-started. \n",
+    "\n"
+   ]
  },
-  "nbformat": 4,
-  "nbformat_minor": 0
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "import getpass\n",
+    "import json\n",
+    "import time\n",
+    "import subprocess\n",
+    "\n",
+    "# swap out for the relevant linux/amd64, darwin/arm64, darwin/amd64, windows/amd64\n",
+    "os.system(\"curl -LO https://indexsupply.net/bin/1.0/linux/amd64/shovel\")\n",
+    "os.system(\"chmod +x shovel\")\n",
+    "\n",
+    "\n",
+    "os.environ[\"PG_URL\"] = \"postgres://\" + getpass.getuser() + \":@localhost:5432/shovel\"\n",
+    "\n",
+    "# create a config.json file with the following contents\n",
+    "config = {\n",
+    "  \"pg_url\": \"$PG_URL\",\n",
+    "  \"eth_sources\": [\n",
+    "    {\"name\": \"mainnet\", \"chain_id\": 1, \"url\": \"https://ethereum-rpc.publicnode.com\"},\n",
+    "    {\"name\": \"base\", \"chain_id\": 8453, \"url\": \"https://base-rpc.publicnode.com\"}\n",
+    "  ],\n",
+    "  \"integrations\": [{\n",
+    "    \"name\": \"usdc_transfer\",\n",
+    "    \"enabled\": True,\n",
+    "    \"sources\": [{\"name\": \"mainnet\"}, {\"name\": \"base\"}],\n",
+    "    \"table\": {\n",
+    "      \"name\": \"usdc\",\n",
+    "      \"columns\": [\n",
+    "        {\"name\": \"log_addr\",  \"type\": \"bytea\"},\n",
+    "        {\"name\": \"block_num\", \"type\": \"numeric\"},\n",
+    "        {\"name\": \"f\",         \"type\": \"bytea\"},\n",
+    "        {\"name\": \"t\",         \"type\": \"bytea\"},\n",
+    "        {\"name\": \"v\",         \"type\": \"numeric\"}\n",
+    "      ]\n",
+    "    },\n",
+    "    \"block\": [\n",
+    "      {\"name\": \"block_num\", \"column\": \"block_num\"},\n",
+    "      {\n",
+    "        \"name\": \"log_addr\",\n",
+    "        \"column\": \"log_addr\",\n",
+    "        \"filter_op\": \"contains\",\n",
+    "        \"filter_arg\": [\n",
+    "          \"a0b86991c6218b36c1d19d4a2e9eb0ce3606eb48\",\n",
+    "          \"833589fCD6eDb6E08f4c7C32D4f71b54bdA02913\"\n",
+    "        ]\n",
+    "      }\n",
+    "    ],\n",
+    "    \"event\": {\n",
+    "      \"name\": \"Transfer\",\n",
+    "      \"type\": \"event\",\n",
+    "      \"anonymous\": False,\n",
+    "      \"inputs\": [\n",
+    "        {\"indexed\": True,  \"name\": \"from\",  \"type\": \"address\", \"column\": \"f\"},\n",
+    "        {\"indexed\": True,  \"name\": \"to\",    \"type\": \"address\", \"column\": \"t\"},\n",
+    "        {\"indexed\": False, \"name\": \"value\", \"type\": \"uint256\", \"column\": \"v\"}\n",
+    "      ]\n",
+    "    }\n",
+    "  }]\n",
+    "}\n",
+    "\n",
+    "# write the config to a file\n",
+    "with open(\"config.json\", \"w\") as f:\n",
+    "  f.write(json.dumps(config))\n",
+    "\n",
+    "\n",
+    "# print the two env variables\n",
+    "os.system(\"echo $PG_URL\")\n",
+    "\n",
+    "os.system(\"createdb -h localhost -p 5432 shovel\")\n",
+    "\n",
+    "os.system(\"echo shovel is now installed. starting:\")\n",
+    "\n",
+    "command = [\"./shovel\", \"-config\", \"config.json\"]\n",
+    "proc = subprocess.Popen(command)\n",
+    "\n",
+    "os.system(\"echo shovel started.\")\n",
+    "\n",
+    "time.sleep(10)\n",
+    "\n",
+    "# after we've fetched some data -- kill the process\n",
+    "proc.terminate()\n",
+    "\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "id": "2wIAHwqH2_mo"
+   },
+   "source": [
+    "**Import Dependencies**"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "id": "9Byiv2Nc2MsK"
+   },
+   "outputs": [],
+   "source": [
+    "# check if notebook is in colab\n",
+    "try:\n",
+    "    # install ezkl\n",
+    "    import google.colab\n",
+    "    import subprocess\n",
+    "    import sys\n",
+    "    subprocess.check_call([sys.executable, \"-m\", \"pip\", \"install\", \"ezkl\"])\n",
+    "    subprocess.check_call([sys.executable, \"-m\", \"pip\", \"install\", \"onnx\"])\n",
+    "\n",
+    "# rely on local installation of ezkl if the notebook is not in colab\n",
+    "except:\n",
+    "    pass\n",
+    "\n",
+    "import ezkl\n",
+    "import torch\n",
+    "import datetime\n",
+    "import pandas as pd\n",
+    "import requests\n",
+    "import json\n",
+    "import os\n",
+    "\n",
+    "import logging\n",
+    "# # uncomment for more descriptive logging \n",
+    "FORMAT = '%(levelname)s %(name)s %(asctime)-15s %(filename)s:%(lineno)d %(message)s'\n",
+    "logging.basicConfig(format=FORMAT)\n",
+    "logging.getLogger().setLevel(logging.DEBUG)\n",
+    "\n",
+    "print(\"ezkl version: \", ezkl.__version__)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "id": "osjj-0Ta3E8O"
+   },
+   "source": [
+    "**Create Computational Graph**"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "colab": {
+     "base_uri": "https://localhost:8080/"
+    },
+    "id": "x1vl9ZXF3EEW",
+    "outputId": "bda21d02-fe5f-4fb2-8106-f51a8e2e67aa"
+   },
+   "outputs": [],
+   "source": [
+    "from torch import nn\n",
+    "import torch\n",
+    "\n",
+    "\n",
+    "class Model(nn.Module):\n",
+    "    def __init__(self):\n",
+    "        super(Model, self).__init__()\n",
+    "\n",
+    "    # x is a time series \n",
+    "    def forward(self, x):\n",
+    "        return [torch.mean(x)]\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "circuit = Model()\n",
+    "\n",
+    "\n",
+    "\n",
+    "\n",
+    "x = 0.1*torch.rand(1,*[1,5], requires_grad=True)\n",
+    "\n",
+    "# # print(torch.__version__)\n",
+    "device = torch.device(\"cuda:0\" if torch.cuda.is_available() else \"cpu\")\n",
+    "\n",
+    "print(device)\n",
+    "\n",
+    "circuit.to(device)\n",
+    "\n",
+    "# Flips the neural net into inference mode\n",
+    "circuit.eval()\n",
+    "\n",
+    "# Export the model\n",
+    "torch.onnx.export(circuit,               # model being run\n",
+    "                      x,                   # model input (or a tuple for multiple inputs)\n",
+    "                      \"lol.onnx\",            # where to save the model (can be a file or file-like object)\n",
+    "                      export_params=True,        # store the trained parameter weights inside the model file\n",
+    "                      opset_version=11,          # the ONNX version to export the model to\n",
+    "                      do_constant_folding=True,  # whether to execute constant folding for optimization\n",
+    "                      input_names = ['input'],   # the model's input names\n",
+    "                      output_names = ['output'], # the model's output names\n",
+    "                      dynamic_axes={'input' : {0 : 'batch_size'},    # variable length axes\n",
+    "                                    'output' : {0 : 'batch_size'}})\n",
+    "\n",
+    "# export(circuit, input_shape=[1, 20])\n",
+    "\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "id": "E3qCeX-X5xqd"
+   },
+   "source": [
+    "**Set Data Source and Get Data**"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "colab": {
+     "base_uri": "https://localhost:8080/"
+    },
+    "id": "6RAMplxk5xPk",
+    "outputId": "bd2158fe-0c00-44fd-e632-6a3f70cdb7c9"
+   },
+   "outputs": [],
+   "source": [
+    "import getpass\n",
+    "# make an input.json file from the df above\n",
+    "input_filename = os.path.join('input.json')\n",
+    "\n",
+    "pg_input_file = dict(input_data = {\n",
+    "  \"host\": \"localhost\",\n",
+    "  # make sure you replace this with your own username\n",
+    "  \"user\": getpass.getuser(),\n",
+    "  \"dbname\": \"shovel\",\n",
+    "  \"password\": \"\",\n",
+    "  \"query\": \"SELECT v FROM usdc ORDER BY block_num DESC LIMIT 5\",\n",
+    "  \"port\": \"5432\",\n",
+    "})\n",
+    "\n",
+    "json_formatted_str = json.dumps(pg_input_file, indent=2)\n",
+    "print(json_formatted_str)\n",
+    "\n",
+    "\n",
+    "    # Serialize data into file:\n",
+    "json.dump(pg_input_file, open(input_filename, 'w' ))\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# this corresponds to 4 batches\n",
+    "calibration_filename = os.path.join('calibration.json')\n",
+    "\n",
+    "pg_cal_file = dict(input_data = {\n",
+    "  \"host\": \"localhost\",\n",
+    "  # make sure you replace this with your own username\n",
+    "  \"user\": getpass.getuser(),\n",
+    "  \"dbname\": \"shovel\",\n",
+    "  \"password\": \"\",\n",
+    "  \"query\": \"SELECT v FROM usdc ORDER BY block_num DESC LIMIT 20\",\n",
+    "  \"port\": \"5432\",\n",
+    "})\n",
+    "\n",
+    "    # Serialize data into file:\n",
+    "json.dump( pg_cal_file, open(calibration_filename, 'w' ))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "id": "eLJ7oirQ_HQR"
+   },
+   "source": [
+    "**EZKL Workflow**"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "id": "rNw0C9QL6W88"
+   },
+   "outputs": [],
+   "source": [
+    "import subprocess\n",
+    "import os\n",
+    "\n",
+    "onnx_filename = os.path.join('lol.onnx')\n",
+    "compiled_filename = os.path.join('lol.compiled')\n",
+    "settings_filename = os.path.join('settings.json')\n",
+    "\n",
+    "# Generate settings using ezkl\n",
+    "res = ezkl.gen_settings(onnx_filename, settings_filename)\n",
+    "\n",
+    "assert res == True\n",
+    "\n",
+    "res = await ezkl.calibrate_settings(input_filename, onnx_filename, settings_filename, \"resources\")\n",
+    "\n",
+    "assert res == True\n",
+    "\n",
+    "await ezkl.get_srs(settings_filename)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "\n",
+    "ezkl.compile_circuit(onnx_filename, compiled_filename, settings_filename)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "colab": {
+     "base_uri": "https://localhost:8080/"
+    },
+    "id": "4MmE9SX66_Il",
+    "outputId": "16403639-66a4-4280-ac7f-6966b75de5a3"
+   },
+   "outputs": [],
+   "source": [
+    "# generate settings\n",
+    "\n",
+    "\n",
+    "# show the settings.json\n",
+    "with open(\"settings.json\") as f:\n",
+    "  data = json.load(f)\n",
+    "  json_formatted_str = json.dumps(data, indent=2)\n",
+    "\n",
+    "  print(json_formatted_str)\n",
+    "\n",
+    "assert os.path.exists(\"settings.json\")\n",
+    "assert os.path.exists(\"input.json\")\n",
+    "assert os.path.exists(\"lol.onnx\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "id": "fULvvnK7_CMb"
+   },
+   "outputs": [],
+   "source": [
+    "pk_path = os.path.join('test.pk')\n",
+    "vk_path = os.path.join('test.vk')\n",
+    "\n",
+    "\n",
+    "# setup the proof\n",
+    "res = ezkl.setup(\n",
+    "        compiled_filename,\n",
+    "        vk_path,\n",
+    "        pk_path\n",
+    "    )\n",
+    "\n",
+    "assert res == True\n",
+    "assert os.path.isfile(vk_path)\n",
+    "assert os.path.isfile(pk_path)\n",
+    "assert os.path.isfile(settings_filename)\n",
+    "\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "witness_path = \"witness.json\"\n",
+    "\n",
+    "# generate the witness\n",
+    "res = await ezkl.gen_witness(\n",
+    "        input_filename,\n",
+    "        compiled_filename,\n",
+    "        witness_path\n",
+    "    )\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "colab": {
+     "base_uri": "https://localhost:8080/"
+    },
+    "id": "Oog3j6Kd-Wed",
+    "outputId": "5839d0c1-5b43-476e-c2f8-6707de562260"
+   },
+   "outputs": [],
+   "source": [
+    "# prove the zk circuit\n",
+    "# GENERATE A PROOF\n",
+    "proof_path = os.path.join('test.pf')\n",
+    "\n",
+    "\n",
+    "proof = ezkl.prove(\n",
+    "        witness_path,\n",
+    "        compiled_filename,\n",
+    "        pk_path,\n",
+    "        proof_path,\n",
+    "        \"single\"\n",
+    "    )\n",
+    "\n",
+    "\n",
+    "print(\"proved\")\n",
+    "\n",
+    "assert os.path.isfile(proof_path)\n",
+    "\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "colab": {
+   "provenance": []
+  },
+  "kernelspec": {
+   "display_name": ".env",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.12.7"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 0
 }
--- a/src/eth.rs
+++ b/src/eth.rs
@@ -488,7 +488,6 @@ pub async fn deploy_da_verifier_via_solidity(
        }
    }

-    
    match call_to_account {
        Some(call) => {
            deploy_single_da_contract(
--- a/src/graph/mod.rs
+++ b/src/graph/mod.rs
@@ -280,7 +280,13 @@ impl GraphWitness {
        })?;

        let reader = std::io::BufReader::with_capacity(*EZKL_BUF_CAPACITY, file);
-        serde_json::from_reader(reader).map_err(|e| e.into())
+        let witness: GraphWitness =
+            serde_json::from_reader(reader).map_err(|e| Into::<GraphError>::into(e))?;
+
+        // check versions match
+        crate::check_version_string_matches(witness.version.as_deref().unwrap_or(""));
+
+        Ok(witness)
    }

    /// Save the model input to a file
@@ -572,10 +578,14 @@ impl GraphSettings {
        // buf reader
        let reader =
            std::io::BufReader::with_capacity(*EZKL_BUF_CAPACITY, std::fs::File::open(path)?);
-        serde_json::from_reader(reader).map_err(|e| {
+        let settings: GraphSettings = serde_json::from_reader(reader).map_err(|e| {
            error!("failed to load settings file at {}", e);
            std::io::Error::new(std::io::ErrorKind::Other, e)
-        })
+        })?;
+
+        crate::check_version_string_matches(&settings.version);
+
+        Ok(settings)
    }

    /// Export the ezkl configuration as json
@@ -697,6 +707,9 @@ impl GraphCircuit {
        let reader = std::io::BufReader::with_capacity(*EZKL_BUF_CAPACITY, f);
        let result: GraphCircuit = bincode::deserialize_from(reader)?;

+        // check the versions matche
+        crate::check_version_string_matches(&result.core.settings.version);
+
        Ok(result)
    }
 }
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -420,3 +420,30 @@ where
    let b = s[pos + 2..].parse()?;
    Ok((a, b))
 }
+
+/// Check if the version string matches the artifact version
+/// If the version string does not match the artifact version, log a warning
+pub fn check_version_string_matches(artifact_version: &str) {
+    if artifact_version == "0.0.0"
+        || artifact_version == "source - no compatibility guaranteed"
+        || artifact_version.is_empty()
+    {
+        log::warn!("Artifact version is 0.0.0, skipping version check");
+        return;
+    }
+
+    let version = crate::version();
+
+    if version == "source - no compatibility guaranteed" {
+        log::warn!("Compiled source version is not guaranteed to match artifact version");
+        return;
+    }
+
+    if version != artifact_version {
+        log::warn!(
+            "Version mismatch: CLI version is {} but artifact version is {}",
+            version,
+            artifact_version
+        );
+    }
+}
--- a/src/pfsys/mod.rs
+++ b/src/pfsys/mod.rs
@@ -822,6 +822,7 @@ where
    Scheme::Scalar: PrimeField + SerdeObject + FromUniformBytes<64>,
 {
    debug!("loading proving key from {:?}", path);
+    let start = instant::Instant::now();
    let f = File::open(path.clone()).map_err(|e| PfsysError::LoadPk(format!("{}", e)))?;
    let mut reader = BufReader::with_capacity(*EZKL_BUF_CAPACITY, f);
    let pk = ProvingKey::<Scheme::Curve>::read::<_, C>(
@@ -830,7 +831,8 @@ where
        params,
    )
    .map_err(|e| PfsysError::LoadPk(format!("{}", e)))?;
-    info!("loaded proving key ✅");
+    let elapsed = start.elapsed();
+    info!("loaded proving key in {:?}", elapsed);
    Ok(pk)
 }

--- a/tests/assets/pk.key
+++ b/tests/assets/pk.key
--- a/tests/assets/vk.key
+++ b/tests/assets/vk.key
Author	SHA1	Message	Date
github-actions[bot]	6974f77039	ci: update version string in docs	2025-01-08 17:19:07 +00:00
dante	6752a05f19	refactor: pregen mv-lookup blinds (#900 )	2025-01-08 17:18:46 +00:00
dante	03aefb85eb	chore: version mismatch warnings for artifacts (#899 )	2025-01-06 16:01:34 +00:00
dante	e86caca8b6	refactor: batched poly reads (#897 )	2025-01-06 15:49:47 +00:00