Merge branch 'master' into rp/populate-shares

README.md

@@ -21,7 +21,7 @@ func main() {
     // Size of each share, in bytes
     bufferSize := 64
     // Init new codec
-    codec := rsmt2d.NewLeoRSFF8Codec()
+    codec := rsmt2d.NewLeoRSCodec()
 
     ones := bytes.Repeat([]byte{1}, bufferSize)
     twos := bytes.Repeat([]byte{2}, bufferSize)

datasquare.go

@@ -307,15 +307,6 @@ func (ds *dataSquare) SetCell(x uint, y uint, newChunk []byte) error {
 	return nil
 }
 
-// setCell overwrites the contents of a specific cell. setCell does not perform
-// any input validation so most usecases should use `SetCell` instead of
-// `setCell`. This method exists strictly for testing.
-func (ds *dataSquare) setCell(x uint, y uint, newChunk []byte) {
-	ds.squareRow[x][y] = newChunk
-	ds.squareCol[y][x] = newChunk
-	ds.resetRoots()
-}
-
 // Flattened returns the concatenated rows of the data square.
 func (ds *dataSquare) Flattened() [][]byte {
 	flattened := [][]byte(nil)

datasquare_test.go

@@ -461,3 +461,12 @@ func (d *errorTree) Push(data []byte) error {
 func (d *errorTree) Root() ([]byte, error) {
 	return nil, fmt.Errorf("error")
 }
+
+// setCell overwrites the contents of a specific cell. setCell does not perform
+// any input validation so most use cases should use `SetCell` instead of
+// `setCell`. This method exists strictly for testing.
+func (ds *dataSquare) setCell(x uint, y uint, newChunk []byte) {
+	ds.squareRow[x][y] = newChunk
+	ds.squareCol[y][x] = newChunk
+	ds.resetRoots()
+}

extendeddatacrossword.go

@@ -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 {
@@ -175,7 +182,7 @@ func (eds *ExtendedDataSquare) solveCrosswordRow(
 
 	// Insert rebuilt shares into square.
 	for c, s := range rebuiltShares {
-		eds.setCell(uint(r), uint(c), s)
+		eds.SetCell(uint(r), uint(c), s)
 	}
 
 	return true, true, nil
@@ -243,7 +250,7 @@ func (eds *ExtendedDataSquare) solveCrosswordCol(
 
 	// Insert rebuilt shares into square.
 	for r, s := range rebuiltShares {
-		eds.setCell(uint(r), uint(c), s)
+		eds.SetCell(uint(r), uint(c), s)
 	}
 
 	return true, true, nil