Merge branch 'master' into use-textdecoder-decoding-code-param-payload

Author: CoveMB

.circleci/config.yml

@@ -15,6 +15,12 @@ parameters:
   run_flaky_tests:
     type: boolean
     default: false
+  run_lint_only:
+    type: boolean
+    default: false
+  run_build_only:
+    type: boolean
+    default: false
   resource_class:
     type: enum
     enum: ["small", "medium", "medium+", "large", "xlarge", "2xlarge"]
@@ -367,7 +373,7 @@ workflows:
               job: ["nogroup"]
               jobsize: ["1"]
               parallelism: [1]
-              scriptparameter: ["\\.pr"]
+              scriptparameter: ["\\.pr\\.js$"]
 
   run_flaky_tests:
     when: << pipeline.parameters.run_flaky_tests >>
@@ -382,7 +388,7 @@ workflows:
             - build
           matrix:
             parameters:
-              browser: ["chrome", "firefox"]
+              browser: ["chrome"]
               script: ["singletest.sh"]
               job: ["nogroup"]
               jobsize: ["1"]
@@ -433,14 +439,29 @@ workflows:
           requires:
             - build
           matrix:
-            alias: browser-tests
+            alias: chrome-tests
             parameters:
-              browser: ["chrome", "firefox"]
+              browser: ["chrome"]
               script: ["browser_test.sh"]
               job: ["0","1","2","3","4","5","6","7","8","9"]
               jobsize: ["10"]
               parallelism: [15]
               scriptparameter: [""]
+      - remix-ide-browser:
+          requires:
+            - build
+          matrix:
+            alias: firefox-tests
+            parameters:
+              browser: ["firefox"]
+              script: ["browser_test.sh"]
+              job: ["0","1","2","3","4","5","6","7","8","9"]
+              jobsize: ["10"]
+              parallelism: [15]
+              scriptparameter: [""]
+          filters:
+            branches:
+              only: ['master', 'remix_live', 'remix_beta', 'remix_alpha']
       - remix-ide-browser:
           requires:
             - build
@@ -460,7 +481,8 @@ workflows:
           requires:
             - lint
             - remix-libs
-            - browser-tests
+            - chrome-tests
+            - firefox-tests
             - metamask
             - plugins
 
@@ -474,7 +496,8 @@ workflows:
           requires:
             - lint
             - remix-libs
-            - browser-tests
+            - chrome-tests
+            - firefox-tests
             - metamask
             - plugins
             - predeploy
@@ -487,7 +510,8 @@ workflows:
           requires:
             - lint
             - remix-libs
-            - browser-tests
+            - chrome-tests
+            - firefox-tests
             - metamask
             - plugins
             - predeploy
@@ -500,12 +524,23 @@ workflows:
           requires:
             - lint
             - remix-libs
-            - browser-tests
+            - chrome-tests
+            - firefox-tests
             - metamask
             - plugins
             - predeploy
           filters:
             branches:
               only: remix_beta
 
+  lint_only:
+    when: << pipeline.parameters.run_lint_only >>
+    jobs:
+      - lint
+
+  build_only:
+    when: << pipeline.parameters.run_build_only >>
+    jobs:
+      - build
+
 # VS Code Extension Version: 1.5.1

.eslintrc.json

@@ -60,7 +60,24 @@
         "object-curly-spacing": ["error", "always", { "arraysInObjects": false }],
         "no-trailing-spaces": "error",
         "no-multi-spaces": "error",
