mirror of
https://github.com/tendermint/tendermint.git
synced 2026-01-10 15:07:24 +00:00
431618cef6
We first introduced auto-update as a separate struct AutoClient, which
was wrapping Client and calling Update periodically.
// AutoClient can auto update itself by fetching headers every N seconds.
type AutoClient struct {
base *Client
updatePeriod time.Duration
quit chan struct{}
trustedHeaders chan *types.SignedHeader
errs chan error
}
// NewAutoClient creates a new client and starts a polling goroutine.
func NewAutoClient(base *Client, updatePeriod time.Duration) *AutoClient {
c := &AutoClient{
base: base,
updatePeriod: updatePeriod,
quit: make(chan struct{}),
trustedHeaders: make(chan *types.SignedHeader),
errs: make(chan error),
}
go c.autoUpdate()
return c
}
// TrustedHeaders returns a channel onto which new trusted headers are posted.
func (c *AutoClient) TrustedHeaders() <-chan *types.SignedHeader {
return c.trustedHeaders
}
// Err returns a channel onto which errors are posted.
func (c *AutoClient) Errs() <-chan error {
return c.errs
}
// Stop stops the client.
func (c *AutoClient) Stop() {
close(c.quit)
}
func (c *AutoClient) autoUpdate() {
ticker := time.NewTicker(c.updatePeriod)
defer ticker.Stop()
for {
select {
case <-ticker.C:
lastTrustedHeight, err := c.base.LastTrustedHeight()
if err != nil {
c.errs <- err
continue
}
if lastTrustedHeight == -1 {
// no headers yet => wait
continue
}
newTrustedHeader, err := c.base.Update(time.Now())
if err != nil {
c.errs <- err
continue
}
if newTrustedHeader != nil {
c.trustedHeaders <- newTrustedHeader
}
case <-c.quit:
return
}
}
}
Later we merged it into the Client itself with the assumption that most clients will want it.
But now I am not sure. Neither IBC nor cosmos/relayer are using it. It increases complexity (Start/Stop methods).
That said, I think it makes sense to remove it until we see a need for it (until we better understand usage behavior). We can always introduce it later 😅. Maybe in the form of AutoClient.
169 lines
3.4 KiB
Go
169 lines
3.4 KiB
Go
package lite
|
|
|
|
import (
|
|
"fmt"
|
|
"io/ioutil"
|
|
stdlog "log"
|
|
"os"
|
|
"testing"
|
|
"time"
|
|
|
|
dbm "github.com/tendermint/tm-db"
|
|
|
|
"github.com/tendermint/tendermint/abci/example/kvstore"
|
|
"github.com/tendermint/tendermint/lite2/provider"
|
|
httpp "github.com/tendermint/tendermint/lite2/provider/http"
|
|
dbs "github.com/tendermint/tendermint/lite2/store/db"
|
|
rpctest "github.com/tendermint/tendermint/rpc/test"
|
|
)
|
|
|
|
// Automatically getting new headers and verifying them.
|
|
func ExampleClient_Update() {
|
|
// give Tendermint time to generate some blocks
|
|
time.Sleep(5 * time.Second)
|
|
|
|
dbDir, err := ioutil.TempDir("", "lite-client-example")
|
|
if err != nil {
|
|
stdlog.Fatal(err)
|
|
}
|
|
defer os.RemoveAll(dbDir)
|
|
|
|
var (
|
|
config = rpctest.GetConfig()
|
|
chainID = config.ChainID()
|
|
)
|
|
|
|
primary, err := httpp.New(chainID, config.RPC.ListenAddress)
|
|
if err != nil {
|
|
stdlog.Fatal(err)
|
|
}
|
|
|
|
header, err := primary.SignedHeader(2)
|
|
if err != nil {
|
|
stdlog.Fatal(err)
|
|
}
|
|
|
|
db, err := dbm.NewGoLevelDB("lite-client-db", dbDir)
|
|
if err != nil {
|
|
stdlog.Fatal(err)
|
|
}
|
|
|
|
c, err := NewClient(
|
|
chainID,
|
|
TrustOptions{
|
|
Period: 504 * time.Hour, // 21 days
|
|
Height: 2,
|
|
Hash: header.Hash(),
|
|
},
|
|
primary,
|
|
[]provider.Provider{primary}, // NOTE: primary should not be used here
|
|
dbs.New(db, chainID),
|
|
// Logger(log.TestingLogger()),
|
|
)
|
|
if err != nil {
|
|
stdlog.Fatal(err)
|
|
}
|
|
defer func() {
|
|
c.Cleanup()
|
|
}()
|
|
|
|
time.Sleep(2 * time.Second)
|
|
|
|
// XXX: 30 * time.Minute clock drift is needed because a) Tendermint strips
|
|
// monotonic component (see types/time/time.go) b) single instance is being
|
|
// run.
|
|
// https://github.com/tendermint/tendermint/issues/4489
|
|
err = c.Update(time.Now().Add(30 * time.Minute))
|
|
if err != nil {
|
|
stdlog.Fatal(err)
|
|
}
|
|
|
|
h, err := c.TrustedHeader(0)
|
|
if err != nil {
|
|
stdlog.Fatal(err)
|
|
}
|
|
|
|
if h.Height > 2 {
|
|
fmt.Println("successful update")
|
|
} else {
|
|
fmt.Println("update failed")
|
|
}
|
|
// Output: successful update
|
|
}
|
|
|
|
// Manually getting headers and verifying them.
|
|
func ExampleClient_VerifyHeaderAtHeight() {
|
|
// give Tendermint time to generate some blocks
|
|
time.Sleep(5 * time.Second)
|
|
|
|
dbDir, err := ioutil.TempDir("", "lite-client-example")
|
|
if err != nil {
|
|
stdlog.Fatal(err)
|
|
}
|
|
defer os.RemoveAll(dbDir)
|
|
|
|
var (
|
|
config = rpctest.GetConfig()
|
|
chainID = config.ChainID()
|
|
)
|
|
|
|
primary, err := httpp.New(chainID, config.RPC.ListenAddress)
|
|
if err != nil {
|
|
stdlog.Fatal(err)
|
|
}
|
|
|
|
header, err := primary.SignedHeader(2)
|
|
if err != nil {
|
|
stdlog.Fatal(err)
|
|
}
|
|
|
|
db, err := dbm.NewGoLevelDB("lite-client-db", dbDir)
|
|
if err != nil {
|
|
stdlog.Fatal(err)
|
|
}
|
|
|
|
c, err := NewClient(
|
|
chainID,
|
|
TrustOptions{
|
|
Period: 504 * time.Hour, // 21 days
|
|
Height: 2,
|
|
Hash: header.Hash(),
|
|
},
|
|
primary,
|
|
[]provider.Provider{primary}, // NOTE: primary should not be used here
|
|
dbs.New(db, chainID),
|
|
// Logger(log.TestingLogger()),
|
|
)
|
|
if err != nil {
|
|
stdlog.Fatal(err)
|
|
}
|
|
defer func() {
|
|
c.Cleanup()
|
|
}()
|
|
|
|
_, err = c.VerifyHeaderAtHeight(3, time.Now())
|
|
if err != nil {
|
|
stdlog.Fatal(err)
|
|
}
|
|
|
|
h, err := c.TrustedHeader(3)
|
|
if err != nil {
|
|
stdlog.Fatal(err)
|
|
}
|
|
|
|
fmt.Println("got header", h.Height)
|
|
// Output: got header 3
|
|
}
|
|
|
|
func TestMain(m *testing.M) {
|
|
// start a tendermint node (and kvstore) in the background to test against
|
|
app := kvstore.NewApplication()
|
|
node := rpctest.StartTendermint(app, rpctest.SuppressStdout)
|
|
|
|
code := m.Run()
|
|
|
|
// and shut down proper at the end
|
|
rpctest.StopTendermint(node)
|
|
os.Exit(code)
|
|
}
|