Add ability to use LoomProvider with the /eth endpoint

.travis_e2e_test.sh

@@ -4,7 +4,7 @@ set -euxo pipefail
 
 eval "$(GIMME_GO_VERSION=1.10.2 gimme)"
 
-export BUILD_ID=build-1213
+export BUILD_ID=build-1283
 
 bash e2e_tests.sh
 

e2e_support/genesis.json

@@ -1,11 +1,11 @@
 {
   "contracts": [
-    {	
-      "vm": "plugin",	
-      "format": "plugin",	
-      "name": "BluePrint",	
-      "location": "blueprint:0.0.1",	
-      "init": {}	
+    {
+      "vm": "plugin",
+      "format": "plugin",
+      "name": "BluePrint",
+      "location": "blueprint:0.0.1",
+      "init": {}
     },
     {
       "vm": "plugin",
@@ -62,6 +62,22 @@
           {
             "name": "tg:binance-cm",
             "status": "WAITING"
+          },
+          {
+            "name": "receipts:v3",
+            "status": "WAITING"
+          },
+          {
+            "name": "receipts:v3.1",
+            "status": "WAITING"
+          },
+          {
+            "name": "receipts:v3.2",
+            "status": "WAITING"
+          },
+          {
+            "name": "evm:constantinople",
+            "status": "WAITING"
           }
         ]
       }
@@ -99,4 +115,4 @@
       }
     }
   ]
-}
+}

e2e_tests.sh

@@ -28,7 +28,7 @@ fi
 
 download_dappchain() {
   cd $LOOM_DIR
-  wget -O loom https://private.delegatecall.com/loom/$PLATFORM/$BUILD_ID/loom-gateway
+  wget -O loom https://downloads.loomx.io/loom/$PLATFORM/$BUILD_ID/loom-gateway
   chmod +x loom
   LOOM_BIN=`pwd`/loom
 }

src/client.ts

@@ -21,7 +21,7 @@ import {
 } from './crypto-utils'
 import { Address, LocalAddress } from './address'
 import { WSRPCClient, IJSONRPCEvent } from './internal/ws-rpc-client'
-import { RPCClientEvent, IJSONRPCClient } from './internal/json-rpc-client'
+import { RPCClientEvent, IJSONRPCClient, IJSONRPCResponse } from './internal/json-rpc-client'
 import { sleep, parseUrl } from './helpers'
 
 export interface ITxHandlerResult {
@@ -243,6 +243,13 @@ export class Client extends EventEmitter {
   private _writeClient: IJSONRPCClient
   private _readClient!: IJSONRPCClient
 
+  /**
+   * Indicates whether the client is configured to use the /eth endpoint on Loom nodes.
+   * When this is enabled the client can only be used to interact with EVM contracts.
+   * NOTE: This limitation will be removed in the near future.
+   */
+  readonly isWeb3EndpointEnabled: boolean
+
   /** Broadcaster to use to send txs & receive results. */
   txBroadcaster: ITxBroadcaster
 
@@ -315,6 +322,8 @@ export class Client extends EventEmitter {
       )
     }
 
+    this.isWeb3EndpointEnabled = true === /eth$/.test(this._readClient.url)
+
     const emitContractEvent = (url: string, event: IJSONRPCEvent) =>
       this._emitContractEvent(url, event)
 
@@ -442,6 +451,17 @@ export class Client extends EventEmitter {
     }
   }
 
+  /**
+   * Sends a Web3 JSON-RPC message to the /eth endpoint on a Loom node.
+   * @param method RPC method name.
+   * @param params Parameter object or array.
+   * @returns A promise that will be resolved with the value of the result field (if any) in the
+   *          JSON-RPC response message.
+   */
+  async sendWeb3MsgAsync<T>(method: string, params: object | any[]): Promise<IJSONRPCResponse<T>> {
+    return this._readClient.sendAsync<IJSONRPCResponse<T>>(method, params)
+  }
+
   /**
    * Queries the receipt corresponding to a transaction hash
    *
@@ -555,7 +575,6 @@ export class Client extends EventEmitter {
       const envelope: EthFilterEnvelope = EthFilterEnvelope.deserializeBinary(
         bufferToProtobufBytes(result)
       )
-
       switch (envelope.getMessageCase()) {
         case EthFilterEnvelope.MessageCase.ETH_BLOCK_HASH_LIST:
           return envelope.getEthBlockHashList() as EthBlockHashList
@@ -675,8 +694,12 @@ export class Client extends EventEmitter {
    * @param method Method selected to the filter, can be "newHeads" or "logs"
    * @param filter JSON string of the filter
    */
