Skip to content

fix: typos in documentation files #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: typos in documentation files #54

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions content/docs/zkdocs/protocol-primitives/nums.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To generate the elements you require:
- **salt:** the salt can be $\mathsf{"shortfactoringproof"}$
{{< /hint >}}

The construction is generic: start a counter and sample an element with an extendible-output hash function over the binding parameters and the counter; if the generated element is in the sample space, we return it; otherwise, we increment the counter and sample again.
The construction is generic: start a counter and sample an element with an extendable-output hash function over the binding parameters and the counter; if the generated element is in the sample space, we return it; otherwise, we increment the counter and sample again.

```python
DS = '|'
Expand All @@ -42,7 +42,7 @@ def gen_element(sample_space_predicate, bitsize, param_list, salt):
# domain separated elements
to_hash = DS + DS.join(to_hash)

# generate bitsize element with extendible-output hash function
# generate bitsize element with extendable-output hash function
e = hash_xof(to_hash, bitsize)

# check that e is in sample_space
Expand All @@ -54,7 +54,7 @@ def gen_element(sample_space_predicate, bitsize, param_list, salt):
```

## Hash function choice
The hash function used here must be an extendible-output function (XOF). These hash functions can generate an output of arbitrary length. We must use these functions since the elements we are sampling can have an arbitrary number of bits, and failing to achieve that size can cause security issues. An example is $\mathsf{SHAKE256}$, which provides 256-bit security against collision attacks when at least 512 bits are sampled.
The hash function used here must be an extendable-output function (XOF). These hash functions can generate an output of arbitrary length. We must use these functions since the elements we are sampling can have an arbitrary number of bits, and failing to achieve that size can cause security issues. An example is $\mathsf{SHAKE256}$, which provides 256-bit security against collision attacks when at least 512 bits are sampled.

An alternative is using $\mathsf{TupleHash}$ which does not require manually domain-separating the elements to be hashed.