origin

package
v0.12.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 21, 2023 License: AGPL-3.0 Imports: 25 Imported by: 0

Documentation

Index

Constants

View Source 
const BalancerV2LoggerTag = "BALANCERV2_ORIGIN"
View Source 
const CurveLoggerTag = "CURVE_ORIGIN"
View Source 
const ISharesLoggerTag = "ISHARES_ORIGIN"
View Source 
const RocketPoolLoggerTag = "ROCKETPOOL_ORIGIN"
View Source 
const SDAILoggerTag = "SDAI_ORIGIN"
View Source 
const SushiswapLoggerTag = "SUSHISWAP_ORIGIN"
View Source 
const TickGenericHTTPLoggerTag = "TICK_GENERIC_HTTP_ORIGIN"
View Source 
const TickGenericJQLoggerTag = "TICK_GENERIC_JQ_ORIGIN"
View Source 
const UniswapV2LoggerTag = "UNISWAPV2_ORIGIN"
View Source 
const UniswapV3LoggerTag = "UNISWAPV3_ORIGIN"
View Source 
const WrappedStakedETHLoggerTag = "WSTETH_ORIGIN"

Variables

This section is empty.

Functions

This section is empty.

Types

type AssetPair added in v0.11.4 

type AssetPair [maxTokenCount]string

func (AssetPair) IndexOf added in v0.11.4 

func (a AssetPair) IndexOf(token string) int

func (*AssetPair) UnmarshalText added in v0.11.4 

func (a *AssetPair) UnmarshalText(text []byte) error

type BalancerV2 

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

func NewBalancerV2 

func NewBalancerV2(config BalancerV2Config) (*BalancerV2, error)

func (*BalancerV2) FetchDataPoints 

func (b *BalancerV2) FetchDataPoints(ctx context.Context, query []any) (map[any]datapoint.Point, error)

type BalancerV2Config 

type BalancerV2Config struct {
	Client             rpc.RPC
	ContractAddresses  ContractAddresses
	ReferenceAddresses ContractAddresses
	Logger             log.Logger
	Blocks             []int64
}

type ContractAddresses 

type ContractAddresses map[AssetPair]types.Address

func (ContractAddresses) ByPair 

func (c ContractAddresses) ByPair(p value.Pair) (types.Address, int, int, error)

ByPair returns the contract address and the indexes of tokens, where the contract contains the given pair If not found base and quote token, return zero address and -1 for indexes For example, if we have a pool address of USDT/WBTC/WETH, and we are looking for USDT/WETH, then ByPair return the pool address and the indexes of 0, 2 (index is based on zero)

type Curve 

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

func NewCurve 

func NewCurve(config CurveConfig) (*Curve, error)

func (*Curve) FetchDataPoints 

func (c *Curve) FetchDataPoints(ctx context.Context, query []any) (map[any]datapoint.Point, error)

type CurveConfig 

type CurveConfig struct {
	Client                      rpc.RPC
	StableSwapContractAddresses ContractAddresses
	CryptoSwapContractAddresses ContractAddresses
	Logger                      log.Logger
	Blocks                      []int64
}

type ERC20 

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

func NewERC20 

func NewERC20(client rpc.RPC) (*ERC20, error)

func (*ERC20) GetSymbolAndDecimals 

func (e *ERC20) GetSymbolAndDecimals(ctx context.Context, addresses []types.Address) (map[string]ERC20Details, error)

type ERC20Details 

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

type HTTPCallback 

type HTTPCallback func(ctx context.Context, pairs []value.Pair, data io.Reader) (map[any]datapoint.Point, error)

type IShares 

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

func NewIShares 

func NewIShares(config ISharesConfig) (*IShares, error)

func (*IShares) FetchDataPoints 

func (g *IShares) FetchDataPoints(ctx context.Context, query []any) (map[any]datapoint.Point, error)

FetchDataPoints implements the Origin interface.

type ISharesConfig 

type ISharesConfig struct {
	URL     string
	Headers http.Header
	Client  *http.Client
	Logger  log.Logger
}

type Origin 

type Origin interface {
	// FetchDataPoints fetches data points for the given list of queries.
	//
	// A query is an any type that can be used to query the origin for a data
	// point. For example, a query could be a pair of assets.
	//
	// Note that this method does not guarantee that data points will be
	// returned for all pairs nor in the same order as the pairs. The caller
	// must verify returned data.
	FetchDataPoints(ctx context.Context, query []any) (map[any]datapoint.Point, error)
}

