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.

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 typos and grammar #4183

Merged
merged 8 commits into from
Jan 9, 2025
2 changes: 1 addition & 1 deletion docs/architecture/adr-002-qgb-valset.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To accommodate the requirements of the [Quantum Gravity Bridge](https://github.c

Add the `ValSet` and `ValSetConfirm` types of messages in order to track the state of the validator set.

PS: The `ValsetConfirm` has been updated in `adr-005-qgb-reduce-state-usage`. Please take a look at it to know how we will be handling the confirms.
PS: The `ValsetConfirm` has been updated in `adr-005-qgb-reduce-state-usage`. Please take a look at it to know how we will be handling the confirmations.
Marcofann marked this conversation as resolved.
Show resolved Hide resolved

## Detailed Design

Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/adr-003-qgb-data-commitments.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To accommodate the requirements of the [Quantum Gravity Bridge](https://github.c

Add the `DataCommitmentConfirm` type of messages in order to attest that a set of blocks has been finalized.

PS: The `ValsetConfirm` have been updated in `adr-005-qgb-reduce-state-usage`. Please take a look at it to know how we will be handling the confirms.
PS: The `ValsetConfirm` have been updated in `adr-005-qgb-reduce-state-usage`. Please take a look at it to know how we will be handling the confirmations.

## Detailed Design

Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/adr-005-qgb-reduce-state-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ This way, we will always have a fixed-sized state, issue defining this: [Prune t

### Separate P2P network

This would mean gossiping about the confirms and attestations in a separate P2P network.
This would mean gossiping about the confirmations and attestations in a separate P2P network.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You missed reverting this instance

Suggested change
This would mean gossiping about the confirmations and attestations in a separate P2P network.
This would mean gossiping about the confirms and attestations in a separate P2P network.

The pros of this approach are that it will be cheaper and wouldn't involve any state changes.
However, slashing will be very difficult, especially for liveness, i.e. an orchestrator not signing an attestation and then slashing them after a certain period.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The commitment is still the same but we need to use the bottom subtree roots for

Given a square size k, the biggest message that you can construct that is affected by the proposed non-interactive default rules has a size (k/2)². If you construct a message that is bigger than (k/2)² the `minSquareSize` will be k. If the minSquareSize is k in a square of size k then the current non-interactive default rules are equivalent to the proposed non-interactive default rules, because the message starts always at the beginning of a row. In other words, if you have k² shares in a message the worst constructible message is a quarter of that k²/4, because that is the size of the next smaller square.

If you choose k²/4 as the worst constructible message it would still have O(sqrt(n)) subtree roots. This is because the size of the message is k²/4 with a width of k and a length of k/4. This means the number of rows the message fills approaches O(sqrt(n)). Therefore we need to find a message where the number of rows is log(n) of the size of the message.
If you choose k²/4 as the worst constructible message it would still have O(sqrt(n)) subtree roots. This is because the size of the message is k²/4 with a width of k and a length of k/4. This means the number of rows the message fills approaches O(sqrt(n)). Therefore, we need to find a message where the number of rows is log(n) of the size of the message.

With k being the square size and n being the number of shares and r being the number of rows, we want to find a message so that:
k * r = n & log(n) = r => k = n/log(n)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Note: the blue nodes are additional nodes that are needed for the Merkle proofs.

![PFB Merkle Proof](./assets/adr011/pfd-merkle-proof.png)

Let's assume a square size of k. The amount of blue nodes from the shares to ROW1 is O(log(k)). The amount of blue nodes from ROW1 to the `DataRoot` is also O(log(k). You will have to include the shares themselves in the proof.
Let's assume a square size of k. The amount of blue nodes from the shares to ROW1 is O(log(k)). The amount of blue nodes from ROW1 to the `DataRoot` is also O(log(k)). You will have to include the shares themselves in the proof.
Share size := 512 bytes
NMT-Node size := 32 bytes + 2\*8 bytes = 48 bytes
MT-Node size := 32 bytes
Expand Down
Loading