Merge pull request #680 from pcriadoperez/portfolio

feat: Porfolio Margin API support

Author: carlosmiei

.github/workflows/check.yml

@@ -34,3 +34,5 @@ jobs:
       run: ./check.sh vet
     - name: UnitTest
       run: ./check.sh unittest
+    # - name: IntegrationTest
+    #   run: ./check.sh integration

README.md

@@ -31,6 +31,7 @@ Name | Description | Status
 [futures-api.md](https://binance-docs.github.io/apidocs/futures/en/#general-info) | Details on the Futures API (/fapi) | <input type="checkbox" checked>  Implemented
 [delivery-api.md](https://binance-docs.github.io/apidocs/delivery/en/#general-info) | Details on the Coin-M Futures API (/dapi) | <input type="checkbox" checked>  Implemented
 [options-api.md](https://binance-docs.github.io/apidocs/voptions/en/#general-info) | Details on the Options API(/eapi) | <input type="checkbox" checked>  Implemented
+[portfolio-margin-api.md](https://developers.binance.com/docs/derivatives/portfolio-margin/general-info) | Details on the Portfolio Margin API(/papi) | <input type="checkbox" checked>  Implemented
 
 
 If you find an unimplemented interface, please submit an issue. It's great if you can open a PR to fix it.

check.sh

@@ -37,6 +37,12 @@ function unittest() {
     )
 }
 
+function integration() {
+    echo "Running integration test ..."
+    cd v2
+    go test -v -tags=integration -race -coverprofile=coverage.txt -covermode=atomic ./...
+}
+
 if [[ -z $ACTION ]]; then
     format
     # lint

typos.toml

@@ -19,6 +19,9 @@ extend-ignore-re=[
     "[Cc]ummulative",
     "OTU",
     "[Tt]ransfered",
+    "DELIVERED_SETTELMENT",
+    "SETTELMENT",
+    "[Aa]ccured"
 ]
 check-filename = true
 

v2/portfolio/account_service.go

@@ -0,0 +1,45 @@
+package portfolio
+
+import (
+	"context"
+	"encoding/json"
+	"net/http"
+)
+
+// GetAccountService get account information
+type GetAccountService struct {
+	c *Client
+}
+
+// Do send request
+func (s *GetAccountService) Do(ctx context.Context, opts ...RequestOption) (res *Account, err error) {
+	r := &request{
+		method:   http.MethodGet,
+		endpoint: "/papi/v1/account",
+		secType:  secTypeSigned,
+	}
+	data, _, err := s.c.callAPI(ctx, r, opts...)
+	if err != nil {
+		return nil, err
+	}
+	res = new(Account)
+	err = json.Unmarshal(data, res)
+	if err != nil {
+		return nil, err
+	}
+	return res, nil
+}
+
+// Account define account info
+type Account struct {
+	UniMMR                   string `json:"uniMMR"`        // Portfolio margin account maintenance margin rate
+	AccountEquity            string `json:"accountEquity"` // Account equity, in USD value
+	ActualEquity             string `json:"actualEquity"`  // Account equity without collateral rate, in USD value
+	AccountInitialMargin     string `json:"accountInitialMargin"`
+	AccountMaintMargin       string `json:"accountMaintMargin"`       // Portfolio margin account maintenance margin, unit：USD
+	AccountStatus            string `json:"accountStatus"`            // Portfolio margin account status
+	VirtualMaxWithdrawAmount string `json:"virtualMaxWithdrawAmount"` // Portfolio margin maximum amount for transfer out in USD
+	TotalAvailableBalance    string `json:"totalAvailableBalance"`
+	TotalMarginOpenLoss      string `json:"totalMarginOpenLoss"` // in USD margin open order
+	UpdateTime               int64  `json:"updateTime"`          // last update time
+}

v2/portfolio/account_service_integration_test.go

@@ -0,0 +1,45 @@
+//go:build integration
+// +build integration
+
+package portfolio
+
+import (
+	"context"
+	"testing"
+)
+
+type accountServiceIntegrationTestSuite struct {
+	*baseIntegrationTestSuite
+}
+
+func TestAccountServiceIntegration(t *testing.T) {
+	base := SetupTest(t)
+	suite := &accountServiceIntegrationTestSuite{
+		baseIntegrationTestSuite: base,
+	}
+
+	t.Run("GetAccount", func(t *testing.T) {
+		service := &GetAccountService{c: suite.client}
+		account, err := service.Do(context.Background())
+		if err != nil {
+			t.Fatalf("Failed to get account info: %v", err)
+		}
+
+		// Basic validation of returned data
+		if account.AccountStatus == "" {
+			t.Error("Expected non-empty account status")
+		}
+
+		if account.AccountEquity == "" {
+			t.Error("Expected non-empty account equity")
+		}
+
+		if account.UniMMR == "" {
+			t.Error("Expected non-empty uniMMR")
+		}
+
+		if account.UpdateTime == 0 {
+			t.Error("Expected non-zero update time")
+		}
+	})
+}

v2/portfolio/account_service_test.go

@@ -0,0 +1,65 @@
+package portfolio
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/suite"
+)
+
+type accountServiceTestSuite struct {
+	baseTestSuite
+}
+
+func TestAccountService(t *testing.T) {
+	suite.Run(t, new(accountServiceTestSuite))
+}
+
+func (s *accountServiceTestSuite) TestGetAccount() {
+	data := []byte(`{
+		"uniMMR": "5167.92171923",
+		"accountEquity": "122607.35137903",
+		"actualEquity": "73.47428058",
+		"accountInitialMargin": "23.72469206",
+		"accountMaintMargin": "23.72469206",
+		"accountStatus": "NORMAL",
+		"virtualMaxWithdrawAmount": "1627523.32459208",
+		"totalAvailableBalance": "100.00",
+		"totalMarginOpenLoss": "0.00",
+		"updateTime": 1657707212154
+	}`)
+	s.mockDo(data, nil)
+	defer s.assertDo()
+	s.assertReq(func(r *request) {
+		e := newSignedRequest()
+		s.assertRequestEqual(e, r)
+	})
+
+	res, err := s.client.NewGetAccountService().Do(newContext())
+	s.r().NoError(err)
+	s.assertAccountEqual(res, &Account{
+		UniMMR:                   "5167.92171923",
+		AccountEquity:            "122607.35137903",
+		ActualEquity:             "73.47428058",
+		AccountInitialMargin:     "23.72469206",
+		AccountMaintMargin:       "23.72469206",
+		AccountStatus:            "NORMAL",
+		VirtualMaxWithdrawAmount: "1627523.32459208",
+		TotalAvailableBalance:    "100.00",
+		TotalMarginOpenLoss:      "0.00",
+		UpdateTime:               1657707212154,
+	})
+}
+
+func (s *accountServiceTestSuite) assertAccountEqual(a, e *Account) {
+	r := s.r()
+	r.Equal(e.UniMMR, a.UniMMR, "UniMMR")
+	r.Equal(e.AccountEquity, a.AccountEquity, "AccountEquity")
+	r.Equal(e.ActualEquity, a.ActualEquity, "ActualEquity")
+	r.Equal(e.AccountInitialMargin, a.AccountInitialMargin, "AccountInitialMargin")
+	r.Equal(e.AccountMaintMargin, a.AccountMaintMargin, "AccountMaintMargin")
+	r.Equal(e.AccountStatus, a.AccountStatus, "AccountStatus")
+	r.Equal(e.VirtualMaxWithdrawAmount, a.VirtualMaxWithdrawAmount, "VirtualMaxWithdrawAmount")
+	r.Equal(e.TotalAvailableBalance, a.TotalAvailableBalance, "TotalAvailableBalance")
+	r.Equal(e.TotalMarginOpenLoss, a.TotalMarginOpenLoss, "TotalMarginOpenLoss")
+	r.Equal(e.UpdateTime, a.UpdateTime, "UpdateTime")
+}

v2/portfolio/auto_repay_futures_status_service.go

@@ -0,0 +1,37 @@
+package portfolio
+
+import (
+	"context"
+	"encoding/json"
+	"net/http"
+)
+
+// GetAutoRepayFuturesStatusService get auto-repay-futures status
+type GetAutoRepayFuturesStatusService struct {
+	c *Client
+}
+
+// Do send request
+func (s *GetAutoRepayFuturesStatusService) Do(ctx context.Context, opts ...RequestOption) (*AutoRepayFuturesStatus, error) {
+	r := &request{
+		method:   http.MethodGet,
+		endpoint: "/papi/v1/repay-futures-switch",
+		secType:  secTypeSigned,
+	}
+
+	data, _, err := s.c.callAPI(ctx, r, opts...)
+	if err != nil {
+		return nil, err
+	}
+	res := new(AutoRepayFuturesStatus)
+	err = json.Unmarshal(data, res)
+	if err != nil {
+		return nil, err
+	}
+	return res, nil
+}
+
+// AutoRepayFuturesStatus define auto repay futures status
+type AutoRepayFuturesStatus struct {
+	AutoRepay bool `json:"autoRepay"` // true for turn on the auto-repay futures; false for turn off
+}

v2/portfolio/auto_repay_futures_status_service_integration_test.go

@@ -0,0 +1,30 @@
+//go:build integration
+// +build integration
+
+package portfolio
+
+import (
+	"context"
+	"testing"
+)
+
+type autoRepayFuturesStatusServiceIntegrationTestSuite struct {
+	*baseIntegrationTestSuite
+}
+
+func TestAutoRepayFuturesStatusServiceIntegration(t *testing.T) {
+	base := SetupTest(t)
+	suite := &autoRepayFuturesStatusServiceIntegrationTestSuite{
+		baseIntegrationTestSuite: base,
+	}
+
+	t.Run("GetAutoRepayFuturesStatus", func(t *testing.T) {
+		service := &GetAutoRepayFuturesStatusService{c: suite.client}
+		status, err := service.Do(context.Background())
+		if err != nil {
+			t.Fatalf("Failed to get auto repay futures status: %v", err)
+		}
+
+		t.Logf("Auto repay futures is %v", status.AutoRepay)
+	})
+}

v2/portfolio/auto_repay_futures_status_service_test.go

@@ -0,0 +1,32 @@
+package portfolio
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/suite"
+)
+
+type autoRepayFuturesStatusServiceTestSuite struct {
+	baseTestSuite
+}
+
+func TestAutoRepayFuturesStatusService(t *testing.T) {
+	suite.Run(t, new(autoRepayFuturesStatusServiceTestSuite))
+}
+
+func (s *autoRepayFuturesStatusServiceTestSuite) TestGetAutoRepayFuturesStatus() {
+	data := []byte(`{
+		"autoRepay": true
+	}`)
+	s.mockDo(data, nil)
+	defer s.assertDo()
+
+	s.assertReq(func(r *request) {
+		e := newSignedRequest()
+		s.assertRequestEqual(e, r)
+	})
+
+	status, err := s.client.NewGetAutoRepayFuturesStatusService().Do(newContext())
+	s.r().NoError(err)
+	s.r().True(status.AutoRepay)
+}

v2/portfolio/auto_repay_futures_switch_service.go

@@ -0,0 +1,45 @@
+package portfolio
+
+import (
+	"context"
+	"encoding/json"
+	"net/http"
+)
+
+// ChangeAutoRepayFuturesStatusService change auto-repay-futures status
+type ChangeAutoRepayFuturesStatusService struct {
+	c         *Client
+	autoRepay bool
+}
+
+// AutoRepay set auto repay status
+func (s *ChangeAutoRepayFuturesStatusService) AutoRepay(autoRepay bool) *ChangeAutoRepayFuturesStatusService {
+	s.autoRepay = autoRepay
+	return s
+}
+
+// Do send request
+func (s *ChangeAutoRepayFuturesStatusService) Do(ctx context.Context, opts ...RequestOption) (*SuccessResponse, error) {
+	r := &request{
+		method:   http.MethodPost,
+		endpoint: "/papi/v1/repay-futures-switch",
+		secType:  secTypeSigned,
+	}
+	r.setParam("autoRepay", s.autoRepay)
+
+	data, _, err := s.c.callAPI(ctx, r, opts...)
+	if err != nil {
+		return nil, err
+	}
+	res := new(SuccessResponse)
+	err = json.Unmarshal(data, res)
+	if err != nil {
+		return nil, err
+	}
+	return res, nil
+}
+
+// SuccessResponse define success response
+type SuccessResponse struct {
+	Msg string `json:"msg"`
+}

v2/portfolio/auto_repay_futures_switch_service_integration_test.go

@@ -0,0 +1,47 @@
+//go:build integration
+// +build integration
+
+package portfolio
+
+import (
+	"context"
+	"testing"
+)
+
+type autoRepayFuturesSwitchServiceIntegrationTestSuite struct {
+	*baseIntegrationTestSuite
+}
+
+func TestAutoRepayFuturesSwitchServiceIntegration(t *testing.T) {
+	base := SetupTest(t)
+	suite := &autoRepayFuturesSwitchServiceIntegrationTestSuite{
+		baseIntegrationTestSuite: base,
+	}
+
+	t.Run("ChangeAutoRepayFuturesStatus", func(t *testing.T) {
+		service := &ChangeAutoRepayFuturesStatusService{c: suite.client}
+
+		// Get current status
+		currentStatus, err := suite.client.NewGetAutoRepayFuturesStatusService().Do(context.Background())
+		if err != nil {
+			t.Fatalf("Failed to get current auto repay futures status: %v", err)
+		}
+
+		// Change status
+		newStatus := !currentStatus.AutoRepay
+		res, err := service.AutoRepay(newStatus).Do(context.Background())
+		if err != nil {
+			t.Fatalf("Failed to change auto repay futures status: %v", err)
+		}
+
+		if res.Msg != "success" {
+			t.Errorf("Expected success message, got %v", res.Msg)
+		}
+
+		// Revert to original status
+		_, err = service.AutoRepay(currentStatus.AutoRepay).Do(context.Background())
+		if err != nil {
+			t.Fatalf("Failed to revert auto repay futures status: %v", err)
+		}
+	})
+}