Origin provides dataPoint prices for a given set of pairs from an external source.

type RocketPool 

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

func NewRocketPool 

func NewRocketPool(config RocketPoolConfig) (*RocketPool, error)

func (*RocketPool) FetchDataPoints 

func (r *RocketPool) FetchDataPoints(ctx context.Context, query []any) (map[any]datapoint.Point, error)

type RocketPoolConfig 

type RocketPoolConfig struct {
	Client            rpc.RPC
	ContractAddresses ContractAddresses
	Logger            log.Logger
	Blocks            []int64
}

type SDAI added in v0.11.5 

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

func NewSDAI added in v0.11.5 

func NewSDAI(config SDAIConfig) (*SDAI, error)

func (*SDAI) FetchDataPoints added in v0.11.5 

func (s *SDAI) FetchDataPoints(ctx context.Context, query []any) (map[any]datapoint.Point, error)

type SDAIConfig added in v0.11.5 

type SDAIConfig struct {
	Client            rpc.RPC
	ContractAddresses ContractAddresses
	Logger            log.Logger
	Blocks            []int64
}

type Static 

type Static struct{}

Static is an origin that returns the same value for all queries.

func NewStatic 

func NewStatic() *Static

NewStatic creates a new static origin.

func (*Static) FetchDataPoints 

func (s *Static) FetchDataPoints(_ context.Context, query []any) (map[any]datapoint.Point, error)

FetchDataPoints implements the data.Type interface.

type Sushiswap 

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

func NewSushiswap 

func NewSushiswap(config SushiswapConfig) (*Sushiswap, error)

func (*Sushiswap) FetchDataPoints 

func (s *Sushiswap) FetchDataPoints(ctx context.Context, query []any) (map[any]datapoint.Point, error)

type SushiswapConfig 

type SushiswapConfig struct {
	Client            rpc.RPC
	ContractAddresses ContractAddresses
	Logger            log.Logger
	Blocks            []int64
}

type TickGenericHTTP 

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

TickGenericHTTP is a generic http price provider that can fetch prices from an HTTP endpoint. The callback function is used to parse the response body.

func NewTickGenericHTTP 

func NewTickGenericHTTP(config TickGenericHTTPConfig) (*TickGenericHTTP, error)

NewTickGenericHTTP creates a new TickGenericHTTP instance.

func (*TickGenericHTTP) FetchDataPoints 

func (g *TickGenericHTTP) FetchDataPoints(ctx context.Context, query []any) (map[any]datapoint.Point, error)

FetchDataPoints implements the Origin interface.

type TickGenericHTTPConfig 

type TickGenericHTTPConfig struct {
	// URL is an TickGenericHTTP endpoint that returns JSON data. It may contain
	// the following variables:
	//   - ${lcbase} - lower case base asset
	//   - ${ucbase} - upper case base asset
	//   - ${lcquote} - lower case quote asset
	//   - ${ucquote} - upper case quote asset
	//   - ${lcbases} - lower case base assets joined by commas
	//   - ${ucbases} - upper case base assets joined by commas
	//   - ${lcquotes} - lower case quote assets joined by commas
	//   - ${ucquotes} - upper case quote assets joined by commas
	URL string

	// Headers is a set of TickGenericHTTP headers that are sent with each request.
	Headers http.Header

	// Callback is a function that is used to parse the response body.
	Callback HTTPCallback

	// Client is an TickGenericHTTP client that is used to fetch data from the
	// TickGenericHTTP endpoint. If nil, http.DefaultClient is used.
	Client *http.Client

	// Logger is an TickGenericHTTP logger that is used to log errors. If nil,
	// null logger is used.
	Logger log.Logger
}

type TickGenericJQ 

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

TickGenericJQ is a generic origin implementation that uses JQ to parse JSON data from an TickGenericHTTP endpoint.

func NewTickGenericJQ 

func NewTickGenericJQ(config TickGenericJQConfig) (*TickGenericJQ, error)

NewTickGenericJQ creates a new TickGenericJQ instance.

The client argument is an TickGenericHTTP client that is used to fetch data from the TickGenericHTTP endpoint.

