linting

packages/contracts/buidler.config.ts

 import { usePlugin, BuidlerConfig } from '@nomiclabs/buidler/config'
 
-import { DEFAULT_ACCOUNTS_BUIDLER, RUN_OVM_TEST_GAS } from './test/helpers/constants'
+import {
+  DEFAULT_ACCOUNTS_BUIDLER,
+  RUN_OVM_TEST_GAS,
+} from './test/helpers/constants'
 
 usePlugin('@nomiclabs/buidler-ethers')
 usePlugin('@nomiclabs/buidler-waffle')

packages/contracts/test/contracts/OVM/execution/OVM_ExecutionManager/context-opcodes.spec.ts

@@ -3,28 +3,28 @@ import {
   ExecutionManagerTestRunner,
   TestDefinition,
   NON_NULL_BYTES32,
-    OVM_TX_GAS_LIMIT
-  } from '../../../../helpers'
+  OVM_TX_GAS_LIMIT,
+} from '../../../../helpers'
 
-  const globalContext = {
-    ovmCHAINID: 420
-  }
+const globalContext = {
+  ovmCHAINID: 420,
+}
 
-  const transactionContext = {
+const transactionContext = {
   ovmTIMESTAMP: 12341234,
   ovmNUMBER: 13371337,
   ovmGASLIMIT: 45674567,
   ovmTXGASLIMIT: 78907890,
   ovmL1QUEUEORIGIN: 1,
-    ovmL1TXORIGIN: '0x1234123412341234123412341234123412341234'
-  }
+  ovmL1TXORIGIN: '0x1234123412341234123412341234123412341234',
+}
 
-  const messageContext = {
+const messageContext = {
   ovmCALLER: '0x6789678967896789678967896789678967896789',
-      ovmADDRESS: '0x4567456745674567456745674567456745674567'
-  }
+  ovmADDRESS: '0x4567456745674567456745674567456745674567',
+}
 
-  const test_contextOpcodes: TestDefinition = {
+const test_contextOpcodes: TestDefinition = {
   name: 'unit tests for basic getter opcodes',
   preState: {
     ExecutionManager: {
@@ -35,7 +35,7 @@ import {
       },
       globalContext,
       transactionContext,
-        messageContext
+      messageContext,
     },
     StateManager: {
       owner: '$OVM_EXECUTION_MANAGER',
@@ -72,8 +72,8 @@ import {
       steps: [
         {
           functionName: 'ovmTIMESTAMP',
-                    expectedReturnValue: transactionContext.ovmTIMESTAMP
-                }
+          expectedReturnValue: transactionContext.ovmTIMESTAMP,
+        },
       ],
     },
     {
@@ -81,8 +81,8 @@ import {
       steps: [
         {
           functionName: 'ovmNUMBER',
-                    expectedReturnValue: transactionContext.ovmNUMBER
-                }
+          expectedReturnValue: transactionContext.ovmNUMBER,
+        },
       ],
     },
     {
@@ -90,8 +90,8 @@ import {
       steps: [
         {
           functionName: 'ovmGASLIMIT',
-                    expectedReturnValue: transactionContext.ovmGASLIMIT
-                }
+          expectedReturnValue: transactionContext.ovmGASLIMIT,
+        },
       ],
     },
     {
@@ -99,8 +99,8 @@ import {
       steps: [
         {
           functionName: 'ovmL1QUEUEORIGIN',
-                    expectedReturnValue: transactionContext.ovmL1QUEUEORIGIN
-                }
+          expectedReturnValue: transactionContext.ovmL1QUEUEORIGIN,
+        },
       ],
     },
     {
@@ -108,8 +108,8 @@ import {
       steps: [
         {
           functionName: 'ovmL1TXORIGIN',
-                    expectedReturnValue: transactionContext.ovmL1TXORIGIN
-                }
+          expectedReturnValue: transactionContext.ovmL1TXORIGIN,
+        },
       ],
     },
     {
@@ -117,12 +117,12 @@ import {
       steps: [
         {
           functionName: 'ovmCHAINID',
-                    expectedReturnValue: globalContext.ovmCHAINID
-                }
+          expectedReturnValue: globalContext.ovmCHAINID,
+        },
       ],
     },
   ],
-  }
+}
 
-  const runner = new ExecutionManagerTestRunner()
-  runner.run(test_contextOpcodes)
+const runner = new ExecutionManagerTestRunner()
+runner.run(test_contextOpcodes)
\ No newline at end of file