-  evmSubscribeAsync(method: string, filterObject: Object): Promise<string> {
-    const filter = JSON.stringify(filterObject)
+  evmSubscribeAsync(method: string, params: Object | any[]): Promise<string> {
+    if (this.isWeb3EndpointEnabled) {
+      return this._readClient.sendAsync<string>('eth_subscribe', params)
+    }
+
+    const filter = JSON.stringify(params)
     return this._readClient.sendAsync<string>('evmsubscribe', {
       method,
       filter
@@ -691,9 +714,11 @@ export class Client extends EventEmitter {
    * @return boolean If true the subscription is removed with success
    */
   evmUnsubscribeAsync(id: string): Promise<boolean> {
-    return this._readClient.sendAsync<boolean>('evmunsubscribe', {
-      id
-    })
+    if (this.isWeb3EndpointEnabled) {
+      return this._readClient.sendAsync<boolean>('eth_unsubscribe', [id])
+    }
+
+    return this._readClient.sendAsync<boolean>('evmunsubscribe', { id })
   }
 
   /**
@@ -748,13 +773,14 @@ export class Client extends EventEmitter {
   }
 
   private _emitContractEvent(url: string, event: IJSONRPCEvent, isEVM: boolean = false): void {
+    debugLog('_emitContractEvent', arguments)
     const { error, result } = event
     if (error) {
       const eventArgs: IClientErrorEventArgs = { kind: ClientEvent.Error, url, error }
       this.emit(ClientEvent.Error, eventArgs)
+    } else if (this.isWeb3EndpointEnabled && isEVM) {
+      this.emit(ClientEvent.EVMEvent, event)
     } else if (result) {
-      debugLog('Event', event.id, result)
-
       // Ugh, no built-in JSON->Protobuf marshaller apparently
       // https://github.com/google/protobuf/issues/1591 so gotta do this manually
       const eventArgs: IChainEventArgs = {
@@ -776,8 +802,11 @@ export class Client extends EventEmitter {
         transactionHashBytes: result.tx_hash ? B64ToUint8Array(result.tx_hash) : new Uint8Array([])
       }
 
-      if (isEVM) this.emit(ClientEvent.EVMEvent, eventArgs)
-      else this.emit(ClientEvent.Contract, eventArgs)
+      if (isEVM) {
+        this.emit(ClientEvent.EVMEvent, eventArgs)
+      } else {
+        this.emit(ClientEvent.Contract, eventArgs)
+      }
     }
   }
 

src/helpers.ts

@@ -127,11 +127,16 @@ export function parseUrl(rawUrl: string): URL {
 }
 
 export function setupProtocolsFromEndpoint(
-  endpoint: string
+  endpoint: string,
+  useWeb3Endpoint: boolean = false
 ): { writer: IJSONRPCClient; reader: IJSONRPCClient } {
   const protocol = selectProtocol(endpoint)
   const writerSuffix = protocol === JSONRPCProtocol.HTTP ? '/rpc' : '/websocket'
-  const readerSuffix = protocol === JSONRPCProtocol.HTTP ? '/query' : '/queryws'
+  const readerSuffix = useWeb3Endpoint
+    ? '/eth'
+    : protocol === JSONRPCProtocol.HTTP
+      ? '/query'
+      : '/queryws'
 
   const writer = createJSONRPCClient({
     protocols: [{ url: endpoint + writerSuffix }]

src/internal/dual-rpc-client.ts

@@ -25,7 +25,7 @@ export class DualRPCClient extends WSRPCClient {
     requestTimeout?: number
     reconnectInterval?: number
     maxReconnects?: number
-    generateRequestId?: (method: string, params: object | any[]) => string
+    generateRequestId?: (method: string, params: object | any[]) => string | number
   }) {
     super(opts.wsUrl, opts)
     const {

src/internal/http-rpc-client.ts

@@ -30,7 +30,7 @@ export class HTTPRPCClient extends EventEmitter implements IJSONRPCClient {
     public url: string,
     opts: {
       requestTimeout?: number
-      generateRequestId?: (method: string, params: object | any[]) => string
+      generateRequestId?: (method: string, params: object | any[]) => string | number
     } = {}
   ) {
     super()
@@ -40,6 +40,7 @@ export class HTTPRPCClient extends EventEmitter implements IJSONRPCClient {
     } = opts
 
     this.requestTimeout = requestTimeout
+    // FIXME: generateRequestId doesn't actually override this._getNextRequestId at the moment
   }
 
   disconnect() {

src/internal/json-rpc-client.ts

@@ -10,19 +10,19 @@ export interface IJSONRPCRequest {
   jsonrpc: '2.0'
   method: string
   params?: any
-  id?: string
+  id?: string | number
 }
 
 export interface IJSONRPCResultResponse<T> {
   jsonrpc: '2.0'
   result: T
-  id: string
+  id: string | number
 }
 
 export interface IJSONRPCErrorResponse {
   jsonrpc: '2.0'
   error: IJSONRPCError
-  id: string
+  id: string | number
 }
 
 export interface IJSONRPCResponse<T> extends IJSONRPCResultResponse<T>, IJSONRPCErrorResponse {}

src/internal/ws-rpc-client.ts

@@ -35,14 +35,25 @@ export class WSRPCClient extends EventEmitter {
   private _isSubcribed: boolean = false
 
   protected _rpcId: number = 0
-  protected _getNextRequestId = () => (++this._rpcId).toString()
+
+  protected _getNextRequestId = () => {
+    const id = ++this._rpcId
+    return this.isWeb3EndpointEnabled ? id.toString() : id
+  }
 
   requestTimeout: number
 
   get isSubscribed(): boolean {
     return this._isSubcribed
   }
 
+  /**
+   * Indicates whether the client is configured to use the /eth endpoint on Loom nodes.
+   * When this is enabled the client can only be used to interact with EVM contracts.
+   * NOTE: This limitation will be removed in the near future.
+   */
+  readonly isWeb3EndpointEnabled: boolean
+
   /**
    *
    * @param url
@@ -59,10 +70,13 @@ export class WSRPCClient extends EventEmitter {
       requestTimeout?: number
       reconnectInterval?: number
       maxReconnects?: number
-      generateRequestId?: (method: string, params: object | any[]) => string
+      generateRequestId?: (method: string, params: object | any[]) => string | number
     } = {}
   ) {
     super()
+
+    this.isWeb3EndpointEnabled = true === /eth$/.test(url)
+
     const {
       autoConnect = true,
       requestTimeout = 15000, // 15s
@@ -206,15 +220,15 @@ export class WSRPCClient extends EventEmitter {
     const msgStr = message instanceof ArrayBuffer ? Buffer.from(message).toString() : message
     const msg = JSON.parse(msgStr)
 
-    // Events from native loomchain have the id equals 0
-    if (msg.id === '0') {
-      log('Loom Event arrived', msg)
+    if (msg.method === 'eth_subscription') {
+      log('EVM contract event arrived', msg)
+      this.emit(RPCClientEvent.EVMMessage, this.url, msg)
+    } else if (msg.id === '0') {
+      // Events from native loomchain have id 0
+      log('Go contract event arrived', msg)
       this.emit(RPCClientEvent.Message, this.url, msg)
-    }
-
-    // Events from EVM have the id from the evmsubscribe command
-    if (/^0x.+$/.test(msg.id)) {
-      log('EVM Event arrived', msg)
+    } else if (/^0x.+$/.test(msg.id)) {
+      // Events from EVM have the id from the evmsubscribe command
       this.emit(RPCClientEvent.EVMMessage, this.url, msg)
     }
   }