diff options
| author | Kamen Mladenov <kamen@syndamia.com> | 2025-02-10 17:15:21 +0200 |
|---|---|---|
| committer | Kamen Mladenov <kamen@syndamia.com> | 2025-02-10 17:15:21 +0200 |
| commit | 0baed210fa4946669e9a701bc688a9618f0d9583 (patch) | |
| tree | 6c83122d6df0906ac00a0f2a6ed6390b73dbdf88 /zkvms/zkm/sdk/README.md | |
| parent | 01b199735cffdec1376024b8214499190d08a876 (diff) | |
| download | zkVMs-benchmarks-0baed210fa4946669e9a701bc688a9618f0d9583.tar zkVMs-benchmarks-0baed210fa4946669e9a701bc688a9618f0d9583.tar.gz zkVMs-benchmarks-0baed210fa4946669e9a701bc688a9618f0d9583.zip | |
feat(zkm): Remove copy of sdk
Diffstat (limited to 'zkvms/zkm/sdk/README.md')
| -rw-r--r-- | zkvms/zkm/sdk/README.md | 42 |
1 files changed, 0 insertions, 42 deletions
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" } -``` |