sqs

README

Sidecar Query Server Ingester

This is an implementation of the sidecar query server (SQS) ingester.

Please find the sidecar query server here

The use case for this is performing certain data and computationally intensive tasks outside of the chain node or the clients. For example, routing falls under this category because it requires all pool data for performing the complex routing algorithm.

SQS is meant to offload the query load from the chain node to a separate server. Primarily, we use it for swap routing.

Integrator Guide

Follow this link to find a guide on how to integrate with the sidecar query server.

Documentation

Index

• Variables
• func NewSidecarQueryServerIngester(poolsIngester domain.PoolsTransformer, appCodec codec.Codec, ...) domain.Ingester
• type Config
  • func NewConfigFromOptions(opts servertypes.AppOptions) Config
  • func (c Config) Initialize(appCodec codec.Codec, keepers domain.SQSIngestKeepers) (domain.Ingester, error)

Variables

var DefaultConfig = Config{
	IsEnabled: false,

	GRPCIngestAddress: "localhost:50051",

	GRPCIngestMaxCallSizeBytes: 50 * 1024 * 1024,
}

DefaultConfig defines the default config for the sidecar query server.

Functions

func NewSidecarQueryServerIngester

func NewSidecarQueryServerIngester(poolsIngester domain.PoolsTransformer, appCodec codec.Codec, keepers domain.SQSIngestKeepers, sqsGRPCClient domain.SQSGRPClient) domain.Ingester

NewSidecarQueryServerIngester creates a new sidecar query server ingester. poolsRepository is the storage for pools. gammKeeper is the keeper for Gamm pools.

Types

type Config

type Config struct {
	// IsEnabled defines if the sidecar query server is enabled.
	IsEnabled bool `mapstructure:"enabled"`
	// GRPCIngestAddress defines the gRPC address of the sidecar query server ingest.
	GRPCIngestAddress string `mapstructure:"grpc-ingest-address"`
	// GRPCIngestMaxCallSizeBytes defines the maximum size of a gRPC ingest call in bytes.
	GRPCIngestMaxCallSizeBytes int `mapstructure:"grpc-ingest-max-call-size-bytes"`
}

Config defines the config for the sidecar query server.

func NewConfigFromOptions

func NewConfigFromOptions(opts servertypes.AppOptions) Config

NewConfigFromOptions returns a new sidecar query server config from the given options.

func (Config) Initialize

func (c Config) Initialize(appCodec codec.Codec, keepers domain.SQSIngestKeepers) (domain.Ingester, error)

Initialize initializes the sidecar query server and returns the ingester.