feat: added proxy support (#17)

* feat: added proxy support

---------

Co-authored-by: agoltzman <106151463+agoltzman@users.noreply.github.com>

Author: a0ngo

README.md

@@ -147,5 +147,9 @@ type FireblocksProviderConfig = {
    * Same as setting env var `DEBUG=fireblocks-web3-provider:error`
    */
   enhancedErrorHandling?: boolean,
+  /**
+   * Proxy path in the format of `http(s)://user:pass@server`
+   */
+  proxyPath?: string
 }
 ```

package-lock.json

@@ -55,9 +55,11 @@
   },
   "dependencies": {
     "@ethersproject/units": "^5.7.0",
+    "axios": "^1.6.2",
     "debug": "^4.3.4",
     "ethers": "^5.7.2",
-    "fireblocks-sdk": "^3.1.4",
+    "fireblocks-sdk": "^4.2.0",
+    "https-proxy-agent": "^7.0.2",
     "web3-providers-http": "1.8.0"
   }
 }

package.json

@@ -9,9 +9,11 @@ import { DEBUG_NAMESPACE_ENHANCED_ERROR_HANDLING, DEBUG_NAMESPACE_REQUESTS_AND_R
 import * as ethers from "ethers";
 import { NativeMetaTransaction__factory } from "./contracts/factories"
 import { _TypedDataEncoder } from "@ethersproject/hash";
+import { HttpsProxyAgent } from 'https-proxy-agent';
 import { formatJsonRpcRequest, formatJsonRpcResult } from "./jsonRpcUtils";
 import { version as SDK_VERSION } from "../package.json";
 import Debug from "debug";
+import { AxiosProxyConfig } from "axios";
 const HttpProvider = require("web3-providers-http");
 const logTransactionStatusChange = Debug(DEBUG_NAMESPACE_TX_STATUS_CHANGES);
 const logEnhancedErrorHandling = Debug(DEBUG_NAMESPACE_ENHANCED_ERROR_HANDLING);
@@ -87,7 +89,8 @@ export class FireblocksWeb3Provider extends HttpProvider {
       undefined,
       {
         userAgent: this.getUserAgent(),
-      })
+        proxy: config.proxyPath ? this.toAxiosProxyConfig(config.proxyPath) : undefined
+      });
     this.feeLevel = config.fallbackFeeLevel || FeeLevel.MEDIUM
     this.note = config.note ?? 'Created by Fireblocks Web3 Provider'
     this.externalTxId = config.externalTxId;
@@ -101,6 +104,14 @@ export class FireblocksWeb3Provider extends HttpProvider {
     this.accountsPopulatedPromise = promiseToFunction(async () => { return await this.populateAccounts() })
     this.whitelistedPopulatedPromise = promiseToFunction(async () => { if (!this.oneTimeAddressesEnabled) return await this.populateWhitelisted() })
     this.gaslessGasTankAddressPopulatedPromise = promiseToFunction(async () => { if (this.gaslessGasTankVaultId) return await this.populateGaslessGasTankAddress() })
+
+    if (config.proxyPath) {
+      const proxyAgent = new HttpsProxyAgent(config.proxyPath);
+      this.agent = {
+        http: proxyAgent,
+        https: proxyAgent
+      }
+    }
   }
 
   private parsePrivateKey(privateKey: string): string {
@@ -622,4 +633,21 @@ Available addresses: ${Object.values(this.accounts).join(', ')}.`
   public setExternalTxId(externalTxId: (() => string) | string | undefined) {
     this.externalTxId = externalTxId;
   }
+
+  private toAxiosProxyConfig(path: string): AxiosProxyConfig {
+    const proxyUrl = new URL(path);
+
+    if (proxyUrl.pathname != '/') {
+      throw 'Proxy with path is not supported by axios';
+    }
+    return {
+      protocol: proxyUrl.protocol.replace(':', ''),
+      host: proxyUrl.hostname,
+      port: parseInt(proxyUrl.port),
+      auth: proxyUrl.username ? {
+        username: proxyUrl.username,
+        password: proxyUrl.password
+      } : undefined
+    }
+  }
 }

src/provider.ts

@@ -1,4 +1,5 @@
 import { FeeLevel } from "fireblocks-sdk";
+import { AxiosProxyConfig } from "axios";
 
 export enum ChainId {
   MAINNET = 1,
@@ -142,6 +143,11 @@ export type FireblocksProviderConfig = {
    * relayed via the provided vault account
    */
   gaslessGasTankVaultId?: number,
+
+/**
+ * Proxy path in the format of `http(s)://user:pass@server`
+ */
+  proxyPath?: string,
 }
 
 export interface RequestArguments<T = any> {