-        "no-multiple-empty-lines": ["error" , { "max": 1}]
+        "no-multiple-empty-lines": ["error" , { "max": 1}],
+        "no-restricted-syntax": [
+          "error",
+          {
+            "selector": "MemberExpression[object.type='Identifier'][object.name='window'][property.type='Identifier'][property.name='_paq']",
+            "message": "Direct usage of window._paq is not allowed. Use one of these alternatives instead:\n  1. TrackingContext: track(eventBuilder)\n  2. MatomoManager: matomoManager.trackEvent(...)\n  3. Matomo Plugin: plugin.call('matomo', 'track', ...)\n  4. Helper: trackMatomoEvent(plugin, eventBuilder)"
+          },
+          {
+            "selector": "MemberExpression[object.type='MemberExpression'][object.object.type='Identifier'][object.object.name='window'][object.property.type='Identifier'][object.property.name='_paq']",
+            "message": "Direct usage of window._paq methods is not allowed. Use one of these alternatives instead:\n  1. TrackingContext: track(eventBuilder)\n  2. MatomoManager: matomoManager.trackEvent(...)\n  3. Matomo Plugin: plugin.call('matomo', 'track', ...)\n  4. Helper: trackMatomoEvent(plugin, eventBuilder)"
+          }
+        ]
+      }
+    },
+    {
+      "files": ["**/src/app/matomo/*.ts", "**/src/assets/js/**/*.js"],
+      "rules": {
+        "no-restricted-syntax": "off"
       }
     },
     {

.gitignore

@@ -82,3 +82,4 @@ apps/remix-ide-e2e/tmp/
 
 # IDE - Cursor
 .cursor/
+PR_MESSAGE.md

apps/circuit-compiler/src/app/actions/index.ts

@@ -3,6 +3,7 @@ import type { CircomPluginClient } from "../services/circomPluginClient"
 import { ActionPayloadTypes, AppState, ICircuitAppContext } from "../types"
 import { GROTH16_VERIFIER, PLONK_VERIFIER } from './constant'
 import { extractNameFromKey, extractParentFromKey } from '@remix-ui/helper'
+import { trackMatomoEvent } from '@remix-api'
 import isElectron from 'is-electron'
 
 export const compileCircuit = async (plugin: CircomPluginClient, appState: AppState) => {
@@ -32,7 +33,7 @@ export const computeWitness = async (plugin: CircomPluginClient, appState: AppSt
         const writePath = extractParentFromKey(appState.filePath) + `/.bin/${fileName.replace('.circom', '_js')}/${fileName.replace('.circom', '.wtn.json')}`
 
         await plugin.call('fileManager', 'writeFile', writePath, JSON.stringify(wtnsJson, null, 2))
-        plugin._paq.push(['trackEvent', 'circuit-compiler', 'computeWitness', 'wtns.exportJson', writePath])
+        trackMatomoEvent(plugin, { category: 'circuitCompiler', action: 'computeWitness', name: 'wtns.exportJson', value: writePath, isClick: true })
       }
     } else {
       console.log('Existing witness computation in progress')
@@ -61,46 +62,46 @@ export const runSetupAndExport = async (plugin: CircomPluginClient, appState: Ap
     const zkey_final = { type: "mem" }
 
     if (appState.provingScheme === 'groth16') {
-      plugin._paq.push(['trackEvent', 'circuit-compiler', 'runSetupAndExport', 'provingScheme', 'groth16'])
+      trackMatomoEvent(plugin, { category: 'circuitCompiler', action: 'runSetupAndExport', name: 'provingScheme', value: 'groth16', isClick: true })
       await snarkjs.zKey.newZKey(r1cs, ptau_final, zkey_final, zkLogger(plugin, dispatch, 'SET_SETUP_EXPORT_FEEDBACK'))
       const vKey = await snarkjs.zKey.exportVerificationKey(zkey_final, zkLogger(plugin, dispatch, 'SET_SETUP_EXPORT_FEEDBACK'))
 
       if (appState.exportVerificationKey) {
         await plugin.call('fileManager', 'writeFile', `${extractParentFromKey(appState.filePath)}/groth16/zk/keys/verification_key.json`, JSON.stringify(vKey, null, 2))
-        plugin._paq.push(['trackEvent', 'circuit-compiler', 'runSetupAndExport', 'zKey.exportVerificationKey', `${extractParentFromKey(appState.filePath)}/groth16/zk/keys/verification_key.json`])
+        trackMatomoEvent(plugin, { category: 'circuitCompiler', action: 'runSetupAndExport', name: 'zKey.exportVerificationKey', value: `${extractParentFromKey(appState.filePath)}/groth16/zk/keys/verification_key.json`, isClick: true })
       }
       if (appState.exportVerificationContract) {
         const templates = { groth16: GROTH16_VERIFIER }
         const solidityContract = await snarkjs.zKey.exportSolidityVerifier(zkey_final, templates, zkLogger(plugin, dispatch, 'SET_SETUP_EXPORT_FEEDBACK'))
 
         await plugin.call('fileManager', 'writeFile', `${extractParentFromKey(appState.filePath)}/groth16/zk/build/zk_verifier.sol`, solidityContract)
-        plugin._paq.push(['trackEvent', 'circuit-compiler', 'runSetupAndExport', 'zKey.exportSolidityVerifier', `${extractParentFromKey(appState.filePath)}/groth16/zk/build/zk_verifier.sol`])
+        trackMatomoEvent(plugin, { category: 'circuitCompiler', action: 'runSetupAndExport', name: 'zKey.exportSolidityVerifier', value: `${extractParentFromKey(appState.filePath)}/groth16/zk/build/zk_verifier.sol`, isClick: true })
       }
       dispatch({ type: 'SET_ZKEY', payload: zkey_final })
       dispatch({ type: 'SET_VERIFICATION_KEY', payload: vKey })
     } else if (appState.provingScheme === 'plonk') {
-      plugin._paq.push(['trackEvent', 'circuit-compiler', 'runSetupAndExport', 'provingScheme', 'plonk'])
+      trackMatomoEvent(plugin, { category: 'circuitCompiler', action: 'runSetupAndExport', name: 'provingScheme', value: 'plonk', isClick: true })
       await snarkjs.plonk.setup(r1cs, ptau_final, zkey_final, zkLogger(plugin, dispatch, 'SET_SETUP_EXPORT_FEEDBACK'))
       const vKey = await snarkjs.zKey.exportVerificationKey(zkey_final, zkLogger(plugin, dispatch, 'SET_SETUP_EXPORT_FEEDBACK'))
 
       if (appState.exportVerificationKey) {
         await plugin.call('fileManager', 'writeFile', `${extractParentFromKey(appState.filePath)}/plonk/zk/keys/verification_key.json`, JSON.stringify(vKey, null, 2))
-        plugin._paq.push(['trackEvent', 'circuit-compiler', 'runSetupAndExport', 'zKey.exportVerificationKey', `${extractParentFromKey(appState.filePath)}/plonk/zk/keys/verification_key.json`])
+        trackMatomoEvent(plugin, { category: 'circuitCompiler', action: 'runSetupAndExport', name: 'zKey.exportVerificationKey', value: `${extractParentFromKey(appState.filePath)}/plonk/zk/keys/verification_key.json`, isClick: true })
       }
       if (appState.exportVerificationContract) {
         const templates = { plonk: PLONK_VERIFIER }
         const solidityContract = await snarkjs.zKey.exportSolidityVerifier(zkey_final, templates, zkLogger(plugin, dispatch, 'SET_SETUP_EXPORT_FEEDBACK'))
 
         await plugin.call('fileManager', 'writeFile', `${extractParentFromKey(appState.filePath)}/plonk/zk/build/zk_verifier.sol`, solidityContract)
-        plugin._paq.push(['trackEvent', 'circuit-compiler', 'runSetupAndExport', 'zKey.exportSolidityVerifier', `${extractParentFromKey(appState.filePath)}/plonk/zk/build/zk_verifier.sol`])
+        trackMatomoEvent(plugin, { category: 'circuitCompiler', action: 'runSetupAndExport', name: 'zKey.exportSolidityVerifier', value: `${extractParentFromKey(appState.filePath)}/plonk/zk/build/zk_verifier.sol`, isClick: true })
       }
       dispatch({ type: 'SET_ZKEY', payload: zkey_final })
       dispatch({ type: 'SET_VERIFICATION_KEY', payload: vKey })
     }
     dispatch({ type: 'SET_COMPILER_STATUS', payload: 'idle' })
     dispatch({ type: 'SET_SETUP_EXPORT_STATUS', payload: 'done' })
   } catch (e) {
-    plugin._paq.push(['trackEvent', 'circuit-compiler', 'runSetupAndExport', 'error', e.message])
+    trackMatomoEvent(plugin, { category: 'circuitCompiler', action: 'runSetupAndExport', name: 'error', value: e.message, isClick: true })
     dispatch({ type: 'SET_COMPILER_STATUS', payload: 'errored' })
     console.error(e)
   }
@@ -132,25 +133,25 @@ export const generateProof = async (plugin: CircomPluginClient, appState: AppSta
 
       plugin.call('fileManager', 'writeFile', `${extractParentFromKey(appState.filePath)}/groth16/zk/build/proof.json`, JSON.stringify(proof, null, 2))
       plugin.call('terminal', 'log', { type: 'log', value: 'zk proof validity ' + verified })
-      plugin._paq.push(['trackEvent', 'circuit-compiler', 'generateProof', 'groth16.prove', verified])
+      trackMatomoEvent(plugin, { category: 'circuitCompiler', action: 'generateProof', name: 'groth16.prove', value: verified, isClick: true })
       if (appState.exportVerifierCalldata) {
         const calldata = await snarkjs.groth16.exportSolidityCallData(proof, publicSignals)
 
         plugin.call('fileManager', 'writeFile', `${extractParentFromKey(appState.filePath)}/groth16/zk/build/verifierCalldata.json`, calldata)
-        plugin._paq.push(['trackEvent', 'circuit-compiler', 'generateProof', 'groth16.exportSolidityCallData', `${extractParentFromKey(appState.filePath)}/groth16/zk/build/verifierCalldata.json`])
+        trackMatomoEvent(plugin, { category: 'circuitCompiler', action: 'generateProof', name: 'groth16.exportSolidityCallData', value: `${extractParentFromKey(appState.filePath)}/groth16/zk/build/verifierCalldata.json`, isClick: true })
       }
     } else if (appState.provingScheme === 'plonk') {
       const { proof, publicSignals } = await snarkjs.plonk.prove(zkey_final, wtns, zkLogger(plugin, dispatch, 'SET_PROOF_FEEDBACK'))
       const verified = await snarkjs.plonk.verify(vKey, publicSignals, proof, zkLogger(plugin, dispatch, 'SET_PROOF_FEEDBACK'))
 
       plugin.call('fileManager', 'writeFile', `${extractParentFromKey(appState.filePath)}/plonk/zk/build/proof.json`, JSON.stringify(proof, null, 2))
       plugin.call('terminal', 'log', { type: 'log', value: 'zk proof validity ' + verified })
-      plugin._paq.push(['trackEvent', 'circuit-compiler', 'generateProof', 'plonk.prove', verified])
+      trackMatomoEvent(plugin, { category: 'circuitCompiler', action: 'generateProof', name: 'plonk.prove', value: verified, isClick: true })
       if (appState.exportVerifierCalldata) {
         const calldata = await snarkjs.plonk.exportSolidityCallData(proof, publicSignals)
 
         plugin.call('fileManager', 'writeFile', `${extractParentFromKey(appState.filePath)}/plonk/zk/build/verifierCalldata.json`, calldata)
-        plugin._paq.push(['trackEvent', 'circuit-compiler', 'generateProof', 'plonk.exportSolidityCallData', `${extractParentFromKey(appState.filePath)}/plonk/zk/build/verifierCalldata.json`])
+        trackMatomoEvent(plugin, { category: 'circuitCompiler', action: 'generateProof', name: 'plonk.exportSolidityCallData', value: `${extractParentFromKey(appState.filePath)}/plonk/zk/build/verifierCalldata.json`, isClick: true })
       }
     }
     dispatch({ type: 'SET_COMPILER_STATUS', payload: 'idle' })

apps/circuit-compiler/src/app/services/circomPluginClient.ts

@@ -1,5 +1,6 @@
 import { PluginClient } from '@remixproject/plugin'
 import { createClient } from '@remixproject/plugin-webview'
+import { trackMatomoEvent } from '@remix-api'
 import EventManager from 'events'
 import pathModule from 'path'
 import { compiler_list, parse, compile, generate_r1cs, generate_witness } from 'circom_wasm'
@@ -21,11 +22,6 @@ export class CircomPluginClient extends PluginClient {
   private lastParsedFiles: Record<string, string> = {}
   private lastCompiledFile: string = ''
   private compiler: typeof compilerV215 & typeof compilerV216 & typeof compilerV217 & typeof compilerV218
-  public _paq = {
-    push: (args) => {
-      this.call('matomo' as any, 'track', args)
-    }
-  }
 
   constructor() {
     super()
@@ -175,7 +171,7 @@ export class CircomPluginClient extends PluginClient {
         const circuitErrors = circuitApi.report()
 
         this.logCompilerReport(circuitErrors)
-        this._paq.push(['trackEvent', 'circuit-compiler', 'compile', 'Compilation failed'])
+        trackMatomoEvent(this, { category: 'circuitCompiler', action: 'compile', name: 'Compilation failed', isClick: true })
         throw new Error(circuitErrors)
       } else {
         this.lastCompiledFile = path
@@ -204,7 +200,7 @@ export class CircomPluginClient extends PluginClient {
           this.internalEvents.emit('circuit_parsing_done', parseErrors, filePathToId)
           this.emit('statusChanged', { key: 'succeed', title: 'circuit compiled successfully', type: 'success' })
         }
-        this._paq.push(['trackEvent', 'circuit-compiler', 'compile', 'Compilation successful'])
+        trackMatomoEvent(this, { category: 'circuitCompiler', action: 'compile', name: 'Compilation successful', isClick: true })
         circuitApi.log().map(log => {
           log && this.call('terminal', 'log', { type: 'log', value: log })
         })
@@ -286,15 +282,15 @@ export class CircomPluginClient extends PluginClient {
         const r1csErrors = r1csApi.report()
 
         this.logCompilerReport(r1csErrors)
-        this._paq.push(['trackEvent', 'circuit-compiler', 'generateR1cs', 'R1CS Generation failed'])
+        trackMatomoEvent(this, { category: 'circuitCompiler', action: 'generateR1cs', name: 'R1CS Generation failed', isClick: true })
         throw new Error(r1csErrors)
       } else {
         const fileName = extractNameFromKey(path)
         const writePath = extractParentFromKey(path) + "/.bin/" + fileName.replace('.circom', '.r1cs')
 
         // @ts-ignore
         await this.call('fileManager', 'writeFile', writePath, r1csProgram, true)
-        this._paq.push(['trackEvent', 'circuit-compiler', 'generateR1cs', 'R1CS Generation successful'])
+        trackMatomoEvent(this, { category: 'circuitCompiler', action: 'generateR1cs', name: 'R1CS Generation successful', isClick: true })
         r1csApi.log().map(log => {
           log && this.call('terminal', 'log', { type: 'log', value: log })
         })
@@ -342,7 +338,7 @@ export class CircomPluginClient extends PluginClient {
     const witness = this.compiler ? await this.compiler.generate_witness(dataRead, input) : await generate_witness(dataRead, input)
     // @ts-ignore
     await this.call('fileManager', 'writeFile', wasmPath.replace('.wasm', '.wtn'), witness, { encoding: null })
-    this._paq.push(['trackEvent', 'circuit-compiler', 'computeWitness', 'compiler.generate_witness', wasmPath.replace('.wasm', '.wtn')])
+    trackMatomoEvent(this, { category: 'circuitCompiler', action: 'computeWitness', name: wasmPath.replace('.wasm', '.wtn'), isClick: true })
     this.internalEvents.emit('circuit_computing_witness_done')
     this.emit('statusChanged', { key: 'succeed', title: 'witness computed successfully', type: 'success' })
     return witness

apps/contract-verification/src/app/ContractVerificationPluginClient.ts

@@ -169,7 +169,7 @@ export class ContractVerificationPluginClient extends PluginClient {
         await this.call('terminal', 'log', { type: 'log', value: `Verifying with ${providerName}...` })
 
         if (providerName === 'Etherscan' || providerName === 'Routescan' || providerName === 'Blockscout') {
-          await new Promise(resolve => setTimeout(resolve, 10000))
+          await new Promise(resolve => setTimeout(resolve, 9000))
         }
 
         if (verifier && typeof verifier.verify === 'function') {

apps/contract-verification/src/app/Verifiers/EtherscanVerifier.ts

@@ -144,7 +144,7 @@ export class EtherscanVerifier extends AbstractVerifier {
 
     if (!response.ok) {
       const responseText = await response.text()
-      console.error('Error on Etherscan API check verification status at ' + this.apiUrl + '\nStatus: ' + response.status + '\nResponse: ' + responseText)
+      console.error('Error on API check verification status at ' + this.apiUrl + '\nStatus: ' + response.status + '\nResponse: ' + responseText)
       throw new Error(responseText)
     }
 
@@ -163,12 +163,12 @@ export class EtherscanVerifier extends AbstractVerifier {
       return { status: 'already verified', receiptId }
     }
     if (checkStatusResponse.result === 'Unknown UID') {
-      console.error('Error on Etherscan API check verification status at ' + this.apiUrl + '\nStatus: ' + checkStatusResponse.status + '\nMessage: ' + checkStatusResponse.message + '\nResult: ' + checkStatusResponse.result)
+      console.error('Error on API check verification status at ' + this.apiUrl + '\nStatus: ' + checkStatusResponse.status + '\nMessage: ' + checkStatusResponse.message + '\nResult: ' + checkStatusResponse.result)
       return { status: 'failed', receiptId, message: checkStatusResponse.result }
     }
 
     if (checkStatusResponse.status !== '1' || !checkStatusResponse.message.startsWith('OK')) {
-      console.error('Error on Etherscan API check verification status at ' + this.apiUrl + '\nStatus: ' + checkStatusResponse.status + '\nMessage: ' + checkStatusResponse.message + '\nResult: ' + checkStatusResponse.result)
+      console.error('Error on API check verification status at ' + this.apiUrl + '\nStatus: ' + checkStatusResponse.status + '\nMessage: ' + checkStatusResponse.message + '\nResult: ' + checkStatusResponse.result)
       throw new Error(checkStatusResponse.result)
     }
 

apps/contract-verification/src/app/app.tsx

@@ -161,7 +161,7 @@ const App = () => {
         setSubmittedContracts((prev) => Object.assign({}, prev, changedSubmittedContracts))
       }
 
-      timer.current = setInterval(pollStatus, 1000)
+      timer.current = setInterval(pollStatus, 3000)
     }
   }, [submittedContracts])