cache

Documentation

Index

• Constants
• Variables
• func CreateCacheCobraCommand() *cobra.Command
• func Server(ctx context.Context, listenAddr string, metricsAddr string, ...)
• type CacheMetrics
  • func NewCacheMetricsServer(listenAddress string) *CacheMetrics
  • func (c *CacheMetrics) AddApiSpecific(block int64, chainId string, method string, apiInterface string, hit bool)
• type CacheServer
  • func (cs *CacheServer) ExpirationForChain(chainID string) time.Duration
  • func (cs *CacheServer) InitCache(ctx context.Context, expiration time.Duration, ...)
  • func (cs *CacheServer) Serve(ctx context.Context, listenAddr string)
• type CacheValue
  • func (cv *CacheValue) Cost() int64
  • func (cv *CacheValue) ToCacheReply() *pairingtypes.CacheRelayReply
• type LastestCacheStore
  • func (cv *LastestCacheStore) Cost() int64
• type RelayerCacheServer
  • func (s *RelayerCacheServer) GetRelay(ctx context.Context, relayCacheGet *pairingtypes.RelayCacheGet) (cacheReply *pairingtypes.CacheRelayReply, err error)
  • func (s *RelayerCacheServer) Health(ctx context.Context, req *emptypb.Empty) (*pairingtypes.CacheUsage, error)
  • func (s *RelayerCacheServer) PrintCacheStats(ctx context.Context, desc string)
  • func (s *RelayerCacheServer) SetRelay(ctx context.Context, relayCacheSet *pairingtypes.RelayCacheSet) (*emptypb.Empty, error)

Constants

const (
	FlagLogLevel       = "log_level"
	FlagMetricsAddress = "metrics_address"
)

const (
	ExpirationFlagName               = "expiration"
	ExpirationNonFinalizedFlagName   = "expiration-non-finalized"
	DefaultExpirationForNonFinalized = 500 * time.Millisecond
	DefaultExpirationTimeFinalized   = time.Hour
	CacheMaxCost                     = 2 * 1024 * 1024 * 1024 // 2GB cost
	CacheNumCounters                 = 100000000              // expect 10M items
)

const (
	DisabledFlagOption = "disabled"
)

const (
	SEP = ";"
)

Variables

var (
	NotFoundError     = sdkerrors.New("Cache miss", 1, "cache entry for specific block and request wasn't found")                                                   // client could'nt connect to any provider.
	HashMismatchError = sdkerrors.New("Cache hit but hash mismatch", 2, "cache entry for specific block and request had a mismatching hash stored")                 // client could'nt connect to any provider.
	EntryTypeError    = sdkerrors.New("Cache hit but entry is a different object", 3, "cache entry for specific block and request had a mismatching object stored") // client could'nt connect to any provider.
)

Functions

func CreateCacheCobraCommand

func CreateCacheCobraCommand() *cobra.Command

func Server

func Server(
	ctx context.Context,
	listenAddr string,
	metricsAddr string,
	flags *pflag.FlagSet,
)

Types

type CacheMetrics

type CacheMetrics struct {
	// contains filtered or unexported fields
}

func NewCacheMetricsServer

func NewCacheMetricsServer(listenAddress string) *CacheMetrics

func (*CacheMetrics) AddApiSpecific

func (c *CacheMetrics) AddApiSpecific(block int64, chainId string, method string, apiInterface string, hit bool)

type CacheServer

type CacheServer struct {
	ExpirationFinalized    time.Duration
	ExpirationNonFinalized time.Duration
	CacheMetrics           *CacheMetrics
	// contains filtered or unexported fields
}

func (*CacheServer) ExpirationForChain

func (cs *CacheServer) ExpirationForChain(chainID string) time.Duration

func (*CacheServer) InitCache

func (cs *CacheServer) InitCache(ctx context.Context, expiration time.Duration, expirationNonFinalized time.Duration, metricsAddr string)

func (*CacheServer) Serve

func (cs *CacheServer) Serve(ctx context.Context,
	listenAddr string,
)

type CacheValue

type CacheValue struct {
	Response         pairingtypes.RelayReply
	Hash             []byte
	OptionalMetadata []pairingtypes.Metadata
}

func (*CacheValue) Cost

func (cv *CacheValue) Cost() int64

func (*CacheValue) ToCacheReply

func (cv *CacheValue) ToCacheReply() *pairingtypes.CacheRelayReply

type LastestCacheStore

type LastestCacheStore struct {
	// contains filtered or unexported fields
}

func (*LastestCacheStore) Cost

func (cv *LastestCacheStore) Cost() int64

type RelayerCacheServer

type RelayerCacheServer struct {
	pairingtypes.UnimplementedRelayerCacheServer
	CacheServer *CacheServer
	// contains filtered or unexported fields
}

func (*RelayerCacheServer) GetRelay

func (s *RelayerCacheServer) GetRelay(ctx context.Context, relayCacheGet *pairingtypes.RelayCacheGet) (cacheReply *pairingtypes.CacheRelayReply, err error)

func (*RelayerCacheServer) Health

func (s *RelayerCacheServer) Health(ctx context.Context, req *emptypb.Empty) (*pairingtypes.CacheUsage, error)

func (*RelayerCacheServer) PrintCacheStats

func (s *RelayerCacheServer) PrintCacheStats(ctx context.Context, desc string)

func (*RelayerCacheServer) SetRelay

func (s *RelayerCacheServer) SetRelay(ctx context.Context, relayCacheSet *pairingtypes.RelayCacheSet) (*emptypb.Empty, error)