mirror of
https://github.com/tendermint/tendermint.git
synced 2026-01-07 05:46:32 +00:00
fb8b00f1d8
Refs #1771 ADR: https://github.com/tendermint/tendermint/blob/master/docs/architecture/adr-044-lite-client-with-weak-subjectivity.md ## Commits: * add Verifier and VerifyCommitTrusting * add two more checks make trustLevel an option * float32 for trustLevel * check newHeader time * started writing lite Client * unify Verify methods * ensure h2.Header.bfttime < h1.Header.bfttime + tp * move trust checks into Verify function * add more comments * more docs * started writing tests * unbonding period failures * tests are green * export ErrNewHeaderTooFarIntoFuture * make golangci happy * test for non-adjusted headers * more precision * providers and stores * VerifyHeader and VerifyHeaderAtHeight funcs * fix compile errors * remove lastVerifiedHeight, persist new trusted header * sequential verification * remove TrustedStore option * started writing tests for light client * cover basic cases for linear verification * bisection tests PASS * rename BisectingVerification to SkippingVerification * refactor the code * add TrustedHeader method * consolidate sequential verification tests * consolidate skipping verification tests * rename trustedVals to trustedNextVals * start writing docs * ValidateTrustLevel func and ErrOldHeaderExpired error * AutoClient and example tests * fix errors * update doc * remove ErrNewHeaderTooFarIntoFuture This check is unnecessary given existing a) ErrOldHeaderExpired b) h2.Time > now checks. * return an error if we're at more recent height * add comments * add LastSignedHeaderHeight method to Store I think it's fine if Store tracks last height * copy over proxy from old lite package * make TrustedHeader return latest if height=0 * modify LastSignedHeaderHeight to return an error if no headers exist * copy over proxy impl * refactor proxy and start http lite client * Tx and BlockchainInfo methods * Block method * commit method * code compiles again * lite client compiles * extract updateLiteClientIfNeededTo func * move final parts * add placeholder for tests * force usage of lite http client in proxy * comment out query tests for now * explicitly mention tp: trusting period * verify nextVals in VerifyHeader * refactor bisection * move the NextValidatorsHash check into updateTrustedHeaderAndVals + update the comment * add ConsensusParams method to RPC client * add ConsensusParams to rpc/mock/client * change trustLevel type to a new cmn.Fraction type + update SkippingVerification comment * stress out trustLevel is only used for non-adjusted headers * fixes after Fede's review Co-authored-by: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * compare newHeader with a header from an alternative provider * save pivot header Refs https://github.com/tendermint/tendermint/pull/3989#discussion_r349122824 * check header can still be trusted in TrustedHeader Refs https://github.com/tendermint/tendermint/pull/3989#discussion_r349101424 * lite: update Validators and Block endpoints - Block no longer contains BlockMeta - Validators now accept two additional params: page and perPage * make linter happy
280 lines
8.1 KiB
Go
280 lines
8.1 KiB
Go
package lite
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
cmn "github.com/tendermint/tendermint/libs/common"
|
|
"github.com/tendermint/tendermint/types"
|
|
)
|
|
|
|
func TestVerifyAdjustedHeaders(t *testing.T) {
|
|
const (
|
|
chainID = "TestVerifyAdjustedHeaders"
|
|
lastHeight = 1
|
|
nextHeight = 2
|
|
)
|
|
|
|
var (
|
|
keys = genPrivKeys(4)
|
|
// 20, 30, 40, 50 - the first 3 don't have 2/3, the last 3 do!
|
|
vals = keys.ToValidators(20, 10)
|
|
bTime, _ = time.Parse(time.RFC3339, "2006-01-02T15:04:05Z")
|
|
header = keys.GenSignedHeader(chainID, lastHeight, bTime, nil, vals, vals,
|
|
[]byte("app_hash"), []byte("cons_hash"), []byte("results_hash"), 0, len(keys))
|
|
)
|
|
|
|
testCases := []struct {
|
|
newHeader *types.SignedHeader
|
|
newVals *types.ValidatorSet
|
|
trustingPeriod time.Duration
|
|
now time.Time
|
|
expErr error
|
|
expErrText string
|
|
}{
|
|
// same header -> no error
|
|
0: {
|
|
header,
|
|
vals,
|
|
3 * time.Hour,
|
|
bTime.Add(2 * time.Hour),
|
|
nil,
|
|
"expected new header height 1 to be greater than one of old header 1",
|
|
},
|
|
// different chainID -> error
|
|
1: {
|
|
keys.GenSignedHeader("different-chainID", nextHeight, bTime.Add(1*time.Hour), nil, vals, vals,
|
|
[]byte("app_hash"), []byte("cons_hash"), []byte("results_hash"), 0, len(keys)),
|
|
vals,
|
|
3 * time.Hour,
|
|
bTime.Add(2 * time.Hour),
|
|
nil,
|
|
"h2.ValidateBasic failed: signedHeader belongs to another chain 'different-chainID' not 'TestVerifyAdjustedHeaders'",
|
|
},
|
|
// 3/3 signed -> no error
|
|
2: {
|
|
keys.GenSignedHeader(chainID, nextHeight, bTime.Add(1*time.Hour), nil, vals, vals,
|
|
[]byte("app_hash"), []byte("cons_hash"), []byte("results_hash"), 0, len(keys)),
|
|
vals,
|
|
3 * time.Hour,
|
|
bTime.Add(2 * time.Hour),
|
|
nil,
|
|
"",
|
|
},
|
|
// 2/3 signed -> no error
|
|
3: {
|
|
keys.GenSignedHeader(chainID, nextHeight, bTime.Add(1*time.Hour), nil, vals, vals,
|
|
[]byte("app_hash"), []byte("cons_hash"), []byte("results_hash"), 1, len(keys)),
|
|
vals,
|
|
3 * time.Hour,
|
|
bTime.Add(2 * time.Hour),
|
|
nil,
|
|
"",
|
|
},
|
|
// 1/3 signed -> error
|
|
4: {
|
|
keys.GenSignedHeader(chainID, nextHeight, bTime.Add(1*time.Hour), nil, vals, vals,
|
|
[]byte("app_hash"), []byte("cons_hash"), []byte("results_hash"), len(keys)-1, len(keys)),
|
|
vals,
|
|
3 * time.Hour,
|
|
bTime.Add(2 * time.Hour),
|
|
types.ErrTooMuchChange{Got: 50, Needed: 93},
|
|
"",
|
|
},
|
|
// vals does not match with what we have -> error
|
|
5: {
|
|
keys.GenSignedHeader(chainID, nextHeight, bTime.Add(1*time.Hour), nil, keys.ToValidators(10, 1), vals,
|
|
[]byte("app_hash"), []byte("cons_hash"), []byte("results_hash"), 0, len(keys)),
|
|
keys.ToValidators(10, 1),
|
|
3 * time.Hour,
|
|
bTime.Add(2 * time.Hour),
|
|
nil,
|
|
"to match those from new header",
|
|
},
|
|
// vals are inconsistent with newHeader -> error
|
|
6: {
|
|
keys.GenSignedHeader(chainID, nextHeight, bTime.Add(1*time.Hour), nil, vals, vals,
|
|
[]byte("app_hash"), []byte("cons_hash"), []byte("results_hash"), 0, len(keys)),
|
|
keys.ToValidators(10, 1),
|
|
3 * time.Hour,
|
|
bTime.Add(2 * time.Hour),
|
|
nil,
|
|
"to match those that were supplied",
|
|
},
|
|
// old header has expired -> error
|
|
7: {
|
|
keys.GenSignedHeader(chainID, nextHeight, bTime.Add(1*time.Hour), nil, vals, vals,
|
|
[]byte("app_hash"), []byte("cons_hash"), []byte("results_hash"), 0, len(keys)),
|
|
keys.ToValidators(10, 1),
|
|
1 * time.Hour,
|
|
bTime.Add(1 * time.Hour),
|
|
nil,
|
|
"old header has expired",
|
|
},
|
|
}
|
|
|
|
for i, tc := range testCases {
|
|
tc := tc
|
|
t.Run(fmt.Sprintf("#%d", i), func(t *testing.T) {
|
|
err := Verify(chainID, header, vals, tc.newHeader, tc.newVals, tc.trustingPeriod, tc.now, DefaultTrustLevel)
|
|
|
|
switch {
|
|
case tc.expErr != nil && assert.Error(t, err):
|
|
assert.Equal(t, tc.expErr, err)
|
|
case tc.expErrText != "":
|
|
assert.Contains(t, err.Error(), tc.expErrText)
|
|
default:
|
|
assert.NoError(t, err)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestVerifyNonAdjustedHeaders(t *testing.T) {
|
|
const (
|
|
chainID = "TestVerifyNonAdjustedHeaders"
|
|
lastHeight = 1
|
|
)
|
|
|
|
var (
|
|
keys = genPrivKeys(4)
|
|
// 20, 30, 40, 50 - the first 3 don't have 2/3, the last 3 do!
|
|
vals = keys.ToValidators(20, 10)
|
|
bTime, _ = time.Parse(time.RFC3339, "2006-01-02T15:04:05Z")
|
|
header = keys.GenSignedHeader(chainID, lastHeight, bTime, nil, vals, vals,
|
|
[]byte("app_hash"), []byte("cons_hash"), []byte("results_hash"), 0, len(keys))
|
|
|
|
// 30, 40, 50
|
|
twoThirds = keys[1:]
|
|
twoThirdsVals = twoThirds.ToValidators(30, 10)
|
|
|
|
// 50
|
|
oneThird = keys[len(keys)-1:]
|
|
oneThirdVals = oneThird.ToValidators(50, 10)
|
|
|
|
// 20
|
|
lessThanOneThird = keys[0:1]
|
|
lessThanOneThirdVals = lessThanOneThird.ToValidators(20, 10)
|
|
)
|
|
|
|
testCases := []struct {
|
|
newHeader *types.SignedHeader
|
|
newVals *types.ValidatorSet
|
|
trustingPeriod time.Duration
|
|
now time.Time
|
|
expErr error
|
|
expErrText string
|
|
}{
|
|
// 3/3 new vals signed, 3/3 old vals present -> no error
|
|
0: {
|
|
keys.GenSignedHeader(chainID, 3, bTime.Add(1*time.Hour), nil, vals, vals,
|
|
[]byte("app_hash"), []byte("cons_hash"), []byte("results_hash"), 0, len(keys)),
|
|
vals,
|
|
3 * time.Hour,
|
|
bTime.Add(2 * time.Hour),
|
|
nil,
|
|
"",
|
|
},
|
|
// 2/3 new vals signed, 3/3 old vals present -> no error
|
|
1: {
|
|
keys.GenSignedHeader(chainID, 4, bTime.Add(1*time.Hour), nil, vals, vals,
|
|
[]byte("app_hash"), []byte("cons_hash"), []byte("results_hash"), 1, len(keys)),
|
|
vals,
|
|
3 * time.Hour,
|
|
bTime.Add(2 * time.Hour),
|
|
nil,
|
|
"",
|
|
},
|
|
// 1/3 new vals signed, 3/3 old vals present -> error
|
|
2: {
|
|
keys.GenSignedHeader(chainID, 5, bTime.Add(1*time.Hour), nil, vals, vals,
|
|
[]byte("app_hash"), []byte("cons_hash"), []byte("results_hash"), len(keys)-1, len(keys)),
|
|
vals,
|
|
3 * time.Hour,
|
|
bTime.Add(2 * time.Hour),
|
|
types.ErrTooMuchChange{Got: 50, Needed: 93},
|
|
"",
|
|
},
|
|
// 3/3 new vals signed, 2/3 old vals present -> no error
|
|
3: {
|
|
twoThirds.GenSignedHeader(chainID, 5, bTime.Add(1*time.Hour), nil, twoThirdsVals, twoThirdsVals,
|
|
[]byte("app_hash"), []byte("cons_hash"), []byte("results_hash"), 0, len(twoThirds)),
|
|
twoThirdsVals,
|
|
3 * time.Hour,
|
|
bTime.Add(2 * time.Hour),
|
|
nil,
|
|
"",
|
|
},
|
|
// 3/3 new vals signed, 1/3 old vals present -> no error
|
|
4: {
|
|
oneThird.GenSignedHeader(chainID, 5, bTime.Add(1*time.Hour), nil, oneThirdVals, oneThirdVals,
|
|
[]byte("app_hash"), []byte("cons_hash"), []byte("results_hash"), 0, len(oneThird)),
|
|
oneThirdVals,
|
|
3 * time.Hour,
|
|
bTime.Add(2 * time.Hour),
|
|
nil,
|
|
"",
|
|
},
|
|
// 3/3 new vals signed, less than 1/3 old vals present -> error
|
|
5: {
|
|
lessThanOneThird.GenSignedHeader(chainID, 5, bTime.Add(1*time.Hour), nil, lessThanOneThirdVals, lessThanOneThirdVals,
|
|
[]byte("app_hash"), []byte("cons_hash"), []byte("results_hash"), 0, len(lessThanOneThird)),
|
|
lessThanOneThirdVals,
|
|
3 * time.Hour,
|
|
bTime.Add(2 * time.Hour),
|
|
types.ErrTooMuchChange{Got: 20, Needed: 46},
|
|
"",
|
|
},
|
|
}
|
|
|
|
for i, tc := range testCases {
|
|
tc := tc
|
|
t.Run(fmt.Sprintf("#%d", i), func(t *testing.T) {
|
|
err := Verify(chainID, header, vals, tc.newHeader, tc.newVals, tc.trustingPeriod, tc.now, DefaultTrustLevel)
|
|
|
|
switch {
|
|
case tc.expErr != nil && assert.Error(t, err):
|
|
assert.Equal(t, tc.expErr, err)
|
|
case tc.expErrText != "":
|
|
assert.Contains(t, err.Error(), tc.expErrText)
|
|
default:
|
|
assert.NoError(t, err)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestValidateTrustLevel(t *testing.T) {
|
|
testCases := []struct {
|
|
lvl cmn.Fraction
|
|
valid bool
|
|
}{
|
|
// valid
|
|
0: {cmn.Fraction{Numerator: 1, Denominator: 1}, true},
|
|
1: {cmn.Fraction{Numerator: 1, Denominator: 3}, true},
|
|
2: {cmn.Fraction{Numerator: 2, Denominator: 3}, true},
|
|
3: {cmn.Fraction{Numerator: 3, Denominator: 3}, true},
|
|
4: {cmn.Fraction{Numerator: 4, Denominator: 5}, true},
|
|
|
|
// invalid
|
|
5: {cmn.Fraction{Numerator: 6, Denominator: 5}, false},
|
|
6: {cmn.Fraction{Numerator: -1, Denominator: 3}, false},
|
|
7: {cmn.Fraction{Numerator: 0, Denominator: 1}, false},
|
|
8: {cmn.Fraction{Numerator: -1, Denominator: -3}, false},
|
|
9: {cmn.Fraction{Numerator: 0, Denominator: 0}, false},
|
|
10: {cmn.Fraction{Numerator: 1, Denominator: 0}, false},
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
err := ValidateTrustLevel(tc.lvl)
|
|
if !tc.valid {
|
|
assert.Error(t, err)
|
|
} else {
|
|
assert.NoError(t, err)
|
|
}
|
|
}
|
|
}
|