Merge pull request #4 from Logarithm-Labs/msg-builders

Add EIP712 order building method

Author: 0xBoringWozniak

hyperliquid/exchange_msg_builders_test.go

@@ -0,0 +1,42 @@
+package hyperliquid
+
+import (
+	"math"
+	"testing"
+)
+
+func GetEmptyExchangeAPI() *ExchangeAPI {
+	exchangeAPI := NewExchangeAPI(true)
+	if GLOBAL_DEBUG {
+		exchangeAPI.SetDebugActive()
+	}
+	return exchangeAPI
+}
+
+func TestExchangeAPI_BuildOrder(t *testing.T) {
+	exchangeAPI := GetEmptyExchangeAPI()
+	// input params
+	coin := "ETH"
+	size := 0.1
+	price := 2500.0
+
+	isBuy := IsBuy(size)
+	orderType := OrderType{
+		Limit: &LimitOrderType{
+			Tif: TifIoc,
+		},
+	}
+	orderRequest := OrderRequest{
+		Coin:       coin,
+		IsBuy:      isBuy,
+		Sz:         math.Abs(size),
+		LimitPx:    price,
+		OrderType:  orderType,
+		ReduceOnly: false,
+	}
+	res, err := exchangeAPI.BuildOrderEIP712(orderRequest, GroupingNa)
+	if err != nil {
+		t.Errorf("BuildOrder() error = %v", err)
+	}
+	t.Logf("BuildOrder() = %+v", res)
+}

hyperliquid/exchange_service.go

@@ -3,6 +3,8 @@ package hyperliquid
 import (
 	"fmt"
 	"math"
+
+	"github.com/ethereum/go-ethereum/signer/core/apitypes"
 )
 
 // IExchangeAPI is an interface for the /exchange service.
@@ -308,3 +310,24 @@ func (api *ExchangeAPI) getChainParams() (string, string) {
 	}
 	return "0x66eee", "Testnet"
 }
+
+// Build bulk orders EIP712 message
+func (api *ExchangeAPI) BuildBulkOrdersEIP712(requests []OrderRequest, grouping Grouping) (apitypes.TypedData, error) {
+	var wires []OrderWire
+	for _, req := range requests {
+		wires = append(wires, OrderRequestToWire(req, api.meta))
+	}
+	timestamp := GetNonce()
+	action := OrderWiresToOrderAction(wires, grouping)
+	srequest, err := api.BuildEIP712Message(action, timestamp)
+	if err != nil {
+		api.debug("Error building EIP712 message: %s", err)
+		return apitypes.TypedData{}, err
+	}
+	return SignRequestToEIP712TypedData(srequest), nil
+}
+
+// Build order EIP712 message
+func (api *ExchangeAPI) BuildOrderEIP712(request OrderRequest, grouping Grouping) (apitypes.TypedData, error) {
+	return api.BuildBulkOrdersEIP712([]OrderRequest{request}, grouping)
+}

hyperliquid/exchange_signing.go

@@ -34,11 +34,19 @@ func (api *ExchangeAPI) SignUserSignableAction(action any, payloadTypes []apityp
 }
 
 func (api *ExchangeAPI) SignL1Action(action any, timestamp uint64) (byte, [32]byte, [32]byte, error) {
-	hash, err := buildActionHash(action, "", timestamp)
+	srequest, err := api.BuildEIP712Message(action, timestamp)
 	if err != nil {
-		api.debug("Error building action hash: %s", err)
+		api.debug("Error building EIP712 message: %s", err)
 		return 0, [32]byte{}, [32]byte{}, err
 	}
+	return api.Sign(srequest)
+}
+
+func (api *ExchangeAPI) BuildEIP712Message(action any, timestamp uint64) (*SignRequest, error) {
+	hash, err := buildActionHash(action, "", timestamp)
+	if err != nil {
+		return nil, err
+	}
 	message := buildMessage(hash.Bytes(), api.IsMainnet())
 	srequest := &SignRequest{
 		DomainName:  "Exchange",
@@ -56,7 +64,7 @@ func (api *ExchangeAPI) SignL1Action(action any, timestamp uint64) (byte, [32]by
 		DTypeMsg:  message,
 		IsMainNet: api.IsMainnet(),
 	}
-	return api.Sign(srequest)
+	return srequest, nil
 }
 
 func (api *ExchangeAPI) SignWithdrawAction(action WithdrawAction) (byte, [32]byte, [32]byte, error) {

hyperliquid/signature.go

@@ -64,13 +64,7 @@ func NewSigner(manager *PKeyManager) Signer {
 }
 
 func (signer *Signer) Sign(request *SignRequest) (byte, [32]byte, [32]byte, error) {
-	typedData := apitypes.TypedData{
-		Domain:      request.GetDomain(),
-		Types:       request.GetTypes(),
-		PrimaryType: request.PrimaryType,
-		Message:     request.DTypeMsg,
-	}
-	return signer.signInternal(typedData)
+	return signer.signInternal(SignRequestToEIP712TypedData(request))
 }
 
 // signInternal signs the typed data and returns the signature in VRS format
@@ -89,6 +83,15 @@ func (signer *Signer) signInternal(message apitypes.TypedData) (byte, [32]byte,
 	return SignatureToVRS(signature)
 }
 
+func SignRequestToEIP712TypedData(request *SignRequest) apitypes.TypedData {
+	return apitypes.TypedData{
+		Domain:      request.GetDomain(),
+		Types:       request.GetTypes(),
+		PrimaryType: request.PrimaryType,
+		Message:     request.DTypeMsg,
+	}
+}
+
 func SignatureToVRS(sig []byte) (byte, [32]byte, [32]byte, error) {
 	var v byte
 	var r [32]byte