client

Documentation

Index

• func DefaultClientMetrics(namespace string) *grpc_prometheus.ClientMetrics
• func NewConnection(target string, opts ...Option) (*grpc.ClientConn, error)
• type Client
  • func NewClientFromConnection(conn grpc.ClientConnInterface) Client
• type ClosableClient
  • func NewClient(target string, opts ...Option) (ClosableClient, error)
• type Config
  • func DefaultConfig() Config
  • func (c Config) Interceptors() []grpc.UnaryClientInterceptor
• type Option
  • func WithLog(log zerolog.Logger) Option

Functions

func DefaultClientMetrics

func DefaultClientMetrics(namespace string) *grpc_prometheus.ClientMetrics

func NewConnection

func NewConnection(
	target string,
	opts ...Option,
) (*grpc.ClientConn, error)

Types

type Client

type Client interface {
	GetLatestBlockHeader(ctx context.Context, isSealed bool) (*flow.BlockHeader, error)
	ExecuteScriptAtBlockHeight(ctx context.Context, height uint64, script []byte, arguments []cadence.Value) (cadence.Value, error)
	GetBlockByHeight(ctx context.Context, height uint64) (*flow.Block, error)
	GetTransaction(ctx context.Context, txID flow.Identifier) (*flow.Transaction, error)
	GetEventsForHeightRange(ctx context.Context, query flowgrpc.EventRangeQuery) ([]flow.BlockEvents, error)
	GetCollection(ctx context.Context, colID flow.Identifier) (*flow.Collection, error)
}

func NewClientFromConnection

func NewClientFromConnection(
	conn grpc.ClientConnInterface,
) Client

type ClosableClient

type ClosableClient interface {
	Client
	io.Closer
}

func NewClient

func NewClient(
	target string,
	opts ...Option,
) (ClosableClient, error)

type Config

type Config struct {
	Log zerolog.Logger

	DefaultCallOptions []grpc.CallOption

	DefaultRateLimit   int
	SpecificRateLimits map[string]int

	Timeout time.Duration

	Retries int

	ClientMetrics *grpc_prometheus.ClientMetrics
	// contains filtered or unexported fields
}

func DefaultConfig

func DefaultConfig() Config

func (Config) Interceptors

func (c Config) Interceptors() []grpc.UnaryClientInterceptor

type Option

type Option func(*Config)

func WithLog

func WithLog(log zerolog.Logger) Option