chore: add debug info to ErrPartSetInvalidProof (#1875)

rootulp · web-flow · commit ba4d47684ed5 · 2025-05-28T13:08:30.000+02:00
Part of celestiaorg/celestia-app#4859 ## Motivation Currently the two instances where `ErrPartSetInvalidProof` is returned look identical. This PR modifies the errors so to include additional information that will help with debugging.
diff --git a/types/part_set.go b/types/part_set.go
@@ -301,12 +301,12 @@ func (ps *PartSet) AddPart(part *Part) (bool, error) {
 
 	// The proof should be compatible with the number of parts.
 	if part.Proof.Total != int64(ps.total) {
-		return false, ErrPartSetInvalidProof
+		return false, fmt.Errorf("%w: part.Proof.Total: %d != ps.total: %d", ErrPartSetInvalidProof, part.Proof.Total, ps.total)
 	}
 
 	// Check hash proof
-	if part.Proof.Verify(ps.Hash(), part.Bytes) != nil {
-		return false, ErrPartSetInvalidProof
+	if err := part.Proof.Verify(ps.Hash(), part.Bytes); err != nil {
+		return false, fmt.Errorf("%w: part.Proof.Verify(ps.Hash(), part.Bytes) = %v", ErrPartSetInvalidProof, err)
 	}
 
 	return ps.AddPartWithoutProof(part)

Original file line number	Diff line number	Diff line change
`@@ -301,12 +301,12 @@ func (ps PartSet) AddPart(part Part) (bool, error) {`
`301`	`301`
`302`	`302`	`// The proof should be compatible with the number of parts.`
`303`	`303`	`if part.Proof.Total != int64(ps.total) {`
`304`		`- return false, ErrPartSetInvalidProof`
	`304`	`+ return false, fmt.Errorf("%w: part.Proof.Total: %d != ps.total: %d", ErrPartSetInvalidProof, part.Proof.Total, ps.total)`
`305`	`305`	`}`
`306`	`306`
`307`	`307`	`// Check hash proof`
`308`		`- if part.Proof.Verify(ps.Hash(), part.Bytes) != nil {`
`309`		`- return false, ErrPartSetInvalidProof`
	`308`	`+ if err := part.Proof.Verify(ps.Hash(), part.Bytes); err != nil {`
	`309`	`+ return false, fmt.Errorf("%w: part.Proof.Verify(ps.Hash(), part.Bytes) = %v", ErrPartSetInvalidProof, err)`
`310`	`310`	`}`
`311`	`311`
`312`	`312`	`return ps.AddPartWithoutProof(part)`