[Question] How to set network proxy?

[inix]

Hi:
The Binance domains are blocked in some areas, how to set network proxy if using this lib?
Thanks

[tiagosiebler]

Hi there,

The second parameter for both REST clients lets you pass parameters to the HTTP client used in my connectors (Axios):
https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L78
https://github.com/tiagosiebler/binance/blob/master/src/usdm-client.ts#L80

One of the axios configuration parameters is for proxies:
https://axios-http.com/docs/req_config

This example passes the example from axios into the main REST client:

import { MainClient } from 'binance';

const axiosOptions = {
    proxy: {
    protocol: 'https',
    host: '127.0.0.1',
    port: 9000,
    auth: {
      username: 'mikeymike',
      password: 'rapunz3l'
    }
  }
}
const client = new MainClient({ }, axiosOptions);

[inix]

Hi there,

The second parameter for both REST clients lets you pass parameters to the HTTP client used in my connectors (Axios): https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L78 https://github.com/tiagosiebler/binance/blob/master/src/usdm-client.ts#L80

One of the axios configuration parameters is for proxies: https://axios-http.com/docs/req_config

This example passes the example from axios into the main REST client:

import { MainClient } from 'binance';

const axiosOptions = {
    proxy: {
    protocol: 'https',
    host: '127.0.0.1',
    port: 9000,
    auth: {
      username: 'mikeymike',
      password: 'rapunz3l'
    }
  }
}
const client = new MainClient({ }, axiosOptions);

Does websocket client support proxy?

[tiagosiebler]

Does websocket client support proxy?

Not at the moment - it simply opens a connection to the ws urls directly:
https://github.com/tiagosiebler/binance/blob/master/src/websocket-client.ts#L159

If you're willing to research how to add proxy support to the ws module when it opens a connection, and implement it (ideally avoiding new dependencies as much as possible), I'll gladly review a pull request.

If you're worried about doing it alone or just want to generally discuss this, I also recommend joining the node traders engineering community on telegram: https://t.me/nodetraders

[inix]

Does websocket client support proxy?

Not at the moment - it simply opens a connection to the ws urls directly: https://github.com/tiagosiebler/binance/blob/master/src/websocket-client.ts#L159

If you're willing to research how to add proxy support to the ws module when it opens a connection, and implement it (ideally avoiding new dependencies as much as possible), I'll gladly review a pull request.

If you're worried about doing it alone or just want to generally discuss this, I also recommend joining the node traders engineering community on telegram: https://t.me/nodetraders

@tiagosiebler
The websocket traffics can go through proxy by using a custom http.Agent implementation like https-proxy-agent or socks-proxy-agent.
More details: https://github.com/websockets/ws#how-to-connect-via-a-proxy
I have tested successfully using https-proxy-agent.

[tiagosiebler]

Sounds good! If you're willing on making the change (in a way that doesn't break existing functionality), I'd gladly review a pull request.

It would also be ideal if these modules could be injected somehow, instead of adding them as a dependency (as they do bring other dependencies as well, which increase module size for others using this connector in frontend projects).

Perhaps a parameter for the websocket client constructor (or a setter method like wsClient.setHttpAgent(httpsproxyagent)), as well as documentation in the readme for using this connector with proxies.

Looks like that would work, based on the https proxy agent docs: https://github.com/TooTallNate/node-https-proxy-agent#ws-websocket-connection-example

[inix]

Sounds good! If you're willing on making the change (in a way that doesn't break existing functionality), I'd gladly review a pull request.

It would also be ideal if these modules could be injected somehow, instead of adding them as a dependency (as they do bring other dependencies as well, which increase module size for others using this connector in frontend projects).

Perhaps a parameter for the websocket client constructor (or a setter method like wsClient.setHttpAgent(httpsproxyagent)), as well as documentation in the readme for using this connector with proxies.

Looks like that would work, based on the https proxy agent docs: https://github.com/TooTallNate/node-https-proxy-agent#ws-websocket-connection-example

Both http proxy and socks proxy repo works. If using socks5 proxy, the proxy addr should be something like 'socks://127.0.0.1' instead of 'socks5://127.0.0.1'.

[genru]

Sounds good! If you're willing on making the change (in a way that doesn't break existing functionality), I'd gladly review a pull request.

It would also be ideal if these modules could be injected somehow, instead of adding them as a dependency (as they do bring other dependencies as well, which increase module size for others using this connector in frontend projects).

Perhaps a parameter for the websocket client constructor (or a setter method like wsClient.setHttpAgent(httpsproxyagent)), as well as documentation in the readme for using this connector with proxies.

Looks like that would work, based on the https proxy agent docs: https://github.com/TooTallNate/node-https-proxy-agent#ws-websocket-connection-example

I noticed the websocket component is using isomorphic-ws which does not support option when create. So i am not sure if it's possible to use agent as proxy solution.

[genru]

Sounds good! If you're willing on making the change (in a way that doesn't break existing functionality), I'd gladly review a pull request.
It would also be ideal if these modules could be injected somehow, instead of adding them as a dependency (as they do bring other dependencies as well, which increase module size for others using this connector in frontend projects).
Perhaps a parameter for the websocket client constructor (or a setter method like wsClient.setHttpAgent(httpsproxyagent)), as well as documentation in the readme for using this connector with proxies.
Looks like that would work, based on the https proxy agent docs: https://github.com/TooTallNate/node-https-proxy-agent#ws-websocket-connection-example

Both http proxy and socks proxy repo works. If using socks5 proxy, the proxy addr should be something like 'socks://127.0.0.1' instead of 'socks5://127.0.0.1'.

@inix could you kindly give some details to instruct how websocket using proxy?