From 694740ba1f1df27215df0bffc6e8f6edd9123069 Mon Sep 17 00:00:00 2001 From: Ryan Orendorff <12442942+ryanorendorff@users.noreply.github.com> Date: Wed, 7 May 2025 16:48:17 -0600 Subject: [PATCH 1/2] Link to redeployed BFV docs --- README.md | 2 +- emsdk/Cargo.toml | 1 + seal_fhe/Cargo.toml | 1 + sunscreen/Cargo.toml | 1 + sunscreen/crates-io.md | 2 +- sunscreen_backend/Cargo.toml | 1 + sunscreen_compiler_common/Cargo.toml | 1 + sunscreen_compiler_macros/Cargo.toml | 1 + sunscreen_docs/src/zkp/zkp_programs/zkp_programs.md | 2 +- sunscreen_fhe_program/Cargo.toml | 1 + sunscreen_math/Cargo.toml | 1 + sunscreen_math_macros/Cargo.toml | 1 + sunscreen_runtime/Cargo.toml | 1 + sunscreen_tfhe/Cargo.toml | 1 + sunscreen_zkp_backend/Cargo.toml | 1 + 15 files changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8bc61f725..8e9970c58 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Sunscreen is an ecosystem for building privacy-preserving applications using ful If you'd like to try out our FHE compiler before downloading it, we offer [a playground](https://playground.sunscreen.tech). -Extensive documentation can be found [here](https://github.com/Sunscreen-tech/Sunscreen/blob/main/sunscreen_docs/src/SUMMARY.md). +Extensive documentation can be found [here](https://bfv-docs.sunscreen.tech). *WARNING!* This library is meant for experiments only. It has not been externally audited and is not intended for use in production. diff --git a/emsdk/Cargo.toml b/emsdk/Cargo.toml index 2bb911a56..9077d4910 100644 --- a/emsdk/Cargo.toml +++ b/emsdk/Cargo.toml @@ -9,6 +9,7 @@ license = "AGPL-3.0-only" description = "A crate for building C++ projects with emcake. This facilitates building wasm binaries with both Rust and C++ code." homepage = "https://sunscreen.tech" repository = "https://github.com/Sunscreen-tech/Sunscreen" +documentation = "https://bfv-docs.sunscreen.tech" keywords = ["emsdk", "emcc", "emcmake"] categories = ["development-tools"] readme = "crates-io.md" diff --git a/seal_fhe/Cargo.toml b/seal_fhe/Cargo.toml index 67349ada3..f371d1391 100644 --- a/seal_fhe/Cargo.toml +++ b/seal_fhe/Cargo.toml @@ -9,6 +9,7 @@ license = "AGPL-3.0-only" description = "This crate contains Rust bindings for Microsoft's SEAL Fully Homomorphic Encryption (FHE) library." homepage = "https://sunscreen.tech" repository = "https://github.com/Sunscreen-tech/Sunscreen" +documentation = "https://bfv-docs.sunscreen.tech" keywords = ["FHE", "BFV", "lattice", "cryptography"] categories = ["cryptography"] readme = "crates-io.md" diff --git a/sunscreen/Cargo.toml b/sunscreen/Cargo.toml index 02a0b6db2..d7fdb29b4 100644 --- a/sunscreen/Cargo.toml +++ b/sunscreen/Cargo.toml @@ -12,6 +12,7 @@ license = "AGPL-3.0-only" description = "A Fully Homomorphic Encryption (FHE) compiler supporting the Brakerski/Fan-Vercauteren (BFV) scheme." homepage = "https://sunscreen.tech" repository = "https://github.com/Sunscreen-tech/Sunscreen" +documentation = "https://bfv-docs.sunscreen.tech" keywords = ["FHE", "BFV", "lattice", "cryptography"] categories = ["cryptography"] readme = "crates-io.md" diff --git a/sunscreen/crates-io.md b/sunscreen/crates-io.md index 54eda6f93..b741ee039 100644 --- a/sunscreen/crates-io.md +++ b/sunscreen/crates-io.md @@ -44,7 +44,7 @@ fn main() -> Result<(), Error> { ``` # Docs -* [User guide](https://github.com/Sunscreen-tech/Sunscreen/blob/main/sunscreen_docs/src/SUMMARY.md) +* [User guide](https://bfv-docs.sunscreen.tech/) * [API docs](https://docs.rs/sunscreen) # Getting help diff --git a/sunscreen_backend/Cargo.toml b/sunscreen_backend/Cargo.toml index 07393ab3c..025189817 100644 --- a/sunscreen_backend/Cargo.toml +++ b/sunscreen_backend/Cargo.toml @@ -9,6 +9,7 @@ license = "AGPL-3.0-only" description = "The backend for the Sunscreen compiler." homepage = "https://sunscreen.tech" repository = "https://github.com/Sunscreen-tech/Sunscreen" +documentation = "https://bfv-docs.sunscreen.tech" keywords = ["FHE", "BFV", "lattice", "cryptography"] categories = ["cryptography"] readme = "crates-io.md" diff --git a/sunscreen_compiler_common/Cargo.toml b/sunscreen_compiler_common/Cargo.toml index 7f564618b..d9526b70c 100644 --- a/sunscreen_compiler_common/Cargo.toml +++ b/sunscreen_compiler_common/Cargo.toml @@ -9,6 +9,7 @@ license = "AGPL-3.0-only" description = "This crate contains common functionality for Sunscreen's FHE and ZKP compilers." homepage = "https://sunscreen.tech" repository = "https://github.com/Sunscreen-tech/Sunscreen" +documentation = "https://bfv-docs.sunscreen.tech" keywords = ["FHE", "BFV", "lattice", "cryptography"] categories = ["cryptography"] readme = "crates-io.md" diff --git a/sunscreen_compiler_macros/Cargo.toml b/sunscreen_compiler_macros/Cargo.toml index a1302966d..594cfbb5a 100644 --- a/sunscreen_compiler_macros/Cargo.toml +++ b/sunscreen_compiler_macros/Cargo.toml @@ -9,6 +9,7 @@ license = "AGPL-3.0-only" description = "This crate contains macros that support the Sunscreen compiler." homepage = "https://sunscreen.tech" repository = "https://github.com/Sunscreen-tech/Sunscreen" +documentation = "https://bfv-docs.sunscreen.tech" keywords = ["FHE", "BFV", "lattice", "cryptography"] categories = ["cryptography"] readme = "crates-io.md" diff --git a/sunscreen_docs/src/zkp/zkp_programs/zkp_programs.md b/sunscreen_docs/src/zkp/zkp_programs/zkp_programs.md index f4a0d140e..cc86f75af 100644 --- a/sunscreen_docs/src/zkp/zkp_programs/zkp_programs.md +++ b/sunscreen_docs/src/zkp/zkp_programs/zkp_programs.md @@ -1,6 +1,6 @@ # What's in a ZKP program? -If you've already read through [our FHE compiler documentation](https://github.com/Sunscreen-tech/Sunscreen/blob/main/sunscreen_docs/src/SUMMARY.md), you'll find that ZKPs +If you've already read through [our FHE compiler documentation](https://bfv-docs.sunscreen.tech/), you'll find that ZKPs are, in many ways, much simpler. This is perhaps unsurprising; whereas FHE enables general purpose private computation, ZKPs have a narrower purpose. For example, ZKP programs don't even have return values! diff --git a/sunscreen_fhe_program/Cargo.toml b/sunscreen_fhe_program/Cargo.toml index 9407a8a9d..738bfe68d 100644 --- a/sunscreen_fhe_program/Cargo.toml +++ b/sunscreen_fhe_program/Cargo.toml @@ -9,6 +9,7 @@ license = "AGPL-3.0-only" description = "This crate provides the data format for Sunscreen FHE programs." homepage = "https://sunscreen.tech" repository = "https://github.com/Sunscreen-tech/Sunscreen" +documentation = "https://bfv-docs.sunscreen.tech" keywords = ["FHE", "BFV", "lattice", "cryptography"] categories = ["cryptography"] readme = "crates-io.md" diff --git a/sunscreen_math/Cargo.toml b/sunscreen_math/Cargo.toml index 9adc45108..5f484234b 100644 --- a/sunscreen_math/Cargo.toml +++ b/sunscreen_math/Cargo.toml @@ -9,6 +9,7 @@ license = "AGPL-3.0-only" description = "This crate contains GPU implementations that support the Sunscreen compiler." homepage = "https://sunscreen.tech" repository = "https://github.com/Sunscreen-tech/Sunscreen" +documentation = "https://bfv-docs.sunscreen.tech" keywords = ["FHE", "BFV", "lattice", "cryptography"] categories = ["cryptography"] readme = "crates-io.md" diff --git a/sunscreen_math_macros/Cargo.toml b/sunscreen_math_macros/Cargo.toml index c4459b59a..feed154e8 100644 --- a/sunscreen_math_macros/Cargo.toml +++ b/sunscreen_math_macros/Cargo.toml @@ -9,6 +9,7 @@ license = "AGPL-3.0-only" description = "This crate contains macros that support the Sunscreen compiler." homepage = "https://sunscreen.tech" repository = "https://github.com/Sunscreen-tech/Sunscreen" +documentation = "https://bfv-docs.sunscreen.tech" keywords = ["FHE", "BFV", "lattice", "cryptography"] categories = ["cryptography"] readme = "crates-io.md" diff --git a/sunscreen_runtime/Cargo.toml b/sunscreen_runtime/Cargo.toml index 5598c25b5..59cfbc9fd 100644 --- a/sunscreen_runtime/Cargo.toml +++ b/sunscreen_runtime/Cargo.toml @@ -9,6 +9,7 @@ license = "AGPL-3.0-only" description = "This crate provides a runtime for performing various FHE operations within Sunscreen." homepage = "https://sunscreen.tech" repository = "https://github.com/Sunscreen-tech/Sunscreen" +documentation = "https://bfv-docs.sunscreen.tech" keywords = ["FHE", "BFV", "lattice", "cryptography"] categories = ["cryptography"] readme = "crates-io.md" diff --git a/sunscreen_tfhe/Cargo.toml b/sunscreen_tfhe/Cargo.toml index 0fa2deb8c..9ee644993 100644 --- a/sunscreen_tfhe/Cargo.toml +++ b/sunscreen_tfhe/Cargo.toml @@ -9,6 +9,7 @@ license = "AGPL-3.0-only" description = "This crate contains the Sunscreen Torus FHE (TFHE) implementation" homepage = "https://sunscreen.tech" repository = "https://github.com/Sunscreen-tech/Sunscreen" +documentation = "https://bfv-docs.sunscreen.tech" keywords = ["FHE", "TFHE", "lattice", "cryptography"] categories = ["cryptography"] readme = "crates-io.md" diff --git a/sunscreen_zkp_backend/Cargo.toml b/sunscreen_zkp_backend/Cargo.toml index 13f091719..ef525529f 100644 --- a/sunscreen_zkp_backend/Cargo.toml +++ b/sunscreen_zkp_backend/Cargo.toml @@ -9,6 +9,7 @@ license = "AGPL-3.0-only" description = "This crate contains the ZKP backend of the Sunscreen compiler." homepage = "https://sunscreen.tech" repository = "https://github.com/Sunscreen-tech/Sunscreen" +documentation = "https://bfv-docs.sunscreen.tech" keywords = ["FHE", "BFV", "lattice", "cryptography"] categories = ["cryptography"] readme = "crates-io.md" From 5114a5a758fd4cdebf304ada949c9d7cccff5122 Mon Sep 17 00:00:00 2001 From: Ryan Orendorff <12442942+ryanorendorff@users.noreply.github.com> Date: Wed, 7 May 2025 17:14:23 -0600 Subject: [PATCH 2/2] Documentation links to HPU docs --- sunscreen_docs/book.toml | 4 ++-- sunscreen_docs/src/fhe/intro/intro.md | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/sunscreen_docs/book.toml b/sunscreen_docs/book.toml index 0dc0ffb4f..336a3127f 100644 --- a/sunscreen_docs/book.toml +++ b/sunscreen_docs/book.toml @@ -1,9 +1,9 @@ [book] -authors = ["Rick Weber", "Ravital Solomon", "Sam Tay"] +authors = ["Sunscreen Team"] language = "en" multilingual = false src = "src" -title = "Sunscreen Documentation" +title = "Sunscreen BFV Documentation" [output.html] mathjax-support = true diff --git a/sunscreen_docs/src/fhe/intro/intro.md b/sunscreen_docs/src/fhe/intro/intro.md index b4a21e381..61a80da9f 100644 --- a/sunscreen_docs/src/fhe/intro/intro.md +++ b/sunscreen_docs/src/fhe/intro/intro.md @@ -1,3 +1,5 @@ +This documentation is about the BFV version of our compiler; for our new FHE compiler based on the TFHE scheme, see our [TFHE Compiler](https://docs.sunscreen.tech) documentation. + # Introduction to FHE and our compiler Fully homomorphic encryption (FHE) is the next generation of public key encryption schemes. Standard public key encryption allows anyone to share data in a secure way. However, you can't really *do* anything with this encrypted data, apart from decrypting it. That's where FHE comes in!