spectre

Documentation

Index

• Constants
• type Config
• type Pair
• type Spectre
  • func NewSpectre(cfg Config) (*Spectre, error)
  • func (s *Spectre) Start(ctx context.Context) error
  • func (s *Spectre) Wait() chan error

Constants

const LoggerTag = "SPECTRE"

Types

type Config

type Config struct {
	Signer ethereum.Signer
	// PriceStore provides prices for Spectre.
	PriceStore *store.PriceStore
	// Interval describes how often we should try to update Oracles.
	Interval time.Duration
	// Pairs is the list supported pairs by Spectre with their configuration.
	Pairs []*Pair
	// Logger is a current logger interface used by the Spectre. The Logger is
	// required to monitor asynchronous processes.
	Logger log.Logger
}

Config is the configuration for Spectre.

type Pair

type Pair struct {
	// AssetPair is the name of asset pair, e.g. ETHUSD.
	AssetPair string
	// OracleSpread is the minimum spread between the Oracle price and new price
	// required to send update.
	OracleSpread float64
	// OracleExpiration is the minimum time difference between the Oracle time
	// and current time required to send an update.
	OracleExpiration time.Duration
	// PriceExpiration is the maximum amount of time before price received
	// from the feeder will be considered as expired.
	PriceExpiration time.Duration
	// Median is the instance of the oracle.Median which is the interface for
	// the Oracle contract.
	Median oracle.Median
}

type Spectre

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

func NewSpectre

func NewSpectre(cfg Config) (*Spectre, error)

func (*Spectre) Start

func (s *Spectre) Start(ctx context.Context) error

func (*Spectre) Wait

func (s *Spectre) Wait() chan error

Wait waits until the context is canceled or until an error occurs.