packages/contracts/test/contracts/OVM/execution/OVM_ExecutionManager/nuisance-gas.spec.ts

@@ -8,19 +8,20 @@ import {
   VERIFIED_EMPTY_CONTRACT_HASH,
   NUISANCE_GAS_COSTS,
   Helper_TestRunner_BYTELEN,
-    ZERO_ADDRESS
-  } from '../../../../helpers'
+  ZERO_ADDRESS,
+} from '../../../../helpers'
 
-  const DUMMY_REVERT_DATA =
+const DUMMY_REVERT_DATA =
   '0xdeadbeef1e5420deadbeef1e5420deadbeef1e5420deadbeef1e5420deadbeef1e5420'
 
 const CREATED_CONTRACT_1 = '0x2bda4a99d5be88609d23b1e4ab5d1d34fb1c2feb'
 
-const FRESH_CALL_NUISANCE_GAS_COST = Helper_TestRunner_BYTELEN * NUISANCE_GAS_COSTS.NUISANCE_GAS_PER_CONTRACT_BYTE + NUISANCE_GAS_COSTS.MIN_NUISANCE_GAS_PER_CONTRACT
+const FRESH_CALL_NUISANCE_GAS_COST =
+  Helper_TestRunner_BYTELEN *
+    NUISANCE_GAS_COSTS.NUISANCE_GAS_PER_CONTRACT_BYTE +
+  NUISANCE_GAS_COSTS.MIN_NUISANCE_GAS_PER_CONTRACT
 
-console.log(`first call cost: ${FRESH_CALL_NUISANCE_GAS_COST}`)
-
-  const test_nuisanceGas: TestDefinition = {
+const test_nuisanceGas: TestDefinition = {
   name: 'Basic tests for nuisance gas',
   preState: {
     ExecutionManager: {
@@ -54,13 +55,14 @@ console.log(`first call cost: ${FRESH_CALL_NUISANCE_GAS_COST}`)
   },
   subTests: [
     {
-            name: 'ovmCALL consumes nuisance gas of CODESIZE * NUISANCE_GAS_PER_CONTRACT_BYTE',
+      name:
+        'ovmCALL consumes nuisance gas of CODESIZE * NUISANCE_GAS_PER_CONTRACT_BYTE',
       postState: {
         ExecutionManager: {
           messageRecord: {
-                        nuisanceGasLeft: OVM_TX_GAS_LIMIT - FRESH_CALL_NUISANCE_GAS_COST
-                    }
-                }
+            nuisanceGasLeft: OVM_TX_GAS_LIMIT - FRESH_CALL_NUISANCE_GAS_COST,
+          },
+        },
       },
       parameters: [
         {
@@ -69,7 +71,7 @@ console.log(`first call cost: ${FRESH_CALL_NUISANCE_GAS_COST}`)
             // do a non-nuisance-gas-consuming opcode (test runner auto-wraps in ovmCALL)
             {
               functionName: 'ovmADDRESS',
-                          expectedReturnValue: "$DUMMY_OVM_ADDRESS_1",
+              expectedReturnValue: '$DUMMY_OVM_ADDRESS_1',
             },
           ],
         },
@@ -80,23 +82,25 @@ console.log(`first call cost: ${FRESH_CALL_NUISANCE_GAS_COST}`)
               functionName: 'ovmCALL',
               functionParams: {
                 gasLimit: OVM_TX_GAS_LIMIT,
-                              target: "$DUMMY_OVM_ADDRESS_1",
-                              subSteps: []
+                target: '$DUMMY_OVM_ADDRESS_1',
+                subSteps: [],
               },
-                          expectedReturnStatus: true
+              expectedReturnStatus: true,
+            },
+          ],
         },
       ],
