Update Spot methods

- Fix FloatToWire
- Add tests
- Add spot state method

Author: 0xBoringWozniak

hyperliquid/consts.go

@@ -1,10 +1,12 @@
 package hyperliquid
 
-const GLOBAL_DEBUG = false // Defualt debug that is used in all tests
+const GLOBAL_DEBUG = true // Defualt debug that is used in all tests
 
 // Execution constants
 const DEFAULT_SLIPPAGE = 0.005 // 0.5% default slippage
-var SZ_DECIMALS = 2            // Default decimals for size
+const SPOT_MAX_DECIMALS = 8    // Default decimals for spot
+const PERP_MAX_DECIMALS = 6    // Default decimals for perp
+var SZ_DECIMALS = 2            // Default decimals for usdc
 
 // Signing constants
 const HYPERLIQUID_CHAIN_ID = 1337

hyperliquid/convert.go

@@ -43,27 +43,21 @@ func OrderWiresToOrderAction(orders []OrderWire, grouping Grouping) PlaceOrderAc
 }
 
 func OrderRequestToWire(req OrderRequest, meta map[string]AssetInfo, isSpot bool) OrderWire {
-
-	var info AssetInfo
-	for _, v := range meta {
-		if v.SpotName == req.Coin {
-			info = v
-			break
-		}
-	}
-
-	var assetId int
+	info := meta[req.Coin]
+	var assetId, maxDecimals int
 	if isSpot {
+		// https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/asset-ids
 		assetId = info.AssetId + 10000
+		maxDecimals = SPOT_MAX_DECIMALS
 	} else {
 		assetId = info.AssetId
+		maxDecimals = PERP_MAX_DECIMALS
 	}
-
 	return OrderWire{
 		Asset:      assetId,
 		IsBuy:      req.IsBuy,
-		LimitPx:    FloatToWire(req.LimitPx, nil),
-		SizePx:     FloatToWire(req.Sz, &info.SzDecimals),
+		LimitPx:    FloatToWire(req.LimitPx, maxDecimals, info.SzDecimals),
+		SizePx:     FloatToWire(req.Sz, maxDecimals, info.SzDecimals),
 		ReduceOnly: req.ReduceOnly,
 		OrderType:  OrderTypeToWire(req.OrderType),
 	}
@@ -90,28 +84,28 @@ func OrderTypeToWire(orderType OrderType) OrderTypeWire {
 	return OrderTypeWire{}
 }
 
-// Format the float with custom decimal places, default is 6.
-// Hyperliquid only allows at most 6 digits.
-func FloatToWire(x float64, szDecimals *int) string {
+// Format the float with custom decimal places, default is 6 (perp), 8 (spot).
+// https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/tick-and-lot-size
+func FloatToWire(x float64, maxDecimals int, szDecimals int) string {
 	bigf := big.NewFloat(x)
 	var maxDecSz uint
-	if szDecimals != nil {
-		maxDecSz = uint(*szDecimals)
+	intPart, _ := bigf.Int64()
+	intSize := len(strconv.FormatInt(intPart, 10))
+	if intSize >= maxDecimals {
+		maxDecSz = 0
 	} else {
-		intPart, _ := bigf.Int64()
-		intSize := len(strconv.FormatInt(intPart, 10))
-		if intSize >= 6 {
-			maxDecSz = 0
-		} else {
-			maxDecSz = uint(6 - intSize)
-		}
+		maxDecSz = uint(maxDecimals - intSize)
 	}
 	x, _ = bigf.Float64()
 	rounded := fmt.Sprintf("%.*f", maxDecSz, x)
-	for strings.HasSuffix(rounded, "0") {
-		rounded = strings.TrimSuffix(rounded, "0")
+	if strings.Contains(rounded, ".") {
+		for strings.HasSuffix(rounded, "0") {
+			rounded = strings.TrimSuffix(rounded, "0")
+		}
+	}
+	if strings.HasSuffix(rounded, ".") {
+		rounded = strings.TrimSuffix(rounded, ".")
 	}
-	rounded = strings.TrimSuffix(rounded, ".")
 	return rounded
 }
 

hyperliquid/exchange_service.go

@@ -120,8 +120,13 @@ func (api *ExchangeAPI) MarketOrder(coin string, size float64, slippage *float64
 
 // MarketOrderSpot is a market order for a spot coin.
 // It is used to buy/sell a spot coin.
+// Limit order with TIF=IOC and px=market price * (1 +- slippage).
+// Size determines the amount of the coin to buy/sell.
+//
+//	MarketOrderSpot("HYPE", 0.1, nil) // Buy 0.1 HYPE
+//	MarketOrderSpot("HYPE", -0.1, nil) // Sell 0.1 HYPE
+//	MarketOrderSpot("HYPE", 0.1, &slippage) // Buy 0.1 HYPE with slippage
 func (api *ExchangeAPI) MarketOrderSpot(coin string, size float64, slippage *float64) (*PlaceOrderResponse, error) {
-	spotName := api.spotMeta[coin].SpotName
 	slpg := GetSlippage(slippage)
 	isBuy := IsBuy(size)
 	finalPx := api.SlippagePriceSpot(coin, isBuy, slpg)
@@ -131,7 +136,7 @@ func (api *ExchangeAPI) MarketOrderSpot(coin string, size float64, slippage *flo
 		},
 	}
 	orderRequest := OrderRequest{
-		Coin:       spotName,
+		Coin:       coin,
 		IsBuy:      isBuy,
 		Sz:         math.Abs(size),
 		LimitPx:    finalPx,
@@ -208,42 +213,26 @@ func (api *ExchangeAPI) ClosePosition(coin string) (*PlaceOrderResponse, error)
 
 // Place single order
 func (api *ExchangeAPI) Order(request OrderRequest, grouping Grouping) (*PlaceOrderResponse, error) {
-	return api.BulkOrders([]OrderRequest{request}, grouping)
+	return api.BulkOrders([]OrderRequest{request}, grouping, false)
 }
 
 // OrderSpot places a spot order
 func (api *ExchangeAPI) OrderSpot(request OrderRequest, grouping Grouping) (*PlaceOrderResponse, error) {
-	return api.BulkOrdersSpot([]OrderRequest{request}, grouping)
+	return api.BulkOrders([]OrderRequest{request}, grouping, true)
 }
 
 // Place orders in bulk
 // https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint#place-an-order
-func (api *ExchangeAPI) BulkOrders(requests []OrderRequest, grouping Grouping) (*PlaceOrderResponse, error) {
+func (api *ExchangeAPI) BulkOrders(requests []OrderRequest, grouping Grouping, isSpot bool) (*PlaceOrderResponse, error) {
 	var wires []OrderWire
-	for _, req := range requests {
-		wires = append(wires, OrderRequestToWire(req, api.meta, false))
+	var meta map[string]AssetInfo
+	if isSpot {
+		meta = api.spotMeta
+	} else {
+		meta = api.meta
 	}
-	timestamp := GetNonce()
-	action := OrderWiresToOrderAction(wires, grouping)
-	v, r, s, err := api.SignL1Action(action, timestamp)
-	if err != nil {
-		api.debug("Error signing L1 action: %s", err)
-		return nil, err
-	}
-	request := ExchangeRequest{
-		Action:       action,
-		Nonce:        timestamp,
-		Signature:    ToTypedSig(r, s, v),
-		VaultAddress: nil,
-	}
-	return MakeUniversalRequest[PlaceOrderResponse](api, request)
-}
-
-// BulkOrdersSpot places spot orders
-func (api *ExchangeAPI) BulkOrdersSpot(requests []OrderRequest, grouping Grouping) (*PlaceOrderResponse, error) {
-	var wires []OrderWire
 	for _, req := range requests {
-		wires = append(wires, OrderRequestToWire(req, api.spotMeta, true))
+		wires = append(wires, OrderRequestToWire(req, meta, isSpot))
 	}
 	timestamp := GetNonce()
 	action := OrderWiresToOrderAction(wires, grouping)
@@ -353,7 +342,7 @@ func (api *ExchangeAPI) Withdraw(destination string, amount float64) (*WithdrawR
 	action := WithdrawAction{
 		Type:        "withdraw3",
 		Destination: destination,
-		Amount:      FloatToWire(amount, &SZ_DECIMALS),
+		Amount:      FloatToWire(amount, PERP_MAX_DECIMALS, SZ_DECIMALS),
 		Time:        nonce,
 	}
 	signatureChainID, chainType := api.getChainParams()

hyperliquid/exchange_test.go

@@ -80,6 +80,7 @@ func TestExchangeAPI_MarketOpen(testing *testing.T) {
 	if totalSize != math.Abs(size) {
 		testing.Errorf("res.Response.Data.Statuses[0].Filled.TotalSz = %v", totalSize)
 	}
+	time.Sleep(2 * time.Second) // wait to execute order
 	accountState, err := exchangeAPI.infoAPI.GetUserState(exchangeAPI.AccountAddress())
 	if err != nil {
 		testing.Errorf("GetAccountState() error = %v", err)
@@ -157,7 +158,7 @@ func TestExchangeAPI_MarketClose(testing *testing.T) {
 
 func TestExchangeAPI_TestWithdraw(testing *testing.T) {
 	exchangeAPI := GetExchangeAPI()
-	withdrawAmount := 2.0
+	withdrawAmount := 10.0
 	stateBefore, err := exchangeAPI.infoAPI.GetUserState(exchangeAPI.AccountAddress())
 	if err != nil {
 		testing.Errorf("GetAccountState() error = %v", err)
@@ -184,3 +185,18 @@ func TestExchangeAPI_TestWithdraw(testing *testing.T) {
 		testing.Errorf("Balance not updated: %v", stateAfter)
 	}
 }
+
+func TestExchageAPI_TestMarketOrderSpot(testing *testing.T) {
+	exchangeAPI := GetExchangeAPI()
+	size := 1600.0
+	coin := "YEETI"
+	res, err := exchangeAPI.MarketOrderSpot(coin, size, nil)
+	if err != nil {
+		testing.Errorf("MakeOpen() error = %v", err)
+	}
+	testing.Logf("MakeOpen() = %v", res)
+	avgPrice := res.Response.Data.Statuses[0].Filled.AvgPx
+	if avgPrice == 0 {
+		testing.Errorf("res.Response.Data.Statuses[0].Filled.AvgPx = %v", avgPrice)
+	}
+}

hyperliquid/info_service.go

@@ -218,6 +218,23 @@ func (api *InfoAPI) GetAccountState() (*UserState, error) {
 	return api.GetUserState(api.AccountAddress())
 }
 
+// Retrieve user's spot account summary
+// https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/spot#retrieve-a-users-token-balances
+func (api *InfoAPI) GetUserStateSpot(address string) (*UserStateSpot, error) {
+	request := UserStateRequest{
+		User:  address,
+		Typez: "spotClearinghouseState",
+	}
+	return MakeUniversalRequest[UserStateSpot](api, request)
+}
+
+// Retrieve account's spot account summary
+// The same as GetUserStateSpot but user is set to the account address
+// Check AccountAddress() or SetAccountAddress() if there is a need to set the account address
+func (api *InfoAPI) GetAccountStateSpot() (*UserStateSpot, error) {
+	return api.GetUserStateSpot(api.AccountAddress())
+}
+
 // Retrieve a user's funding history
 // https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-a-users-funding-history-or-non-funding-ledger-updates
 func (api *InfoAPI) GetFundingUpdates(address string, startTime int64, endTime int64) (*[]FundingUpdate, error) {
@@ -269,6 +286,11 @@ func (api *InfoAPI) GetHistoricalFundingRates(coin string, startTime int64, endT
 }
 
 // Helper function to get the market price of a given coin
+// The coin parameter is the name of the coin
+//
+// Example:
+//
+//	api.GetMartketPx("BTC")
 func (api *InfoAPI) GetMartketPx(coin string) (float64, error) {
 	allMids, err := api.GetAllMids()
 	if err != nil {
@@ -282,12 +304,16 @@ func (api *InfoAPI) GetMartketPx(coin string) (float64, error) {
 }
 
 // GetSpotMarketPx returns the market price of a given spot coin
+// The coin parameter is the name of the coin
+//
+// Example:
+//
+//	api.GetSpotMarketPx("HYPE")
 func (api *InfoAPI) GetSpotMarketPx(coin string) (float64, error) {
 	spotPrices, err := api.GetAllSpotPrices()
 	if err != nil {
 		return 0, err
 	}
-
 	spotName := api.spotMeta[coin].SpotName
 	parsed, err := strconv.ParseFloat((*spotPrices)[spotName], 32)
 	if err != nil {

hyperliquid/info_test.go

@@ -10,6 +10,8 @@ func GetInfoAPI() *InfoAPI {
 	if GLOBAL_DEBUG {
 		api.SetDebugActive()
 	}
+	// It should be active account to pass all tests
+	// like GetAccountFills, GetAccountWithdrawals, etc.
 	TEST_ADDRESS := os.Getenv("TEST_ADDRESS")
 	if TEST_ADDRESS == "" {
 		panic("Set TEST_ADDRESS in .env file")
@@ -294,3 +296,71 @@ func TestInfoAPI_BuildMetaMap(t *testing.T) {
 	}
 	t.Logf("BuildMetaMap() = %v", res)
 }
+
+func TestInfoAPI_BuildSpotMetaMap(t *testing.T) {
+	api := GetInfoAPI()
+	res, err := api.BuildSpotMetaMap()
+	if err != nil {
+		t.Errorf("BuildSpotMetaMap() error = %v", err)
+	}
+	if len(res) == 0 {
+		t.Errorf("BuildSpotMetaMap() = %v, want > %v", res, 0)
+	}
+	// check PURR, HYPE in map
+	if _, ok := res["PURR"]; !ok {
+		t.Errorf("BuildSpotMetaMap() = %v, want %v", res, "PURR")
+	}
+	if _, ok := res["HYPE"]; !ok {
+		t.Errorf("BuildSpotMetaMap() = %v, want %v", res, "HYPE")
+	}
+	t.Logf("map(PURR) = %+v", res["PURR"])
+	t.Logf("BuildSpotMetaMap() = %+v", res)
+}
+
+func TestInfoAPI_GetSpotMeta(t *testing.T) {
+	api := GetInfoAPI()
+	res, err := api.GetSpotMeta()
+	if err != nil {
+		t.Errorf("GetSpotMeta() error = %v", err)
+	}
+	if len(res.Tokens) == 0 {
+		t.Errorf("GetSpotMeta() = %v, want > %v", res, 0)
+	}
+	t.Logf("GetSpotMeta() = %v", res)
+}
+
+func TestInfoAPI_GetAllSpotPrices(t *testing.T) {
+	api := GetInfoAPI()
+	res, err := api.GetAllSpotPrices()
+	if err != nil {
+		t.Errorf("GetAllSpotPrices() error = %v", err)
+	}
+	if len(*res) == 0 {
+		t.Errorf("GetAllSpotPrices() = %v, want > %v", res, 0)
+	}
+	t.Logf("GetAllSpotPrices() = %+v", res)
+}
+
+func TestInfoAPI_GetSpotMarketPx(t *testing.T) {
+	api := GetInfoAPI()
+	res, err := api.GetSpotMarketPx("HYPE")
+	if err != nil {
+		t.Errorf("GetSpotMarketPx() error = %v", err)
+	}
+	if res < 0 {
+		t.Errorf("GetSpotMarketPx() = %v, want > %v", res, 0)
+	}
+	t.Logf("GetSpotMarketPx(HYPE) = %v", res)
+}
+
+func TestInfoAPI_GetUserStateSpot(t *testing.T) {
+	api := GetInfoAPI()
+	res, err := api.GetAccountStateSpot()
+	if err != nil {
+		t.Errorf("GetUserStateSpot() error = %v", err)
+	}
+	if len(res.Balances) == 0 {
+		t.Errorf("GetUserStateSpot() = %v, want > %v", res, 0)
+	}
+	t.Logf("GetUserStateSpot() = %+v", res)
+}

hyperliquid/info_types.go

@@ -54,6 +54,25 @@ type Position struct {
 	} `json:"cumFunding"`
 }
 
+type UserStateSpot struct {
+	Balances []SpotAssetPosition `json:"balances"`
+}
+
+type SpotAssetPosition struct {
+	/*
+			 "coin": "USDC",
+		            "token": 0,
+		            "hold": "0.0",
+		            "total": "14.625485",
+		            "entryNtl": "0.0"
+	*/
+	Coin     string  `json:"coin"`
+	Token    int     `json:"token"`
+	Hold     float64 `json:"hold,string"`
+	Total    float64 `json:"total,string"`
+	EntryNtl float64 `json:"entryNtl,string"`
+}
+
 type Order struct {
 	Children         []any   `json:"children,omitempty"`
 	Cloid            string  `json:"cloid,omitempty"`