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.

Sign up for GitHub

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

Sentinel Root Fix #234

Merged
merged 7 commits into from
Jul 6, 2021
Merged

Sentinel Root Fix #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
23579bf
fix sentinel value
AdityaSripal Jul 6, 2021
a8216a5
Merge branch 'main' into aditya/sentinel_root
colin-axner Jul 6, 2021
1fe41ba
add godoc and test
colin-axner Jul 6, 2021
bf0e296
Merge branch 'aditya/sentinel_root' of github.com:cosmos/ibc-go into …
colin-axner Jul 6, 2021
71848cb
fix grammar
colin-axner Jul 6, 2021
7697a18
add changelog
colin-axner Jul 6, 2021
171d214
Merge branch 'main' into aditya/sentinel_root
colin-axner Jul 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Ref: https://keepachangelog.com/en/1.0.0/

### Bug Fixes

* (07-tendermint) [\#234](https://github.com/cosmos/ibc-go/pull/234) Use sentinel value for the consensus state root set during a client upgrade. This prevents genesis validation from failing.
* (modules) [\#223](https://github.com/cosmos/ibc-go/pull/223) Use correct Prometheus format for metric labels.
* (06-solomachine) [\#214](https://github.com/cosmos/ibc-go/pull/214) Disable defensive timestamp check in SendPacket for solo machine clients.
* (07-tendermint) [\#210](https://github.com/cosmos/ibc-go/pull/210) Export all consensus metadata on genesis restarts for tendermint clients.
Expand Down
3 changes: 3 additions & 0 deletions modules/light-clients/07-tendermint/types/consensus_state.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ import (
"github.com/cosmos/ibc-go/modules/core/exported"
)

// SentinelRoot is used as a stand-in root value for the consensus state set at the upgrade height
const SentinelRoot = "sentinel_root"
colin-axner marked this conversation as resolved.
Show resolved Hide resolved

// NewConsensusState creates a new ConsensusState instance.
func NewConsensusState(
timestamp time.Time, root commitmenttypes.MerkleRoot, nextValsHash tmbytes.HexBytes,
Expand Down
7 changes: 7 additions & 0 deletions modules/light-clients/07-tendermint/types/consensus_state_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,13 @@ func (suite *TendermintTestSuite) TestConsensusStateValidateBasic() {
NextValidatorsHash: suite.valsHash,
},
true},
{"success with sentinel",
&types.ConsensusState{
Timestamp: suite.now,
Root: commitmenttypes.NewMerkleRoot([]byte(types.SentinelRoot)),
NextValidatorsHash: suite.valsHash,
},
true},
{"root is nil",
&types.ConsensusState{
Timestamp: suite.now,
Expand Down
4 changes: 2 additions & 2 deletions modules/light-clients/07-tendermint/types/upgrade.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,14 +108,14 @@ func (cs ClientState) VerifyUpgradeAndUpdateState(
}

// The new consensus state is merely used as a trusted kernel against which headers on the new
// chain can be verified. The root is empty as it cannot be known in advance, thus no proof verification will pass.
// chain can be verified. The root is just a stand-in sentinel value as it cannot be known in advance, thus no proof verification will pass.
// The timestamp and the NextValidatorsHash of the consensus state is the blocktime and NextValidatorsHash
// of the last block committed by the old chain. This will allow the first block of the new chain to be verified against
// the last validators of the old chain so long as it is submitted within the TrustingPeriod of this client.
// NOTE: We do not set processed time for this consensus state since this consensus state should not be used for packet verification
// as the root is empty. The next consensus state submitted using update will be usable for packet-verification.
newConsState := NewConsensusState(
tmUpgradeConsState.Timestamp, commitmenttypes.MerkleRoot{}, tmUpgradeConsState.NextValidatorsHash,
tmUpgradeConsState.Timestamp, commitmenttypes.NewMerkleRoot([]byte(SentinelRoot)), tmUpgradeConsState.NextValidatorsHash,
)

// set metadata for this consensus state
Expand Down