From 0baed210fa4946669e9a701bc688a9618f0d9583 Mon Sep 17 00:00:00 2001 From: Kamen Mladenov Date: Mon, 10 Feb 2025 17:15:21 +0200 Subject: feat(zkm): Remove copy of sdk --- zkvms/zkm/sdk/README.md | 42 ------------------------------------------ 1 file changed, 42 deletions(-) delete mode 100644 zkvms/zkm/sdk/README.md (limited to 'zkvms/zkm/sdk/README.md') diff --git a/zkvms/zkm/sdk/README.md b/zkvms/zkm/sdk/README.md deleted file mode 100644 index 182111b..0000000 --- a/zkvms/zkm/sdk/README.md +++ /dev/null @@ -1,42 +0,0 @@ -This is a copy of [ZKM's project SDK](https://github.com/zkMIPS/zkm-project-template/tree/main/sdk), which changes the zkVM cargo dependencies to point to `/nix/store`. -It is also used as a convinent place which stores the SDK's `libsnark` (`sdk/src/local/libsnark`), so during compilation it is not fetched from the source repo (refer to `zkvms/zkm/default.nix`). - ---- - -# ZKM SDK usage - -## Use the libsnark - -1. The compile.sh in the path sdk/src/local/libsnark only supports X86_64 linux.For MacOS, there is a [Dockerfile](../Dockerfile) in the template. - -``` -cd zkm-project-template/sdk/src/local/libsnark -./compile.sh -``` - If successful, it will generate the libsnark.so in sdk/src/local/libsnark/ - -2. To instruct your Rust environment on the location of the libsnark.so , you can set the LD_LIBRARY_PATH environment variable. For example: - -``` -export LD_LIBRARY_PATH=Your BASEDIR/zkm-project-template/sdk/src/local/libsnark:$LD_LIBRARY_PATH -``` - -3. Import the SDK - -``` -// Cargo.toml -[dependencies] -zkm-sdk = { git = "https://github.com/zkMIPS/zkm-project-template", branch = "main", features = ["snark"] } -``` - -## Don't use the libsnark - -1. Set the environment variable `NO_USE_SNARK=true` . - -2. Import the SDK - -``` -// Cargo.toml -[dependencies] -zkm-sdk = { git = "https://github.com/zkMIPS/zkm-project-template", branch = "main" } -``` -- cgit v1.2.3