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

Speedup TWAP pruning logic #7415

Merged
merged 1 commit into from
Feb 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
16 changes: 11 additions & 5 deletions x/twap/store.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,23 +94,29 @@ func (k Keeper) pruneRecordsBeforeTimeButNewest(ctx sdk.Context, lastKeptTime ti
seenPoolAssetTriplets := map[uniqueTriplet]struct{}{}

for ; iter.Valid(); iter.Next() {
twapToRemove, err := types.ParseTwapFromBz(iter.Value())
timeIndexKey := iter.Key()
timeS, poolId, asset0, asset1, err := types.ParseFieldsFromHistoricalTimeKey(timeIndexKey)
if err != nil {
return err
}

poolKey := uniqueTriplet{
poolId: twapToRemove.PoolId,
asset0: twapToRemove.Asset0Denom,
asset1: twapToRemove.Asset1Denom,
poolId,
asset0,
asset1,
}
_, hasSeenPoolRecord := seenPoolAssetTriplets[poolKey]
if !hasSeenPoolRecord {
seenPoolAssetTriplets[poolKey] = struct{}{}
continue
}

k.DeleteHistoricalRecord(ctx, twapToRemove)
Copy link
Member

Choose a reason for hiding this comment

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

This method now seems unused, can we delete the method as well?

Copy link
Member Author

Choose a reason for hiding this comment

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

Hrmm, seems like a useful helper / reference implementation tho

// Now we need to delete the historical record, formatted by both historical time and pool index.
// We already are iterating over the historical time index, so we delete that key. Then we
// reformat the key to delete the historical pool index key.
store.Delete(timeIndexKey)
poolIndexKey := types.FormatHistoricalPoolIndexTWAPKeyFromStrTime(poolId, asset0, asset1, timeS)
store.Delete(poolIndexKey)
}
return nil
}
Expand Down
26 changes: 24 additions & 2 deletions x/twap/types/keys.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"bytes"
"errors"
"fmt"
"strconv"
time "time"

sdk "github.com/cosmos/cosmos-sdk/types"
Expand Down Expand Up @@ -66,12 +67,33 @@ func FormatHistoricalTimeIndexTWAPKey(accumulatorWriteTime time.Time, poolId uin
}

func FormatHistoricalPoolIndexTWAPKey(poolId uint64, denom1, denom2 string, accumulatorWriteTime time.Time) []byte {
var buffer bytes.Buffer
timeS := osmoutils.FormatTimeString(accumulatorWriteTime)
fmt.Fprintf(&buffer, "%s%d%s%s%s%s%s%s", HistoricalTWAPPoolIndexPrefix, poolId, KeySeparator, denom1, KeySeparator, denom2, KeySeparator, timeS)
return FormatHistoricalPoolIndexTWAPKeyFromStrTime(poolId, denom1, denom2, timeS)
}

func FormatHistoricalPoolIndexTWAPKeyFromStrTime(poolId uint64, denom1, denom2 string, accumulatorWriteTimeString string) []byte {
var buffer bytes.Buffer
fmt.Fprintf(&buffer, "%s%d%s%s%s%s%s%s", HistoricalTWAPPoolIndexPrefix, poolId, KeySeparator, denom1, KeySeparator, denom2, KeySeparator, accumulatorWriteTimeString)
Copy link
Contributor

Choose a reason for hiding this comment

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

Not relevant for this PR, but we may want to have a generic osmoutils.BuildKey(elements ...interface{}) that does this to avoid potential future key issues

Copy link
Contributor

Choose a reason for hiding this comment

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

also, should this end un a KeySeparator? Right now we're not appending anything, but if someone adds a traling key part in the future it may become an issue

Suggested change
fmt.Fprintf(&buffer, "%s%d%s%s%s%s%s%s", HistoricalTWAPPoolIndexPrefix, poolId, KeySeparator, denom1, KeySeparator, denom2, KeySeparator, accumulatorWriteTimeString)
fmt.Fprintf(&buffer, "%s%d%s%s%s%s%s%s%s", HistoricalTWAPPoolIndexPrefix, poolId, KeySeparator, denom1, KeySeparator, denom2, KeySeparator, accumulatorWriteTimeString, KeySeparator)

Copy link
Contributor

Choose a reason for hiding this comment

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

actually, ignore that. It would require a migration of existing keys.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think your right, alas wasn't thought about before. would take a migration now

return buffer.Bytes()
}

// returns timeString, poolIdString, denom1, denom2, error
// nolint: revive
func ParseFieldsFromHistoricalTimeKey(bz []byte) (string, uint64, string, string, error) {
split := bytes.Split(bz, []byte(KeySeparator))
if len(split) != 5 {
return "", 0, "", "", errors.New("invalid key")
}
timeS := string(split[1])
poolId, err := strconv.Atoi(string(split[2]))
if err != nil {
return "", 0, "", "", err
}
denom1 := string(split[3])
denom2 := string(split[4])
return timeS, uint64(poolId), denom1, denom2, err
}

func FormatHistoricalPoolIndexTimePrefix(poolId uint64, denom1, denom2 string) []byte {
return []byte(fmt.Sprintf("%s%d%s%s%s%s%s", HistoricalTWAPPoolIndexPrefix, poolId, KeySeparator, denom1, KeySeparator, denom2, KeySeparator))
}
Expand Down