Fix JSON serialization of timestamp field for CommitSig::BlockIdFlagAbsent
#1353
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…agAbsent`
`CommitSig::BlockIdFlagAbsent` currently serializes to JSON as
```json
{
"block_id_flag": 1,
"validator_address": "",
"timestamp": "1970-01-01T00:00:00Z",
"signature": ""
}```
which fails the CometBFT check `CommitSig.ValidateBasic()` with `time is present`
This check is performed as
```go
switch cs.BlockIDFlag {
case BlockIDFlagAbsent:
if len(cs.ValidatorAddress) != 0 {
return errors.New("validator address is present")
}
if !cs.Timestamp.IsZero() {
return errors.New("time is present")
}
```
`IsZero()` is defined as
```go
// IsZero reports whether t represents the zero time instant,
// January 1, year 1, 00:00:00 UTC.
func (t Time) IsZero() bool {
return t.sec() == 0 && t.nsec() == 0
}
```
From the documentation of the `Time` struct, we see that it expects a
zero time to be `0001-01-01T00:00:00Z` and not `1970-01-01T00:00:00Z`:
```go
// The zero value for a Time is defined to be
// January 1, year 1, 00:00:00.000000000 UTC
// which (1) looks like a zero, or as close as you can get in a date
// (1-1-1 00:00:00 UTC), (2) is unlikely enough to arise in practice to
// be a suitable "not set" sentinel, unlike Jan 1 1970, and (3) has a
// non-negative year even in time zones west of UTC, unlike 1-1-0
// 00:00:00 UTC, which would be 12-31-(-1) 19:00:00 in New York.
```
This PR fixes this discrepency for the case of `BlockIDFlagAbsent`.
There may be other instances where the timestamp is formatted
incorrectly, but those haven't been seen in production yet.
We should follow-up on that eventually.
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See #1352 for the rationale behind this fix.
.changelog/