Limit finalized header gap #1156

claravanstaden · 2024-03-13T11:31:37Z

Adds the following:

an interim finalized update between sync committee updates if the headers are more than 1982 slots apart
a MySQLite datastore to store metadata and ssz blobs on disk. Prunes after X number of states.
command to store ssz states on disk - should be configured to run with cron twice a day or so
extract interfaces so that we can easier write tests and get coverage up for the relayer. While the relayer is not part of our on-chain code, it is vital to our bridge and can stall the bridge if buggy

relayer/relays/beacon/header/header.go

relayer/relays/beacon/header/syncer/syncer.go

# Conflicts: # relayer/relays/beacon/header/header.go # relayer/relays/beacon/state/beacon_deneb_encoding.go # relayer/relays/beacon/state/beacon_encoding.go

yrong · 2024-03-18T06:43:30Z

relayer/relays/beacon/store/datastore.go

Assuming we have configured a fallback client which can fetch the beacon state for arbitrary slots. Do we still need to store the beacon state in a local db here? Is that for another kind of fallback?

I have removed the fallback client since I encountered similar issues with Prysm that we are having with Lodestar. I think fundamentally relying on the beacon node and its config is risky. I think the beacon store adds a layer of reassurance that we'll be able to get the proofs we need if our bridge goes offline for an extended period.

claravanstaden · 2024-03-18T14:25:02Z

relayer/chain/parachain/writer.go

+	BatchCall(ctx context.Context, extrinsic string, calls []interface{}) error
+	WriteToParachainAndRateLimit(ctx context.Context, extrinsicName string, payload ...interface{}) error
+	WriteToParachainAndWatch(ctx context.Context, extrinsicName string, payload ...interface{}) error
+	GetLastFinalizedHeaderState() (state.FinalizedHeader, error)
+	GetFinalizedStateByStorageKey(key string) (scale.BeaconState, error)
+	GetLastBasicChannelBlockNumber() (uint64, error)
+	GetLastBasicChannelNonceByAddress(address common.Address) (uint64, error)
+	GetFinalizedHeaderStateByBlockRoot(blockRoot types.H256) (state.FinalizedHeader, error)
+	GetCompactExecutionHeaderStateByBlockHash(blockHash types.H256) (state.CompactExecutionHeaderState, error)
+	GetLastFinalizedStateIndex() (types.U32, error)
+	GetFinalizedBeaconRootByIndex(index uint32) (types.H256, error)


Extract interfaces that we can mock out in tests.

claravanstaden · 2024-03-18T14:25:30Z

relayer/chain/parachain/writer.go

+func (wr *ParachainWriter) writeToParachain(ctx context.Context, extrinsicName string, payload ...interface{}) (*author.ExtrinsicStatusSubscription, error) {
+	extI, err := wr.prepExtrinstic(ctx, extrinsicName, payload...)
+	if err != nil {
+		return nil, err
+	}
+
+	sub, err := wr.conn.API().RPC.Author.SubmitAndWatchExtrinsic(*extI)
+	if err != nil {
+		return nil, err
+	}
+
+	return sub, nil
+}
+
+func (wr *ParachainWriter) queryAccountNonce() (uint32, error) {
+	key, err := types.CreateStorageKey(wr.conn.Metadata(), "System", "Account", wr.conn.Keypair().PublicKey, nil)
+	if err != nil {
+		return 0, err
+	}
+
+	var accountInfo types.AccountInfo
+	ok, err := wr.conn.API().RPC.State.GetStorageLatest(key, &accountInfo)
+	if err != nil {
+		return 0, err
+	}
+	if !ok {
+		return 0, fmt.Errorf("no account info found for %s", wr.conn.Keypair().URI)
+	}
+
+	return uint32(accountInfo.Nonce), nil
+}
+
+func (wr *ParachainWriter) prepExtrinstic(ctx context.Context, extrinsicName string, payload ...interface{}) (*types.Extrinsic, error) {
+	meta, err := wr.conn.API().RPC.State.GetMetadataLatest()
+	if err != nil {
+		return nil, err
+	}
+
+	c, err := types.NewCall(meta, extrinsicName, payload...)
+	if err != nil {
+		return nil, err
+	}
+
+	latestHash, err := wr.conn.API().RPC.Chain.GetFinalizedHead()
+	if err != nil {
+		return nil, err
+	}
+
+	latestBlock, err := wr.conn.API().RPC.Chain.GetBlock(latestHash)
+	if err != nil {
+		return nil, err
+	}
+
+	ext := types.NewExtrinsic(c)
+	era := NewMortalEra(uint64(latestBlock.Block.Header.Number))
+
+	genesisHash, err := wr.conn.API().RPC.Chain.GetBlockHash(0)
+	if err != nil {
+		return nil, err
+	}
+
+	rv, err := wr.conn.API().RPC.State.GetRuntimeVersionLatest()
+	if err != nil {
+		return nil, err
+	}
+
+	o := types.SignatureOptions{
+		BlockHash:          latestHash,
+		Era:                era,
+		GenesisHash:        genesisHash,
+		Nonce:              types.NewUCompactFromUInt(uint64(wr.nonce)),
+		SpecVersion:        rv.SpecVersion,
+		Tip:                types.NewUCompactFromUInt(0),
+		TransactionVersion: rv.TransactionVersion,
+	}
+
+	extI := ext
+
+	err = extI.Sign(*wr.conn.Keypair(), o)
+	if err != nil {
+		return nil, err
+	}
+
+	return &extI, nil
+}
+
+func (wr *ParachainWriter) prepCall(extrinsicName string, payload ...interface{}) (*types.Call, error) {
+	meta, err := wr.conn.API().RPC.State.GetMetadataLatest()
+	if err != nil {
+		return nil, err
+	}
+
+	c, err := types.NewCall(meta, extrinsicName, payload...)
+	if err != nil {
+		return nil, err
+	}
+	return &c, nil
+}
+