The url argument is an TickGenericHTTP endpoint that returns JSON data. It may contain the following variables:

  • ${lcbase} - lower case base asset
  • ${ucbase} - upper case base asset
  • ${lcquote} - lower case quote asset
  • ${ucquote} - upper case quote asset
  • ${lcbases} - lower case base assets joined by commas
  • ${ucbases} - upper case base assets joined by commas
  • ${lcquotes} - lower case quote assets joined by commas
  • ${ucquotes} - upper case quote assets joined by commas

The jq argument is a JQ query that is used to parse JSON data. It must return a single value that will be used as a price or an object with the following fields:

  • price - a price
  • time - a timestamp (optional)
  • volume - a 24h volume (optional)

The JQ query may contain the following variables:

  • $lcbase - lower case base asset
  • $ucbase - upper case base asset
  • $lcquote - lower case quote asset
  • $ucquote - upper case quote asset

Price and volume must be a string that can be parsed as a number or a number.

Time must be a string that can be parsed as time or a number that represents a UNIX timestamp.

If JQ query returns multiple values, the dataPoint will be invalid.

func (*TickGenericJQ) FetchDataPoints 

func (g *TickGenericJQ) FetchDataPoints(ctx context.Context, query []any) (map[any]datapoint.Point, error)

FetchDataPoints implements the Origin interface.

type TickGenericJQConfig 

type TickGenericJQConfig struct {
	// URL is an TickGenericHTTP endpoint that returns JSON data. It may contain
	// the following variables:
	//   - ${lcbase} - lower case base asset
	//   - ${ucbase} - upper case base asset
	//   - ${lcquote} - lower case quote asset
	//   - ${ucquote} - upper case quote asset
	//   - ${lcbases} - lower case base assets joined by commas
	//   - ${ucbases} - upper case base assets joined by commas
	//   - ${lcquotes} - lower case quote assets joined by commas
	//   - ${ucquotes} - upper case quote assets joined by commas
	URL string

	// Query is a JQ query that is used to parse JSON data. It must
	// return a single value that will be used as a price or an object with the
	// following fields:
	//   - price - a price
	//   - time - a timestamp (optional)
	//   - volume - a 24h volume (optional)
	//
	// The JQ query may contain the following variables:
	//   - $lcbase - lower case base asset
	//   - $ucbase - upper case base asset
	//   - $lcquote - lower case quote asset
	//   - $ucquote - upper case quote asset
	//
	// Price and volume must be a number or a string that can be parsed as a number.
	// Time must be a number or a string that can be parsed as a number or a string
	// that can be parsed as a time.
	Query string

	// Headers is a set of TickGenericHTTP headers that are sent with each request.
	Headers http.Header

	// Client is an TickGenericHTTP client that is used to fetch data from the
	// TickGenericHTTP endpoint. If nil, http.DefaultClient is used.
	Client *http.Client

	// Logger is an TickGenericHTTP logger that is used to log errors. If nil,
	// null logger is used.
	Logger log.Logger
}

type UniswapV2 added in v0.12.0 

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

func NewUniswapV2 added in v0.12.0 

func NewUniswapV2(config UniswapV2Config) (*UniswapV2, error)

func (*UniswapV2) FetchDataPoints added in v0.12.0 

func (u *UniswapV2) FetchDataPoints(ctx context.Context, query []any) (map[any]datapoint.Point, error)

type UniswapV2Config added in v0.12.0 

type UniswapV2Config struct {
	Client            rpc.RPC
	ContractAddresses ContractAddresses
	Logger            log.Logger
	Blocks            []int64
}

type UniswapV3 

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

func NewUniswapV3 

func NewUniswapV3(config UniswapV3Config) (*UniswapV3, error)

func (*UniswapV3) FetchDataPoints 

func (u *UniswapV3) FetchDataPoints(ctx context.Context, query []any) (map[any]datapoint.Point, error)

type UniswapV3Config 

type UniswapV3Config struct {
	Client            rpc.RPC
	ContractAddresses ContractAddresses
	Logger            log.Logger
	Blocks            []int64
}

type WrappedStakedETH 

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

func NewWrappedStakedETH 

func NewWrappedStakedETH(config WrappedStakedETHConfig) (*WrappedStakedETH, error)

func (*WrappedStakedETH) FetchDataPoints 

func (w *WrappedStakedETH) FetchDataPoints(ctx context.Context, query []any) (map[any]datapoint.Point, error)

type WrappedStakedETHConfig 

type WrappedStakedETHConfig struct {
	Client            rpc.RPC
	ContractAddresses ContractAddresses
	Logger            log.Logger
	Blocks            []int64
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.