Skip to content

Commit

Permalink
docs: clarify shares inside ErrByzantineData
Browse files Browse the repository at this point in the history
  • Loading branch information
rootulp committed Jul 3, 2023
1 parent 2557620 commit 9df24b4
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions extendeddatacrossword.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,16 @@ var ErrUnrepairableDataSquare = errors.New("failed to solve data square")
// expected row or column Merkle root. It is also returned when the parity data
// from a row or a column is not equal to the encoded original data.
type ErrByzantineData struct {
Axis Axis // Axis of the data.
Index uint // Row/Col index.
Shares [][]byte // Pre-repaired shares. Missing shares are nil.
// Axis describes if this ErrByzantineData is for a row or column.
Axis Axis
// Index is the row or column index.
Index uint
// Shares contain the shares in the row or column that the client can
// determine proofs for (either through sampling or using shares decoded
// from the extended data square). In other words, it contains shares whose
// individual inclusion is guaranteed to be provable by the full node (i.e.
// shares usable in a bad encoding fraud proof). Missing shares are nil.
Shares [][]byte
}

func (e *ErrByzantineData) Error() string {
Expand Down

0 comments on commit 9df24b4

Please sign in to comment.