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.

Sign up for GitHub

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

Add local cache inside the takerfee #8148

Merged
merged 7 commits into from
May 13, 2024
Merged

Add local cache inside the takerfee #8148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0bced61
Add local cache inside the takerfee
ValarDragon Apr 26, 2024
16543ba
add error handling
ValarDragon Apr 26, 2024
74b693d
Add Changelog
ValarDragon Apr 26, 2024
17f918b
Merge branch 'main' into dev/add_poolmanager_takerfee_cache
ValarDragon May 1, 2024
3cd99a5
Fix cache per @adam's comment
ValarDragon May 2, 2024
ef97dc5
Merge branch 'main' into dev/add_poolmanager_takerfee_cache
ValarDragon May 13, 2024
5327f96
Update x/poolmanager/taker_fee.go
ValarDragon May 13, 2024
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## Unreleased

* [#8128](https://github.com/osmosis-labs/osmosis/pull/8128) Cache the result for poolmanager.GetPoolModule
* [#8148](https://github.com/osmosis-labs/osmosis/pull/8148) Remove the deserialization time for GetDefaultTakerFee()

## v25.0.0

Expand Down
3 changes: 3 additions & 0 deletions x/poolmanager/keeper.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ type Keeper struct {
poolModules []types.PoolModuleI

paramSpace paramtypes.Subspace

defaultTakerFeeBz []byte
Copy link
Member

Choose a reason for hiding this comment

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

We need to initialize this value somewhere right?

Copy link
Member Author

Choose a reason for hiding this comment

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

no its intended to be set to nil until initialization!

defaultTakerFeeVal sdk.Dec
Comment on lines +45 to +46
Copy link
Contributor

Choose a reason for hiding this comment

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

Initialization of new fields in Keeper struct.

The new fields defaultTakerFeeBz and defaultTakerFeeVal in the Keeper struct are not initialized in the NewKeeper constructor. This might lead to nil pointer dereferences or unexpected behavior. Ensure these fields are properly initialized when a new Keeper instance is created.

}

func NewKeeper(storeKey storetypes.StoreKey, paramSpace paramtypes.Subspace, gammKeeper types.PoolModuleI, concentratedKeeper types.PoolModuleI, cosmwasmpoolKeeper types.PoolModuleI, bankKeeper types.BankI, accountKeeper types.AccountI, communityPoolKeeper types.CommunityPoolI, stakingKeeper types.StakingKeeper, protorevKeeper types.ProtorevKeeper) *Keeper {
Expand Down
18 changes: 14 additions & 4 deletions x/poolmanager/taker_fee.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package poolmanager

import (
"bytes"
"encoding/json"
"fmt"

sdk "github.com/cosmos/cosmos-sdk/types"
Expand All @@ -12,10 +14,18 @@ import (
txfeestypes "github.com/osmosis-labs/osmosis/v25/x/txfees/types"
)

func (k Keeper) GetDefaultTakerFee(ctx sdk.Context) sdk.Dec {
var defaultTakerFee sdk.Dec
k.paramSpace.Get(ctx, types.KeyDefaultTakerFee, &defaultTakerFee)
return defaultTakerFee
func (k *Keeper) GetDefaultTakerFee(ctx sdk.Context) sdk.Dec {
defaultTakerFeeBz := k.paramSpace.GetRaw(ctx, types.KeyDefaultTakerFee)
if !bytes.Equal(defaultTakerFeeBz, k.defaultTakerFeeBz) {
Copy link
Member

Choose a reason for hiding this comment

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

ditto here for the value for k.defaultTakerFeeBz

Copy link
Member Author

Choose a reason for hiding this comment

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

Intended to be nil!

Copy link
Member

Choose a reason for hiding this comment

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

I think this is still wrong though, which was highlighted as I was stepping through with debugger. Don't we want to set k.defaultTakerFeeBz to defaultTakerFeeBz at the end? Otherwise this will always hit the if statement. Its not "wrong", but we are forced to unmarshal the value every time which defeats the purpose.

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh yes, whoops

var defaultTakerFeeValue sdk.Dec
err := json.Unmarshal(defaultTakerFeeBz, &defaultTakerFeeValue)
if err != nil {
defaultTakerFeeValue = sdk.ZeroDec()
}
k.defaultTakerFeeBz = defaultTakerFeeBz
ValarDragon marked this conversation as resolved.
Show resolved Hide resolved
k.defaultTakerFeeVal = defaultTakerFeeValue
}
return k.defaultTakerFeeVal
}

// SetDenomPairTakerFee sets the taker fee for the given trading pair.
Expand Down