[BUG] Do we need LFS for recursion_zkr.zip? about risc0 HOT 5 CLOSED

This issue is only relevant for users that want to build from source. If users use the binary release, then this can be avoided. I don't know of any good alternatives at this time.

from risc0.

For using crates, the build script should download the ZKR from an S3 bucket, so crates from crates.io should work. If this isn't working as intended we can open a ticket for that issue.

from risc0.

Actually that is what I want to follow up next. So, for people who build from sources.

Would it help to let the build script ignore an un-pulled LFS metadata file with the same name?
https://github.com/risc0/risc0/blob/main/risc0/circuit/recursion/build.rs#L54C12-L54C12

Currently, the build script would copy-paste the zip file if it exists.

if std::fs::metadata(&src_path).is_ok() {
    let tgt_path = out_dir.join(FILENAME);
    std::fs::copy(&src_path, &tgt_path).unwrap();
}

But the one that exists could be the 133-byte LFS metadata file.

version https://git-lfs.github.com/spec/v1
oid sha256:ae5736a42189aec2f04936c3aee4b5441e48b26b4fa1fae28657cf50cdf3cae4
size 25527822

This would lead to an error:

thread '<unnamed>' panicked at /Users/cusgadmin/.cargo/git/checkouts/risc0-b4649977e2e81438/341a014/risc0/circuit/recursion/src/zkr.rs:29:71:
called `Result::unwrap()` on an `Err` value: InvalidArchive("Could not find central directory end")
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
Traceback (most recent call last):
  File "/Users/cusgadmin/RustroverProjects/r0prover-python/test/test.py", line 33, in <module>
    receipt_1_lifted = l2_r0prover.lift_segment_receipt(receipt_1)
                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
pyo3_runtime.PanicException: called `Result::unwrap()` on an `Err` value: InvalidArchive("Could not find central directory end")

It would be great if the build script, after seeing a file there that is definitely not the actual zip file (such as hash mismatch), would instead download it from the S3 bucket.

How do you think?

from risc0.

Sure, I'd welcome a PR for that, or one of us could try that at some point.

from risc0.

I will follow up on this with a PR.

from risc0.