gecko.go

package rates

import (
	"time"

	"golang.org/x/time/rate"
)

const (
	// See the following for docs and details: https://www.coingecko.com/en/api.
	coingeckoAPIV3 = "https://api.coingecko.com/api/v3"
	// A mirror of CoinGecko API specifically for use with BitBoxApp.
	shiftGeckoMirrorAPIV3 = "https://exchangerates.shiftcrypto.io/api/v3"
	// The maximum duration the updater is allowed to get exchange rates for
	// in a single request. If increasing the range, make sure the response
	// fits into LimitReader in fetchGeckoMarketRange.
	// Larger range reduces the QPS but increases size and IO time, and may lead
	// to increased request failures especially with an intermittent connection.
	// For comparison, a range of 2 years is about 1Mb.
	maxGeckoRange = 364 * 24 * time.Hour
)

// apiRateLimit specifies the maximum number of API calls per second
// to one of the supported exchange rates providers.
func apiRateLimit(baseURL string) rate.Limit {
	switch baseURL {
	default:
		return rate.Limit(1) // arbitrary; localhost, staging, etc.
	case coingeckoAPIV3:
		// API calls. From https://www.coingecko.com/en/api:
		// > Generous rate limits with up to 100 requests/minute
		// We use slightly lower value.
		return rate.Limit(0.5)
	case shiftGeckoMirrorAPIV3:
		return rate.Limit(100)
	}
}

var (
	// Values are copied from https://api.coingecko.com/api/v3/coins/list.
	// TODO: Replace keys with coin.Code.
	geckoCoin = map[string]string{
		"btc": "bitcoin",
		"ltc": "litecoin",
		"eth": "ethereum",
		// Useful for testing with testnets.
		"tbtc":   "bitcoin",
		"rbtc":   "bitcoin",
		"tltc":   "litecoin",
		"sepeth": "ethereum",
		// ERC20 tokens as used in the backend.
		// Frontend and app config use unprefixed name, without "eth-erc20-".
		"eth-erc20-bat":       "basic-attention-token",
		"eth-erc20-dai0x6b17": "dai",
		"eth-erc20-link":      "chainlink",
		"eth-erc20-mkr":       "maker",
		"eth-erc20-usdc":      "usd-coin",
		"eth-erc20-usdt":      "tether",
		"eth-erc20-zrx":       "0x",
		"eth-erc20-wbtc":      "wrapped-bitcoin",
		"eth-erc20-paxg":      "pax-gold",
	}

	// The keys are CoinGecko coin codes.
	// The values are BitBoxApp coin units.
	geckoCoinToUnit = map[string]string{
		"bitcoin":  "BTC",
		"litecoin": "LTC",
		"ethereum": "ETH",
		// ERC20 tokens as used in the backend.
		"basic-attention-token": "BAT",
		"dai":                   "DAI",
		"chainlink":             "LINK",
		"maker":                 "MKR",
		"usd-coin":              "USDC",
		"tether":                "USDT",
		"0x":                    "ZRX",
		"wrapped-bitcoin":       "WBTC",
		"pax-gold":              "PAXG",
	}

	// Copied from https://api.coingecko.com/api/v3/simple/supported_vs_currencies.
	// The keys are BitBoxApp fiat codes. Values are CoinGecko fiat codes.
	toGeckoFiat = map[string]string{
		"USD": "usd",
		"EUR": "eur",
		"CHF": "chf",
		"GBP": "gbp",
		"JPY": "jpy",
		"KRW": "krw",
		"CNY": "cny",
		"RUB": "rub",
		"CAD": "cad",
		"AUD": "aud",
		"ILS": "ils",
		"BTC": "btc",
		"SGD": "sgd",
		"HKD": "hkd",
		"BRL": "brl",
		"NOK": "nok",
		"SEK": "sek",
		"PLN": "pln",
		"CZK": "czk",
		// Satoshi rates are converted manually in the backend using Bitcoin.
		"sat": "btc",
	}

	// Copied from https://api.coingecko.com/api/v3/simple/supported_vs_currencies.
	// The keys are CoinGecko fiat codes. Values are BitBoxApp fiat codes.
	fromGeckoFiat = map[string]string{
		"usd": "USD",
		"eur": "EUR",
		"chf": "CHF",
		"gbp": "GBP",
		"jpy": "JPY",
		"krw": "KRW",
		"cny": "CNY",
		"rub": "RUB",
		"cad": "CAD",
		"aud": "AUD",
		"ils": "ILS",
		"btc": "BTC",
		"sgd": "SGD",
		"hkd": "HKD",
		"brl": "BRL",
		"nok": "NOK",
		"sek": "SEK",
		"pln": "PLN",
		"czk": "CZK",
	}
)