-                }
-            ]
     },
     {
-            name: 'ovmCALL consumes nuisance gas of CODESIZE * NUISANCE_GAS_PER_CONTRACT_BYTE twice for two unique ovmCALLS',
+      name:
+        'ovmCALL consumes nuisance gas of CODESIZE * NUISANCE_GAS_PER_CONTRACT_BYTE twice for two unique ovmCALLS',
       postState: {
         ExecutionManager: {
           messageRecord: {
-                        nuisanceGasLeft: OVM_TX_GAS_LIMIT - 2 * FRESH_CALL_NUISANCE_GAS_COST
-                    }
-                }
+            nuisanceGasLeft:
+              OVM_TX_GAS_LIMIT - 2 * FRESH_CALL_NUISANCE_GAS_COST,
+          },
+        },
       },
       parameters: [
         {
@@ -106,10 +110,10 @@ console.log(`first call cost: ${FRESH_CALL_NUISANCE_GAS_COST}`)
               functionName: 'ovmCALL',
               functionParams: {
                 gasLimit: OVM_TX_GAS_LIMIT,
-                              target: "$DUMMY_OVM_ADDRESS_2",
-                              subSteps: []
+                target: '$DUMMY_OVM_ADDRESS_2',
+                subSteps: [],
               },
-                          expectedReturnStatus: true
+              expectedReturnStatus: true,
             },
           ],
         },
@@ -120,33 +124,37 @@ console.log(`first call cost: ${FRESH_CALL_NUISANCE_GAS_COST}`)
               functionName: 'ovmCALL',
               functionParams: {
                 gasLimit: OVM_TX_GAS_LIMIT,
-                              target: "$DUMMY_OVM_ADDRESS_2",
+                target: '$DUMMY_OVM_ADDRESS_2',
                 subSteps: [
                   {
                     functionName: 'ovmCALL',
                     functionParams: {
                       gasLimit: OVM_TX_GAS_LIMIT,
                       target: '$DUMMY_OVM_ADDRESS_1',
-                                          subSteps: []
+                      subSteps: [],
+                    },
+                    expectedReturnStatus: true,
+                  },
+                ],
               },
-                                      expectedReturnStatus: true
-                                  }
-                              ]
+              expectedReturnStatus: true,
             },
-                          expectedReturnStatus: true
+          ],
         },
       ],
-                }
-            ]
     },
     {
-            name: 'ovmCALL consumes all allotted nuisance gas if code contract throws unknown exception',
+      name:
+        'ovmCALL consumes all allotted nuisance gas if code contract throws unknown exception',
       postState: {
         ExecutionManager: {
           messageRecord: {
-                        nuisanceGasLeft: OVM_TX_GAS_LIMIT - FRESH_CALL_NUISANCE_GAS_COST - OVM_TX_GAS_LIMIT / 2
-                    }
-                }
+            nuisanceGasLeft:
+              OVM_TX_GAS_LIMIT -
+              FRESH_CALL_NUISANCE_GAS_COST -
+              OVM_TX_GAS_LIMIT / 2,
+          },
+        },
       },
       parameters: [
         {
@@ -156,25 +164,26 @@ console.log(`first call cost: ${FRESH_CALL_NUISANCE_GAS_COST}`)
               functionName: 'ovmCALL',
               functionParams: {
                 gasLimit: OVM_TX_GAS_LIMIT / 2,
-                              target: "$DUMMY_OVM_ADDRESS_1",
+                target: '$DUMMY_OVM_ADDRESS_1',
                 subSteps: [
                   {
-                                      functionName: 'evmINVALID'
-                                  }
-                              ]
+                    functionName: 'evmINVALID',
+                  },
+                ],
               },
               expectedReturnStatus: true,
               expectedReturnValue: {
                 ovmSuccess: false,
-                              returnData: '0x'
-                          }
+                returnData: '0x',
+              },
             },
           ],
         },
-            ]
+      ],
     },
     {
-            name: 'ovmCREATE consumes all allotted nuisance gas if creation code throws data-less exception',
+      name:
+        'ovmCREATE consumes all allotted nuisance gas if creation code throws data-less exception',
       postState: {
         ExecutionManager: {
           messageRecord: {
@@ -183,9 +192,9 @@ console.log(`first call cost: ${FRESH_CALL_NUISANCE_GAS_COST}`)
             // This is because there is natural gas consumption between the ovmCALL(GAS/2) and ovmCREATE, which allots nuisance gas via _getNuisanceGasLimit.
             // This means that the ovmCREATE exception, DOES consumes all nuisance gas allotted, but that allotment
             // is less than the full OVM_TX_GAS_LIMIT / 2 which is alloted to the parent ovmCALL.
-                        nuisanceGasLeft: 4603714
-                    }
-                }
+            nuisanceGasLeft: 4603714,
+          },
+        },
       },
       parameters: [
         {
@@ -202,24 +211,23 @@ console.log(`first call cost: ${FRESH_CALL_NUISANCE_GAS_COST}`)
                     functionParams: {
                       subSteps: [
                         {
-                                                functionName: 'evmINVALID'
-                                            }
-                                        ]
+                          functionName: 'evmINVALID',
+                        },
+                      ],
                     },
                     expectedReturnStatus: true,
