diff --git a/proto/ojo/symbiotic/v1/symbiotic.proto b/proto/ojo/symbiotic/v1/symbiotic.proto index ccf29ac5..b8ecadc9 100644 --- a/proto/ojo/symbiotic/v1/symbiotic.proto +++ b/proto/ojo/symbiotic/v1/symbiotic.proto @@ -13,6 +13,8 @@ message Params { string middleware_address = 1; // block period for syncing with the symbiotic network on Ethereum int64 symbiotic_sync_period = 2; + // maximum amount of cached block hashes in the store + uint64 maximum_cached_block_hashes = 3; } // Cached block hash and height of block hash from the chain the ojo middleware is on. diff --git a/util/block_period.go b/util/block_period.go new file mode 100644 index 00000000..b187e878 --- /dev/null +++ b/util/block_period.go @@ -0,0 +1,10 @@ +package util + +import ( + sdk "github.com/cosmos/cosmos-sdk/types" +) + +// IsPeriodLastBlock returns true if we are at the last block of the period +func IsPeriodLastBlock(ctx sdk.Context, blocksPerPeriod uint64) bool { + return (SafeInt64ToUint64(ctx.BlockHeight())+1)%blocksPerPeriod == 0 +} diff --git a/x/oracle/abci/endblocker.go b/x/oracle/abci/endblocker.go index 00c59f4b..66d165d8 100644 --- a/x/oracle/abci/endblocker.go +++ b/x/oracle/abci/endblocker.go @@ -44,13 +44,13 @@ func EndBlocker(ctx context.Context, k keeper.Keeper) error { // Set all current active validators into the ValidatorRewardSet at // the beginning of a new Slash Window. - if k.IsPeriodLastBlock(sdkCtx, params.SlashWindow+1) { + if util.IsPeriodLastBlock(sdkCtx, params.SlashWindow+1) { if err := k.SetValidatorRewardSet(sdkCtx); err != nil { return err } } - if k.IsPeriodLastBlock(sdkCtx, params.VotePeriod) { + if util.IsPeriodLastBlock(sdkCtx, params.VotePeriod) { if k.PriceFeeder.Oracle != nil && k.PriceFeeder.AppConfig.Enable { // Update price feeder oracle with latest params. k.PriceFeeder.Oracle.ParamCache.UpdateParamCache(sdkCtx.BlockHeight(), k.GetParams(sdkCtx), nil) @@ -69,7 +69,7 @@ func EndBlocker(ctx context.Context, k keeper.Keeper) error { // Slash oracle providers who missed voting over the threshold and reset // miss counters of all validators at the last block of slash window. - if k.IsPeriodLastBlock(sdkCtx, params.SlashWindow) { + if util.IsPeriodLastBlock(sdkCtx, params.SlashWindow) { k.SlashAndResetMissCounters(sdkCtx) } k.PruneAllPrices(sdkCtx) @@ -145,12 +145,12 @@ func CalcPrices(ctx sdk.Context, params types.Params, k keeper.Keeper) error { return err } - if k.IsPeriodLastBlock(ctx, params.HistoricStampPeriod) { + if util.IsPeriodLastBlock(ctx, params.HistoricStampPeriod) { k.AddHistoricPrice(ctx, ballotDenom.Denom, exchangeRate) } // Calculate and stamp median/median deviation if median stamp period has passed - if k.IsPeriodLastBlock(ctx, params.MedianStampPeriod) { + if util.IsPeriodLastBlock(ctx, params.MedianStampPeriod) { if err = k.CalcAndSetHistoricMedian(ctx, ballotDenom.Denom); err != nil { return err } diff --git a/x/oracle/keeper/end_blocker.go b/x/oracle/keeper/end_blocker.go index f99707c2..8e3dce6c 100644 --- a/x/oracle/keeper/end_blocker.go +++ b/x/oracle/keeper/end_blocker.go @@ -12,13 +12,13 @@ func (k *Keeper) PruneAllPrices(ctx sdk.Context) { params := k.GetParams(ctx) blockHeight := util.SafeInt64ToUint64(ctx.BlockHeight()) - if k.IsPeriodLastBlock(ctx, params.HistoricStampPeriod) { + if util.IsPeriodLastBlock(ctx, params.HistoricStampPeriod) { pruneHistoricPeriod := params.HistoricStampPeriod * params.MaximumPriceStamps if pruneHistoricPeriod < blockHeight { k.PruneHistoricPricesBeforeBlock(ctx, blockHeight-pruneHistoricPeriod) } - if k.IsPeriodLastBlock(ctx, params.MedianStampPeriod) { + if util.IsPeriodLastBlock(ctx, params.MedianStampPeriod) { pruneMedianPeriod := params.MedianStampPeriod * params.MaximumMedianStamps if pruneMedianPeriod < blockHeight { k.PruneMediansBeforeBlock(ctx, blockHeight-pruneMedianPeriod) @@ -28,11 +28,6 @@ func (k *Keeper) PruneAllPrices(ctx sdk.Context) { } } -// IsPeriodLastBlock returns true if we are at the last block of the period -func (k *Keeper) IsPeriodLastBlock(ctx sdk.Context, blocksPerPeriod uint64) bool { - return (util.SafeInt64ToUint64(ctx.BlockHeight())+1)%blocksPerPeriod == 0 -} - // RecordEndBlockMetrics records miss counter and price metrics at the end of the block func (k *Keeper) RecordEndBlockMetrics(ctx sdk.Context) { if !k.telemetryEnabled { diff --git a/x/symbiotic/abci.go b/x/symbiotic/abci.go index b9dac701..3a739ca2 100644 --- a/x/symbiotic/abci.go +++ b/x/symbiotic/abci.go @@ -1,12 +1,27 @@ package symbiotic import ( + "context" + sdk "github.com/cosmos/cosmos-sdk/types" + "github.com/ojo-network/ojo/util" "github.com/ojo-network/ojo/x/symbiotic/keeper" ) // EndBlocker is called at the end of every block -func EndBlocker(_ sdk.Context, _ keeper.Keeper) error { +func EndBlocker(ctx context.Context, k keeper.Keeper) error { + sdkCtx := sdk.UnwrapSDKContext(ctx) + params := k.GetParams(sdkCtx) + blockHeight := util.SafeInt64ToUint64(sdkCtx.BlockHeight()) + syncPeriod := util.SafeInt64ToUint64(params.SymbioticSyncPeriod) + + if util.IsPeriodLastBlock(sdkCtx, syncPeriod) { + prunePeriod := params.MaximumCachedBlockHashes * syncPeriod + if prunePeriod < blockHeight { + k.PruneBlockHashesBeforeBlock(sdkCtx, blockHeight-prunePeriod) + } + } + return nil } diff --git a/x/symbiotic/keeper/keeper.go b/x/symbiotic/keeper/keeper.go index eec5b89b..538106ed 100644 --- a/x/symbiotic/keeper/keeper.go +++ b/x/symbiotic/keeper/keeper.go @@ -73,18 +73,42 @@ func (k Keeper) GetCachedBlockHash( return cachedBlockHash, nil } -func (k Keeper) GetAllCachedBlockHashes( +func (k Keeper) IterateAllCachedBlockHashes( ctx sdk.Context, -) []types.CachedBlockHash { + handler func(types.CachedBlockHash) bool, +) { store := ctx.KVStore(k.storeKey) - iterator := storetypes.KVStorePrefixIterator(store, types.CachedBlockHashPrefix) - defer iterator.Close() + iter := storetypes.KVStorePrefixIterator(store, types.CachedBlockHashPrefix) + defer iter.Close() - cachedBlockHashes := []types.CachedBlockHash{} - for ; iterator.Valid(); iterator.Next() { + for ; iter.Valid(); iter.Next() { cachedBlockHash := types.CachedBlockHash{} - k.cdc.MustUnmarshal(iterator.Value(), &cachedBlockHash) - cachedBlockHashes = append(cachedBlockHashes, cachedBlockHash) + k.cdc.MustUnmarshal(iter.Value(), &cachedBlockHash) + if handler(cachedBlockHash) { + break + } } +} + +func (k Keeper) GetAllCachedBlockHashes( + ctx sdk.Context, +) []types.CachedBlockHash { + cachedBlockHashes := []types.CachedBlockHash{} + k.IterateAllCachedBlockHashes(ctx, func(cachedBlockHash types.CachedBlockHash) (stop bool) { + cachedBlockHashes = append(cachedBlockHashes, cachedBlockHash) + return false + }) return cachedBlockHashes } + +func (k Keeper) PruneBlockHashesBeforeBlock( + ctx sdk.Context, + blockNum uint64, +) { + k.IterateAllCachedBlockHashes(ctx, func(cachedBlockHash types.CachedBlockHash) (stop bool) { + if cachedBlockHash.Height <= int64(blockNum) { + k.DeleteCachedBlockHash(ctx, cachedBlockHash) + } + return false + }) +} diff --git a/x/symbiotic/types/symbiotic.pb.go b/x/symbiotic/types/symbiotic.pb.go index 9f9875c6..0867875a 100644 --- a/x/symbiotic/types/symbiotic.pb.go +++ b/x/symbiotic/types/symbiotic.pb.go @@ -29,6 +29,8 @@ type Params struct { MiddlewareAddress string `protobuf:"bytes,1,opt,name=middleware_address,json=middlewareAddress,proto3" json:"middleware_address,omitempty"` // block period for syncing with the symbiotic network on Ethereum SymbioticSyncPeriod int64 `protobuf:"varint,2,opt,name=symbiotic_sync_period,json=symbioticSyncPeriod,proto3" json:"symbiotic_sync_period,omitempty"` + // maximum amount of cached block hashes in the store + MaximumCachedBlockHashes uint64 `protobuf:"varint,3,opt,name=maximum_cached_block_hashes,json=maximumCachedBlockHashes,proto3" json:"maximum_cached_block_hashes,omitempty"` } func (m *Params) Reset() { *m = Params{} } @@ -113,24 +115,26 @@ func init() { func init() { proto.RegisterFile("ojo/symbiotic/v1/symbiotic.proto", fileDescriptor_4008c10d1c664ed5) } var fileDescriptor_4008c10d1c664ed5 = []byte{ - // 271 bytes of a gzipped FileDescriptorProto - 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x4c, 0x90, 0xbd, 0x4e, 0xf3, 0x30, - 0x18, 0x85, 0xe3, 0xef, 0x93, 0x2a, 0xd5, 0x0b, 0x10, 0x7e, 0x54, 0x21, 0x61, 0x45, 0x9d, 0x3a, - 0xd0, 0x44, 0x85, 0x2b, 0xa0, 0x2c, 0x15, 0x53, 0x55, 0x36, 0x96, 0xc8, 0xb1, 0xad, 0xd8, 0x49, - 0x93, 0x37, 0xb2, 0x4d, 0x4b, 0xee, 0x82, 0xcb, 0xea, 0xd8, 0x91, 0x11, 0x92, 0x1b, 0x41, 0x49, - 0xa3, 0x84, 0xed, 0x3c, 0x7e, 0xac, 0xf3, 0x4a, 0x07, 0x7b, 0x90, 0x40, 0x60, 0xca, 0x2c, 0x52, - 0x60, 0x15, 0x0b, 0x76, 0x8b, 0x01, 0xfc, 0x42, 0x83, 0x05, 0xf7, 0x1c, 0x12, 0xf0, 0x87, 0xc7, - 0xdd, 0xe2, 0xf6, 0x2a, 0x86, 0x18, 0x5a, 0x19, 0x34, 0xe9, 0xf4, 0x6f, 0x9a, 0xe2, 0xd1, 0x9a, - 0x6a, 0x9a, 0x19, 0x77, 0x8e, 0xdd, 0x4c, 0x71, 0xbe, 0x15, 0x7b, 0xaa, 0x45, 0x48, 0x39, 0xd7, - 0xc2, 0x98, 0x09, 0xf2, 0xd0, 0x6c, 0xbc, 0xb9, 0x18, 0xcc, 0xd3, 0x49, 0xb8, 0x0f, 0xf8, 0xba, - 0xaf, 0x0f, 0x4d, 0x99, 0xb3, 0xb0, 0x10, 0x5a, 0x01, 0x9f, 0xfc, 0xf3, 0xd0, 0xec, 0xff, 0xe6, - 0xb2, 0x97, 0xaf, 0x65, 0xce, 0xd6, 0xad, 0x9a, 0xae, 0xf0, 0xd9, 0x33, 0x65, 0x52, 0xf0, 0xe5, - 0x16, 0x58, 0xba, 0xa2, 0x46, 0xba, 0x77, 0x18, 0x47, 0x0d, 0x84, 0x92, 0x1a, 0xd9, 0x5d, 0x1b, - 0x47, 0xbd, 0xbe, 0xc1, 0x23, 0x29, 0x54, 0x2c, 0x6d, 0x57, 0xdb, 0xd1, 0xf2, 0xe5, 0xf0, 0x43, - 0x9c, 0x43, 0x45, 0xd0, 0xb1, 0x22, 0xe8, 0xbb, 0x22, 0xe8, 0xb3, 0x26, 0xce, 0xb1, 0x26, 0xce, - 0x57, 0x4d, 0x9c, 0xb7, 0xfb, 0x58, 0x59, 0xf9, 0x1e, 0xf9, 0x0c, 0xb2, 0x00, 0x12, 0x98, 0xe7, - 0xc2, 0xee, 0x41, 0xa7, 0x4d, 0x0e, 0x3e, 0xfe, 0xec, 0x66, 0xcb, 0x42, 0x98, 0x68, 0xd4, 0x2e, - 0xf1, 0xf8, 0x1b, 0x00, 0x00, 0xff, 0xff, 0x01, 0x2f, 0xe3, 0xf4, 0x55, 0x01, 0x00, 0x00, + // 302 bytes of a gzipped FileDescriptorProto + 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x5c, 0x90, 0xcd, 0x4e, 0x32, 0x31, + 0x14, 0x86, 0xa7, 0x1f, 0x5f, 0x48, 0xe8, 0x46, 0x1d, 0x7f, 0x32, 0xd1, 0xd8, 0x4c, 0x58, 0xb1, + 0x10, 0x26, 0xe8, 0xda, 0x85, 0xb8, 0x21, 0xae, 0x08, 0xee, 0xdc, 0x34, 0x9d, 0xb6, 0x99, 0x16, + 0x28, 0x87, 0xb4, 0xe5, 0x67, 0xee, 0xc2, 0xeb, 0xf0, 0x4a, 0x58, 0xb2, 0x74, 0xa9, 0x70, 0x23, + 0x86, 0x61, 0xc2, 0x18, 0x77, 0xe7, 0x9c, 0xe7, 0xc9, 0xc9, 0x9b, 0x17, 0xc7, 0x30, 0x82, 0xc4, + 0xe5, 0x26, 0xd5, 0xe0, 0x35, 0x4f, 0x16, 0xdd, 0x6a, 0xe9, 0xcc, 0x2c, 0x78, 0x08, 0x4f, 0x61, + 0x04, 0x9d, 0xea, 0xb8, 0xe8, 0x5e, 0x5f, 0x64, 0x90, 0x41, 0x01, 0x93, 0xfd, 0x74, 0xf0, 0x9a, + 0x1f, 0x08, 0xd7, 0x07, 0xcc, 0x32, 0xe3, 0xc2, 0x36, 0x0e, 0x8d, 0x16, 0x62, 0x22, 0x97, 0xcc, + 0x4a, 0xca, 0x84, 0xb0, 0xd2, 0xb9, 0x08, 0xc5, 0xa8, 0xd5, 0x18, 0x9e, 0x55, 0xe4, 0xe9, 0x00, + 0xc2, 0x7b, 0x7c, 0x79, 0xfc, 0x4f, 0x5d, 0x3e, 0xe5, 0x74, 0x26, 0xad, 0x06, 0x11, 0xfd, 0x8b, + 0x51, 0xab, 0x36, 0x3c, 0x3f, 0xc2, 0xd7, 0x7c, 0xca, 0x07, 0x05, 0x0a, 0x1f, 0xf1, 0x8d, 0x61, + 0x2b, 0x6d, 0xe6, 0x86, 0x72, 0xc6, 0x95, 0x14, 0x34, 0x9d, 0x00, 0x1f, 0x53, 0xc5, 0x9c, 0x92, + 0x2e, 0xaa, 0xc5, 0xa8, 0xf5, 0x7f, 0x18, 0x95, 0xca, 0x73, 0x61, 0xf4, 0xf6, 0x42, 0xbf, 0xe0, + 0xcd, 0x3e, 0x3e, 0xf9, 0x73, 0x0c, 0x6f, 0x31, 0xae, 0x5e, 0x94, 0x61, 0x1b, 0xe9, 0x11, 0x5f, + 0xe1, 0xba, 0x92, 0x3a, 0x53, 0xbe, 0x4c, 0x55, 0x6e, 0xbd, 0x97, 0xf5, 0x37, 0x09, 0xd6, 0x5b, + 0x82, 0x36, 0x5b, 0x82, 0xbe, 0xb6, 0x04, 0xbd, 0xef, 0x48, 0xb0, 0xd9, 0x91, 0xe0, 0x73, 0x47, + 0x82, 0xb7, 0xbb, 0x4c, 0x7b, 0x35, 0x4f, 0x3b, 0x1c, 0x4c, 0x02, 0x23, 0x68, 0x4f, 0xa5, 0x5f, + 0x82, 0x1d, 0xef, 0xe7, 0x64, 0xf5, 0xab, 0x77, 0x9f, 0xcf, 0xa4, 0x4b, 0xeb, 0x45, 0x93, 0x0f, + 0x3f, 0x01, 0x00, 0x00, 0xff, 0xff, 0x01, 0x76, 0x64, 0x1d, 0x95, 0x01, 0x00, 0x00, } func (m *Params) Marshal() (dAtA []byte, err error) { @@ -153,6 +157,11 @@ func (m *Params) MarshalToSizedBuffer(dAtA []byte) (int, error) { _ = i var l int _ = l + if m.MaximumCachedBlockHashes != 0 { + i = encodeVarintSymbiotic(dAtA, i, uint64(m.MaximumCachedBlockHashes)) + i-- + dAtA[i] = 0x18 + } if m.SymbioticSyncPeriod != 0 { i = encodeVarintSymbiotic(dAtA, i, uint64(m.SymbioticSyncPeriod)) i-- @@ -227,6 +236,9 @@ func (m *Params) Size() (n int) { if m.SymbioticSyncPeriod != 0 { n += 1 + sovSymbiotic(uint64(m.SymbioticSyncPeriod)) } + if m.MaximumCachedBlockHashes != 0 { + n += 1 + sovSymbiotic(uint64(m.MaximumCachedBlockHashes)) + } return n } @@ -332,6 +344,25 @@ func (m *Params) Unmarshal(dAtA []byte) error { break } } + case 3: + if wireType != 0 { + return fmt.Errorf("proto: wrong wireType = %d for field MaximumCachedBlockHashes", wireType) + } + m.MaximumCachedBlockHashes = 0 + for shift := uint(0); ; shift += 7 { + if shift >= 64 { + return ErrIntOverflowSymbiotic + } + if iNdEx >= l { + return io.ErrUnexpectedEOF + } + b := dAtA[iNdEx] + iNdEx++ + m.MaximumCachedBlockHashes |= uint64(b&0x7F) << shift + if b < 0x80 { + break + } + } default: iNdEx = preIndex skippy, err := skipSymbiotic(dAtA[iNdEx:])