[Tech] Proxy Server Updates (#404)

* init

* bump version, fix session params

* update yarn lock

* refactor providers, web3 to ethers

* fix types

* fix types, fix build

* fix ipc handlers

* test fixes, linting, prettier, format on save

* improve zod error response

* fix eslint errors in tests, fix logger types

* fix mm extension tests

* fix mm sdk

* fix wc and mm sdk uri

* fix window.ethereum type errors

* prettier

* fix mmsdk and wc

* rm log

* rm only

* merge submodules

* point ext helper to main

Author: BrettCleary

.eslintignore

@@ -2,6 +2,5 @@ i18next-parser.config.js
 flatpak/build/
 flatpak/.flatpak-builder/
 vite.config.ts
-**/__tests__/**
 **/__mocks__/**
 sign/**

.eslintrc

@@ -2,7 +2,8 @@
   "env": {
     "browser": true,
     "es2021": true,
-    "node": true
+    "node": true,
+    "jest": true
   },
   "extends": [
     "eslint:recommended",

.vscode/settings.json

@@ -8,8 +8,5 @@
   },
   "[typescriptreact]": {
     "editor.defaultFormatter": "rvest.vs-code-prettier-eslint"
-  },
-  "[typescript]": {
-    "editor.defaultFormatter": "rvest.vs-code-prettier-eslint"
   }
 }

package.json

@@ -155,11 +155,11 @@
     "@hyperplay/ui": "^0.1.4",
     "@mantine/core": "^6.0.9",
     "@mantine/hooks": "^6.0.9",
-    "@metamask/sdk": "^0.1.0",
+    "@metamask/sdk": "^0.5.3",
     "@mui/icons-material": "^5.10.9",
     "@mui/material": "^5.10.12",
     "@node-steam/vdf": "^2.2.0",
-    "@rudderstack/rudder-sdk-node": "^2.0.0",
+    "@rudderstack/rudder-sdk-node": "^2.0.3",
     "@sentry/electron": "^4.6.0",
     "@sentry/react": "7.50.0",
     "@shockpkg/icon-encoder": "^2.1.3",
@@ -169,18 +169,22 @@
     "@types/qrcode": "^1.5.0",
     "@types/react-blockies": "^1.4.1",
     "@types/unzipper": "^0.10.6",
-    "@walletconnect/web3-provider": "^1.8.0",
+    "@walletconnect/browser-utils": "^1.8.0",
+    "@walletconnect/ethereum-provider": "^2.9.0",
+    "@walletconnect/modal": "^2.6.0",
+    "@walletconnect/types": "^2.9.0",
     "axios": "^0.26.1",
     "bn.js": "^5.2.1",
     "check-disk-space": "^3.3.1",
-    "classic-level": "^1.2.0",
+    "classic-level": "1.2.0",
     "classnames": "^2.3.1",
     "compare-versions": "^6.0.0-rc.1",
     "crc": "^4.1.1",
     "discord-rich-presence-typescript": "^0.0.8",
     "easydl": "^1.0.3",
     "electron-store": "^8.0.1",
     "electron-updater": "^5.0.1",
+    "ethers": "^6.6.3",
     "express": "^4.18.1",
     "filesize": "^8.0.7",
     "find-process": "^1.4.7",
@@ -195,10 +199,11 @@
     "i18next-http-backend": "^1.4.0",
     "ini": "^3.0.0",
     "jsdom": "^20.0.0",
+    "lokijs": "^1.5.12",
     "mobx": "^6.9.0",
     "mobx-react-lite": "^3.4.0",
     "plist": "^3.0.5",
-    "qrcode": "^1.5.1",
+    "qrcode": "^1.5.3",
     "react": "^18.2.0",
     "react-blockies": "^1.4.1",
     "react-dom": "^18.2.0",
@@ -214,8 +219,8 @@
     "systeminformation": "^5.15.0",
     "ts-prune": "^0.10.3",
     "tslib": "^2.4.0",
-    "web3": "^1.7.5",
-    "yauzl": "^2.10.0"
+    "yauzl": "^2.10.0",
+    "zod": "^3.21.4"
   },
   "scripts": {
     "start": "vite",
@@ -273,6 +278,7 @@
     "@types/react-router-dom": "^5.3.3",
     "@types/supertest": "^2.0.12",
     "@types/tmp": "^0.2.3",
+    "@types/ws": "^8.5.5",
     "@typescript-eslint/eslint-plugin": "^5.20.0",
     "@typescript-eslint/parser": "^5.20.0",
     "@vitejs/plugin-react": "^2.2.0",

src/backend/__mocks__/providerCallbacks.ts

@@ -1,3 +1,4 @@
+import { backendEvents } from './../backend_events'
 /* eslint-disable  @typescript-eslint/no-explicit-any */
 let connectedResolve: any
 
@@ -7,24 +8,24 @@ export const getConnectedPromise = async function () {
   })
 }
 
