hyperledger / fabric-x-common / 36576186420

82%

main: 82%

Pull #191

github

[committerpb] Add the abort snapshot transaction status and key encoding

#### Type of change

- New feature

#### Description

- `SnapshotState.Status` gains `ABORTED = 6`: terminal, meaning the snapshot will not be
  hashed. Written only by the validator-committer when an abort snapshot transaction
  commits, the rule `CHECKPOINTED` already follows, and never by the snapshot hasher.
- `MALFORMED_SNAPSHOT_INVALID_ABORT_KEY = 122`: an abort transaction's read-write key does
  not decode as an abort key.
- `REJECTED_SNAPSHOT_ABORT_NO_SUCH_SNAPSHOT = 123`: a well-formed abort key naming a block
  that is not the snapshot awaiting its checkpoint, or one whose lifecycle is already
  closed. Both are per-transaction rejections rather than failures, because the submitter
  chose the block number and local state is not in question.
- `MALFORMED_SNAPSHOT_NOT_MARKER_ONLY`'s comment is updated: a `_snapshot` TX is now valid
  in two shapes, a marker-only snapshot request and an abort carrying exactly one
  read-write.
- `SnapshotAbortKey(blockNum)` builds the `_snapshot` write key of an abort snapshot
  transaction: the `\xffabort/` prefix followed by the block number, encoded order-preserving
  as a checkpoint key is. The leading raw `0xff` byte cannot occur in valid UTF-8 transaction
  IDs, which the sidecar already enforces; no hex-ID assumption is needed.
- `IsSnapshotAbortKey` inspects the prefix only, so a prefixed key whose block number does
  not decode is rejected as a malformed abort rather than mistaken for a snapshot request.
- `BlockNumFromSnapshotAbortKey` decodes the block number and rejects trailing bytes rather
  than ignoring them: accepting a prefix would attribute the abort to the wrong snapshot.
- `snapshot.pb.go` and `status.pb.go` regenerated via `make proto`.

#### Additional details (Optional)

The key encoding lives in this module rather than in fabric-x-committer because the only
legitimate submitter of an abort is an administrator, w... (continued)

17 of 17 new or added lines in 1 file covered. (100.0%)

13677 of 16671 relevant lines covered (82.04%)

0.82 hits per line