feat: Support custom URLs to use a proxy server (#345)

bennycode · Jan 1, 2021 · ebcb8d2 · ebcb8d2
1 parent 834b726
commit ebcb8d2
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 2 deletions.
diff --git a/src/CoinbasePro.test.ts b/src/CoinbasePro.test.ts
@@ -29,5 +29,19 @@ describe('CoinbasePro', () => {
 
       expect(client.url.REST).toBe(CoinbasePro.SETUP.SANDBOX.REST);
     });
+
+    it('supports custom URLs to use a proxy server', () => {
+      const proxyUrl = 'http://localhost:3000/rest-proxy';
+
+      const client = new CoinbasePro({
+        apiKey: '',
+        apiSecret: '',
+        passphrase: '',
+        httpUrl: proxyUrl,
+        wsUrl: 'wss://ws-feed-public.sandbox.pro.coinbase.com',
+      });
+
+      expect(client.url.REST).toBe(proxyUrl);
+    });
   });
 });
diff --git a/src/CoinbasePro.ts b/src/CoinbasePro.ts
@@ -2,13 +2,29 @@ import {RESTClient} from './client/RESTClient';
 import {WebSocketClient} from './client/WebSocketClient';
 import {RequestSetup, RequestSigner, SignedRequest} from './auth/RequestSigner';
 
-export interface ClientAuthentication {
+export interface ClientAuthenticationBase {
+  apiKey: string;
+  apiSecret: string;
+  passphrase: string;
+}
+
+export interface ClientAuthenticationBaseUrls extends ClientAuthenticationBase {
   apiKey: string;
   apiSecret: string;
   passphrase: string;
   useSandbox: boolean;
 }
 
+export interface ClientAuthenticationCustomUrls extends ClientAuthenticationBase {
+  apiKey: string;
+  apiSecret: string;
+  httpUrl: string;
+  passphrase: string;
+  wsUrl: string;
+}
+
+export type ClientAuthentication = ClientAuthenticationBaseUrls | ClientAuthenticationCustomUrls;
+
 export interface ClientConnection {
   REST: string;
   WebSocket: string;
@@ -41,7 +57,18 @@ export class CoinbasePro {
       useSandbox: false,
     }
   ) {
-    this.url = auth.useSandbox === true ? CoinbasePro.SETUP.SANDBOX : CoinbasePro.SETUP.PRODUCTION;
+    if (typeof (auth as ClientAuthenticationBaseUrls).useSandbox === 'boolean') {
+      this.url =
+        (auth as ClientAuthenticationBaseUrls).useSandbox === true
+          ? CoinbasePro.SETUP.SANDBOX
+          : CoinbasePro.SETUP.PRODUCTION;
+    } else {
+      const {httpUrl, wsUrl} = auth as ClientAuthenticationCustomUrls;
+      this.url = {
+        REST: httpUrl,
+        WebSocket: wsUrl,
+      };
+    }
 
     const signRequest = async (setup: RequestSetup): Promise<SignedRequest> => {
       const clockSkew = await this.rest.time.getClockSkew();