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

code hygiene: idiomatic error naming #24

Merged
merged 2 commits into from
Apr 3, 2021
Merged

Conversation

liamsi
Copy link
Member

@liamsi liamsi commented Apr 2, 2021

I've spend some time looking into refactoring and cleaning up rsmt2d. This is the first of a few smaller PRs in this direction:

  • prefix errors with Err
  • remove tracking EDS in errors

@liamsi liamsi requested review from adlerjohn and evan-forbes April 2, 2021 22:30
@liamsi liamsi marked this pull request as ready for review April 2, 2021 22:30
Copy link
Member

@evan-forbes evan-forbes left a comment

Choose a reason for hiding this comment

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

👍

// ByzantineColumnError is thrown when there is a repaired column does not match the expected column merkle root.
type ByzantineColumnError struct {
ColumnNumber uint
LastGoodSquare ExtendedDataSquare
Copy link
Member Author

@liamsi liamsi Apr 3, 2021

Choose a reason for hiding this comment

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

Is it really OK to remove this LastGoodSquare? It's currently not really used but I'm not sure if this will be needed to proof that this column was actually byzantine? (cc @adlerjohn) (same for rows below)

In other words, will this be useful to construct these: https://github.com/lazyledger/lazyledger-specs/blob/master/specs/data_structures.md#badencodingfraudproof ?

Copy link
Member

@adlerjohn adlerjohn Apr 3, 2021

Choose a reason for hiding this comment

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

I don't really see the need for returning a backup copy of the entire square?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, that's what I thought too. Thanks for confirming. The data is in the hands of the caller anyways. If required, the caller can construct everything from the row/col index and the data again (not sure if they need to in any case though).

It would help if the spec actually explained under what circumstances nodes and (which nodes?) would construct a BadEncodingProof from what data. Should I open an issue about that?

Copy link
Member

@adlerjohn adlerjohn Apr 3, 2021

Choose a reason for hiding this comment

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

Should I open an issue about that?

Maybe a comment in celestiaorg/celestia-specs#23 that explains what specifically you want to see? I'm going to start working on Evidence relatively soon.

Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

Yes, thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants