exchanges/futures: Implement open interest (#1417)

* adds open interest to exchanges

* ADDS TESTING YEAH

* New endpoints, BTSE, RPCS, cached

* slight design change, begin gateio

You will need to get cached for
each exchange that supports it

* gateio, huobi, rpc

* fix up kraken, cache retrieval

* okx, gateio

* finalising all implementations and tests

* definitely my final ever commit on this

* Well, well, well

* final v2

* quick fix of bug

* test coverage, assert notempty, test helper

Added a new testhelper for currency
management because its very annoying
in a parallel test setting which wastes
so much space otherwise

* minimises REST requests for Open Interest

* types.Number merge misses

* Minimises Kraken REST calls

* len change, value -> pointer receiver

* further fixup

* fixes gateio, batch calculates open interest

* single gateio, lint const fixes

* rejig and more thorough oi for huobi

* formatting expansion

* minor fix for handling expiring contracts

* rm unused Binance strings

* add bybit support, fix bybit issues

* oopsie doopsie, dont look at my whoopsie

* Fix issue, remove feature

* move an irrelevant function for the pr

* mini bybit upgrades

* fixes cli request bug
This commit is contained in:
Scott
2024-01-12 15:27:35 +11:00
committed by GitHub
parent 614042110a
commit b71bf1f3d1
62 changed files with 22660 additions and 10095 deletions

View File

@@ -46,6 +46,8 @@ const (
accountTypeNormal = 0 // 0: regular account
accountTypeUnified = 1 // 1: unified trade account
longDatedFormat = "02Jan06"
)
var (
@@ -321,7 +323,7 @@ func (by *Bybit) GetTickers(ctx context.Context, category, symbol, baseCoin stri
params.Set("baseCoin", baseCoin)
}
if !expiryDate.IsZero() {
params.Set("expData", expiryDate.Format("02Jan06"))
params.Set("expData", expiryDate.Format(longDatedFormat))
}
var resp *TickerData
return resp, by.SendHTTPRequest(ctx, exchange.RestSpot, common.EncodeURLValues("market/tickers", params), defaultEPL, &resp)
@@ -377,8 +379,8 @@ func (by *Bybit) GetPublicTradingHistory(ctx context.Context, category, symbol,
return resp, by.SendHTTPRequest(ctx, exchange.RestSpot, common.EncodeURLValues("market/recent-trade", params), defaultEPL, &resp)
}
// GetOpenInterest retrieves open interest of each symbol.
func (by *Bybit) GetOpenInterest(ctx context.Context, category, symbol, intervalTime string, startTime, endTime time.Time, limit int64, cursor string) (*OpenInterest, error) {
// GetOpenInterestData retrieves open interest of each symbol.
func (by *Bybit) GetOpenInterestData(ctx context.Context, category, symbol, intervalTime string, startTime, endTime time.Time, limit int64, cursor string) (*OpenInterest, error) {
if category == "" {
return nil, errCategoryNotSet
} else if category != cLinear && category != cInverse {
@@ -1236,7 +1238,7 @@ func (by *Bybit) GetPreUpgradeOptionDeliveryRecord(ctx context.Context, category
return nil, errAPIKeyIsNotUnified
}
if !expiryDate.IsZero() {
params.Set("expData", expiryDate.Format("02Jan06"))
params.Set("expData", expiryDate.Format(longDatedFormat))
}
var resp *PreUpdateOptionDeliveryRecord
return resp, by.SendAuthHTTPRequestV5(ctx, exchange.RestSpot, http.MethodGet, "/v5/pre-upgrade/asset/delivery-record", params, nil, &resp, defaultEPL)
@@ -1478,7 +1480,7 @@ func (by *Bybit) GetDeliveryRecord(ctx context.Context, category, symbol, cursor
params.Set("symbol", symbol)
}
if !expiryDate.IsZero() {
params.Set("expData", expiryDate.Format("02Jan06"))
params.Set("expData", expiryDate.Format(longDatedFormat))
}
if cursor != "" {
params.Set("cursor", cursor)

View File

@@ -11,6 +11,7 @@ import (
"testing"
"github.com/thrasher-corp/gocryptotrader/config"
"github.com/thrasher-corp/gocryptotrader/exchanges/asset"
"github.com/thrasher-corp/gocryptotrader/exchanges/request"
"github.com/thrasher-corp/gocryptotrader/exchanges/sharedtestvalues"
gctlog "github.com/thrasher-corp/gocryptotrader/log"
@@ -50,3 +51,56 @@ func TestMain(m *testing.M) {
}
os.Exit(m.Run())
}
func instantiateTradablePairs() error {
err := b.UpdateTradablePairs(context.Background(), true)
if err != nil {
return err
}
tradables, err := b.GetEnabledPairs(asset.Spot)
if err != nil {
return err
}
format, err := b.GetPairFormat(asset.Spot, true)
if err != nil {
return err
}
spotTradablePair = tradables[0].Format(format)
tradables, err = b.GetEnabledPairs(asset.USDTMarginedFutures)
if err != nil {
return err
}
format, err = b.GetPairFormat(asset.USDTMarginedFutures, true)
if err != nil {
return err
}
usdtMarginedTradablePair = tradables[0].Format(format)
tradables, err = b.GetEnabledPairs(asset.USDCMarginedFutures)
if err != nil {
return err
}
format, err = b.GetPairFormat(asset.USDCMarginedFutures, true)
if err != nil {
return err
}
usdcMarginedTradablePair = tradables[0].Format(format)
tradables, err = b.GetEnabledPairs(asset.CoinMarginedFutures)
if err != nil {
return err
}
format, err = b.GetPairFormat(asset.CoinMarginedFutures, true)
if err != nil {
return err
}
inverseTradablePair = tradables[0].Format(format)
tradables, err = b.GetEnabledPairs(asset.Options)
if err != nil {
return err
}
format, err = b.GetPairFormat(asset.Options, true)
if err != nil {
return err
}
optionsTradablePair = tradables[0].Format(format)
return nil
}

View File

@@ -4,12 +4,15 @@ import (
"context"
"encoding/json"
"errors"
"fmt"
"sync"
"testing"
"time"
"github.com/gofrs/uuid"
"github.com/stretchr/testify/assert"
"github.com/thrasher-corp/gocryptotrader/common"
"github.com/thrasher-corp/gocryptotrader/common/key"
"github.com/thrasher-corp/gocryptotrader/currency"
exchange "github.com/thrasher-corp/gocryptotrader/exchanges"
"github.com/thrasher-corp/gocryptotrader/exchanges/asset"
@@ -706,25 +709,25 @@ func TestGetPublicTradingHistory(t *testing.T) {
}
}
func TestGetOpenInterest(t *testing.T) {
func TestGetOpenInterestData(t *testing.T) {
t.Parallel()
_, err := b.GetOpenInterest(context.Background(), "spot", spotTradablePair.String(), "5min", time.Time{}, time.Time{}, 0, "")
_, err := b.GetOpenInterestData(context.Background(), "spot", spotTradablePair.String(), "5min", time.Time{}, time.Time{}, 0, "")
if !errors.Is(err, errInvalidCategory) {
t.Errorf("expected %v, got %v", errInvalidCategory, err)
}
_, err = b.GetOpenInterest(context.Background(), "linear", usdtMarginedTradablePair.String(), "5min", time.Time{}, time.Time{}, 0, "")
_, err = b.GetOpenInterestData(context.Background(), "linear", usdtMarginedTradablePair.String(), "5min", time.Time{}, time.Time{}, 0, "")
if err != nil {
t.Error(err)
}
_, err = b.GetOpenInterest(context.Background(), "linear", usdcMarginedTradablePair.String(), "5min", time.Time{}, time.Time{}, 0, "")
_, err = b.GetOpenInterestData(context.Background(), "linear", usdcMarginedTradablePair.String(), "5min", time.Time{}, time.Time{}, 0, "")
if err != nil {
t.Error(err)
}
_, err = b.GetOpenInterest(context.Background(), "inverse", inverseTradablePair.String(), "5min", time.Time{}, time.Time{}, 0, "")
_, err = b.GetOpenInterestData(context.Background(), "inverse", inverseTradablePair.String(), "5min", time.Time{}, time.Time{}, 0, "")
if err != nil {
t.Error(err)
}
_, err = b.GetOpenInterest(context.Background(), "option", optionsTradablePair.String(), "5min", time.Time{}, time.Time{}, 0, "")
_, err = b.GetOpenInterestData(context.Background(), "option", optionsTradablePair.String(), "5min", time.Time{}, time.Time{}, 0, "")
if !errors.Is(err, errInvalidCategory) {
t.Errorf("expected %v, got %v", errInvalidCategory, err)
}
@@ -2918,59 +2921,6 @@ func TestGetBrokerEarning(t *testing.T) {
}
}
func instantiateTradablePairs() error {
err := b.UpdateTradablePairs(context.Background(), true)
if err != nil {
return err
}
tradables, err := b.GetEnabledPairs(asset.Spot)
if err != nil {
return err
}
format, err := b.GetPairFormat(asset.Spot, true)
if err != nil {
return err
}
spotTradablePair = tradables[0].Format(format)
tradables, err = b.GetEnabledPairs(asset.USDTMarginedFutures)
if err != nil {
return err
}
format, err = b.GetPairFormat(asset.USDTMarginedFutures, true)
if err != nil {
return err
}
usdtMarginedTradablePair = tradables[0].Format(format)
tradables, err = b.GetEnabledPairs(asset.USDCMarginedFutures)
if err != nil {
return err
}
format, err = b.GetPairFormat(asset.USDCMarginedFutures, true)
if err != nil {
return err
}
usdcMarginedTradablePair = tradables[0].Format(format)
tradables, err = b.GetEnabledPairs(asset.CoinMarginedFutures)
if err != nil {
return err
}
format, err = b.GetPairFormat(asset.CoinMarginedFutures, true)
if err != nil {
return err
}
inverseTradablePair = tradables[0].Format(format)
tradables, err = b.GetEnabledPairs(asset.Options)
if err != nil {
return err
}
format, err = b.GetPairFormat(asset.Options, true)
if err != nil {
return err
}
optionsTradablePair = tradables[0].Format(format)
return nil
}
func TestUpdateAccountInfo(t *testing.T) {
t.Parallel()
if mockTests {
@@ -3537,3 +3487,61 @@ func TestUpdateOptionsTickerInformation(t *testing.T) {
t.Fatal(err)
}
}
func TestGetOpenInterest(t *testing.T) {
t.Parallel()
_, err := b.GetOpenInterest(context.Background(), key.PairAsset{
Base: currency.ETH.Item,
Quote: currency.USDT.Item,
Asset: asset.Spot,
})
assert.ErrorIs(t, err, asset.ErrNotSupported)
resp, err := b.GetOpenInterest(context.Background(), key.PairAsset{
Base: usdcMarginedTradablePair.Base.Item,
Quote: usdcMarginedTradablePair.Quote.Item,
Asset: asset.USDCMarginedFutures,
})
assert.NoError(t, err)
assert.NotEmpty(t, resp)
resp, err = b.GetOpenInterest(context.Background(), key.PairAsset{
Base: usdtMarginedTradablePair.Base.Item,
Quote: usdtMarginedTradablePair.Quote.Item,
Asset: asset.USDTMarginedFutures,
})
assert.NoError(t, err)
assert.NotEmpty(t, resp)
resp, err = b.GetOpenInterest(context.Background(), key.PairAsset{
Base: inverseTradablePair.Base.Item,
Quote: inverseTradablePair.Quote.Item,
Asset: asset.CoinMarginedFutures,
})
assert.NoError(t, err)
assert.NotEmpty(t, resp)
resp, err = b.GetOpenInterest(context.Background())
assert.NoError(t, err)
assert.NotEmpty(t, resp)
}
func TestIsPerpetualFutureCurrency(t *testing.T) {
t.Parallel()
is, err := b.IsPerpetualFutureCurrency(asset.Spot, spotTradablePair)
assert.NoError(t, err)
assert.False(t, is)
is, err = b.IsPerpetualFutureCurrency(asset.CoinMarginedFutures, inverseTradablePair)
assert.NoError(t, err)
assert.True(t, is, fmt.Sprintf("%s %s should be a perp", asset.CoinMarginedFutures, inverseTradablePair))
is, err = b.IsPerpetualFutureCurrency(asset.USDTMarginedFutures, usdtMarginedTradablePair)
assert.NoError(t, err)
assert.True(t, is, fmt.Sprintf("%s %s should be a perp", asset.USDTMarginedFutures, usdtMarginedTradablePair))
is, err = b.IsPerpetualFutureCurrency(asset.USDCMarginedFutures, usdcMarginedTradablePair)
assert.NoError(t, err)
assert.True(t, is, fmt.Sprintf("%s %s should be a perp", asset.USDCMarginedFutures, usdcMarginedTradablePair))
}

View File

@@ -11,6 +11,7 @@ import (
"github.com/shopspring/decimal"
"github.com/thrasher-corp/gocryptotrader/common"
"github.com/thrasher-corp/gocryptotrader/common/key"
"github.com/thrasher-corp/gocryptotrader/config"
"github.com/thrasher-corp/gocryptotrader/currency"
exchange "github.com/thrasher-corp/gocryptotrader/exchanges"
@@ -36,11 +37,11 @@ import (
// GetDefaultConfig returns a default exchange config
func (by *Bybit) GetDefaultConfig(ctx context.Context) (*config.Exchange, error) {
by.SetDefaults()
exchCfg := new(config.Exchange)
exchCfg.Name = by.Name
exchCfg.HTTPTimeout = exchange.DefaultHTTPTimeout
exchCfg.BaseCurrencies = by.BaseCurrencies
err := by.SetupDefaults(exchCfg)
exchCfg, err := by.GetStandardConfig()
if err != nil {
return nil, err
}
err = by.SetupDefaults(exchCfg)
if err != nil {
return nil, err
}
@@ -156,6 +157,23 @@ func (by *Bybit) SetDefaults() {
Kline: kline.ExchangeCapabilitiesSupported{
Intervals: true,
},
FuturesCapabilities: exchange.FuturesCapabilities{
FundingRates: true,
FundingRateBatching: map[asset.Item]bool{
asset.USDCMarginedFutures: true,
asset.USDTMarginedFutures: true,
asset.CoinMarginedFutures: true,
},
SupportedFundingRateFrequencies: map[kline.Interval]bool{
kline.FourHour: true,
kline.EightHour: true,
},
OpenInterest: exchange.OpenInterestSupport{
Supported: true,
SupportedViaTicker: true,
SupportsRestBatch: true,
},
},
},
Enabled: exchange.FeaturesEnabled{
AutoPairUpdates: true,
@@ -368,7 +386,12 @@ func (by *Bybit) FetchTradablePairs(ctx context.Context, a asset.Item) (currency
if allPairs[x].Status != "Trading" || allPairs[x].QuoteCoin != "USDC" {
continue
}
pair, err = currency.NewPairFromString(allPairs[x].Symbol)
if strings.EqualFold(allPairs[x].ContractType, "linearfutures") {
// long-dated contracts have a delimiter
pair, err = currency.NewPairFromString(allPairs[x].Symbol)
} else {
pair, err = currency.NewPairFromStrings(allPairs[x].BaseCoin, allPairs[x].Symbol[len(allPairs[x].BaseCoin):])
}
if err != nil {
return nil, err
}
@@ -1641,6 +1664,17 @@ func (by *Bybit) SetLeverage(ctx context.Context, item asset.Item, pair currency
}
}
// IsPerpetualFutureCurrency ensures a given asset and currency is a perpetual future
func (by *Bybit) IsPerpetualFutureCurrency(a asset.Item, p currency.Pair) (bool, error) {
if !a.IsFutures() {
return false, nil
}
return p.Quote.Equal(currency.PERP) ||
p.Quote.Equal(currency.USD) ||
p.Quote.Equal(currency.USDC) ||
p.Quote.Equal(currency.USDT), nil
}
// GetFuturesContractDetails returns details about futures contracts
func (by *Bybit) GetFuturesContractDetails(ctx context.Context, item asset.Item) ([]futures.Contract, error) {
if !item.IsFutures() {
@@ -1665,12 +1699,7 @@ func (by *Bybit) GetFuturesContractDetails(ctx context.Context, item asset.Item)
continue
}
var cp, underlying currency.Pair
splitCoin := strings.Split(inverseContracts.List[i].Symbol, inverseContracts.List[i].BaseCoin)
if len(splitCoin) <= 1 {
continue
}
cp, err = currency.NewPairFromStrings(inverseContracts.List[i].BaseCoin, splitCoin[1])
cp, err = currency.NewPairFromStrings(inverseContracts.List[i].BaseCoin, inverseContracts.List[i].Symbol[len(inverseContracts.List[i].BaseCoin):])
if err != nil {
return nil, err
}
@@ -1752,11 +1781,7 @@ func (by *Bybit) GetFuturesContractDetails(ctx context.Context, item asset.Item)
switch contractType {
case "linearperpetual":
ct = futures.Perpetual
splitCoin := strings.Split(instruments[i].Symbol, instruments[i].BaseCoin)
if len(splitCoin) <= 1 {
continue
}
cp, err = currency.NewPairFromStrings(instruments[i].BaseCoin, splitCoin[1])
cp, err = currency.NewPairFromStrings(instruments[i].BaseCoin, instruments[i].Symbol[len(instruments[i].BaseCoin):])
if err != nil {
return nil, err
}
@@ -1767,6 +1792,9 @@ func (by *Bybit) GetFuturesContractDetails(ctx context.Context, item asset.Item)
}
cp, err = by.MatchSymbolWithAvailablePairs(instruments[i].Symbol, item, true)
if err != nil {
if errors.Is(err, currency.ErrPairNotFound) {
continue
}
return nil, err
}
default:
@@ -1776,6 +1804,9 @@ func (by *Bybit) GetFuturesContractDetails(ctx context.Context, item asset.Item)
ct = futures.Unknown
cp, err = by.MatchSymbolWithAvailablePairs(instruments[i].Symbol, item, true)
if err != nil {
if errors.Is(err, currency.ErrPairNotFound) {
continue
}
return nil, err
}
}
@@ -1818,12 +1849,8 @@ func (by *Bybit) GetFuturesContractDetails(ctx context.Context, item asset.Item)
instruments = append(instruments, inverseContracts.List[i])
}
for i := range instruments {
splitCoin := strings.Split(instruments[i].Symbol, instruments[i].BaseCoin)
if len(splitCoin) <= 1 {
continue
}
var cp, underlying currency.Pair
cp, err = currency.NewPairFromStrings(instruments[i].BaseCoin, splitCoin[1])
cp, err = currency.NewPairFromStrings(instruments[i].BaseCoin, instruments[i].Symbol[len(instruments[i].BaseCoin):])
if err != nil {
return nil, err
}
@@ -1889,12 +1916,16 @@ func getContractLength(contractLength time.Duration) (futures.ContractType, erro
ct = futures.Weekly
case contractLength <= kline.TwoWeek.Duration()+kline.ThreeDay.Duration():
ct = futures.Fortnightly
case contractLength <= kline.ThreeWeek.Duration()+kline.ThreeDay.Duration():
ct = futures.ThreeWeekly
case contractLength <= kline.ThreeMonth.Duration()+kline.ThreeWeek.Duration():
ct = futures.Quarterly
case contractLength <= kline.SixMonth.Duration()+kline.ThreeWeek.Duration():
ct = futures.HalfYearly
case contractLength <= kline.NineMonth.Duration()+kline.ThreeWeek.Duration():
ct = futures.NineMonthly
case contractLength <= kline.OneYear.Duration()+kline.ThreeWeek.Duration():
ct = futures.Yearly
default:
ct = futures.SemiAnnually
}
@@ -1927,6 +1958,11 @@ func (by *Bybit) GetLatestFundingRates(ctx context.Context, r *fundingrate.Lates
return nil, err
}
instrumentInfo, err := by.GetInstrumentInfo(ctx, getCategoryName(r.Asset), symbol, "", "", "", 1000)
if err != nil {
return nil, err
}
resp := make([]fundingrate.LatestRateResponse, 0, len(ticks.List))
for i := range ticks.List {
var cp currency.Pair
@@ -1937,13 +1973,25 @@ func (by *Bybit) GetLatestFundingRates(ctx context.Context, r *fundingrate.Lates
} else if !isEnabled {
continue
}
var fundingInterval time.Duration
for j := range instrumentInfo.List {
if instrumentInfo.List[j].Symbol != ticks.List[i].Symbol {
continue
}
fundingInterval = time.Duration(instrumentInfo.List[j].FundingInterval) * time.Minute
break
}
var lrt time.Time
if fundingInterval > 0 {
lrt = ticks.List[i].NextFundingTime.Time().Add(-fundingInterval)
}
resp = append(resp, fundingrate.LatestRateResponse{
Exchange: by.Name,
TimeChecked: time.Now(),
Asset: r.Asset,
Pair: cp,
LatestRate: fundingrate.Rate{
Time: ticks.List[i].NextFundingTime.Time().Add(-time.Hour * 8),
Time: lrt,
Rate: decimal.NewFromFloat(ticks.List[i].FundingRate.Float64()),
},
TimeOfNextRate: ticks.List[i].NextFundingTime.Time(),
@@ -1956,3 +2004,81 @@ func (by *Bybit) GetLatestFundingRates(ctx context.Context, r *fundingrate.Lates
}
return nil, fmt.Errorf("%w %s", asset.ErrNotSupported, r.Asset)
}
// GetOpenInterest returns the open interest rate for a given asset pair
func (by *Bybit) GetOpenInterest(ctx context.Context, k ...key.PairAsset) ([]futures.OpenInterest, error) {
for i := range k {
if k[i].Asset != asset.USDCMarginedFutures &&
k[i].Asset != asset.USDTMarginedFutures &&
k[i].Asset != asset.CoinMarginedFutures {
return nil, fmt.Errorf("%w %v", asset.ErrNotSupported, k[i].Asset)
}
}
if len(k) == 1 {
formattedPair, err := by.FormatExchangeCurrency(k[0].Pair(), k[0].Asset)
if err != nil {
return nil, err
}
if _, parseErr := time.Parse(longDatedFormat, k[0].Quote.Symbol); parseErr == nil {
// long-dated contracts have a delimiter
formattedPair.Delimiter = currency.DashDelimiter
}
pFmt := formattedPair.String()
var ticks *TickerData
ticks, err = by.GetTickers(ctx, getCategoryName(k[0].Asset), pFmt, "", time.Time{})
if err != nil {
return nil, err
}
for i := range ticks.List {
if ticks.List[i].Symbol != pFmt {
continue
}
return []futures.OpenInterest{{
Key: key.ExchangePairAsset{
Exchange: by.Name,
Asset: k[0].Asset,
Base: k[0].Base,
Quote: k[0].Quote,
},
OpenInterest: ticks.List[i].OpenInterest.Float64(),
}}, nil
}
}
assets := []asset.Item{asset.USDCMarginedFutures, asset.USDTMarginedFutures, asset.CoinMarginedFutures}
var resp []futures.OpenInterest
for i := range assets {
ticks, err := by.GetTickers(ctx, getCategoryName(assets[i]), "", "", time.Time{})
if err != nil {
return nil, err
}
for x := range ticks.List {
var pair currency.Pair
var isEnabled bool
// only long-dated contracts have a delimiter
pair, isEnabled, err = by.MatchSymbolCheckEnabled(ticks.List[x].Symbol, assets[i], strings.Contains(ticks.List[x].Symbol, currency.DashDelimiter))
if err != nil || !isEnabled {
continue
}
var appendData bool
for j := range k {
if k[j].Pair().Equal(pair) {
appendData = true
break
}
}
if len(k) > 0 && !appendData {
continue
}
resp = append(resp, futures.OpenInterest{
Key: key.ExchangePairAsset{
Exchange: by.Name,
Base: pair.Base.Item,
Quote: pair.Quote.Item,
Asset: assets[i],
},
OpenInterest: ticks.List[i].OpenInterest.Float64(),
})
}
}
return resp, nil
}