benchmarks

README

Benchmarks Client

More information about the Benchmarks API can be found here.

Current Supported Endpoints

• /v1/updates/price/{timestamp} (documentation)

Documentation

Index

• type Client
  • func NewClient(cfg *Config, logger retryablehttp.LeveledLogger) (*Client, error)
  • func (c *Client) GetHistoricalPriceUpdatesSync(_ context.Context, timestamp time.Time, priceFeeds ...string) (map[string]*apyth.PythStructsPriceFeed, error)
  • func (c *Client) Shutdown()
• type Config
  • func (c *Config) Validate() error

Types

type Client

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

Client is a client for the Pyth Benchmarks API (https://benchmarks.pyth.network/docs)

func NewClient

func NewClient(cfg *Config, logger retryablehttp.LeveledLogger) (*Client, error)

NewClient creates a client for the Pyth Benchmarks API.

func (*Client) GetHistoricalPriceUpdatesSync

func (c *Client) GetHistoricalPriceUpdatesSync(
	_ context.Context, timestamp time.Time, priceFeeds ...string,
) (map[string]*apyth.PythStructsPriceFeed, error)

func (*Client) Shutdown

func (c *Client) Shutdown()

Shutdown gracefully shuts down the Pythnet Hermes client.

type Config

type Config struct {
	APIEndpoint string
	HTTPTimeout time.Duration
	MaxRetries  int
}

func (*Config) Validate

func (c *Config) Validate() error