apidata

package

v0.6.3 Latest Latest Go to latest Published: Sep 7, 2023 License: BlueOak-1.0.0 Imports: 10 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type BookSource interface {
	Book(mktName string) (*msgjson.OrderBook, error)
}

BookSource is a source of order book information. The BookSource is added after construction but before use.

type DBSource interface {
	LoadEpochStats(base, quote uint32, caches []*candles.Cache) error
}

DBSource is a source of persistent data. DBSource is used to prime the caches at startup.

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

DataAPI is a data API backend.

func NewDataAPI(dbSrc DBSource) *DataAPI

NewDataAPI is the constructor for a new DataAPI.

func (s *DataAPI) AddMarketSource(mkt MarketSource) error

AddMarketSource should be called before any markets are running.

func (s *DataAPI) ReportEpoch(base, quote uint32, epochIdx uint64, stats *matcher.MatchCycleStats) (*msgjson.Spot, error)

ReportEpoch should be called by every Market after every match cycle to report their epoch stats.

func (s *DataAPI) SetBookSource(bs BookSource)

SetBookSource should be called before the first call to handleBook.

type MarketSource interface {
	EpochDuration() uint64
	Base() uint32
	Quote() uint32
}

MarketSource is a source of market information. Markets are added after construction but before use using the AddMarketSource method.