-
Notifications
You must be signed in to change notification settings - Fork 265
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
persist LC sync progress across restarts (#4371)
Persist the latest finalized header and sync committee across restarts of `nimbus_light_client` to avoid redoing time-consuming bootstrap step.
- Loading branch information
1 parent
c46dc3d
commit 2e09011
Showing
7 changed files
with
269 additions
and
24 deletions.
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # beacon_chain | ||
| # Copyright (c) 2022 Status Research & Development GmbH | ||
| # Licensed and distributed under either of | ||
| # * MIT license (license terms in the root directory or at https://opensource.org/licenses/MIT). | ||
| # * Apache v2 license (license terms in the root directory or at https://www.apache.org/licenses/LICENSE-2.0). | ||
| # at your option. This file may not be copied, modified, or distributed except according to those terms. | ||
|
|
||
| when (NimMajor, NimMinor) < (1, 4): | ||
| {.push raises: [Defect].} | ||
| else: | ||
| {.push raises: [].} | ||
|
|
||
| import spec/datatypes/constants | ||
|
|
||
| # No `uint64` support in Sqlite | ||
| template isSupportedBySQLite*(slot: Slot): bool = | ||
| slot <= int64.high.Slot | ||
| template isSupportedBySQLite*(period: SyncCommitteePeriod): bool = | ||
| period <= int64.high.SyncCommitteePeriod |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,187 @@ | ||
| # beacon_chain | ||
| # Copyright (c) 2022 Status Research & Development GmbH | ||
| # Licensed and distributed under either of | ||
| # * MIT license (license terms in the root directory or at https://opensource.org/licenses/MIT). | ||
| # * Apache v2 license (license terms in the root directory or at https://www.apache.org/licenses/LICENSE-2.0). | ||
| # at your option. This file may not be copied, modified, or distributed except according to those terms. | ||
|
|
||
| when (NimMajor, NimMinor) < (1, 4): | ||
| {.push raises: [Defect].} | ||
| else: | ||
| {.push raises: [].} | ||
|
|
||
| import | ||
| # Status libraries | ||
| chronicles, | ||
| eth/db/kvstore_sqlite3, | ||
| # Beacon chain internals | ||
| spec/datatypes/altair, | ||
| spec/[eth2_ssz_serialization, helpers], | ||
| ./db_limits | ||
|
|
||
| logScope: topics = "lcdb" | ||
|
|
||
| # `altair_lc_headers` holds the latest `LightClientStore.finalized_header`. | ||
| # | ||
| # `altair_sync_committees` holds finalized `SyncCommittee` by period, needed to | ||
| # continue an interrupted sync process without having to obtain bootstrap info. | ||
|
|
||
| type | ||
| LightClientHeaderKind {.pure.} = enum | ||
| Finalized = 1 | ||
|
|
||
| LightClientHeadersStore = object | ||
| getStmt: SqliteStmt[int64, seq[byte]] | ||
| putStmt: SqliteStmt[(int64, seq[byte]), void] | ||
|
|
||
| SyncCommitteeStore = object | ||
| getStmt: SqliteStmt[int64, seq[byte]] | ||
| putStmt: SqliteStmt[(int64, seq[byte]), void] | ||
| keepFromStmt: SqliteStmt[int64, void] | ||
|
|
||
| LightClientDB* = ref object | ||
| backend: SqStoreRef | ||
| ## SQLite backend | ||
|
|
||
| headers: LightClientHeadersStore | ||
| ## LightClientHeaderKind -> BeaconBlockHeader | ||
| ## Stores the latest light client headers. | ||
|
|
||
| syncCommittees: SyncCommitteeStore | ||
| ## SyncCommitteePeriod -> altair.SyncCommittee | ||
| ## Stores finalized `SyncCommittee` by sync committee period. | ||
|
|
||
| func initLightClientHeadersStore( | ||
| backend: SqStoreRef, | ||
| name: string): KvResult[LightClientHeadersStore] = | ||
| ? backend.exec(""" | ||
| CREATE TABLE IF NOT EXISTS `""" & name & """` ( | ||
| `kind` INTEGER PRIMARY KEY, -- `LightClientHeaderKind` | ||
| `header` BLOB -- `BeaconBlockHeader` (SSZ) | ||
| ); | ||
| """) | ||
|
|
||
| let | ||
| getStmt = backend.prepareStmt(""" | ||
| SELECT `header` | ||
| FROM `""" & name & """` | ||
| WHERE `kind` = ?; | ||
| """, int64, seq[byte], managed = false).expect("SQL query OK") | ||
| putStmt = backend.prepareStmt(""" | ||
| REPLACE INTO `""" & name & """` ( | ||
| `kind`, `header` | ||
| ) VALUES (?, ?); | ||
| """, (int64, seq[byte]), void, managed = false).expect("SQL query OK") | ||
|
|
||
| ok LightClientHeadersStore( | ||
| getStmt: getStmt, | ||
| putStmt: putStmt) | ||
|
|
||
| func close(store: LightClientHeadersStore) = | ||
| store.getStmt.dispose() | ||
| store.putStmt.dispose() | ||
|
|
||
| proc getLatestFinalizedHeader*(db: LightClientDB): Opt[BeaconBlockHeader] = | ||
| var header: seq[byte] | ||
| for res in db.headers.getStmt.exec( | ||
| LightClientHeaderKind.Finalized.int64, header): | ||
| res.expect("SQL query OK") | ||
| try: | ||
| return ok SSZ.decode(header, BeaconBlockHeader) | ||
| except SszError as exc: | ||
| error "LC store corrupted", store = "headers", | ||
| kind = "Finalized", exc = exc.msg | ||
| return err() | ||
|
|
||
| func putLatestFinalizedHeader*( | ||
| db: LightClientDB, header: BeaconBlockHeader) = | ||
| block: | ||
| let res = db.headers.putStmt.exec( | ||
| (LightClientHeaderKind.Finalized.int64, SSZ.encode(header))) | ||
| res.expect("SQL query OK") | ||
| block: | ||
| let period = header.slot.sync_committee_period | ||
| doAssert period.isSupportedBySQLite | ||
| let res = db.syncCommittees.keepFromStmt.exec(period.int64) | ||
| res.expect("SQL query OK") | ||
|
|
||
| func initSyncCommitteesStore( | ||
| backend: SqStoreRef, | ||
| name: string): KvResult[SyncCommitteeStore] = | ||
| ? backend.exec(""" | ||
| CREATE TABLE IF NOT EXISTS `""" & name & """` ( | ||
| `period` INTEGER PRIMARY KEY, -- `SyncCommitteePeriod` | ||
| `sync_committee` BLOB -- `altair.SyncCommittee` (SSZ) | ||
| ); | ||
| """) | ||
|
|
||
| let | ||
| getStmt = backend.prepareStmt(""" | ||
| SELECT `sync_committee` | ||
| FROM `""" & name & """` | ||
| WHERE `period` = ?; | ||
| """, int64, seq[byte], managed = false).expect("SQL query OK") | ||
| putStmt = backend.prepareStmt(""" | ||
| REPLACE INTO `""" & name & """` ( | ||
| `period`, `sync_committee` | ||
| ) VALUES (?, ?); | ||
| """, (int64, seq[byte]), void, managed = false).expect("SQL query OK") | ||
| keepFromStmt = backend.prepareStmt(""" | ||
| DELETE FROM `""" & name & """` | ||
| WHERE `period` < ?; | ||
| """, int64, void, managed = false).expect("SQL query OK") | ||
|
|
||
| ok SyncCommitteeStore( | ||
| getStmt: getStmt, | ||
| putStmt: putStmt, | ||
| keepFromStmt: keepFromStmt) | ||
|
|
||
| func close(store: SyncCommitteeStore) = | ||
| store.getStmt.dispose() | ||
| store.putStmt.dispose() | ||
| store.keepFromStmt.dispose() | ||
|
|
||
| proc getSyncCommittee*( | ||
| db: LightClientDB, period: SyncCommitteePeriod): Opt[altair.SyncCommittee] = | ||
| doAssert period.isSupportedBySQLite | ||
| var syncCommittee: seq[byte] | ||
| for res in db.syncCommittees.getStmt.exec(period.int64, syncCommittee): | ||
| res.expect("SQL query OK") | ||
| try: | ||
| return ok SSZ.decode(syncCommittee, altair.SyncCommittee) | ||
| except SszError as exc: | ||
| error "LC store corrupted", store = "syncCommittees", | ||
| period, exc = exc.msg | ||
| return err() | ||
|
|
||
| func putSyncCommittee*( | ||
| db: LightClientDB, period: SyncCommitteePeriod, | ||
| syncCommittee: altair.SyncCommittee) = | ||
| doAssert period.isSupportedBySQLite | ||
| let res = db.syncCommittees.putStmt.exec( | ||
| (period.int64, SSZ.encode(syncCommittee))) | ||
| res.expect("SQL query OK") | ||
|
|
||
| type LightClientDBNames* = object | ||
| altairHeaders*: string | ||
| altairSyncCommittees*: string | ||
|
|
||
| func initLightClientDB*( | ||
| backend: SqStoreRef, | ||
| names: LightClientDBNames): KvResult[LightClientDB] = | ||
| let | ||
| headers = | ||
| ? backend.initLightClientHeadersStore(names.altairHeaders) | ||
| syncCommittees = | ||
| ? backend.initSyncCommitteesStore(names.altairSyncCommittees) | ||
|
|
||
| ok LightClientDB( | ||
| backend: backend, | ||
| headers: headers, | ||
| syncCommittees: syncCommittees) | ||
|
|
||
| func close*(db: LightClientDB) = | ||
| if db.backend != nil: | ||
| db.headers.close() | ||
| db.syncCommittees.close() | ||
| db[].reset() |
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