Commit Graph

309 Commits

Author SHA1 Message Date
Huulu 20c12903d2
chore: correcting few mistakes in documentation (#240)
* typo fix

* typo fix

* typo fix
2023-12-20 10:01:39 +01:00
Han 324c88608d
Document PSE fork features (#226)
* fix: panic if input or table contains simple selector in `lookup_any`

* fix: include `shuffle` in `Debug` of `PinnedConstraintSystem` if it is not empty

* doc: add `book/src/user/experimental-features.md`

* doc: apply suggestion from Carlos and add more links to doc page and example

* doc: mention `experimental-features.md` in `README.md`
2023-11-10 08:00:59 +01:00
Daira Hopwood 5af2bd3bd7 [Book] Rename "polynomial degree bound" to "maximum constraint degree".
This is because "degree bound" is often defined to be exclusive.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2022-07-07 18:13:14 -04:00
Daira Hopwood 104101d0eb [Book] Make the permutation diagram stand out against dark backgrounds.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2022-07-07 18:13:14 -04:00
ying tong 69a980ff40
[book] Add `U` to `BCMS` comparison table 2022-06-15 10:40:49 -04:00
Jack Grigg c1007d8c23 halo2_gadgets: Add protocol rule links for the chip constraints
Part of zcash/zcash#3957.
2022-05-25 22:41:04 +00:00
str4d 50921f95f7
Merge pull request #573 from zcash/str4d/chip-review
Changes from `halo2_gadgets` review
2022-05-10 22:54:45 +01:00
Jack Grigg ac67b117ca book: Document `EccChip` assumptions and general layout 2022-05-10 20:26:30 +00:00
Jack Grigg ad51e4a2bd book: Document var-mul constraints for complete addition and LSB 2022-05-10 20:26:30 +00:00
Jack Grigg f57b93f8e0 book: Fix various small bugs and add some missing constraints 2022-05-10 20:26:30 +00:00
therealyingtong e4e7821fc1 [book] Add 'Selector combining' to SUMMARY.md 2022-05-10 15:38:10 +08:00
Jack Grigg 88e189eebb book: Add page for witnessing ECC points 2022-05-10 00:20:00 +00:00
Jack Grigg 17cd222979 book: Add explicit constraints table for incomplete addition 2022-05-10 00:20:00 +00:00
Jack Grigg 144d082528 halo2_gadgets: Refactor complete addition constraints
We also fix several typos in the constraint analysis on the complete
addition book page, and adjust the constraints table for readability.
2022-05-10 00:20:00 +00:00
Jack Grigg 03697e2a7d book: Rewrite Sinsemilla gadget page
The book now has enough detail for it to be obvious why there are
factors of 2 present in several equations.
2022-05-08 02:38:01 +00:00
Jack Grigg 7ea240dbdf book: Rewrite `MerkleCRH` gadget page
The page now follows the pattern of other chip-specifying pages in how
it documents constraints (in particular, giving the specific form of the
constraint to match the implemented AST).

Additionally, a typo in the decomposition constraint for `left` has been
fixed (the implementation was correct).
2022-05-08 02:20:42 +00:00
Kris Nuttycombe 1791e693bb
Merge branch 'main' into main 2022-05-05 17:07:57 -06:00
Sean Bowe 1ea7aa1b89
Fix order of \epsilon bound. 2022-04-25 13:40:31 -06:00
Sean Bowe 05b8b77500
x -> x_3 rename in zero knowledge section. 2022-04-25 13:38:58 -06:00
Sean Bowe d420b7825a
Remove redundant mention of blinding factors 2022-04-25 13:36:28 -06:00
Sean Bowe b46848eaa8
Fix upper bound of \epsilon. 2022-04-25 13:34:42 -06:00
Sean Bowe 8e58245b75
Add draft of halo2 security proof to the formal protocol description 2022-04-25 11:59:29 -06:00
Daira Hopwood 66827f3df9
Merge pull request #544 from zcash/book-patch-vanishing
[book] Use more intuitive expression for vanishing poly degree
2022-04-22 16:46:39 +01:00
Daira Hopwood 84f5c26b7f [book] Add description of selector combining optimization.
fixes #466

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2022-04-18 20:19:26 +01:00
ying tong 8cb9226670
[book] Use more intuitive expression for vanishing poly degree 2022-04-10 17:10:51 +02:00
ying tong 2194973aa8
[book] Correct typo in protocol description.
Co-authored-by: Daira Hopwood <daira@jacaranda.org>
2022-03-17 21:35:06 +08:00
Daira Hopwood c5cdea1eb0
Merge pull request #487 from daira/book-improve-incomplete-addition
Improve the explanation of incomplete addition
2022-02-15 01:05:00 +00:00
Sean Bowe a129490517
Minor changes 2022-02-10 08:08:20 -07:00
Sean Bowe a4d3c328b9
halo2_proofs: rename variables for consistency
This changes variable names in the multiopen and commitment opening implementations
and the book's protocol description to keep names and indicies consistent with one
another.

Co-Authored-By: Jack Grigg <jack@electriccoin.co>
2022-02-09 13:37:50 -07:00
Daira Hopwood c4bdab59e3 Improve the explanation of incomplete addition:
* use biimplication in the correctness argument to ensure both soundness and completeness;
* avoid introducing lambda at all; it's unnecessary and omitting it shortens the explanation.

Co-authored-by: Jack Grigg <str4d@electriccoin.co>
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2022-02-03 22:06:05 +00:00
Jack Grigg 5202ec6eda Integrate `halo2_gadgets` into the workspace
THe SHA-256 example gadget has been moved into the `halo2_gadgets` crate
behind an `unstable` feature flag.
2022-01-27 23:32:04 +00:00
Jack Grigg 7e9ced2eaa Merge `halo2_gadgets` from zcash/orchard into halo2_gadgets-import 2022-01-27 23:08:35 +00:00
Jack Grigg a2367abcaf Migrate to `halo2_gadgets` crate in subdir
- The crate module structure from `orchard` has been flattened.
- The book pages we want to include in `halo2` have been moved to their
  target location, to avoid any conflicts during the merge.
- Common files that already exist in zcash/halo2 have been removed.
2022-01-27 23:08:01 +00:00
Jack Grigg c2866beb47 Delete Orchard-specific code, dependencies, and book pages
The tests do not compile as of this commit, due to Orchard-specific
constants being deleted, but everything else compiles.

Co-authored-by: ying tong <yingtong@z.cash>
2022-01-27 23:07:59 +00:00
Jack Grigg 3c6558f049 Move `halo2` code into `halo2_proofs` crate 2022-01-20 18:50:43 +00:00
str4d 408b617376
Merge pull request #397 from rex4539/typos
Fix typos
2021-12-31 14:14:34 +00:00
ying tong 2ab6e1b0d6
[book] Fix SHA256 interpolation polynomial
Closes #434
2021-12-23 22:07:09 +08:00
therealyingtong e0a0a0d509 book: Introduce RangeCheck macro. 2021-11-30 09:30:43 -05:00
therealyingtong 303bdc3f65 Replace local bool_check expressions with utilities::bool_check(). 2021-11-29 21:45:48 -05:00
Jack Grigg fa61746526 book: Rename remaining UPA references to PLONKish
These were missed in zcash/halo2#320.
2021-11-15 15:53:38 +00:00
Dimitris Apostolou 58e3793911
Fix typos 2021-11-12 03:40:53 +02:00
Jack Grigg a222cdc6d4 book: Document Debian packages required for `dev-graph` feature flag 2021-11-10 16:22:20 +00:00
str4d a635b7c25a
Merge pull request #375 from zcash/366-dev-graph-examples
Update `dev-graph` examples
2021-11-11 03:48:41 +13:00
Kris Nuttycombe 8cfff30cc7
Apply suggestions from code review 2021-10-26 07:56:25 -06:00
ying tong 3d2c0e429e
[book] Update link `upa.md` -> `plonkish.md`
Closes #367
2021-10-14 12:38:52 +02:00
zyd bac1aa4e84 book: Fix typo 2021-10-06 20:43:21 +08:00
zyd b12d03e815 book: Fix typo 2021-10-02 11:10:47 +08:00
Jack Grigg 5be597c3bc book: Add example for `halo2::dev::circuit_dot_graph` 2021-10-01 16:01:24 +01:00
Jack Grigg c9d890377c book: Render example for `CircuitLayout` 2021-10-01 13:39:04 +01:00
Jack Grigg e3e68bc5d7 book: Fix bugs in dev tools page 2021-10-01 13:39:04 +01:00