change(state): Check database format is valid on shutdown, to catch format errors in new block code

[teor2345]

Motivation

We want to catch format errors in new block code. But currently that code is only tested when Zebra adds new blocks, then shuts down, then opens the same state. So PRs can merge with bugs in that code.

Instead, we check the format is valid before Zebra shuts down. This tells users early if they need to re-sync their state, rather than surprising them the next time they launch Zebra.

It also prevents us writing invalid cached states in CI.

Close #7570.

Complex Code or Requirements

I think a panic on shutdown should fail CI, but I haven't checked to make sure. Do you think it's worth doing that manually?

Solution

• Tell the user what to do when the database format is invalid
• Check the database format before Zebra shuts down

Related Refactors:

• Split a path-based database version method

Review

This is optional for the release.

Reviewer Checklist

• Will the PR name make sense to users?
  • Does it need extra CHANGELOG info? (new features, breaking changes, large changes)
• Are the PR labels correct?
• Does the code do what the ticket and PR says?
  • Does it change concurrent code, unsafe code, or consensus rules?
• How do you know it works? Does it have tests?

Follow Up Work

We could replace a whole lot of config arguments with the database and version paths, but that can happen later if needed. Storing an Arc<Config> isn't that expensive.

[upbqdn]

I think a panic on shutdown should fail CI, but I haven't checked to make sure. Do you think it's worth doing that manually?

I don't think so.

The base branch was changed.