Split providers into messaging and trustlines

Author: cducrest

docs/guides.md

@@ -58,10 +58,18 @@ The user therefore needs some coins ([TLC](https://explore.tlbc.trustlines.found
 
 ```javascript
 const laika = new TLNetwork({
-  protocol: 'https',
-  wsProtocol: 'wss',
-  host: 'relay0.testnet.trustlines.network',
-  path: '/api/v1',
+  relayProviderUrlObject: {
+    protocol: 'https',
+    wsProtocol: 'wss',
+    host: 'relay0.testnet.trustlines.network',
+    path: '/api/v1'
+  },
+  messagingProviderUrlObject: {
+    protocol: 'https',
+    wsProtocol: 'wss',
+    host: 'relay0.testnet.trustlines.network',
+    path: '/api/v1'
+  },
   walletType: 'ethers'
 })
 
@@ -77,10 +85,18 @@ An additional step of deploying the identity contract of the newly created user
 
 ```javascript
 const laika = new TLNetwork({
-  protocol: 'https',
-  wsProtocol: 'wss',
-  host: 'relay0.testnet.trustlines.network',
-  path: '/api/v1',
+  relayProviderUrlObject: {
+    protocol: 'https',
+    wsProtocol: 'wss',
+    host: 'relay0.testnet.trustlines.network',
+    path: '/api/v1'
+  },
+  messagingProviderUrlObject: {
+    protocol: 'https',
+    wsProtocol: 'wss',
+    host: 'relay0.testnet.trustlines.network',
+    path: '/api/v1'
+  },
   walletType: 'identity',
   identityFactoryAddress: '0x8D2720877Fa796E3C3B91BB91ad6CfcC07Ea249E',
   identityImplementationAddress: '0x8BEe92893D3ec62e5B3EBBe4e536A60Fd9AFc9D7'

src/Messaging.ts

@@ -2,7 +2,7 @@ import { Observable } from 'rxjs/Observable'
 import { fromPromise } from 'rxjs/observable/fromPromise'
 
 import { CurrencyNetwork } from './CurrencyNetwork'
-import { TLProvider } from './providers/TLProvider'
+import { Provider } from './providers/Provider'
 import { User } from './User'
 
 import utils from './utils'
@@ -17,11 +17,11 @@ import {
 export class Messaging {
   private user: User
   private currencyNetwork: CurrencyNetwork
-  private provider: TLProvider
+  private provider: Provider
 
   constructor(params: {
     currencyNetwork: CurrencyNetwork
-    provider: TLProvider
+    provider: Provider
     user: User
   }) {
     this.user = params.user

src/TLNetwork.ts

@@ -14,6 +14,7 @@ import { User } from './User'
 import { RelayProvider } from './providers/RelayProvider'
 import { TLProvider } from './providers/TLProvider'
 
+import { Provider } from './providers/Provider'
 import { TLSigner } from './signers/TLSigner'
 import { Web3Signer } from './signers/Web3Signer'
 
@@ -26,14 +27,32 @@ import {
 
 import utils from './utils'
 
-import { TLNetworkConfig } from './typings'
+import { ProviderUrl, TLNetworkConfig } from './typings'
 import { IdentityWallet } from './wallets/IdentityWallet'
 
 /**
  * The TLNetwork class is the single entry-point into the trustlines-clientlib.
  * It contains all of the library's functionality and all calls to the library should be made through a `TLNetwork` instance.
  */
 export class TLNetwork {
+  private static validateConfig(config: TLNetworkConfig): void {
+    if (
+      config.relayProviderUrlObject &&
+      (config.relayApiUrl || config.relayWsApiUrl)
+    ) {
+      throw new Error(
+        `Invalid input config; cannot input both relay provider url object and full urls`
+      )
+    }
+    if (
+      config.messagingProviderUrlObject &&
+      (config.messagingApiUrl || config.messagingWsApiUrl)
+    ) {
+      throw new Error(
+        `Invalid input config; cannot input both messaging provider url object and full urls`
+      )
+    }
+  }
   /**
    * User instance containing all user/keystore related methods.
    */
@@ -94,90 +113,107 @@ export class TLNetwork {
   /**
    * @hidden
    */
-  public provider: TLProvider
+  public relayProvider: TLProvider
+  /**
+   * @hidden
+   */
+  public messagingProvider: Provider
 
   /**
    * Initiates a new TLNetwork instance that provides the public interface to trustlines-clientlib.
    * @param config Configuration object. See [[TLNetworkConfig]] for more information.
    */
   constructor(config: TLNetworkConfig = {}) {
+    TLNetwork.validateConfig(config)
+    const defaultProviderUrl: ProviderUrl = {
+      protocol: 'http',
+      host: 'localhost',
+      port: '',
+      path: '',
+      wsProtocol: 'ws'
+    }
     const {
-      protocol = 'http',
-      host = 'localhost',
-      port = '',
-      path = '',
-      wsProtocol = 'ws',
+      relayProviderUrlObject = config.relayProviderUrlObject ||
+        defaultProviderUrl,
+      messagingProviderUrlObject = config.messagingProviderUrlObject ||
+        defaultProviderUrl,
       relayApiUrl,
       relayWsApiUrl,
+      messagingApiUrl,
+      messagingWsApiUrl,
       web3Provider,
       identityFactoryAddress,
       identityImplementationAddress,
       walletType = WALLET_TYPE_ETHERS,
       chainId
     } = config
 
-    this.setProvider(
+    this.setProviders(
       new RelayProvider(
-        relayApiUrl || utils.buildApiUrl(protocol, host, port, path),
-        relayWsApiUrl || utils.buildApiUrl(wsProtocol, host, port, path)
+        relayApiUrl || utils.buildApiUrl(relayProviderUrlObject),
+        relayWsApiUrl || utils.buildWsApiUrl(relayProviderUrlObject)
+      ),
+      new Provider(
+        messagingApiUrl || utils.buildApiUrl(messagingProviderUrlObject),
+        messagingWsApiUrl || utils.buildWsApiUrl(messagingProviderUrlObject)
       )
     )
 
-    this.setWallet(walletType, this.provider, chainId, {
+    this.setWallet(walletType, this.relayProvider, chainId, {
       identityFactoryAddress,
       identityImplementationAddress
     })
     this.setSigner(web3Provider, this.wallet)
 
-    this.currencyNetwork = new CurrencyNetwork(this.provider)
+    this.currencyNetwork = new CurrencyNetwork(this.relayProvider)
     this.transaction = new Transaction({
-      provider: this.provider,
+      provider: this.relayProvider,
       signer: this.signer,
       currencyNetwork: this.currencyNetwork
     })
     this.user = new User({
-      provider: this.provider,
+      provider: this.relayProvider,
       signer: this.signer,
       wallet: this.wallet
     })
     this.contact = new Contact({
-      provider: this.provider,
+      provider: this.relayProvider,
       user: this.user
     })
     this.event = new Event({
       currencyNetwork: this.currencyNetwork,
-      provider: this.provider,
+      provider: this.relayProvider,
       user: this.user
     })
     this.messaging = new Messaging({
       currencyNetwork: this.currencyNetwork,
-      provider: this.provider,
+      provider: this.messagingProvider,
       user: this.user
     })
     this.trustline = new Trustline({
       currencyNetwork: this.currencyNetwork,
       event: this.event,
-      provider: this.provider,
+      provider: this.relayProvider,
       transaction: this.transaction,
       user: this.user
     })
     this.payment = new Payment({
       currencyNetwork: this.currencyNetwork,
       event: this.event,
-      provider: this.provider,
+      provider: this.relayProvider,
       transaction: this.transaction,
       user: this.user
     })
     this.exchange = new Exchange({
       currencyNetwork: this.currencyNetwork,
       event: this.event,
       payment: this.payment,
-      provider: this.provider,
+      provider: this.relayProvider,
       transaction: this.transaction,
       user: this.user
     })
     this.ethWrapper = new EthWrapper({
-      provider: this.provider,
+      provider: this.relayProvider,
       transaction: this.transaction,
       user: this.user
     })
@@ -186,11 +222,15 @@ export class TLNetwork {
   /**
    * @hidden
    */
-  public setProvider(provider: TLProvider): void {
-    if (!(provider instanceof RelayProvider)) {
+  public setProviders(
+    relayProvider: TLProvider,
+    messagingProvider: Provider
+  ): void {
+    if (!(relayProvider instanceof RelayProvider)) {
       throw new Error('Provider not supported.')
     }
-    this.provider = provider
+    this.relayProvider = relayProvider
+    this.messagingProvider = messagingProvider
   }
 
   /**

src/providers/Provider.ts

@@ -0,0 +1,67 @@
+import { Observable } from 'rxjs/Observable'
+
+import utils from '../utils'
+
+import { ReconnectingWSOptions } from '../typings'
+
+export class Provider {
+  public ApiUrl: string
+  public WsApiUrl: string
+
+  constructor(ApiUrl: string, WsApiUrl: string) {
+    this.ApiUrl = ApiUrl
+    this.WsApiUrl = WsApiUrl
+  }
+
+  /**
+   * Returns a JSON response from the REST API of the server.
+   * @param endpoint Endpoint to fetch.
+   * @param options Optional fetch options.
+   */
+  public async fetchEndpoint<T>(
+    endpoint: string,
+    options?: object
+  ): Promise<T> {
+    const trimmedEndpoint = utils.trimUrl(endpoint)
+    return utils.fetchUrl<T>(`${this.ApiUrl}/${trimmedEndpoint}`, options)
+  }
+
+  public async postToEndpoint<T>(endpoint: string, data: any): Promise<T> {
+    const options = {
+      body: JSON.stringify(data),
+      headers: new Headers({ 'Content-Type': 'application/json' }),
+      method: 'POST'
+    }
+    return this.fetchEndpoint<T>(endpoint, options)
+  }
+
+  /**
+   * Creates a websocket stream connection to the server.
+   * @param endpoint Websocket stream endpoint to connect to.
+   * @param functionName Function to call on connection.
+   * @param args Function arguments.
+   * @param reconnectOnError Optional flag whether to try reconnecting web socket.
+   */
+  public createWebsocketStream(
+    endpoint: string,
+    functionName: string,
+    args: object,
+    reconnectingOptions?: ReconnectingWSOptions
+  ): Observable<any> {
+    const trimmedEndpoint = utils.trimUrl(endpoint)
+    return utils.websocketStream(
+      `${this.WsApiUrl}/${trimmedEndpoint}`,
+      functionName,
+      args,
+      reconnectingOptions
+    )
+  }
+
+  /**
+   * Returns the version of the currently configured provider server.
+   * @returns Version of relay in the format `<name>/vX.X.X`.
+   */
+  public async getVersion(): Promise<string> {
+    return this.fetchEndpoint<string>(`version`)
+  }
+}