feat: custom base urls. (#1103)

* feat: custom base urls.

.changeset/clean-dodos-decide.md

@@ -0,0 +1,6 @@
+---
+'@moralisweb3/evm-api': patch
+'moralis': patch
+---
+
+Added the optional `evmApiBaseUrl` config option. You may replace the default base URL of the EVM API with your own.

.changeset/five-cooks-sleep.md

@@ -0,0 +1,6 @@
+---
+'@moralisweb3/sol-api': patch
+'moralis': patch
+---
+
+Added the optional `solApiBaseUrl` config option. You may replace the default base URL of the Solana API with your own.

packages/auth/src/Auth.test.ts

@@ -0,0 +1,20 @@
+import { ApiUtils } from '@moralisweb3/api-utils';
+import { Core } from '@moralisweb3/common-core';
+import { Auth } from './Auth';
+
+describe('Auth', () => {
+  function setupAuth() {
+    const core = Core.create();
+    const apiUtils = ApiUtils.create(core);
+    const auth = Auth.create(core);
+    core.registerModules([apiUtils, auth]);
+
+    return { core, auth };
+  }
+
+  it('returns default baseUrl', () => {
+    const { auth } = setupAuth();
+
+    expect(auth.baseUrl).toBe('https://authapi.moralis.io');
+  });
+});

packages/auth/src/Auth.ts

@@ -39,7 +39,7 @@ export class Auth extends ApiModule {
   }
 
   private constructor(core: Core) {
-    super(Auth.moduleName, core, BASE_URL);
+    super(Auth.moduleName, core, () => BASE_URL);
   }
 
   public setup() {

packages/common/core/src/Config/MoralisConfig.ts

@@ -15,11 +15,13 @@ export interface EvmUtilsConfigValues {
 // @moralisweb3/evm-api
 export interface EvmApiConfigValues {
   defaultEvmApiChain: EvmChainish;
+  evmApiBaseUrl: string;
 }
 
 // @moralisweb3/sol-api
 export interface SolApiConfigValues {
   defaultSolNetwork: SolNetworkish;
+  solApiBaseUrl: string;
 }
 
 export type MoralisCoreConfigValues =

packages/common/core/src/Modules/ApiModule.ts

@@ -7,11 +7,23 @@ import { Core } from '../Core';
  * It should always be created with:
  * - `name`: name of the module (should be unique)
  * - `core`: the Core instance
- * - `baseUrl`: the base url where of the api
+ * - `baseUrlProvider`: the provider of the base URL.
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export abstract class ApiModule extends Module {
-  public constructor(name: string, core: Core, public readonly baseUrl: string) {
+  private _baseUrl?: string;
+
+  /**
+   * @description The base URL of the API.
+   */
+  public get baseUrl(): string {
+    if (!this._baseUrl) {
+      this._baseUrl = this.baseUrlProvider();
+    }
+    return this._baseUrl;
+  }
+
+  public constructor(name: string, core: Core, private readonly baseUrlProvider: () => string) {
     super(name, core, ModuleType.API);
   }
 }

packages/common/core/src/Modules/Modules.test.ts

@@ -22,7 +22,7 @@ class TestModule extends Module {
 
 class TestApiModule extends ApiModule {
   public constructor(core: Core) {
-    super(TEST_API_MODULE_NAME, core, 'http://foo');
+    super(TEST_API_MODULE_NAME, core, () => 'http://foo');
   }
   public setup(): void {
     // Nothing

packages/evmApi/src/EvmApi.test.ts

@@ -3,12 +3,17 @@ import { ApiUtils, ApiUtilsConfig } from '@moralisweb3/api-utils';
 import { EvmApi } from './EvmApi';
 
 describe('EvmApi', () => {
+  function setupEvmApi() {
+    const core = Core.create();
+    const apiUtils = ApiUtils.create(core);
+    const evmApi = EvmApi.create(core);
+    core.registerModules([apiUtils, evmApi]);
+    return { core, evmApi };
+  }
+
   it('supports multi-tenancy', async () => {
-    function createEvmApi(apiKey: string): EvmApi {
-      const core = Core.create();
-      const apiUtils = ApiUtils.create(core);
-      const evmApi = EvmApi.create(core);
-      core.registerModules([apiUtils, evmApi]);
+    function setupMultiTenancyEvmApi(apiKey: string): EvmApi {
+      const { core, evmApi } = setupEvmApi();
       core.config.set(ApiUtilsConfig.apiKey, apiKey);
       return evmApi;
     }
@@ -30,9 +35,9 @@ describe('EvmApi', () => {
     });
 
     const alfaApiKey = 'alfa-api-key';
-    const alfa = createEvmApi(alfaApiKey);
+    const alfa = setupMultiTenancyEvmApi(alfaApiKey);
     const betaApiKey = 'beta-api-key';
-    const beta = createEvmApi(betaApiKey);
+    const beta = setupMultiTenancyEvmApi(betaApiKey);
 
     const alfaVersion = await alfa.utils.web3ApiVersion();
     expect(alfaVersion.result.version).toEqual(mockedVersion);
@@ -44,4 +49,19 @@ describe('EvmApi', () => {
 
     jest.restoreAllMocks();
   });
+
+  it('returns default baseUrl', () => {
+    const { evmApi } = setupEvmApi();
+
+    expect(evmApi.baseUrl).toBe('https://deep-index.moralis.io/api/v2');
+  });
+
+  it('supports custom baseUrl', () => {
+    const customBaseUrl = 'https://custom-evm-api-url.com';
+
+    const { core, evmApi } = setupEvmApi();
+    core.config.set('evmApiBaseUrl', customBaseUrl);
+
+    expect(evmApi.baseUrl).toBe(customBaseUrl);
+  });
 });

packages/evmApi/src/EvmApi.ts

@@ -2,8 +2,7 @@ import { Core, CoreProvider } from '@moralisweb3/common-core';
 import { EvmApiConfigSetup } from './config/EvmApiConfigSetup';
 
 import { ClientEvmApi } from './generated/ClientEvmApi';
-
-const BASE_URL = 'https://deep-index.moralis.io/api/v2';
+import { EvmApiConfig } from './config/EvmApiConfig';
 
 export class EvmApi extends ClientEvmApi {
   public static readonly moduleName = 'evmApi';
@@ -13,7 +12,7 @@ export class EvmApi extends ClientEvmApi {
   }
 
   private constructor(core: Core) {
-    super(EvmApi.moduleName, core, BASE_URL);
+    super(EvmApi.moduleName, core, () => core.config.get(EvmApiConfig.evmApiBaseUrl));
   }
 
   public setup() {

packages/evmApi/src/config/EvmApiConfig.ts

@@ -1,7 +1,11 @@
-import { ConfigKey } from '@moralisweb3/common-core';
-import { EvmChainish } from '@moralisweb3/common-evm-utils';
+import { ConfigKey, EvmChainish } from '@moralisweb3/common-core';
 
 export const EvmApiConfig = {
+  evmApiBaseUrl: {
+    name: 'evmApiBaseUrl',
+    defaultValue: 'https://deep-index.moralis.io/api/v2',
+  } as ConfigKey<string>,
+
   defaultEvmApiChain: {
     name: 'defaultEvmApiChain',
     defaultValue: '0x1',

packages/evmApi/src/config/EvmApiConfigSetup.ts

@@ -3,6 +3,7 @@ import { EvmApiConfig } from './EvmApiConfig';
 
 export class EvmApiConfigSetup {
   public static register(config: Config) {
+    config.registerKey(EvmApiConfig.evmApiBaseUrl);
     config.registerKey(EvmApiConfig.defaultEvmApiChain);
   }
 }

packages/solApi/src/SolApi.test.ts

@@ -0,0 +1,30 @@
+import { ApiUtils } from '@moralisweb3/api-utils';
+import { Core } from '@moralisweb3/common-core';
+import { SolApi } from './SolApi';
+
+describe('SolApi', () => {
+  function setupSolApi() {
+    const core = Core.create();
+    const apiUtils = ApiUtils.create(core);
+    const solApi = SolApi.create(core);
+    core.registerModules([apiUtils, solApi]);
+
+    return { core, solApi };
+  }
+
+  it('returns default baseUrl', () => {
+    const { solApi } = setupSolApi();
+
+    expect(solApi.baseUrl).toBe('https://solana-gateway.moralis.io');
+  });
+
+  it('supports custom baseUrl', () => {
+    const customBaseUrl = 'https://custom-sol-api-url.com';
+
+    const { core, solApi } = setupSolApi();
+
+    core.config.set('solApiBaseUrl', customBaseUrl);
+
+    expect(solApi.baseUrl).toBe(customBaseUrl);
+  });
+});

packages/solApi/src/SolApi.ts

@@ -1,7 +1,7 @@
 import { Core, CoreProvider } from '@moralisweb3/common-core';
 import { ClientSolApi } from './generated/ClientSolApi';
-
-const BASE_URL = 'https://solana-gateway.moralis.io';
+import { EvmSolApiConfigSetup } from './config/SolApiConfigSetup';
+import { SolApiConfig } from './config/SolApiConfig';
 
 export class SolApi extends ClientSolApi {
   public static readonly moduleName = 'solApi';
@@ -11,11 +11,11 @@ export class SolApi extends ClientSolApi {
   }
 
   private constructor(core: Core) {
-    super(SolApi.moduleName, core, BASE_URL);
+    super(SolApi.moduleName, core, () => core.config.get(SolApiConfig.solApiBaseUrl));
   }
 
   public setup() {
-    // Nothing
+    EvmSolApiConfigSetup.register(this.core.config);
   }
 
   public start() {

packages/solApi/src/config/SolApiConfig.ts

@@ -0,0 +1,8 @@
+import { ConfigKey } from '@moralisweb3/common-core';
+
+export const SolApiConfig = {
+  solApiBaseUrl: {
+    name: 'solApiBaseUrl',
+    defaultValue: 'https://solana-gateway.moralis.io',
+  } as ConfigKey<string>,
+};

packages/solApi/src/config/SolApiConfigSetup.ts

@@ -0,0 +1,8 @@
+import { Config } from '@moralisweb3/common-core';
+import { SolApiConfig } from './SolApiConfig';
+
+export class EvmSolApiConfigSetup {
+  public static register(config: Config) {
+    config.registerKey(SolApiConfig.solApiBaseUrl);
+  }
+}

packages/streams/src/Streams.test.ts

@@ -0,0 +1,20 @@
+import { ApiUtils } from '@moralisweb3/api-utils';
+import { Core } from '@moralisweb3/common-core';
+import { Streams } from './Streams';
+
+describe('Streams', () => {
+  function setupStreams() {
+    const core = Core.create();
+    const apiUtils = ApiUtils.create(core);
+    const streams = Streams.create(core);
+    core.registerModules([apiUtils, streams]);
+
+    return { core, streams };
+  }
+
+  it('returns default baseUrl', () => {
+    const { streams } = setupStreams();
+
+    expect(streams.baseUrl).toBe('https://api.moralis-streams.com');
+  });
+});

packages/streams/src/Streams.ts

@@ -39,7 +39,7 @@ export class Streams extends ApiModule {
   }
 
   private constructor(core: Core) {
-    super(Streams.moduleName, core, BASE_URL);
+    super(Streams.moduleName, core, () => BASE_URL);
   }
 
   public setup() {