feat: add clientOID field to LimitOrder and MarketOrder

Author: ignimbrite

hyperliquid/consts.go

@@ -1,6 +1,6 @@
 package hyperliquid
 
-const GLOBAL_DEBUG = false // Defualt debug that is used in all tests
+const GLOBAL_DEBUG = false // Default debug that is used in all tests
 
 // Execution constants
 const DEFAULT_SLIPPAGE = 0.005 // 0.5% default slippage

hyperliquid/convert.go

@@ -60,6 +60,7 @@ func OrderRequestToWire(req OrderRequest, meta map[string]AssetInfo, isSpot bool
 		SizePx:     FloatToWire(req.Sz, maxDecimals, info.SzDecimals),
 		ReduceOnly: req.ReduceOnly,
 		OrderType:  OrderTypeToWire(req.OrderType),
+		Cloid:      req.Cloid,
 	}
 }
 

hyperliquid/exchange_service.go

@@ -14,8 +14,8 @@ type IExchangeAPI interface {
 	// Open orders
 	BulkOrders(requests []OrderRequest, grouping Grouping) (*PlaceOrderResponse, error)
 	Order(request OrderRequest, grouping Grouping) (*PlaceOrderResponse, error)
-	MarketOrder(coin string, size float64, slippage *float64) (*PlaceOrderResponse, error)
-	LimitOrder(orderType string, coin string, size float64, px float64, isBuy bool, reduceOnly bool) (*PlaceOrderResponse, error)
+	MarketOrder(coin string, size float64, slippage *float64, clientOID ...string) (*PlaceOrderResponse, error)
+	LimitOrder(orderType string, coin string, size float64, px float64, isBuy bool, reduceOnly bool, clientOID ...string) (*PlaceOrderResponse, error)
 
 	// Order management
 	CancelOrderByOID(coin string, orderID int) (any, error)
@@ -98,7 +98,7 @@ func (api *ExchangeAPI) SlippagePriceSpot(coin string, isBuy bool, slippage floa
 //	MarketOrder("BTC", 0.1, nil) // Buy 0.1 BTC
 //	MarketOrder("BTC", -0.1, nil) // Sell 0.1 BTC
 //	MarketOrder("BTC", 0.1, &slippage) // Buy 0.1 BTC with slippage
-func (api *ExchangeAPI) MarketOrder(coin string, size float64, slippage *float64) (*PlaceOrderResponse, error) {
+func (api *ExchangeAPI) MarketOrder(coin string, size float64, slippage *float64, clientOID ...string) (*PlaceOrderResponse, error) {
 	slpg := GetSlippage(slippage)
 	isBuy := IsBuy(size)
 	finalPx := api.SlippagePrice(coin, isBuy, slpg)
@@ -115,6 +115,9 @@ func (api *ExchangeAPI) MarketOrder(coin string, size float64, slippage *float64
 		OrderType:  orderType,
 		ReduceOnly: false,
 	}
+	if len(clientOID) > 0 {
+		orderRequest.Cloid = clientOID[0]
+	}
 	return api.Order(orderRequest, GroupingNa)
 }
 
@@ -150,7 +153,7 @@ func (api *ExchangeAPI) MarketOrderSpot(coin string, size float64, slippage *flo
 // Order type can be Gtc, Ioc, Alo.
 // Size determines the amount of the coin to buy/sell.
 // See the constants TifGtc, TifIoc, TifAlo.
-func (api *ExchangeAPI) LimitOrder(orderType string, coin string, size float64, px float64, reduceOnly bool) (*PlaceOrderResponse, error) {
+func (api *ExchangeAPI) LimitOrder(orderType string, coin string, size float64, px float64, reduceOnly bool, clientOID ...string) (*PlaceOrderResponse, error) {
 	// check if the order type is valid
 	if orderType != TifGtc && orderType != TifIoc && orderType != TifAlo {
 		return nil, APIError{Message: fmt.Sprintf("Invalid order type: %s. Available types: %s, %s, %s", orderType, TifGtc, TifIoc, TifAlo)}
@@ -168,6 +171,9 @@ func (api *ExchangeAPI) LimitOrder(orderType string, coin string, size float64,
 		OrderType:  orderTypeZ,
 		ReduceOnly: reduceOnly,
 	}
+	if len(clientOID) > 0 {
+		orderRequest.Cloid = clientOID[0]
+	}
 	return api.Order(orderRequest, GroupingNa)
 }
 

hyperliquid/exchange_types.go

@@ -28,6 +28,7 @@ type OrderRequest struct {
 	LimitPx    float64   `json:"limit_px"`
 	OrderType  OrderType `json:"order_type"`
 	ReduceOnly bool      `json:"reduce_only"`
+	Cloid      string    `json:"cloid,omitempty"`
 }
 
 type OrderType struct {
@@ -160,7 +161,8 @@ type CancelResponseStatuses struct {
 }
 
 type RestingStatus struct {
-	OrderId int `json:"oid"`
+	OrderId int    `json:"oid"`
+	Cloid   string `json:"cloid,omitempty"`
 }
 
 type CloseRequest struct {
@@ -175,6 +177,7 @@ type FilledStatus struct {
 	OrderId int     `json:"oid"`
 	AvgPx   float64 `json:"avgPx,string"`
 	TotalSz float64 `json:"totalSz,string"`
+	Cloid   string  `json:"cloid,omitempty"`
 }
 
 type Liquidation struct {

hyperliquid/hyperliquid_test.go

@@ -70,38 +70,46 @@ func TestHyperliquid_MakeSomeTradingLogic(t *testing.T) {
 	}
 	t.Logf("LimitOrder(TifGtc, ETH, -0.01, 5000.1, true): %v", res3)
 
+	res4, err := client.LimitOrder(TifGtc, "ETH", 0.01, 1234.1, false, "0x1234567890abcdef1234567890abcdef")
+	if err != nil {
+		if err != nil {
+			t.Errorf("Error: %v", err)
+		}
+	}
+	t.Logf("LimitOrder(TifIoc, ETH, 0.01, 1234.1, false, 0x1234567890abcdef1234567890abcdef): %v", res4)
+
 	// Get all ordres
-	res4, err := client.GetAccountOpenOrders()
+	res5, err := client.GetAccountOpenOrders()
 	if err != nil {
 		t.Errorf("Error: %v", err)
 	}
-	t.Logf("GetAccountOpenOrders(): %v", res4)
+	t.Logf("GetAccountOpenOrders(): %v", res5)
 
 	// Close all orders
-	res5, err := client.CancelAllOrders()
+	res6, err := client.CancelAllOrders()
 	if err != nil {
 		t.Errorf("Error: %v", err)
 	}
-	t.Logf("CancelAllOrders(): %v", res5)
+	t.Logf("CancelAllOrders(): %v", res6)
 
 	// Make market order
-	res6, err := client.MarketOrder("ETH", 0.01, nil)
+	res7, err := client.MarketOrder("ETH", 0.01, nil)
 	if err != nil {
 		t.Errorf("Error: %v", err)
 	}
-	t.Logf("MarketOrder(ETH, 0.01, nil): %v", res6)
+	t.Logf("MarketOrder(ETH, 0.01, nil): %v", res7)
 
 	// Close position
-	res7, err := client.ClosePosition("ETH")
+	res8, err := client.ClosePosition("ETH")
 	if err != nil {
 		t.Errorf("Error: %v", err)
 	}
-	t.Logf("ClosePosition(ETH): %v", res7)
+	t.Logf("ClosePosition(ETH): %v", res8)
 
 	// Get account balance
-	res8, err := client.GetAccountState()
+	res9, err := client.GetAccountState()
 	if err != nil {
 		t.Errorf("Error: %v", err)
 	}
-	t.Logf("GetAccountState(): %v", res8)
+	t.Logf("GetAccountState(): %v", res9)
 }