40 Commits

Author SHA1 Message Date
Ryan Orendorff
d7f58b39c1 Link to redeployed BFV docs (#398) 2025-05-07 23:27:35 +00:00
Ryan Orendorff
5ab19fb39c Update README (#397) 2025-05-07 17:24:09 +00:00
Sam Tay
191536e5e7 Avoid extra CI builds (#340) 2024-02-08 00:22:36 +00:00
Sam Tay
18ea59b542 Proof linking (#339) 2024-02-03 20:01:24 +00:00
rickwebiii
1f5a2b7356 fix broken doc links (#333)
Co-authored-by: Sam Tay <samctay@pm.me>
2023-11-30 13:29:29 -08:00
Sam Tay
8eb8936f51 Add ZKP compiler docs (#302)
* Enable folding

* Move troubleshooting.md

* Merge in zkp docs

* Convert all absolute links to relative

* Fix CI
2023-08-22 18:35:53 -04:00
Sam Tay
badb8f9c8f ZKP tweaks (#279)
* Export type alias for bulletproof backend fields

Also, keep bulletproof stuff namespaced to a `bulletproofs` module.

* Change sudoku to use pub over const

* Docs updates

* Rename / clean up sudoku

* Export `Proof` type

Basically required for being able to deserialize a proof

* Add zkp/serde workspace example

* Drive by cleaning

* Exports necessary for gadget impls

* Rename compute_inputs to compute_hidden_inputs

* Add prove/verify builders

* Export the builder types

This isnt strictly necessary but it would be weird for these to not show up in the cargo docs

* Clippy fix

* Add helper .compile() & .runtime() methods to fhe prog fns

I do wonder if these should be defined in a separate trait, just so that they don't live next to the more internal functions in documentation.

* Use new swag to simplify the front-facing api docs example

* Add some whitespace

* Switch to an extension trait

* Add an extension to ZkpProgramFn

* Take an owned ZkpBackend, rather than reference

Its typical to have the caller handle cloning, rather than taking a reference, requiring Clone impl, and forcing clone. Plus, as of now the only backend is a zero size null struct, so nothing to be gained by using a reference. It also just looks weird to always pass `&BulletproofsBackend::new()`

* Update sudoku to use new swag

* Target second attribute in multi attribute error

* Enforce ordering zkp inputs: constants,public,private

Honestly this feels a little unnatural to me. Might want to reverse: private, public, constant and then change all the prove/verify methods to that ordering

* Build whitelist example in CI

* Reorder constant->public->private to private->public->constant

* Fix trailing ws

* Fix example

* Make .runtime() more consistent with .compile()

* Get rid of some boilerplate impls

* Add custom zkp type example

* Move example run checks into example tests

Should speed up CI a bit

* Change whitelist -> allowlist
2023-07-18 15:15:51 -04:00
Sam Tay
08cdfa7e94 Fix more docs (#258)
* Fix a couple broken doc links

* Fix broken batching links
2023-06-19 22:47:03 -07:00
mliu24
5b848e1901 fixed a typo (#256) 2023-06-12 20:37:35 -07:00
Sam Tay
c2ad1138c2 Fix broken doc links (#252)
* Fix broken doc links

* Fail CI on api doc warnings

* Fix broken api docs
2023-06-12 12:46:08 -07:00
Sam Tay
aadde9d162 Offer a simpler API for runtime creation (#246)
* Offer a simpler API for runtime creation

* Update docs and examples to use `FheRuntime::new`
2023-06-06 18:56:46 -07:00
Ryan Orendorff
70f28be1ee Fix wasm activate instruction to activate 3.1.3 (#209) 2023-01-31 10:25:20 -07:00
rickwebiii
3543b88387 Rweber/zkp (#187)
Refactor APIs to support ZKPs
2022-11-22 15:44:00 -08:00
rickwebiii
3cdd0a5193 Add chaining docs (#177)
* Port over docs changes from docs-preliminary

* Fix casing and typos

* Fix failing docs tests
2022-10-17 14:34:45 -07:00
ravital
37fd05d1ea Update README.md 2022-07-17 23:19:51 -07:00
rickwebiii
ca1ff36590 Update docs crate version (#158) 2022-07-17 14:11:49 -07:00
ravital
44bef75f4b Update faq.md 2022-07-13 16:42:51 -07:00
ravital
a643550ce2 Update running_fhe_programs.md 2022-07-13 16:35:04 -07:00
ravital
78c551e6aa Update encryption.md 2022-07-13 16:08:12 -07:00
ravital
99807bd878 Update intro.md 2022-07-13 15:12:50 -07:00
ravital
07a3254f79 Update types.md 2022-07-13 15:08:57 -07:00
ravital
909303dbd1 Update SUMMARY.md 2022-07-13 15:08:32 -07:00
rickwebiii
bcd68a4b64 Rweber/docs (#148)
* Add deployment script

* Fix links

* fixes

* fixes
2022-07-13 14:27:07 -07:00
ravital
1f4c8eb8a7 Update SUMMARY.md 2022-07-13 12:47:27 -07:00
ravital
39391495f4 Update compiler.md 2022-07-13 12:42:05 -07:00
ravital
399a6a6d93 Create performance.md 2022-07-13 12:34:12 -07:00
ravital
1805eaa178 Create who.md 2022-07-13 12:32:38 -07:00
ravital
663c95bed3 Create features.md 2022-07-13 12:31:36 -07:00
rickwebiii
121e7be325 Rweber/multiprogram (#130)
Allow compiling multiple FHE programs to use the same parameters.
2022-07-06 17:04:43 -07:00
ravital
43a580af93 Update getting_started.md 2022-06-24 12:03:10 -07:00
ravital
06d27912cf Update faq.md 2022-06-24 12:01:00 -07:00
ravital
48960fd735 Update compiler.md 2022-06-24 11:59:22 -07:00
ravital
c364304e95 Update book.toml 2022-06-24 11:58:40 -07:00
rickwebiii
50f7dc5740 Update installation 2022-05-21 00:05:08 -07:00
rickwebiii
905d69bd09 Add docs deployment 2022-05-18 14:36:29 -07:00
rickwebiii
105bd10f5e ignore docs output 2022-05-18 12:23:27 -07:00
rickwebiii
ca8bcb44fa Update guide for running doc tests 2022-05-18 11:07:04 -07:00
rickwebiii
fd22815330 Update docs to run examples 2022-05-18 10:58:32 -07:00
ravital
535510b057 Update README.md 2022-05-02 16:25:04 -07:00
Rick Weber
a323229243 WIP 2022-05-02 12:05:08 -07:00