-                                    expectedReturnValue: ZERO_ADDRESS
+                    expectedReturnValue: ZERO_ADDRESS,
                   },
-                               ]
+                ],
               },
               expectedReturnStatus: true,
-                       }
+            },
           ],
-                }
-            ]
-        }
+        },
       ],
-  }
-  
-  const runner = new ExecutionManagerTestRunner()
-  runner.run(test_nuisanceGas)
+    },
+  ],
+}
 
+const runner = new ExecutionManagerTestRunner()
+runner.run(test_nuisanceGas)

packages/contracts/test/contracts/OVM/execution/OVM_ExecutionManager/ovmSTATICCALL.spec.ts

@@ -186,7 +186,11 @@ const test_ovmSTATICCALL: TestDefinition = {
                   [
                     {
                       functionName: 'ovmSTATICCALL',
-                      functionParams: [OVM_TX_GAS_LIMIT, '$DUMMY_OVM_ADDRESS_2', []],
+                      functionParams: [
+                        OVM_TX_GAS_LIMIT,
+                        '$DUMMY_OVM_ADDRESS_2',
+                        [],
+                      ],
                       expectedReturnStatus: true,
                       expectedReturnValues: [],
                     },
@@ -226,7 +230,12 @@ const test_ovmSTATICCALL: TestDefinition = {
                 functionParams: [
                   OVM_TX_GAS_LIMIT / 2,
                   '$DUMMY_OVM_ADDRESS_2',
-                  [REVERT_FLAGS.STATIC_VIOLATION, '0x', OVM_TX_GAS_LIMIT / 2, 0],
+                  [
+                    REVERT_FLAGS.STATIC_VIOLATION,
+                    '0x',
+                    OVM_TX_GAS_LIMIT / 2,
+                    0,
+                  ],
                 ],
                 expectedReturnStatus: true,
                 expectedReturnValues: [false, '0x'],
@@ -257,7 +266,12 @@ const test_ovmSTATICCALL: TestDefinition = {
                       functionParams: [
                         OVM_TX_GAS_LIMIT / 2,
                         '$DUMMY_OVM_ADDRESS_2',
-                        [REVERT_FLAGS.STATIC_VIOLATION, '0x', OVM_TX_GAS_LIMIT / 2, 0],
+                        [
+                          REVERT_FLAGS.STATIC_VIOLATION,
+                          '0x',
+                          OVM_TX_GAS_LIMIT / 2,
+                          0,
+                        ],
                       ],
                       expectedReturnStatus: true,
                       expectedReturnValues: [false, '0x'],

packages/contracts/test/helpers/codec/revert-flags.ts

@@ -21,7 +21,7 @@ export const decodeRevertData = (revertData: string): any => {
     ['uint256', 'uint256', 'uint256', 'bytes'],
     revertData
   )
-  console.log(`flag is: ${decoded[0].toNumber()}`)
+
   return (
     '[revertFlag:' +
     Object.keys(REVERT_FLAGS)[decoded[0]] +

packages/contracts/test/helpers/constants.ts

@@ -32,5 +32,5 @@ export const NUISANCE_GAS_COSTS = {
   MIN_GAS_FOR_INVALID_STATE_ACCESS: 30000,
 }
 
-  // TODO: get this exported/imported somehow in a way that we can do math on it.  unfortunately using require('.....artifacts/contract.json') is erroring...
+// TODO: get this exported/imported somehow in a way that we can do math on it.  unfortunately using require('.....artifacts/contract.json') is erroring...
 export const Helper_TestRunner_BYTELEN = 3654

packages/contracts/test/helpers/test-utils/test-runner.ts

@@ -29,7 +29,11 @@ import {
 } from './test.types'
 import { encodeRevertData } from '../codec'
 import { getModifiableStorageFactory } from '../storage/contract-storage'
-import { OVM_TX_GAS_LIMIT, RUN_OVM_TEST_GAS, NON_NULL_BYTES32 } from '../constants'
+import {
+  OVM_TX_GAS_LIMIT,
+  RUN_OVM_TEST_GAS,
+  NON_NULL_BYTES32,
+} from '../constants'
 
 export class ExecutionManagerTestRunner {
   private snapshot: string
@@ -55,8 +59,14 @@ export class ExecutionManagerTestRunner {
       test.subTests?.map((subTest) => {
         this.run({
           ...subTest,
-          preState: merge(cloneDeep(test.preState), cloneDeep(subTest.preState)),	
-          postState: merge(cloneDeep(test.postState), cloneDeep(subTest.postState))
+          preState: merge(
+            cloneDeep(test.preState),
+            cloneDeep(subTest.preState)
+          ),
+          postState: merge(
+            cloneDeep(test.postState),
+            cloneDeep(subTest.postState)
+          ),
         })
       })
 
@@ -123,13 +133,11 @@ export class ExecutionManagerTestRunner {
   }
 
   private async initContracts() {
-    console.log('initcontracts')
     if (this.snapshot) {
       await ethers.provider.send('evm_revert', [this.snapshot])
       this.snapshot = await ethers.provider.send('evm_snapshot', [])
       return
     }
-    console.log('no snapshot')
 
     this.contracts.OVM_SafetyChecker = await (
       await ethers.getContractFactory('OVM_SafetyChecker')
@@ -204,7 +212,9 @@ export class ExecutionManagerTestRunner {
           functionName: 'ovmCALL',
           functionParams: {
             gasLimit: OVM_TX_GAS_LIMIT,
-            target: ExecutionManagerTestRunner.getDummyAddress("$DUMMY_OVM_ADDRESS_1"),
+            target: ExecutionManagerTestRunner.getDummyAddress(
+              '$DUMMY_OVM_ADDRESS_1'
+            ),
             subSteps: step.functionParams.subSteps,
           },
           expectedReturnStatus: true,
@@ -224,17 +234,17 @@ export class ExecutionManagerTestRunner {
           data: calldata,
         },
         this.contracts.OVM_StateManager.address,
-        { gasLimit: RUN_OVM_TEST_GAS}
+        { gasLimit: RUN_OVM_TEST_GAS }
       )
     } else {
       await this.contracts.OVM_ExecutionManager.ovmCALL(
         OVM_TX_GAS_LIMIT,
-        ExecutionManagerTestRunner.getDummyAddress("$DUMMY_OVM_ADDRESS_1"),
+        ExecutionManagerTestRunner.getDummyAddress('$DUMMY_OVM_ADDRESS_1'),
         this.contracts.Helper_TestRunner.interface.encodeFunctionData(
           'runSingleTestStep',
           [this.parseTestStep(step)]
         ),
-        { gasLimit: RUN_OVM_TEST_GAS}
+        { gasLimit: RUN_OVM_TEST_GAS }
       )
     }
   }
@@ -336,13 +346,19 @@ export class ExecutionManagerTestRunner {
     if (isTestStep_CALL(step)) {
       if (step.expectedReturnValue === '0x00') {
         return step.expectedReturnValue
-      } else if (typeof step.expectedReturnValue === 'string' || step.expectedReturnValue === undefined) {
+      } else if (
+        typeof step.expectedReturnValue === 'string' ||
+        step.expectedReturnValue === undefined
+      ) {
         returnData = [
           step.expectedReturnStatus,
           step.expectedReturnValue || '0x',
         ]
       } else {
-        returnData = [step.expectedReturnValue.ovmSuccess, step.expectedReturnValue.returnData]
+        returnData = [
+          step.expectedReturnValue.ovmSuccess,
+          step.expectedReturnValue.returnData,
+        ]
       }
     } else if (BigNumber.isBigNumber(step.expectedReturnValue)) {
       returnData = [step.expectedReturnValue.toHexString()]

packages/contracts/test/helpers/test-utils/test.types.ts

@@ -94,7 +94,10 @@ export interface TestStep_CALL {
     subSteps?: TestStep[]
   }
   expectedReturnStatus: boolean
-  expectedReturnValue?: string | RevertFlagError |  {ovmSuccess: boolean, returnData: string}
+  expectedReturnValue?:
+    | string
+    | RevertFlagError
+    | { ovmSuccess: boolean; returnData: string }
 }
 
 interface TestStep_CREATE {
@@ -176,7 +179,7 @@ export const isTestStep_Context = (
     'ovmTIMESTAMP',
     'ovmGASLIMIT',
     'ovmCHAINID',
-    'ovmL1QUEUEORIGIN'
+    'ovmL1QUEUEORIGIN',
   ].includes(step.functionName)
 }