BE-689 | feat: orderbook orders cache plugin (#622)

Author: crnbarr93

CHANGELOG.md

@@ -35,14 +35,18 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 # Changelog
 
+## Unreleased
+
+- #622 - feat: orderbook orders cache plugin
+
 ## v28.3.1
 
 - #637 - BE-714 | Optimize route finding algorithm
 
 ## v28.3.0
 
 - Remove dependency on keyring, wire in CosmosSigner and grab private key from SQS_PRIVATE_KEY environment variable.
-- #632 - E-697 | Increase max routes for pricing worker
+- #632 - BE-697 | Increase max routes for pricing worker
 - #633 - BE-707 | Skip processing quote requests when system is not healthy 
 
 ## v28.2.0

app/sidecar_query_server.go

@@ -34,6 +34,7 @@ import (
 	"github.com/osmosis-labs/sqs/ingest/usecase/plugins/basefee"
 	orderbookclaimbot "github.com/osmosis-labs/sqs/ingest/usecase/plugins/orderbook/claimbot"
 	orderbookfillbot "github.com/osmosis-labs/sqs/ingest/usecase/plugins/orderbook/fillbot"
+	orderbookorderscache "github.com/osmosis-labs/sqs/ingest/usecase/plugins/orderbook/orderscache"
 	orderbookrepository "github.com/osmosis-labs/sqs/orderbook/repository"
 	orderbookusecase "github.com/osmosis-labs/sqs/orderbook/usecase"
 	"github.com/osmosis-labs/sqs/quotesimulator"
@@ -309,6 +310,10 @@ func NewSideCarQueryServer(ctx context.Context, appCodec codec.Codec, config dom
 			if plugin.IsEnabled() {
 				var currentPlugin domain.EndBlockProcessPlugin
 
+				if plugin.GetName() == orderbookplugindomain.OrderbookOrdersCachePlugin {
+					currentPlugin = orderbookorderscache.New(orderBookRepository, poolsUseCase, logger, passthroughGRPCClient)
+				}
+
 				if plugin.GetName() == orderbookplugindomain.OrderbookFillbotPlugin {
 					signer, err := initializeCosmosSigner()
 					if err != nil {

config.json

@@ -16,9 +16,13 @@
 				"name": "orderbook-claimbot-plugin",
 				"enabled": false
 			},
-            {
+			{
 				"name": "custom-submodule-plugin",
 				"enabled": false
+			},
+			{
+				"name": "orderbook-orders-cache-plugin",
+				"enabled": true
 			}
 		]
 	}

domain/config.go

@@ -160,6 +160,10 @@ var DefaultConfig = Config{
 		ServerAddress:                  ":50051",
 		ServerConnectionTimeoutSeconds: 10,
 		Plugins: []Plugin{
+			&OrderBookPluginConfig{
+				Enabled: true,
+				Name:    orderbookplugindomain.OrderbookOrdersCachePlugin,
+			},
 			&OrderBookPluginConfig{
 				Enabled: false,
 				Name:    orderbookplugindomain.OrderbookFillbotPlugin,
@@ -385,6 +389,8 @@ func validateDynamicMinLiquidityCapDesc(values []DynamicMinLiquidityCapFilterEnt
 // PluginFactory creates a Plugin instance based on the provided name.
 func PluginFactory(name string) Plugin {
 	switch name {
+	case orderbookplugindomain.OrderbookOrdersCachePlugin:
+		return &OrderBookPluginConfig{}
 	case orderbookplugindomain.OrderbookFillbotPlugin:
 		return &OrderBookPluginConfig{}
 	case orderbookplugindomain.OrderbookClaimbotPlugin:

domain/mocks/orderbook_repository_mock.go

@@ -12,6 +12,8 @@ type OrderbookRepositoryMock struct {
 	GetAllTicksFunc func(poolID uint64) (map[int64]orderbookdomain.OrderbookTick, bool)
 	GetTicksFunc    func(poolID uint64, tickIDs []int64) (map[int64]orderbookdomain.OrderbookTick, error)
 	GetTickByIDFunc func(poolID uint64, tickID int64) (orderbookdomain.OrderbookTick, bool)
+	StoreOrdersFunc func(poolID uint64, orders []orderbookdomain.Order) error
+	GetOrdersFunc   func(poolID uint64, ownerAddress string) ([]orderbookdomain.Order, bool)
 }
 
 // StoreTicks implements OrderBookRepository.
@@ -52,3 +54,31 @@ func (m *OrderbookRepositoryMock) GetTickByID(poolID uint64, tickID int64) (orde
 	}
 	panic("GetTickByID not implemented")
 }
+
+func (m *OrderbookRepositoryMock) WithStoreOrders(err error) {
+	m.StoreOrdersFunc = func(poolID uint64, orders []orderbookdomain.Order) error {
+		return err
+	}
+}
+
+// StoreOrders implements OrderBookRepository.
+func (m *OrderbookRepositoryMock) StoreOrders(poolID uint64, orders []orderbookdomain.Order) error {
+	if m.StoreOrdersFunc != nil {
+		return m.StoreOrdersFunc(poolID, orders)
+	}
+	panic("StoreOrders not implemented")
+}
+
+func (m *OrderbookRepositoryMock) WithGetOrdersFunc(orders []orderbookdomain.Order, ok bool) {
+	m.GetOrdersFunc = func(poolID uint64, ownerAddress string) ([]orderbookdomain.Order, bool) {
+		return orders, ok
+	}
+}
+
+// GetOrders implements OrderBookRepository.
+func (m *OrderbookRepositoryMock) GetOrders(poolID uint64, ownerAddress string) ([]orderbookdomain.Order, bool) {
+	if m.GetOrdersFunc != nil {
+		return m.GetOrdersFunc(poolID, ownerAddress)
+	}
+	panic("GetOrders not implemented")
+}

domain/mocks/passthrough_grpc_client_mock.go

@@ -9,13 +9,16 @@ import (
 	"google.golang.org/grpc"
 )
 
+var _ passthroughdomain.PassthroughGRPCClient = &PassthroughGRPCClientMock{}
+
 type PassthroughGRPCClientMock struct {
 	MockAllBalancesCb                   func(ctx context.Context, address string) (sdk.Coins, error)
 	MockAccountLockedCoinsCb            func(ctx context.Context, address string) (sdk.Coins, error)
 	MockAccountUnlockingCoinsCb         func(ctx context.Context, address string) (sdk.Coins, error)
 	MockDelegatorDelegationsCb          func(ctx context.Context, address string) (sdk.Coins, error)
 	MockDelegatorUnbondingDelegationsCb func(ctx context.Context, address string) (sdk.Coins, error)
 	MockUserPositionsBalancesCb         func(ctx context.Context, address string) (sdk.Coins, sdk.Coins, error)
+	MockGetOrderbookOrdersRawCb         func(ctx context.Context, poolID uint64) ([][]byte, error)
 	MockDelegationRewardsCb             func(ctx context.Context, address string) (sdk.Coins, error)
 }
 
@@ -78,6 +81,14 @@ func (p *PassthroughGRPCClientMock) AccountUnlockingCoins(ctx context.Context, a
 	return nil, errors.New("MockAccountLockedCoinsCb is not implemented")
 }
 
+// GetOrderbookOrdersRaw implements passthroughdomain.PassthroughGRPCClient.
+func (p *PassthroughGRPCClientMock) GetOrderbookOrdersRaw(ctx context.Context, poolID uint64) ([][]byte, error) {
+	if p.MockGetOrderbookOrdersRawCb != nil {
+		return p.MockGetOrderbookOrdersRawCb(ctx, poolID)
+	}
+	return nil, errors.New("MockGetOrderbookOrdersRawCb is not implemented")
+}
+
 // DelegationRewards implements passthroughdomain.PassthroughGRPCClient.
 func (p *PassthroughGRPCClientMock) DelegationRewards(ctx context.Context, address string) (sdk.Coins, error) {
 	if p.MockDelegationRewardsCb != nil {
@@ -86,5 +97,3 @@ func (p *PassthroughGRPCClientMock) DelegationRewards(ctx context.Context, addre
 
 	return nil, errors.New("MockDelegationRewardsCb is not implemented")
 }
-
-var _ passthroughdomain.PassthroughGRPCClient = &PassthroughGRPCClientMock{}

domain/orderbook/orderbook_repository.go

@@ -15,4 +15,10 @@ type OrderBookRepository interface {
 	// GetTickByID returns a specific orderbook tick for a given orderbook pool id.
 	// Returns false if the tick is not found.
 	GetTickByID(poolID uint64, tickID int64) (OrderbookTick, bool)
+
+	// StoreOrders stores the orders for a given orderbook pool id.
+	StoreOrders(poolID uint64, orders []Order) error
+
+	// GetOrders returns the orders for a given orderbook pool id.
+	GetOrders(poolID uint64, ownerAddress string) ([]Order, bool)
 }

domain/orderbook/plugin/config.go

@@ -2,7 +2,8 @@ package orderbookplugindomain
 
 // Orderbook plugin names
 const (
-	OrderbookFillbotPlugin  = "orderbook-fillbot-plugin"
-	OrderbookClaimbotPlugin = "orderbook-claimbot-plugin"
-	CustomSubmodulePlugin   = "custom-submodule-plugin"
+	OrderbookFillbotPlugin     = "orderbook-fillbot-plugin"
+	OrderbookClaimbotPlugin    = "orderbook-claimbot-plugin"
+	OrderbookOrdersCachePlugin = "orderbook-orders-cache-plugin"
+	CustomSubmodulePlugin      = "custom-submodule-plugin"
 )

domain/passthrough/passthrough_grpc_client.go

@@ -10,6 +10,7 @@ import (
 	staking "github.com/cosmos/cosmos-sdk/x/staking/types"
 	math "github.com/osmosis-labs/osmosis/osmomath"
 	concentratedLiquidity "github.com/osmosis-labs/osmosis/v28/x/concentrated-liquidity/client/queryproto"
+	cosmwasmpool "github.com/osmosis-labs/osmosis/v28/x/cosmwasmpool/client/queryproto"
 	lockup "github.com/osmosis-labs/osmosis/v28/x/lockup/types"
 	polarisgrpc "github.com/osmosis-labs/sqs/delivery/grpc"
 	"google.golang.org/grpc"
@@ -39,6 +40,9 @@ type PassthroughGRPCClient interface {
 	// DelegationTotalRewards returns the total unclaimed staking rewards accrued of the user with the given address.
 	DelegationRewards(ctx context.Context, address string) (sdk.Coins, error)
 
+	// GetOrderbookOrdersRaw returns the raw orderbook orders for the given pool ID.
+	GetOrderbookOrdersRaw(ctx context.Context, poolID uint64) ([][]byte, error)
+
 	GetChainGRPCClient() grpc.ClientConnInterface
 }
 
@@ -55,8 +59,8 @@ type passthroughGRPCClient struct {
 	lockupQueryClient                lockup.QueryClient
 	concentratedLiquidityQueryClient concentratedLiquidity.QueryClient
 	distributionClient               distribution.QueryClient
-
-	chainGRPCClient grpc.ClientConnInterface
+	cosmwasmpoolClient               cosmwasmpool.QueryClient
+	chainGRPCClient                  grpc.ClientConnInterface
 }
 
 const (
@@ -79,6 +83,7 @@ func NewPassthroughGRPCClient(grpcURI string) (PassthroughGRPCClient, error) {
 		lockupQueryClient:                lockup.NewQueryClient(grpcClient),
 		concentratedLiquidityQueryClient: concentratedLiquidity.NewQueryClient(grpcClient),
 		distributionClient:               distribution.NewQueryClient(grpcClient),
+		cosmwasmpoolClient:               cosmwasmpool.NewQueryClient(grpcClient),
 
 		chainGRPCClient: grpcClient,
 	}, nil
@@ -89,7 +94,6 @@ func (p *passthroughGRPCClient) AccountLockedCoins(ctx context.Context, address
 	if err != nil {
 		return nil, err
 	}
-
 	return response.Coins, nil
 }
 
@@ -194,6 +198,14 @@ func (p *passthroughGRPCClient) DelegationRewards(ctx context.Context, address s
 	return rewardCoins, nil
 }
 
+func (p *passthroughGRPCClient) GetOrderbookOrdersRaw(ctx context.Context, poolID uint64) ([][]byte, error) {
+	response, err := p.cosmwasmpoolClient.PoolRawFilteredState(ctx, &cosmwasmpool.PoolRawFilteredStateRequest{PoolId: poolID, KeyFilter: "order", ValueFilter: "order_id"})
+	if err != nil {
+		return nil, err
+	}
+	return response.Values, nil
+}
+
 // GetChainGRPCClient implements PassthroughGRPCClient.
 func (p *passthroughGRPCClient) GetChainGRPCClient() grpc.ClientConnInterface {
 	return p.chainGRPCClient

go.mod

@@ -1,6 +1,6 @@
 module github.com/osmosis-labs/sqs
 
-go 1.22.7
+go 1.22.11
 
 require (
 	cosmossdk.io/math v1.5.0
@@ -25,7 +25,7 @@ require (
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.34.0
 	go.opentelemetry.io/otel/sdk v1.34.0
 	go.uber.org/zap v1.26.0
-	google.golang.org/grpc v1.69.4
+	google.golang.org/grpc v1.70.0
 )
 
 require (
@@ -142,7 +142,7 @@ require (
 	github.com/godbus/dbus v0.0.0-20190726142602-4481cbc300e2 // indirect
 	github.com/gogo/googleapis v1.4.1 // indirect
 	github.com/gogo/protobuf v1.3.3 // indirect
-	github.com/golang/glog v1.2.2 // indirect
+	github.com/golang/glog v1.2.3 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/golang/mock v1.6.0 // indirect
 	github.com/golang/protobuf v1.5.4
@@ -203,7 +203,7 @@ require (
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/prometheus/client_model v0.6.1 // indirect
-	github.com/prometheus/common v0.60.1 // indirect
+	github.com/prometheus/common v0.62.0 // indirect
 	github.com/prometheus/procfs v0.15.1 // indirect
 	github.com/rakyll/statik v0.1.7 // indirect
 	github.com/rcrowley/go-metrics v0.0.0-20201227073835-cf1acfcdf475 // indirect
@@ -236,20 +236,20 @@ require (
 	go.opentelemetry.io/otel/trace v1.34.0
 	go.uber.org/multierr v1.11.0 // indirect
 	golang.org/x/crypto v0.32.0 // indirect
-	golang.org/x/exp v0.0.0-20240613232115-7f521ea00fb8
+	golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56
 	golang.org/x/net v0.34.0 // indirect
 	golang.org/x/oauth2 v0.24.0 // indirect
 	golang.org/x/sync v0.10.0 // indirect
 	golang.org/x/sys v0.29.0 // indirect
 	golang.org/x/term v0.28.0 // indirect
 	golang.org/x/text v0.21.0 // indirect
 	golang.org/x/time v0.6.0 // indirect
-	golang.org/x/tools v0.22.0 // indirect
+	golang.org/x/tools v0.23.0 // indirect
 	google.golang.org/api v0.197.0 // indirect
 	google.golang.org/genproto v0.0.0-20240903143218-8af14fe29dc1 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20250115164207-1a7da9e5054f
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20250115164207-1a7da9e5054f // indirect
-	google.golang.org/protobuf v1.36.3
+	google.golang.org/protobuf v1.36.4
 	gopkg.in/ini.v1 v1.67.0 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
@@ -284,7 +284,7 @@ replace (
 
 	// This replacement can be removed once Osmosis v28.0.3 or higher is released
 	// It is required to pull in test cases for BE-676 from backport branch: https://github.com/osmosis-labs/osmosis/pull/8962
-	github.com/osmosis-labs/osmosis/v28 v28.0.2 => github.com/osmosis-labs/osmosis/v28 v28.0.3-0.20250128064600-532afea930f9
+	github.com/osmosis-labs/osmosis/v28 v28.0.2 => github.com/osmosis-labs/osmosis/v28 v28.0.5-0.20250218091759-db70d39ef671
 
 	github.com/osmosis-labs/osmosis/x/epochs => github.com/osmosis-labs/osmosis/x/epochs v0.0.5-0.20240825083448-87db4447a1ff
 	github.com/osmosis-labs/osmosis/x/ibc-hooks => github.com/osmosis-labs/osmosis/x/ibc-hooks v0.0.0-20240825083448-87db4447a1ff