-export function walletConnected(accounts: string[]) {
+backendEvents.on('walletConnected', function (accounts: string[]) {
   console.log('renderer receives: connected, accts = ', accounts)
   connectedResolve()
-}
+})
 
-export function walletDisconnected(code: number, reason: string) {
+backendEvents.on('walletDisconnected', function (code: number, reason: string) {
   console.log('renderer receives: disconnected: ', code, reason)
-}
+})
 
-export function accountsChanged(accounts: string[]) {
-  console.log('renderer receives: accounts changed to ', accounts)
-  connectedResolve()
-}
+backendEvents.on('connectionRequestRejected', function () {
+  console.log('renderer receives: connection request rejected ')
+})
 
-export function chainChanged(chainId: number) {
+backendEvents.on('chainChanged', function (chainId: number) {
   console.log('renderer receives: chain changed to ', chainId)
-}
+})
 
-export function connectionRequestRejected() {
-  console.log('renderer receives: connection request rejected ')
-}
+backendEvents.on('accountsChanged', function (accounts: string[]) {
+  console.log('renderer receives: accounts changed to ', accounts)
+  connectedResolve()
+})

src/backend/__tests__/constants.test.ts

@@ -28,7 +28,7 @@ describe('Constants - getShell', () => {
 
   async function getShell(): Promise<string> {
     jest.resetModules()
-    return await import('../constants').then((module) => {
+    return import('../constants').then((module) => {
       return module.execOptions.shell
     })
   }

src/backend/__tests__/main_window.test.ts

@@ -17,7 +17,7 @@ describe('main_window', () => {
     })
 
     describe('if there is a main window', () => {
-      let window = {
+      const window = {
         webContents: {
           send: jest.fn()
         }

src/backend/__tests__/utils.test.ts

@@ -7,7 +7,6 @@ import { test_data } from './test_data/github-api-heroic-test-data.json'
 import path from 'path'
 import {
   copyFileSync,
-  createWriteStream,
   existsSync,
   readFileSync,
   rmSync,
@@ -60,6 +59,7 @@ describe('backend/utils.ts', () => {
       [{ target: 'v2.4.0-beta.1', base: '2.4.0' }, false],
       [{ target: 'v2.4.0-beta.2', base: '2.4.0-beta.1' }, true],
       [{ target: 'v2.4.0-beta.1', base: '2.4.0-beta.2' }, false],
+      /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
       [{ target: undefined as any, base: undefined as any }, false]
     ])
 

src/backend/hyperplay-extension-helper

@@ -17,7 +17,9 @@ let tmpDir = {} as DirResult
 
 const shouldSkip = platform() === 'win32'
 const skipMessage = 'on windows so skipping test'
-const emptyTest = it('should do nothing', () => {})
+const emptyTest = it('should do nothing', () => {
+  console.log('running empty test')
+})
 
 describe('logger/logfile.ts', () => {
   if (shouldSkip) {
@@ -173,11 +175,9 @@ describe('logger/logfile.ts', () => {
   })
 
   test('appendMessageToLogFile fails', () => {
-    const appendFileSyncSpy = jest
-      .spyOn(graceful_fs, 'appendFileSync')
-      .mockImplementation(() => {
-        throw Error('append failed')
-      })
+    jest.spyOn(graceful_fs, 'appendFileSync').mockImplementation(() => {
+      throw Error('append failed')
+    })
 
     logfile.appendMessageToLogFile('Hello World')
     expect(logError).toBeCalledWith(

src/backend/hyperplay-proxy-server

@@ -42,7 +42,9 @@ function getStringPassedToLogFile(type: logLevel, skipMessagePrefix = false) {
 
 const shouldSkip = platform() === 'win32'
 const skipMessage = 'on windows so skipping test'
-const emptyTest = it('should do nothing', () => {})
+const emptyTest = it('should do nothing', () => {
+  console.log('running empty test')
+})
 
 describe('logger/logger.ts', () => {
   if (shouldSkip) {
@@ -62,7 +64,7 @@ describe('logger/logger.ts', () => {
       .mockImplementation()
 
     interface TestCaseProps {
-      function: Function
+      function: logger.LogFunction
       spyConsole: jest.SpyInstance
     }
 
@@ -95,7 +97,7 @@ describe('logger/logger.ts', () => {
     jest.spyOn(global.console, 'log').mockImplementation()
     jest.spyOn(global.console, 'warn').mockImplementation()
 
-    const testCases = new Map<logLevel, Function>([
+    const testCases = new Map<logLevel, logger.LogFunction>([
       ['ERROR', logger.logError],
       ['INFO', logger.logInfo],
       ['WARNING', logger.logWarning],
@@ -116,7 +118,7 @@ describe('logger/logger.ts', () => {
     jest.spyOn(global.console, 'log').mockImplementation()
     jest.spyOn(global.console, 'warn').mockImplementation()
 
-    const testCases = new Map<logLevel, Function>([
+    const testCases = new Map<logLevel, logger.LogFunction>([
       ['ERROR', logger.logError],
       ['INFO', logger.logInfo],
       ['WARNING', logger.logWarning],

src/backend/logger/__tests__/logfile.test.ts

@@ -160,8 +160,6 @@ function logBase(
  * @param showDialog set true to show in frontend
  * @defaultvalue {@link LogPrefix.General}
  */
-export function logDebug(input: LogInputType, options?: LogOptions): void
-export function logDebug(input: LogInputType, prefix?: LogPrefix): void
 export function logDebug(
   input: LogInputType,
   options_or_prefix?: LogOptions | LogPrefix
@@ -177,15 +175,15 @@ export function logDebug(
  * @param showDialog set true to show in frontend
  * @defaultvalue {@link LogPrefix.General}
  */
-export function logError(input: LogInputType, options?: LogOptions): void
-export function logError(input: LogInputType, prefix?: LogPrefix): void
 export function logError(
   input: LogInputType,
   options_or_prefix?: LogOptions | LogPrefix
 ) {
   logBase(input, 'ERROR', options_or_prefix)
 }
 
+export type LogFunction = typeof logError
+
 /**
  * Log info messages
  * @param input info messages to log
@@ -194,8 +192,6 @@ export function logError(
  * @param showDialog set true to show in frontend
  * @defaultvalue {@link LogPrefix.General}
  */
-export function logInfo(input: LogInputType, options?: LogOptions): void
-export function logInfo(input: LogInputType, prefix?: LogPrefix): void
 export function logInfo(
   input: LogInputType,
   options_or_prefix?: LogOptions | LogPrefix
@@ -211,8 +207,6 @@ export function logInfo(
  * @param showDialog set true to show in frontend
  * @defaultvalue {@link LogPrefix.General}
  */
-export function logWarning(input: LogInputType, options?: LogOptions): void
-export function logWarning(input: LogInputType, prefix?: LogPrefix): void
 export function logWarning(
   input: LogInputType,
   options_or_prefix?: LogOptions | LogPrefix

src/backend/logger/__tests__/logger.test.ts

@@ -121,16 +121,8 @@ import { getFonts } from 'font-list'
 import { runWineCommand, verifyWinePrefix } from './launcher'
 import shlex from 'shlex'
 import { initQueue } from './downloadmanager/downloadqueue'
-import * as ProviderHelper from './hyperplay-proxy-server/providerHelper'
 import * as ExtensionHelper from './hyperplay-extension-helper/extensionProvider'
 import * as ProxyServer from './hyperplay-proxy-server/proxy'
-import {
-  AccountsChangedType,
-  ChainChangedType,
-  ConnectionRequestRejectedType,
-  WalletConnectedType,
-  WalletDisconnectedType
-} from './hyperplay-proxy-server/commonProxyTypes'
 
 ProxyServer.serverStarted.then(() => console.log('Server started'))
 import {
@@ -1800,41 +1792,29 @@ import { backendEvents } from 'backend/backend_events'
 import { toggleOverlay } from 'backend/hyperplay-overlay'
 
 // sends messages to renderer process through preload.ts callbacks
-export const walletConnected: WalletConnectedType = function (
-  accounts: string[]
-) {
+backendEvents.on('walletConnected', function (accounts: string[]) {
   getMainWindow()?.webContents.send('walletConnected', accounts)
-}
+})
 
-export const walletDisconnected: WalletDisconnectedType = function (
-  code: number,
-  reason: string
-) {
+backendEvents.on('walletDisconnected', function (code: number, reason: string) {
   getMainWindow()?.webContents.send('walletDisconnected', code, reason)
-}
+})
 
-export const accountsChanged: AccountsChangedType = function (
-  accounts: string[]
-) {
-  getMainWindow()?.webContents.send('accountChanged', accounts)
-}
+backendEvents.on('connectionRequestRejected', function () {
+  getMainWindow()?.webContents.send('connectionRequestRejected')
+})
 
-export const chainChanged: ChainChangedType = function (chainId: number) {
+backendEvents.on('chainChanged', function (chainId: number) {
   getMainWindow()?.webContents.send('chainChanged', chainId)
-}
+})
 
-export const connectionRequestRejected: ConnectionRequestRejectedType =
-  function () {
-    getMainWindow()?.webContents.send('connectionRequestRejected')
-  }
+backendEvents.on('accountsChanged', function (accounts: string[]) {
+  getMainWindow()?.webContents.send('accountChanged', accounts)
+})
 
-ProviderHelper.passEventCallbacks(
-  accountsChanged,
-  walletConnected,
-  walletDisconnected,
-  chainChanged,
-  connectionRequestRejected
-)
+backendEvents.on('metamaskOtpUpdated', function (otp: string) {
+  getMainWindow()?.webContents.send('metamaskOtpUpdated', otp)
+})
 
 ipcMain.on('openHyperplaySite', async () => openUrlOrFile(hyperplaySite))
 

src/backend/logger/logger.ts

@@ -2,13 +2,13 @@ import { apiObject } from '@rudderstack/rudder-sdk-node'
 import { sendFrontendMessage } from 'backend/main_window'
 import { GameInfo, MetricsOptInStatus } from 'common/types'
 import Store from 'electron-store'
-import web3 from 'web3'
 import { getAppVersion, getFormattedOsName, processIsClosed } from '../utils'
 import { rudderstack } from './rudderstack-client'
 import { PossibleMetricEventNames, PossibleMetricPayloads } from './types'
 import { hrtime } from 'process'
 import find from 'find-process'
 import { backendEvents } from 'backend/backend_events'
+import { ethers } from 'ethers'
 
 /**
  * Our global anonymous id which is used for any events that contain data that
@@ -98,7 +98,7 @@ const METRICS_PARTICIPATION_EVENTS = ['Metrics Opt-in', 'Metrics Opt-out']
  * @returns A random hex string
  */
 function generateRandomId() {
-  return web3.utils.randomHex(24)
+  return ethers.hexlify(ethers.randomBytes(24))
 }
 
 /**