Just reordered the private methods.

yrong · 2024-03-19T13:52:12Z

relayer/relays/beacon/header/header.go

 		if checkpointSlot == 0 {
-			log.WithFields(log.Fields{"calculatedCheckpointSlot": checkpointSlot}).Info("checkpoint slot not available, try with slot in next sync period instead")
-			checkpointSlot = h.syncer.CalculateNextCheckpointSlot(slot)
-			lastFinalizedHeaderState, err := h.writer.GetLastFinalizedHeaderState()
+			checkpointSlot, err = h.populateCheckPointCacheWithDataFromChain(slot, checkpointSlot)


A bit weird this function is called with checkpointSlot as const zero, then could it be simplified as h.populateCheckPointCacheWithDataFromChain(slot)?

That's a good point! de118ca

relayer/relays/beacon/header/header.go

yrong · 2024-03-19T13:59:58Z

relayer/relays/beacon/header/header.go

 func (h *Header) getHeaderUpdateBySlot(slot uint64) (scale.HeaderUpdatePayload, error) {
+	slot = slot + 1


Is adding this line correctly and the smoke test register_token still work? I don't think we need it.

Good catch 😄 0da2b16

yrong · 2024-03-19T14:08:51Z

relayer/relays/beacon/header/header.go

@@ -386,3 +457,40 @@ func (h *Header) isInitialSyncPeriod() bool {
 	lastFinalizedPeriod := h.syncer.ComputeSyncPeriodAtSlot(h.cache.Finalized.LastSyncedSlot)
 	return initialPeriod == lastFinalizedPeriod
 }
+
+func (h *Header) findClosestCheckPoint(slot uint64) (state.FinalizedHeader, error) {


IIUC it's not closest anymore instead the most distant. So the previous name findCheckPointBackward make more sense here?

Renamed here b5334dc.

# Conflicts: # relayer/cmd/root.go # relayer/relays/beacon/header/header.go # relayer/relays/beacon/state/beacon_deneb_encoding.go # relayer/relays/beacon/state/beacon_encoding.go

yrong

+1

…o limit-finalized-headers-gap

* construct finalized update * extract interfaces for tests * mock data and tests * adds db store * completes db store * test works * cleanup and fixes * cleanup and fixes * tests * relayer progress * finish tests * formatting * move the interim finalized header check * fix ci * fix ci * adds working dir * go mod download * version * wrap go version * update * add gopath to bin * install sszgen * missing go install * remove build * skip utility tests * remove unused file * remove test line * rename method * refactor method * Fix compile error and breaking tests * clean up imports * fix duplicate import --------- Co-authored-by: claravanstaden <Cats 4 life!> Co-authored-by: ron <[email protected]>

construct finalized update

024159d

yrong reviewed Mar 13, 2024

View reviewed changes

relayer/relays/beacon/header/header.go Outdated Show resolved Hide resolved

yrong reviewed Mar 13, 2024

View reviewed changes

relayer/relays/beacon/header/header.go Outdated Show resolved Hide resolved

yrong reviewed Mar 13, 2024

View reviewed changes

relayer/relays/beacon/header/syncer/syncer.go Show resolved Hide resolved

claravanstaden added 9 commits March 14, 2024 12:26

extract interfaces for tests

42b62c8

mock data and tests

e3e1247

adds db store

8ccbc4f

Merge branch 'main' into limit-finalized-headers-gap

9ba62db

# Conflicts: # relayer/relays/beacon/header/header.go # relayer/relays/beacon/state/beacon_deneb_encoding.go # relayer/relays/beacon/state/beacon_encoding.go

completes db store

9e1582c

test works

a5d88bb

cleanup and fixes

98a713d

cleanup and fixes

106e9ce

tests

b66be24

yrong reviewed Mar 18, 2024

View reviewed changes

claravanstaden added 16 commits March 18, 2024 15:22

relayer progress

a237b1b

finish tests

04a5213

formatting

ebeb5e3

move the interim finalized header check

dd46c65

fix ci

c0b3f11

fix ci

4d9ee30

adds working dir

82e37e9

go mod download

bd632f5

version

82ffe26

wrap go version

9271dfc

update

e9d254d

add gopath to bin

e15e4bd

install sszgen

2c994cc

missing go install

d118781

remove build

46e2ebe

skip utility tests

5431c57

claravanstaden marked this pull request as ready for review March 18, 2024 14:23

claravanstaden commented Mar 18, 2024

View reviewed changes

claravanstaden requested review from yrong, vgeddes and alistair-singh March 18, 2024 14:26

yrong reviewed Mar 19, 2024

View reviewed changes

relayer/relays/beacon/header/header.go Outdated Show resolved Hide resolved

yrong reviewed Mar 19, 2024

View reviewed changes

vgeddes approved these changes Mar 19, 2024

View reviewed changes

claravanstaden added 5 commits March 20, 2024 14:23

Merge branch 'main' into limit-finalized-headers-gap

8673521

# Conflicts: # relayer/cmd/root.go # relayer/relays/beacon/header/header.go # relayer/relays/beacon/state/beacon_deneb_encoding.go # relayer/relays/beacon/state/beacon_encoding.go

remove unused file

ebf100a

remove test line

0da2b16

rename method

b5334dc

refactor method

de118ca

yrong approved these changes Mar 20, 2024

View reviewed changes

yrong and others added 4 commits March 21, 2024 11:25

Fix compile error and breaking tests

9397587

clean up imports

c428bff

Merge remote-tracking branch 'origin/limit-finalized-headers-gap' int…

9669aab

…o limit-finalized-headers-gap

fix duplicate import

862c6dc

claravanstaden merged commit 8a51ac9 into main Mar 21, 2024
3 checks passed

claravanstaden deleted the limit-finalized-headers-gap branch March 21, 2024 08:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Limit finalized header gap #1156

Limit finalized header gap #1156

claravanstaden commented Mar 13, 2024 •

edited

Loading

yrong Mar 18, 2024

claravanstaden Mar 18, 2024

claravanstaden Mar 18, 2024

claravanstaden Mar 18, 2024

yrong Mar 19, 2024 •

edited

Loading

claravanstaden Mar 20, 2024

yrong Mar 19, 2024 •

edited

Loading

claravanstaden Mar 20, 2024

yrong Mar 19, 2024

claravanstaden Mar 20, 2024

yrong left a comment

		func (h *Header) getHeaderUpdateBySlot(slot uint64) (scale.HeaderUpdatePayload, error) {
		slot = slot + 1

Limit finalized header gap #1156

Limit finalized header gap #1156

Conversation

claravanstaden commented Mar 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yrong Mar 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yrong Mar 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yrong left a comment

Choose a reason for hiding this comment

claravanstaden commented Mar 13, 2024 •

edited

Loading

yrong Mar 19, 2024 •

edited

Loading

yrong Mar 19, 2024 •

edited

Loading