Skip to content

Commit

Permalink
chore: clarifies that Q3 can be computed from Q1 as well (#1461)
Browse files Browse the repository at this point in the history
## Overview
This PR includes a minor modification on the NMT wrapper spec requested
by @liamsi and also previously discussed in
#1442.

This PR briefly mentions that in the extended data square, `Q3` can be
derived from `Q1` or `Q2`, with a pointer to the relevant spec.

## Checklist

- [x] New and updated code has appropriate documentation
- [x] New and updated code has new and/or updated testing
- [x] Required CI checks are passing
- [x] Visual proof for any user facing features like CLI or
documentation updates
- [x] Linked issues closed with keywords
  • Loading branch information
staheri14 authored Mar 9, 2023
1 parent 7b737c1 commit b689639
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/spec/nmt-wrapper.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ The [extended version][reedsolomon-link] is called extended data square, that is
Figure 1 provides an illustration of a sample data square and its extended version.
`Q0` corresponds to the original data square.
`Q1` and `Q2` represent the horizontal and vertical extensions of `Q0`, respectively.
`Q3` is the extension of `Q2` in the horizontal direction.
`Q3` is the horizontal extension of `Q2` or alternatively, it can be considered as the vertical extension of `Q1`.
Additional information about the extension logic can be found in the specifications of the [2D Reed-Solomon encoding scheme][reedsolomon-link].
<img src="https://raw.githubusercontent.com/celestiaorg/celestia-app/c09843d07d4c3842753138de96b304b4866e8f5d/specs/src/specs/figures/rs2d_extending.svg" alt="Figure 1. Extended Data Square." style="max-width: 50%; height: auto;">

Figure 1. `r` and `c` stand for row and column, respectively.
Expand Down

0 comments on commit b689639

Please sign in to comment.