Skip to content
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

Docs fix spelling issues #318

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Docs fix spelling issues #318

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a577f51
Update client.md
nnsW3 Jan 15, 2025
607d06e
Update data.md
nnsW3 Jan 15, 2025
5bcc197
Update utreexo.md
nnsW3 Jan 15, 2025
f52229f
Update README.md
nnsW3 Jan 15, 2025
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Tasks:

### Milestone 3 - Bitcoin script validation

Try to run script validation with external Cairo crate.
Try to run script validation with an external Cairo crate.

Tasks:

Expand Down
2 changes: 1 addition & 1 deletion docs/client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ python ./scripts/data/client.py --start $INITIAL_CHAIN_HEIGHT --mode utreexo

Raito will check that the block at level `$INITIAL_CHAIN_HEIGHT + 1` is valid and fail otherwise.

## How to generate test case
## How to generate a test case

In the following example we will create an integration test for applying block 630000 with all validations and Utreexo accumulator enabled:

Expand Down
4 changes: 2 additions & 2 deletions docs/data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Generating ChainState and Block data involves joining information between multip

Input data is processed in multiple steps:
1. [previous_timestamps.sql](../scripts/data/previous_timestamps.sql) and [previous_utxos.sql](../scripts/data/previous_utxos.sql) queries dump data into GCS
2. Timestamp data dump is processed by [generate_timestamp_data.py](../scripts/data/generate_timestamp_data.py) script. Data is downloaded from GCS and index files are created. Index maps block number to per block timestamp related data. Index is broken down into smaller files, in order to be quickly loaded into the memory.
2. Timestamp data dump is processed by [generate_timestamp_data.py](../scripts/data/generate_timestamp_data.py) script. Data is downloaded from GCS and index files are created. Index maps block number to per block timestamp-related data. Index is broken down into smaller files, in order to be quickly loaded into the memory.
3. Utxo data dump is by [generate_utxo_data.py](../scripts/data/generate_utxo_data.py) script: is downloaded from GCS, data files are broken down into smaller chunks, each chunk contains data about several blocks. Index files are created. Index maps block number to a chunk file. Index is broken down into smaller files.
4. After data dump processing is complete functions [`get_timestamp_data`](../scripts/data/generate_timestamp_data.py#L88) and [`get_utxo_set`](../scripts/data/generate_utxo_data.py#L125) give access to the per block data.
5. Script [generate_data](../scripts/data/generate_data.py) generates data that can be consumed by the `validate_and_apply` function.
Expand All @@ -30,7 +30,7 @@ cargo install --git https://github.com/Davidson-Souza/bridge.git --no-default-fe

### Configure

You need to configure connection to the Bitcoin RPC via environment variables:
You need to configure the connection to the Bitcoin RPC via environment variables:

```sh
export BITCOIN_CORE_RPC_URL=http://localhost:8332
Expand Down
4 changes: 2 additions & 2 deletions docs/utreexo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ With the new design where leaves are never actually removed the forest constantl
<img src="./img/utreexo_pollard.svg" alt=""/>
</p>

Although the new scheme is more memory consuming it has several advantages:
Although the new scheme is more memory-consuming it has several advantages:
- Better UTXO locality: the leaves that are spent soon are clustered at the right, so the proof size is optimal in most cases (see some [cool charts](https://github.com/mit-dci/utreexo/issues/257)); at the same time the proof size for old UTXOs is also amortized thanks to the "hollowing";
- The removal algorithm does not mess much with the tree structure and requires less updates of the intermediate nodes.

Expand All @@ -41,7 +41,7 @@ This allows more convenient navigation through the pollard and some bit tricks.
## Stump

Stump is the "light" version of Utreexo accumulator that contains the minimal necessary data required to verify inclusion proofs and add/remove leaves. It is not sufficient to generate proofs though — for that you need the full pollard, which is quite large.
Stump is a perfect fit for a ZK client where maintaining large state is prohibitively expensive.
Stump is a perfect fit for a ZK client where maintaining a large state is prohibitively expensive.

More specifically, stump consists of roots and the number of leaves (as we know this is the total number of UTXOs). Note that there are differences in how roots are stored and represented compared to the vanilla implementation:
- Roots are sorted top down
Expand Down
Loading