Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move memstore hydration initialized flag to memstore #2681

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions protocol/x/clob/keeper/keeper.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package keeper

import (
"errors"
"fmt"
"math/big"
"sync/atomic"
Expand Down Expand Up @@ -54,8 +53,7 @@ type (
streamingManager streamingtypes.FullNodeStreamingManager
finalizeBlockEventStager finalizeblock.EventStager[*types.ClobStagedFinalizeBlockEvent]

initialized *atomic.Bool
memStoreInitialized *atomic.Bool
initialized *atomic.Bool
Copy link
Contributor

@teddyding teddyding Jan 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: rename to inMemStructsInitialized or sth similar to disambiguate with memStoreInitialized


Flags flags.ClobFlags

Expand Down Expand Up @@ -124,7 +122,6 @@ func NewKeeper(
accountPlusKeeper: accountPlusKeeper,
indexerEventManager: indexerEventManager,
streamingManager: streamingManager,
memStoreInitialized: &atomic.Bool{}, // False by default.
initialized: &atomic.Bool{}, // False by default.
txDecoder: txDecoder,
mevTelemetryConfig: MevTelemetryConfig{
Expand Down Expand Up @@ -187,14 +184,16 @@ func (k Keeper) IsInitialized() bool {

// Initialize hydrates the clob keeper with the necessary in memory data structures.
func (k Keeper) Initialize(ctx sdk.Context) {
// Initialize memstore in clobKeeper with order fill amounts and stateful orders.
k.InitMemStore(ctx)

// Code below hydrates the in memory data structures and is not rolled back even if
// the block execution is discarded by OE. Therefore, they are only called once.
alreadyInitialized := k.initialized.Swap(true)
if alreadyInitialized {
return
}

// Initialize memstore in clobKeeper with order fill amounts and stateful orders.
k.InitMemStore(ctx)

// Branch the context for hydration.
// This means that new order matches from hydration will get added to the operations
// queue but the corresponding state changes will be discarded.
Expand Down Expand Up @@ -254,11 +253,14 @@ func (k Keeper) ProcessStagedFinalizeBlockEvents(ctx sdk.Context) {
// InitMemStore initializes the memstore of the `clob` keeper.
// This is called during app initialization in `app.go`, before any ABCI calls are received.
func (k Keeper) InitMemStore(ctx sdk.Context) {
alreadyInitialized := k.memStoreInitialized.Swap(true)
alreadyInitialized := k.GetMemstoreInitialized(ctx)
if alreadyInitialized {
panic(errors.New("Memory store already initialized and is not intended to be invoked more then once."))
return
}

// Set memstore initialized flag.
k.SetMemstoreInitialized(ctx)

memStore := ctx.KVStore(k.memKey)
memStoreType := memStore.GetStoreType()
if memStoreType != storetypes.StoreTypeMemory {
Expand Down Expand Up @@ -307,6 +309,19 @@ func (k Keeper) InitMemStore(ctx sdk.Context) {
}
}

func (k Keeper) GetMemstoreInitialized(ctx sdk.Context) bool {
store := ctx.KVStore(k.memKey)
return store.Has([]byte(types.KeyMemstoreInitialized))
}

func (k Keeper) SetMemstoreInitialized(ctx sdk.Context) {
store := ctx.KVStore(k.memKey)
store.Set(
[]byte(types.KeyMemstoreInitialized),
[]byte{1},
)
}

// Sets the ante handler after it has been constructed. This breaks a cycle between
// when the ante handler is constructed and when the clob keeper is constructed.
func (k *Keeper) SetAnteHandler(anteHandler sdk.AnteHandler) {
Expand Down
3 changes: 3 additions & 0 deletions protocol/x/clob/types/keys.go
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ const (

// Memstore
const (
// KeyMemstoreInitialized is the key to check if the memstore has been initialized.
KeyMemstoreInitialized = "MemstoreInit"

// ProcessProposerMatchesEventsKey is the key to retrieve information about how to update
// memclob state based on the latest block.
ProcessProposerMatchesEventsKey = "ProposerEvents"
Expand Down
Loading