-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add RewardsClaimed metaState model to capture state that isnt E…
…igenState (#188) Sometimes we may want to process logs and store the output in a more normalized and accessible format, such as tracking claimed rewards. This introduces the concept of the MetaState models to handle such cases. The `RewardsClaimed` model tracks the RewardsClaimed event from the RewardsCoordinator. closes #58
- Loading branch information
Showing
15 changed files
with
651 additions
and
10 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,88 @@ | ||
| package baseModel | ||
|
|
||
| import ( | ||
| "database/sql" | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "github.com/Layr-Labs/sidecar/pkg/parser" | ||
| "github.com/Layr-Labs/sidecar/pkg/storage" | ||
| "go.uber.org/zap" | ||
| "gorm.io/gorm" | ||
| "slices" | ||
| "strings" | ||
| ) | ||
|
|
||
| func IsInterestingLog(contractsEvents map[string][]string, log *storage.TransactionLog) bool { | ||
| logAddress := strings.ToLower(log.Address) | ||
| if eventNames, ok := contractsEvents[logAddress]; ok { | ||
| if slices.Contains(eventNames, log.EventName) { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } | ||
|
|
||
| func ParseLogArguments(log *storage.TransactionLog, l *zap.Logger) ([]parser.Argument, error) { | ||
| arguments := make([]parser.Argument, 0) | ||
| err := json.Unmarshal([]byte(log.Arguments), &arguments) | ||
| if err != nil { | ||
| l.Sugar().Errorw("Failed to unmarshal arguments", | ||
| zap.Error(err), | ||
| zap.String("transactionHash", log.TransactionHash), | ||
| zap.Uint64("transactionIndex", log.TransactionIndex), | ||
| ) | ||
| return nil, err | ||
| } | ||
| return arguments, nil | ||
| } | ||
|
|
||
| func ParseLogOutput[T any](log *storage.TransactionLog, l *zap.Logger) (*T, error) { | ||
| var outputData *T | ||
| err := json.Unmarshal([]byte(log.OutputData), &outputData) | ||
| if err != nil { | ||
| l.Sugar().Errorw("Failed to unmarshal outputData", | ||
| zap.Error(err), | ||
| zap.String("transactionHash", log.TransactionHash), | ||
| zap.Uint64("transactionIndex", log.TransactionIndex), | ||
| ) | ||
| return nil, err | ||
| } | ||
| return outputData, nil | ||
| } | ||
|
|
||
| func DeleteState(tableName string, startBlockNumber uint64, endBlockNumber uint64, db *gorm.DB, l *zap.Logger) error { | ||
| if endBlockNumber != 0 && endBlockNumber < startBlockNumber { | ||
| l.Sugar().Errorw("Invalid block range", | ||
| zap.Uint64("startBlockNumber", startBlockNumber), | ||
| zap.Uint64("endBlockNumber", endBlockNumber), | ||
| ) | ||
| return errors.New("Invalid block range; endBlockNumber must be greater than or equal to startBlockNumber") | ||
| } | ||
|
|
||
| // tokenizing the table name apparently doesnt work, so we need to use Sprintf to include it. | ||
| query := fmt.Sprintf(` | ||
| delete from %s | ||
| where block_number >= @startBlockNumber | ||
| `, tableName) | ||
| if endBlockNumber > 0 { | ||
| query += " and block_number <= @endBlockNumber" | ||
| } | ||
| res := db.Exec(query, | ||
| sql.Named("tableName", tableName), | ||
| sql.Named("startBlockNumber", startBlockNumber), | ||
| sql.Named("endBlockNumber", endBlockNumber)) | ||
| if res.Error != nil { | ||
| l.Sugar().Errorw("Failed to delete state", zap.Error(res.Error)) | ||
| return res.Error | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func CastCommittedStateToInterface[T any](committedState []*T) []interface{} { | ||
| state := make([]interface{}, len(committedState)) | ||
| for i, v := range committedState { | ||
| state[i] = *v | ||
| } | ||
| return state | ||
| } |
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,23 @@ | ||
| package metaState | ||
|
|
||
| import ( | ||
| "github.com/Layr-Labs/sidecar/internal/config" | ||
| "github.com/Layr-Labs/sidecar/pkg/metaState/metaStateManager" | ||
| "github.com/Layr-Labs/sidecar/pkg/metaState/rewardsClaimed" | ||
| "go.uber.org/zap" | ||
| "gorm.io/gorm" | ||
| ) | ||
|
|
||
| func LoadMetaStateModels( | ||
| msm *metaStateManager.MetaStateManager, | ||
| db *gorm.DB, | ||
| l *zap.Logger, | ||
| cfg *config.Config, | ||
| ) error { | ||
| if _, err := rewardsClaimed.NewRewardsClaimedModel(db, l, cfg, msm); err != nil { | ||
| l.Sugar().Errorw("Failed to create RewardsClaimedModel", zap.Error(err)) | ||
| return err | ||
| } | ||
|
|
||
| return nil | ||
| } |
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,90 @@ | ||
| package metaStateManager | ||
|
|
||
| import ( | ||
| "github.com/Layr-Labs/sidecar/internal/config" | ||
| "github.com/Layr-Labs/sidecar/pkg/metaState/types" | ||
| "github.com/Layr-Labs/sidecar/pkg/storage" | ||
| "go.uber.org/zap" | ||
| "gorm.io/gorm" | ||
| ) | ||
|
|
||
| type MetaStateManager struct { | ||
| db *gorm.DB | ||
| logger *zap.Logger | ||
| globalConfig *config.Config | ||
| metaStateModels []types.IMetaStateModel | ||
| } | ||
|
|
||
| func NewMetaStateManager(db *gorm.DB, l *zap.Logger, gc *config.Config) *MetaStateManager { | ||
| return &MetaStateManager{ | ||
| db: db, | ||
| logger: l, | ||
| globalConfig: gc, | ||
| metaStateModels: make([]types.IMetaStateModel, 0), | ||
| } | ||
| } | ||
|
|
||
| func (msm *MetaStateManager) RegisterMetaStateModel(model types.IMetaStateModel) { | ||
| msm.metaStateModels = append(msm.metaStateModels, model) | ||
| } | ||
|
|
||
| func (msm *MetaStateManager) InitProcessingForBlock(blockNumber uint64) error { | ||
| for _, model := range msm.metaStateModels { | ||
| if err := model.SetupStateForBlock(blockNumber); err != nil { | ||
| msm.logger.Sugar().Errorw("Failed to setup state for block", | ||
| "blockNumber", blockNumber, | ||
| "model", model, | ||
| "error", err, | ||
| ) | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (msm *MetaStateManager) CleanupProcessedStateForBlock(blockNumber uint64) error { | ||
| for _, model := range msm.metaStateModels { | ||
| if err := model.CleanupProcessedStateForBlock(blockNumber); err != nil { | ||
| msm.logger.Sugar().Errorw("Failed to cleanup state for block", | ||
| "blockNumber", blockNumber, | ||
| "model", model, | ||
| "error", err, | ||
| ) | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (msm *MetaStateManager) HandleTransactionLog(log *storage.TransactionLog) error { | ||
| for _, model := range msm.metaStateModels { | ||
| if model.IsInterestingLog(log) { | ||
| if _, err := model.HandleTransactionLog(log); err != nil { | ||
| msm.logger.Sugar().Errorw("Failed to handle log", | ||
| "log", log, | ||
| "model", model, | ||
| "error", err, | ||
| ) | ||
| return err | ||
| } | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (msm *MetaStateManager) CommitFinalState(blockNumber uint64) (map[string][]interface{}, error) { | ||
| committedState := make(map[string][]interface{}) | ||
| for _, model := range msm.metaStateModels { | ||
| state, err := model.CommitFinalState(blockNumber) | ||
| if err != nil { | ||
| msm.logger.Sugar().Errorw("Failed to commit final state", | ||
| "blockNumber", blockNumber, | ||
| "model", model, | ||
| "error", err, | ||
| ) | ||
| return nil, err | ||
| } | ||
| committedState[model.ModelName()] = state | ||
| } | ||
| return committedState, nil | ||
| } |
Oops, something went wrong.