update READMD.md and add introduction about proxy; replace options with

xyq-c-cpp · xyq-c-cpp · commit 3306b8a83a65 · 2024-06-19T16:18:14.000+08:00
eoptions, just change the package name
diff --git a/README.md b/README.md
@@ -21,8 +21,12 @@ Name | Description | Status
 [web-socket-streams.md](https://github.com/binance/binance-spot-api-docs/blob/master/web-socket-streams.md) | Details on available streams and payloads | <input type="checkbox" checked>  Implemented
 [user-data-stream.md](https://github.com/binance/binance-spot-api-docs/blob/master/user-data-stream.md) | Details on the dedicated account stream | <input type="checkbox" checked>  Implemented
 [margin-api.md](https://binance-docs.github.io/apidocs/spot/en) | Details on the Margin API (/sapi) | <input type="checkbox" checked>  Implemented
-[futures-api.md](https://binance-docs.github.io/apidocs/futures/en/#general-info) | Details on the Futures API (/fapi) | <input type="checkbox" checked>  Partially 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>  Partially Implemented
+[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
+[eoptions-api.md](https://binance-docs.github.io/apidocs/voptions/en/#general-info) | Detains on the European Options API(/eapi) | <input type="checkbox" checked>  Implemented  
+
+  
+Found an unimplemented interface, please submit a issue.
 
 ### Installation
 
@@ -40,7 +44,12 @@ go get github.com/adshao/go-binance/v1
 
 ```golang
 import (
+    // for spot and other interface contained in https://binance-docs.github.io/apidocs/spot/en/#change-log
     "github.com/adshao/go-binance/v2"
+    
+    "github.com/adshao/go-binance/v2/futures" // optional package
+    "github.com/adshao/go-binance/v2/delivery" // optional package
+    "github.com/adshao/go-binance/v2/eoptions" // optional package
 )
 ```
 
@@ -72,6 +81,14 @@ Following are some simple examples, please refer to [godoc](https://godoc.org/gi
 
 If you have any questions, please refer to the specific version of the code for specific reference definitions or usage methods
 
+##### Proxy Client
+  
+```
+proxyUrl := "http://127.0.0.1:7890" // for example, please replace as your exact proxy url.
+client := binance.NewProxiedClient(apiKey, apiSecret, proxyUrl)
+```
+  
+
 #### Create Order
 
 ```golang
@@ -219,8 +236,10 @@ fmt.Println(res)
 
 You don't need Client in websocket API. Just call binance.WsXxxServe(args, handler, errHandler).
 
-> For delivery API you can use `delivery.WsXxxServe(args, handler, errHandler)`.
+> For delivery API you can use `delivery.WsXxxServe(args, handler, errHandler)`.  
 
+If you wanna use proxy, you can set `HTTP_PROXY` or `HTTP_PROXY` in environment variable.
+  
 #### Depth
 
 ```golang
diff --git a/v2/client.go b/v2/client.go
@@ -19,8 +19,8 @@ import (
 
 	"github.com/adshao/go-binance/v2/common"
 	"github.com/adshao/go-binance/v2/delivery"
+	"github.com/adshao/go-binance/v2/eoptions"
 	"github.com/adshao/go-binance/v2/futures"
-	"github.com/adshao/go-binance/v2/options"
 )
 
 // SideType define side type of order
@@ -362,9 +362,9 @@ func NewDeliveryClient(apiKey, secretKey string) *delivery.Client {
 	return delivery.NewClient(apiKey, secretKey)
 }
 
-// NewOptionsClient initialize client for options API
-func NewOptionsClient(apiKey, secretKey string) *options.Client {
-	return options.NewClient(apiKey, secretKey)
+// NewOptionsClient initialize client for eoptions API
+func NewOptionsClient(apiKey, secretKey string) *eoptions.Client {
+	return eoptions.NewClient(apiKey, secretKey)
 }
 
 type doFunc func(req *http.Request) (*http.Response, error)
diff --git a/v2/eoptions/account_service.go b/v2/eoptions/account_service.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"context"
diff --git a/v2/eoptions/account_service_test.go b/v2/eoptions/account_service_test.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"testing"
diff --git a/v2/eoptions/client.go b/v2/eoptions/client.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"bytes"
diff --git a/v2/eoptions/client_test.go b/v2/eoptions/client_test.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"bytes"
diff --git a/v2/eoptions/depth_service.go b/v2/eoptions/depth_service.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"context"
diff --git a/v2/eoptions/depth_service_test.go b/v2/eoptions/depth_service_test.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"testing"
diff --git a/v2/eoptions/exchange_info_service.go b/v2/eoptions/exchange_info_service.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"context"
diff --git a/v2/eoptions/exchange_info_service_test.go b/v2/eoptions/exchange_info_service_test.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"testing"
diff --git a/v2/eoptions/exercise_history_service.go b/v2/eoptions/exercise_history_service.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"context"
diff --git a/v2/eoptions/exercise_history_service_test.go b/v2/eoptions/exercise_history_service_test.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"testing"
diff --git a/v2/eoptions/index_service.go b/v2/eoptions/index_service.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"context"
diff --git a/v2/eoptions/index_service_test.go b/v2/eoptions/index_service_test.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"testing"
diff --git a/v2/eoptions/kline_service.go b/v2/eoptions/kline_service.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"context"
diff --git a/v2/eoptions/kline_service_test.go b/v2/eoptions/kline_service_test.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"testing"
diff --git a/v2/eoptions/mark_service.go b/v2/eoptions/mark_service.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"context"
diff --git a/v2/eoptions/mark_service_test.go b/v2/eoptions/mark_service_test.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"testing"
diff --git a/v2/eoptions/open_interest_service.go b/v2/eoptions/open_interest_service.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"context"
diff --git a/v2/eoptions/open_interest_service_test.go b/v2/eoptions/open_interest_service_test.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"testing"
diff --git a/v2/eoptions/order_service.go b/v2/eoptions/order_service.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"context"
diff --git a/v2/eoptions/order_service_test.go b/v2/eoptions/order_service_test.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"encoding/json"
diff --git a/v2/eoptions/request.go b/v2/eoptions/request.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"fmt"
diff --git a/v2/eoptions/server_service.go b/v2/eoptions/server_service.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"context"
diff --git a/v2/eoptions/server_service_test.go b/v2/eoptions/server_service_test.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"testing"
diff --git a/v2/eoptions/ticker_service.go b/v2/eoptions/ticker_service.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"context"
diff --git a/v2/eoptions/ticker_service_test.go b/v2/eoptions/ticker_service_test.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"testing"
diff --git a/v2/eoptions/trade_service_test.go b/v2/eoptions/trade_service_test.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"testing"
diff --git a/v2/eoptions/trades_service.go b/v2/eoptions/trades_service.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"context"
diff --git a/v2/eoptions/user_stream_service.go b/v2/eoptions/user_stream_service.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"context"
diff --git a/v2/eoptions/user_stream_service_test.go b/v2/eoptions/user_stream_service_test.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"testing"
diff --git a/v2/eoptions/websocket.go b/v2/eoptions/websocket.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"net/http"
diff --git a/v2/eoptions/websocket_service.go b/v2/eoptions/websocket_service.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"encoding/json"
diff --git a/v2/eoptions/websocket_service_test.go b/v2/eoptions/websocket_service_test.go
@@ -1,4 +1,4 @@
-package options
+package eoptions
 
 import (
 	"errors"

Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,8 @@ import (`
`19`	`19`
`20`	`20`	`"github.com/adshao/go-binance/v2/common"`
`21`	`21`	`"github.com/adshao/go-binance/v2/delivery"`
	`22`	`+ "github.com/adshao/go-binance/v2/eoptions"`
`22`	`23`	`"github.com/adshao/go-binance/v2/futures"`
`23`		`- "github.com/adshao/go-binance/v2/options"`
`24`	`24`	`)`
`25`	`25`
`26`	`26`	`// SideType define side type of order`
`@@ -362,9 +362,9 @@ func NewDeliveryClient(apiKey, secretKey string) *delivery.Client {`
`362`	`362`	`return delivery.NewClient(apiKey, secretKey)`
`363`	`363`	`}`
`364`	`364`
`365`		`-// NewOptionsClient initialize client for options API`
`366`		`-func NewOptionsClient(apiKey, secretKey string) *options.Client {`
`367`		`- return options.NewClient(apiKey, secretKey)`
	`365`	`+// NewOptionsClient initialize client for eoptions API`
	`366`	`+func NewOptionsClient(apiKey, secretKey string) *eoptions.Client {`
	`367`	`+ return eoptions.NewClient(apiKey, secretKey)`
`368`	`368`	`}`
`369`	`369`
`370`	`370`	`type doFunc func(req http.Request) (http.Response, error)`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package options`
	`1`	`+package eoptions`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"context"`