Documentation ¶
Index ¶
- func MigrateDB(s *TickerSession) (int, error)
- func OpenTestDBConnection(t *testing.T) *dbtest.DB
- type Asset
- type Issuer
- type Market
- type OrderbookStats
- type PartialMarket
- type TickerSession
- func (s *TickerSession) BulkInsertTrades(ctx context.Context, trades []Trade) (err error)
- func (s *TickerSession) DeleteOldTrades(ctx context.Context, minDate time.Time) error
- func (s *TickerSession) GetAllIssuers(ctx context.Context) (issuers []Issuer, err error)
- func (s *TickerSession) GetAllValidAssets(ctx context.Context) (assets []Asset, err error)
- func (s *TickerSession) GetAssetByCodeAndIssuerAccount(ctx context.Context, code string, issuerAccount string) (found bool, id int32, err error)
- func (s *TickerSession) GetAssetsWithNestedIssuer(ctx context.Context) (assets []Asset, err error)
- func (s *TickerSession) GetLastTrade(ctx context.Context) (trade Trade, err error)
- func (s *TickerSession) InsertOrUpdateAsset(ctx context.Context, a *Asset, preserveFields []string) (err error)
- func (s *TickerSession) InsertOrUpdateIssuer(ctx context.Context, issuer *Issuer, preserveFields []string) (id int32, err error)
- func (s *TickerSession) InsertOrUpdateOrderbookStats(ctx context.Context, o *OrderbookStats, preserveFields []string) (err error)
- func (s *TickerSession) Retrieve7DRelevantMarkets(ctx context.Context) (partialMkts []PartialMarket, err error)
- func (s *TickerSession) RetrieveMarketData(ctx context.Context) (markets []Market, err error)
- func (s *TickerSession) RetrievePartialAggMarkets(ctx context.Context, pairName *string, numHoursAgo int) (partialMkts []PartialMarket, err error)
- func (s *TickerSession) RetrievePartialMarkets(ctx context.Context, baseAssetCode *string, baseAssetIssuer *string, ...) (partialMkts []PartialMarket, err error)
- type Trade
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func MigrateDB ¶
func MigrateDB(s *TickerSession) (int, error)
Types ¶
type Asset ¶
type Asset struct { ID int32 `db:"id"` Code string `db:"code"` IssuerAccount string `db:"issuer_account"` Type string `db:"type"` NumAccounts int32 `db:"num_accounts"` AuthRequired bool `db:"auth_required"` AuthRevocable bool `db:"auth_revocable"` Amount float64 `db:"amount"` AssetControlledByDomain bool `db:"asset_controlled_by_domain"` AnchorAssetCode string `db:"anchor_asset_code"` AnchorAssetType string `db:"anchor_asset_type"` IsValid bool `db:"is_valid"` ValidationError string `db:"validation_error"` LastValid time.Time `db:"last_valid"` LastChecked time.Time `db:"last_checked"` DisplayDecimals int `db:"display_decimals"` Name string `db:"name"` Desc string `db:"description"` Conditions string `db:"conditions"` IsAssetAnchored bool `db:"is_asset_anchored"` FixedNumber int `db:"fixed_number"` MaxNumber int `db:"max_number"` IsUnlimited bool `db:"is_unlimited"` RedemptionInstructions string `db:"redemption_instructions"` CollateralAddresses string `db:"collateral_addresses"` CollateralAddressSignatures string `db:"collateral_address_signatures"` Countries string `db:"countries"` Status string `db:"status"` IssuerID int32 `db:"issuer_id"` Issuer Issuer `db:"-"` }
Asset represents an entry on the assets table
type Issuer ¶
type Issuer struct { ID int32 `db:"id"` PublicKey string `db:"public_key"` Name string `db:"name"` URL string `db:"url"` TOMLURL string `db:"toml_url"` FederationServer string `db:"federation_server"` AuthServer string `db:"auth_server"` TransferServer string `db:"transfer_server"` WebAuthEndpoint string `db:"web_auth_endpoint"` DepositServer string `db:"deposit_server"` OrgTwitter string `db:"org_twitter"` }
Issuer represents an entry on the issuers table
type Market ¶
type Market struct { TradePair string `db:"trade_pair_name"` BaseVolume24h float64 `db:"base_volume_24h"` CounterVolume24h float64 `db:"counter_volume_24h"` TradeCount24h int64 `db:"trade_count_24h"` OpenPrice24h float64 `db:"open_price_24h"` LowestPrice24h float64 `db:"lowest_price_24h"` HighestPrice24h float64 `db:"highest_price_24h"` PriceChange24h float64 `db:"price_change_24h"` BaseVolume7d float64 `db:"base_volume_7d"` CounterVolume7d float64 `db:"counter_volume_7d"` TradeCount7d int64 `db:"trade_count_7d"` OpenPrice7d float64 `db:"open_price_7d"` LowestPrice7d float64 `db:"lowest_price_7d"` HighestPrice7d float64 `db:"highest_price_7d"` PriceChange7d float64 `db:"price_change_7d"` LastPriceCloseTime time.Time `db:"close_time"` LastPrice float64 `db:"last_price"` NumBids int `db:"num_bids"` BidVolume float64 `db:"bid_volume"` HighestBid float64 `db:"highest_bid"` NumAsks int `db:"num_asks"` AskVolume float64 `db:"ask_volume"` LowestAsk float64 `db:"lowest_ask"` }
Market represent the aggregated market data retrieved from the database. Note: this struct does *not* directly map to a db entity.
type OrderbookStats ¶
type OrderbookStats struct { ID int32 `db:"id"` BaseAssetID int32 `db:"base_asset_id"` CounterAssetID int32 `db:"counter_asset_id"` NumBids int `db:"num_bids"` BidVolume float64 `db:"bid_volume"` HighestBid float64 `db:"highest_bid"` NumAsks int `db:"num_asks"` AskVolume float64 `db:"ask_volume"` LowestAsk float64 `db:"lowest_ask"` Spread float64 `db:"spread"` SpreadMidPoint float64 `db:"spread_mid_point"` UpdatedAt time.Time `db:"updated_at"` }
OrderbookStats represents an entry on the orderbook_stats table
type PartialMarket ¶
type PartialMarket struct { TradePairName string `db:"trade_pair_name"` BaseAssetID int32 `db:"base_asset_id"` BaseAssetCode string `db:"base_asset_code"` BaseAssetIssuer string `db:"base_asset_issuer"` BaseAssetType string `db:"base_asset_type"` CounterAssetID int32 `db:"counter_asset_id"` CounterAssetCode string `db:"counter_asset_code"` CounterAssetIssuer string `db:"counter_asset_issuer"` CounterAssetType string `db:"counter_asset_type"` BaseVolume float64 `db:"base_volume"` CounterVolume float64 `db:"counter_volume"` TradeCount int32 `db:"trade_count"` Open float64 `db:"open_price"` Low float64 `db:"lowest_price"` High float64 `db:"highest_price"` Change float64 `db:"price_change"` Close float64 `db:"last_price"` NumBids int `db:"num_bids"` BidVolume float64 `db:"bid_volume"` HighestBid float64 `db:"highest_bid"` NumAsks int `db:"num_asks"` AskVolume float64 `db:"ask_volume"` LowestAsk float64 `db:"lowest_ask"` IntervalStart time.Time `db:"interval_start"` FirstLedgerCloseTime time.Time `db:"first_ledger_close_time"` LastLedgerCloseTime time.Time `db:"last_ledger_close_time"` }
PartialMarket represents the aggregated market data for a specific pair of assets (or asset codes) during an arbitrary time range. Note: this struct does *not* directly map to a db entity.
type TickerSession ¶
TickerSession provides helper methods for making queries against `DB`.
func CreateSession ¶
func CreateSession(driverName, dataSourceName string) (session TickerSession, err error)
CreateSession returns a new TickerSession that connects to the given db settings
func (*TickerSession) BulkInsertTrades ¶
func (s *TickerSession) BulkInsertTrades(ctx context.Context, trades []Trade) (err error)
BulkInsertTrades inserts a slice of trades in the database. Trades that are already in the database (i.e. aurora_id already exists) are ignored.
func (*TickerSession) DeleteOldTrades ¶
DeleteOldTrades deletes trades in the database older than minDate.
func (*TickerSession) GetAllIssuers ¶
func (s *TickerSession) GetAllIssuers(ctx context.Context) (issuers []Issuer, err error)
GetAllIssuers returns a slice with all issuers in the database
func (*TickerSession) GetAllValidAssets ¶
func (s *TickerSession) GetAllValidAssets(ctx context.Context) (assets []Asset, err error)
GetAllValidAssets returns a slice with all assets in the database with is_valid = true
func (*TickerSession) GetAssetByCodeAndIssuerAccount ¶
func (s *TickerSession) GetAssetByCodeAndIssuerAccount(ctx context.Context, code string, issuerAccount string, ) (found bool, id int32, err error)
GetAssetByCodeAndIssuerAccount searches for an Asset with the given code and public key, and returns its ID in case it is found.
func (*TickerSession) GetAssetsWithNestedIssuer ¶
func (s *TickerSession) GetAssetsWithNestedIssuer(ctx context.Context) (assets []Asset, err error)
GetAssetsWithNestedIssuer returns a slice with all assets in the database with is_valid = true, also adding the nested Issuer attribute
func (*TickerSession) GetLastTrade ¶
func (s *TickerSession) GetLastTrade(ctx context.Context) (trade Trade, err error)
GetLastTrade returns the newest Trade object in the database.
func (*TickerSession) InsertOrUpdateAsset ¶
func (s *TickerSession) InsertOrUpdateAsset(ctx context.Context, a *Asset, preserveFields []string) (err error)
InsertOrUpdateAsset inserts an Asset on the database (if new), or updates an existing one
func (*TickerSession) InsertOrUpdateIssuer ¶
func (s *TickerSession) InsertOrUpdateIssuer(ctx context.Context, issuer *Issuer, preserveFields []string) (id int32, err error)
InsertOrUpdateIssuer inserts an Issuer on the database (if new), or updates an existing one
func (*TickerSession) InsertOrUpdateOrderbookStats ¶
func (s *TickerSession) InsertOrUpdateOrderbookStats(ctx context.Context, o *OrderbookStats, preserveFields []string) (err error)
InsertOrUpdateOrderbookStats inserts an OrdebookStats entry on the database (if new), or updates an existing one
func (*TickerSession) Retrieve7DRelevantMarkets ¶
func (s *TickerSession) Retrieve7DRelevantMarkets(ctx context.Context) (partialMkts []PartialMarket, err error)
Retrieve7DRelevantMarkets retrieves the base and counter asset data of the markets that were relevant in the last 7-day period.
func (*TickerSession) RetrieveMarketData ¶
func (s *TickerSession) RetrieveMarketData(ctx context.Context) (markets []Market, err error)
RetrieveMarketData retrieves the 24h- and 7d aggregated market data for all markets that were active during this period.
func (*TickerSession) RetrievePartialAggMarkets ¶
func (s *TickerSession) RetrievePartialAggMarkets(ctx context.Context, pairName *string, numHoursAgo int, ) (partialMkts []PartialMarket, err error)
RetrievePartialAggMarkets retrieves the aggregated market data for all markets (or for a specific one if PairName != nil) for a given period.
func (*TickerSession) RetrievePartialMarkets ¶
func (s *TickerSession) RetrievePartialMarkets(ctx context.Context, baseAssetCode *string, baseAssetIssuer *string, counterAssetCode *string, counterAssetIssuer *string, numHoursAgo int, ) (partialMkts []PartialMarket, err error)
RetrievePartialMarkets retrieves data in the PartialMarket format from the database. It optionally filters the data according to the provided base and counter asset params provided, as well as the numHoursAgo time offset.
type Trade ¶
type Trade struct { ID int64 `db:"id"` AuroraID string `db:"aurora_id"` LedgerCloseTime time.Time `db:"ledger_close_time"` OfferID string `db:"offer_id"` BaseOfferID string `db:"base_offer_id"` BaseAccount string `db:"base_account"` BaseAmount float64 `db:"base_amount"` BaseAssetID int32 `db:"base_asset_id"` CounterOfferID string `db:"counter_offer_id"` CounterAccount string `db:"counter_account"` CounterAmount float64 `db:"counter_amount"` CounterAssetID int32 `db:"counter_asset_id"` BaseIsSeller bool `db:"base_is_seller"` Price float64 `db:"price"` }
Trade represents an entry on the trades table