Merge pull request #23 from vyomshm/feat/add-vault-methods

added vault create, modify and distribute methods

Author: sonirico

actions.go

@@ -20,7 +20,7 @@ type CancelAction struct {
 // CancelOrderWire has
 // See: https://github.com/hyperliquid-dex/hyperliquid-python-sdk/blob/f19056ca1b65cc15a019d92dffa9ada887b3d808/hyperliquid/exchange.py#L305-L310
 type CancelByCloidWire struct {
-	Asset    int    `json:"asset"     msgpack:"asset"`
+	Asset    int    `json:"asset" msgpack:"asset"`
 	ClientID string `json:"cloid" msgpack:"cloid"`
 }
 
@@ -71,6 +71,29 @@ type VaultUsdTransferAction struct {
 	Usd          int    `json:"usd"          msgpack:"usd"`
 }
 
+// CreateVaultAction represents create vault action
+type CreateVaultAction struct {
+	Type        string `json:"type"        msgpack:"type"`
+	Name        string `json:"name"        msgpack:"name"`
+	Description string `json:"description" msgpack:"description"`
+	InitialUsd  int    `json:"initialUsd"  msgpack:"initialUsd"`
+}
+
+// VaultModifyAction represents vault modify action
+type VaultModifyAction struct {
+	Type                  string `json:"type"                  msgpack:"type"`
+	VaultAddress          string `json:"vaultAddress"          msgpack:"vaultAddress"`
+	AllowDeposits         bool   `json:"allowDeposits"         msgpack:"allowDeposits"`
+	AlwaysCloseOnWithdraw bool   `json:"alwaysCloseOnWithdraw" msgpack:"alwaysCloseOnWithdraw"`
+}
+
+// VaultDistributeAction represents vault distribute action
+type VaultDistributeAction struct {
+	Type         string `json:"type"         msgpack:"type"`
+	VaultAddress string `json:"vaultAddress" msgpack:"vaultAddress"`
+	Usd          int    `json:"usd"          msgpack:"usd"`
+}
+
 // UpdateLeverageAction represents leverage update
 type UpdateLeverageAction struct {
 	Type     string         `json:"type"     msgpack:"type"`

exchange_others.go

@@ -317,6 +317,116 @@ func (e *Exchange) VaultUsdTransfer(
 	return &result, nil
 }
 
+// CreateVault creates a new vault
+func (e *Exchange) CreateVault(
+	name string,
+	description string,
+	initialUsd int,
+) (*CreateVaultResponse, error) {
+	timestamp := time.Now().UnixMilli()
+
+	action := CreateVaultAction{
+		Type:        "createVault",
+		Name:        name,
+		Description: description,
+		InitialUsd:  initialUsd,
+	}
+
+	sig, err := SignL1Action(
+		e.privateKey,
+		action,
+		"", // No vault address
+		timestamp,
+		e.expiresAfter,
+		e.client.baseURL == MainnetAPIURL,
+	)
+	if err != nil {
+		return nil, err
+	}
+
+	resp, err := e.postAction(action, sig, timestamp)
+	if err != nil {
+		return nil, err
+	}
+
+	var result CreateVaultResponse
+	if err := json.Unmarshal(resp, &result); err != nil {
+		return nil, err
+	}
+	return &result, nil
+}
+
+func (e *Exchange) VaultModify(
+	vaultAddress string,
+	allowDeposits bool,
+	alwaysCloseOnWithdraw bool,
+) (*TransferResponse, error) {
+	timestamp := time.Now().UnixMilli()
+
+	action := VaultModifyAction{
+		Type:                  "vaultModify",
+		VaultAddress:          vaultAddress,
+		AllowDeposits:         allowDeposits,
+		AlwaysCloseOnWithdraw: alwaysCloseOnWithdraw,
+	}
+
+	sig, err := SignL1Action(
+		e.privateKey,
+		action,
+		"", // No vault address
+		timestamp,
+		e.expiresAfter,
+		e.client.baseURL == MainnetAPIURL,
+	)
+	if err != nil {
+		return nil, err
+	}
+
+	resp, err := e.postAction(action, sig, timestamp)
+	if err != nil {
+		return nil, err
+	}
+
+	var result TransferResponse
+	if err := json.Unmarshal(resp, &result); err != nil {
+		return nil, err
+	}
+	return &result, nil
+}
+
+func (e *Exchange) VaultDistribute(vaultAddress string, usd int) (*TransferResponse, error) {
+	timestamp := time.Now().UnixMilli()
+
+	action := VaultDistributeAction{
+		Type:         "vaultDistribute",
+		VaultAddress: vaultAddress,
+		Usd:          usd,
+	}
+
+	sig, err := SignL1Action(
+		e.privateKey,
+		action,
+		"", // No vault address
+		timestamp,
+		e.expiresAfter,
+		e.client.baseURL == MainnetAPIURL,
+	)
+	if err != nil {
+		return nil, err
+	}
+
+	resp, err := e.postAction(action, sig, timestamp)
+	if err != nil {
+		return nil, err
+	}
+
+	var result TransferResponse
+	if err := json.Unmarshal(resp, &result); err != nil {
+		return nil, err
+	}
+	return &result, nil
+}
+
 // UsdTransfer transfers USD to another address
 func (e *Exchange) UsdTransfer(amount float64, destination string) (*TransferResponse, error) {
 	timestamp := time.Now().UnixMilli()

go.mod

@@ -4,13 +4,15 @@ go 1.23.0
 
 require (
 	github.com/ethereum/go-ethereum v1.16.2
+	github.com/google/go-cmp v0.7.0
 	github.com/gorilla/websocket v1.5.3
 	github.com/joho/godotenv v1.5.1
 	github.com/mailru/easyjson v0.9.0
 	github.com/sonirico/vago v0.8.1
 	github.com/stretchr/testify v1.10.0
 	github.com/valyala/fastjson v1.6.4
 	github.com/vmihailenco/msgpack/v5 v5.4.1
+	gopkg.in/dnaeon/go-vcr.v4 v4.0.4
 )
 
 require (
@@ -22,7 +24,6 @@ require (
 	github.com/decred/dcrd/dcrec/secp256k1/v4 v4.4.0 // indirect
 	github.com/ethereum/c-kzg-4844/v2 v2.1.1 // indirect
 	github.com/ethereum/go-verkle v0.2.2 // indirect
-	github.com/google/go-cmp v0.7.0 // indirect
 	github.com/holiman/uint256 v1.3.2 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/mattn/go-runewidth v0.0.16 // indirect
@@ -34,6 +35,5 @@ require (
 	golang.org/x/crypto v0.40.0 // indirect
 	golang.org/x/sync v0.16.0 // indirect
 	golang.org/x/sys v0.34.0 // indirect
-	gopkg.in/dnaeon/go-vcr.v4 v4.0.4 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

types.go

@@ -343,6 +343,12 @@ type ApprovalResponse struct {
 	Error  string `json:"error,omitempty"`
 }
 
+type CreateVaultResponse struct {
+	Status string `json:"status"`
+	Data   string `json:"data,omitempty"`
+	Error  string `json:"error,omitempty"`
+}
+
 type CreateSubAccountResponse struct {
 	Status string      `json:"status"`
 	Data   *SubAccount `json:"data,omitempty"`