remix-project/libs/remix-simulator/src/provider.ts

import { Blocks } from './methods/blocks'

import { info } from './utils/logs'
import merge from 'merge'

import { Web3Accounts } from './methods/accounts'
import { Filters } from './methods/filters'
import { methods as miscMethods } from './methods/misc'
import { methods as netMethods } from './methods/net'
import { Transactions } from './methods/transactions'
import { Debug } from './methods/debug'
import { VMContext } from './vm-context'
import { Web3PluginBase } from 'web3'

export interface JSONRPCRequestPayload {
  params: any[];
  method: string;
  id: number;
  jsonrpc: string;
}

export interface JSONRPCResponsePayload {
  result: any;
  id: number;
  jsonrpc: string;
}

export type JSONRPCResponseCallback = (err: Error, result?: JSONRPCResponsePayload) => void

export type State = Record<string, string>

export type ProviderOptions = {
  fork?: string,
  nodeUrl?: string,
  blockNumber?: number | 'latest',
  stateDb?: State,
  details?: boolean
  blocks?: string[],
  coinbase?: string
}

export class Provider {
  options: ProviderOptions
  vmContext
  Accounts
  Transactions
  methods
  connected: boolean
  initialized: boolean
  pendingRequests: Array<any>

  constructor (options: ProviderOptions = {} as ProviderOptions) {
    this.options = options
    this.connected = true
    this.vmContext = new VMContext(options['fork'], options['nodeUrl'], options['blockNumber'], options['stateDb'], options['blocks'])

    this.Accounts = new Web3Accounts(this.vmContext)
    this.Transactions = new Transactions(this.vmContext)

    this.methods = {}
    this.methods = merge(this.methods, this.Accounts.methods())
    this.methods = merge(this.methods, (new Blocks(this.vmContext, options)).methods())
    this.methods = merge(this.methods, miscMethods())
    this.methods = merge(this.methods, (new Filters(this.vmContext)).methods())
    this.methods = merge(this.methods, netMethods())
    this.methods = merge(this.methods, this.Transactions.methods())
    this.methods = merge(this.methods, (new Debug(this.vmContext)).methods())
  }

  async init () {
    this.initialized = false
    this.pendingRequests = []
    await this.vmContext.init()
    await this.Accounts.resetAccounts()
    this.Transactions.init(this.Accounts.accounts, this.vmContext.serializedBlocks)
    this.initialized = true
    if (this.pendingRequests.length > 0) {
      this.pendingRequests.map((req) => {
        this.sendAsync(req.payload, req.callback)
      })
      this.pendingRequests = []
    }
  }

  _send(payload: JSONRPCRequestPayload, callback: (err: Error, result?: JSONRPCResponsePayload) => void) {
    // log.info('payload method is ', payload.method) // commented because, this floods the IDE console
    if (!this.initialized) {
      this.pendingRequests.push({ payload, callback })
      return
    }
    const method = this.methods[payload.method]
    if (this.options.details) {
      info(payload)
    }
    if (method) {
      return method.call(method, payload, (err, result) => {
        if (this.options.details) {
          info(err)
          info(result)
        }
        if (err) {
          return callback(err)
        }
        const response = { id: payload.id, jsonrpc: '2.0', result: result }
        callback(null, response)
      })
    }
    callback(new Error('unknown method ' + payload.method))
  }

  async sendAsync (payload: JSONRPCRequestPayload, callback?: (err: Error, result?: JSONRPCResponsePayload) => void) : Promise<JSONRPCResponsePayload> {
    return new Promise((resolve,reject)=>{
      const cb = (err, result) => {
        if (typeof callback==='function'){
          return callback(err, result)
        }
        if (err){
          return reject(err)
        }
        return resolve(result)
      }
      this._send(payload, cb)
    })
  }

  send (payload, callback) {
    this.sendAsync(payload, callback)
  }

  async request (payload: JSONRPCRequestPayload) : Promise<any> {
    const ret = await this.sendAsync(payload)
    return ret.result
  }

  isConnected () {
    return true
  }

  disconnect () {
    return false
  }

  supportsSubscriptions () {
    return true
  }

  on (type, cb) {
    this.vmContext.logsManager.addListener(type, cb)
  }
}

export function extend (web3) {
  if (!web3.remix){
    web3.registerPlugin(new Web3TestPlugin())
  }
}

class Web3TestPlugin extends Web3PluginBase {
  public pluginNamespace = 'remix'

  public getExecutionResultFromSimulator(transactionHash) {
    return this.requestManager.send({
      method: 'eth_getExecutionResultFromSimulator',
      params: [transactionHash]
    })
  }

  public getHHLogsForTx(transactionHash) {
    return this.requestManager.send({
      method: 'eth_getHHLogsForTx',
      params: [transactionHash]
    })
  }

  public getHashFromTagBySimulator(timestamp) {
    return this.requestManager.send({
      method: 'eth_getHashFromTagBySimulator',
      params: [timestamp]
    })
  }

  public registerCallId(id) {
    return this.requestManager.send({
      method: 'eth_registerCallId',
      params: [id]
    })
  }

  public getStateDb() {
    return this.requestManager.send({
      method: 'eth_getStateDb',
      params: []
    })
  }

  public getBlocksData() {
    return this.requestManager.send({
      method: 'eth_getBlocksData',
      params: []
    })
  }
}