How to use ethers.js v6 with proxy connection ( From Node.js )

[ghost]

This is currently undocumented and since this method is available since V6, will leave the sample code here

https://github.com/kaliubuntu0206/ethers-proxy-example
https://github.com/kaliubuntu0206/ethers-proxy-example/blob/main/index.js

Requires latest ethers.js version (v6.8.0) to make it work

Reference:

https://docs.ethers.org/v6/api/utils/fetching/#FetchRequest_registerGetUrl
https://docs.ethers.org/v6/api/utils/fetching/#FetchGetUrlFunc

Example code:

const { JsonRpcProvider, FetchRequest } = require('ethers');
const { HttpsProxyAgent } = require('https-proxy-agent');
const http = require('node:http');
const { createProxy } = require('proxy');

const ETH_RPC = 'https://eth.llamarpc.com';
// Example that doesn't use proxy connections
const BSC_RPC = 'https://binance.llamarpc.com';
const HTTP_PROXY = `http://localhost:3128`;

/**
 * Define new FetchRequest used for a provider
 */
// Assigning custom getUrl function will apply to all ethers v6 providers

const fetchReq = new FetchRequest(ETH_RPC);
fetchReq.getUrlFunc = FetchRequest.createGetUrlFunc({ agent: new HttpsProxyAgent(HTTP_PROXY) });
const provider = new JsonRpcProvider(fetchReq);
const provider2 = new JsonRpcProvider(BSC_RPC);

let resolvePromise;
const promise = new Promise((resolve) => {resolvePromise = resolve});

promise.then(() => provider.getBlockNumber().then(console.log));
promise.then(() => provider2.getBlockNumber().then(console.log));

/**
 * (Optional) Define new http proxy server to demonstrate RPC proxy connection (like squid)
 */
const server = createProxy(http.createServer());

server.listen(3128, () => {
  resolvePromise();
  console.log('HTTP(s) proxy server listening on port %d', server.address().port);
});

server.on('connect', (res, socket) => {
  // This is where you could find out that ethers provider will connect RPC via proxy agent
  console.log(`Proxy connection from ${socket.remoteAddress} with headers: ${JSON.stringify(res.rawHeaders)}`);
});

Related issues:

#4178
#3655
#3644
#4173
#3625
#2829

[ghost]

If you think the following code is too complicated, here is the alternative approach to add proxy support #4337

[bolabola]

666

[liangxiwei]

I read the source and just add this code before init provider,it will be work

FetchRequest.registerGetUrl(
    FetchRequest.createGetUrlFunc({
      agent: new HttpsProxyAgent(HTTP_PROXY),
    })
  );