Skip to content

Commit 5f2d718

Browse files
committed
improve persister godocs
1 parent 79c4329 commit 5f2d718

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

module/executiondatasync/optimistic_sync/persisters/block.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ import (
1414
)
1515

1616
// BlockPersister stores execution data for a single execution result into the database.
17-
// It uses the set of [stores.PersisterStore] to persist the data with a singl atomic batch operation.
17+
// It uses the set of [stores.PersisterStore] to persist the data with a single atomic batch operation.
18+
// To ensure the database only contains data certified by the protocol, the block persister must
19+
// only be called for sealed execution results.
1820
type BlockPersister struct {
1921
log zerolog.Logger
2022

module/executiondatasync/optimistic_sync/persisters/registers.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@ import (
77
"github.com/onflow/flow-go/storage"
88
)
99

10-
// RegistersPersister stores [flow.RegisterEntry] values into the registers db
10+
// RegistersPersister stores register data for a single execution result into the registers db in a
11+
// single atomic batch operation.
12+
// To ensure the database only contains data certified by the protocol, the registers persister must
13+
// only be called for sealed execution results.
1114
type RegistersPersister struct {
1215
data []flow.RegisterEntry
1316
registers storage.RegisterIndex

0 commit comments

Comments
 (0)