Merge pull request crytic#1396 from crytic/changelog

Update CHANGELOG, fix typos and grammar

Author: elopez

CHANGELOG.md

@@ -1,9 +1,14 @@
 ## Unreleased
 
 * feat: show which project is being fuzzed (#1381)
+* feat: keyboard navigation for the UI (Tab, PgUp, PgDown, arrows) (#1386)
 * ARM64 Docker containers (#1352)
+* ARM64 Linux builds (#1377)
 * Fix worker crashes when shrinking empty reproducers (#1378)
-* Upgrade `hevm` to reduce memory usage on certain scenarios (#1346)
+* Improved UI responsiveness (#1387)
+* Update `hevm` to reduce memory usage on certain scenarios (#1346)
+* Update `hevm` to fix multiple deployments under `prank`ing cheatcodes (#1377)
+* Echidna is now built with GHC 9.8.4 (#1377)
 
 ## 2.2.6
 

lib/Echidna/ABI.hs

@@ -218,7 +218,7 @@ fixAbiInt n x =
      else AbiInt n (x `mod` (2 ^ (n - 1) - 1))
 
 -- | Given a way to generate random 'Word8's and a 'ByteString' b of length l,
--- generate between 0 and 2l 'Word8's and add insert them into b at random indices.
+-- generate between 0 and 2l 'Word8's and insert them into b at random indices.
 addChars :: MonadRandom m => m Word8 -> ByteString -> m ByteString
 addChars c b = foldM withR b . enumFromTo 0 =<< rand where
   rand       = getRandomR (0, BS.length b - 1)

lib/Echidna/Campaign.hs

@@ -417,7 +417,7 @@ callseq vm txSeq = do
             _ -> Nothing
         _ -> Nothing
 
-  -- | Add transactions to the corpus discarding reverted ones
+  -- | Add transactions to the corpus, discarding reverted ones
   addToCorpus :: Int -> [(Tx, (VMResult Concrete RealWorld, Gas))] -> Corpus -> Corpus
   addToCorpus n res corpus =
     if null rtxs then corpus else Set.insert (n, rtxs) corpus
@@ -441,7 +441,7 @@ execTxOptC vm tx = do
   pure (res, vm')
 
 -- | Given current `gasInfo` and a sequence of executed transactions, updates
--- information on highest gas usage for each call
+-- information on the highest gas usage for each call
 updateGasInfo
   :: [(Tx, (VMResult Concrete RealWorld, Gas))]
   -> [Tx]

lib/Echidna/Shrink.hs

@@ -30,7 +30,7 @@ shrinkTest
 shrinkTest vm test = do
   env <- ask
   case test.state of
-    -- If we run out of tries to shrink, return the sequence as we have them
+    -- If we run out of tries to shrink, return the sequence as we have it
     Large i | i >= env.cfg.campaignConf.shrinkLimit && not (isOptimizationTest test) ->
       pure $ Just test { state = Solved }
     Large i ->
@@ -116,7 +116,7 @@ shrinkSeq vm f v txs = do
     -- | Simplify a sequence of transactions reducing the complexity of its arguments (using shrinkTx)
     -- and then reducing its sender (using shrinkSender)
     shrunk = mapM (shrinkSender <=< shrinkTx) txs
-    -- | Simplifiy a sequence of transactions randomly dropping one transaction (with uniform selection)
+    -- | Simplify a sequence of transactions randomly dropping one transaction (with uniform selection)
     shorten = (\i -> take i txs ++ drop (i + 1) txs) <$> getRandomR (0, length txs)
 
 -- | Given a transaction, replace the sender of the transaction by another one

lib/Echidna/Solidity.hs

@@ -98,7 +98,7 @@ compileContracts solConf fp = do
     -- | OS-specific path to the "null" file, which accepts writes without storing them
     nullFilePath :: String
     nullFilePath = if os == "mingw32" then "\\\\.\\NUL" else "/dev/null"
-  -- clean up previous artifacts
+  -- clean up previous artifact files
   removeJsonFiles "crytic-export"
   mconcat . NE.toList <$> mapM compileOne fp
 

lib/Echidna/Types/Campaign.hs

@@ -37,7 +37,7 @@ data CampaignConf = CampaignConf
   , corpusDir          :: Maybe FilePath
     -- ^ Directory to load and save lists of transactions
   , mutConsts          :: MutationConsts Integer
-    -- ^ Directory to load and save lists of transactions
+    -- ^ Mutation constants for fuzzing
   , coverageFormats    :: [CoverageFileType]
     -- ^ List of file formats to save coverage reports
   , workers            :: Maybe Word8

lib/Echidna/Types/Solidity.hs

@@ -51,7 +51,7 @@ instance Show SolException where
     NoCryticCompile        -> "crytic-compile not installed or not found in PATH. To install it, run:\n   pip install crytic-compile"
     InvalidMethodFilters f -> "Applying the filter " ++ show f ++ " to the methods produces an empty list. Are you filtering the correct functions using `filterFunctions` or fuzzing the correct contract?"
     SetUpCallFailed        -> "Calling the setUp() function failed (revert, out-of-gas, sending ether to a non-payable constructor, etc.)"
-    DeploymentFailed a t   -> "Deploying the contract " ++ show a ++ " failed (revert, out-of-gas, sending ether to an non-payable constructor, etc.):\n" ++ unpack t
+    DeploymentFailed a t   -> "Deploying the contract " ++ show a ++ " failed (revert, out-of-gas, sending ether to a non-payable constructor, etc.):\n" ++ unpack t
     OutdatedSolcVersion v  -> "Solc version " ++ toString v ++ " detected. Echidna doesn't support versions of solc before " ++ toString minSupportedSolcVersion ++ ". Please use a newer version."
 
 

lib/Echidna/UI.hs

@@ -194,7 +194,7 @@ ui vm dict initialCorpus cliSelectedContract = do
 
       liftIO $ killThread ticker
 
-      -- print final status regardless the last scheduled update
+      -- print final status regardless of the last scheduled update
       liftIO printStatus
 
       when (isJust conf.campaignConf.serverPort) $ do
@@ -293,7 +293,7 @@ monitor = do
         state <- get
         let updatedState = state { campaigns = c', status = Running, now, tests }
         newWidget <- liftIO $ runReaderT (campaignStatus updatedState) env
-        -- purposedly using lazy modify here, so unnecesary widget states don't get computed
+        -- intentionally using lazy modify here, so unnecessary widget states don't get computed
         modify $ const updatedState { campaignWidget = newWidget }
       AppEvent (FetchCacheUpdated contracts slots) ->
         modify' $ \state ->

src/test/Common.hs

@@ -99,7 +99,7 @@ runContract f selectedContract cfg workerType = do
   (_stopReason, finalState) <- flip runReaderT env $
     runWorker workerType (pure ()) vm dict 0 [] cfg.campaignConf.testLimit selectedContract
 
-  -- TODO: consider snapshotting the state so checking function don't need to
+  -- TODO: consider snapshotting the state so checking functions don't need to
   -- be IO
   pure (env, finalState)
 

src/test/Tests/Dapptest.hs

@@ -13,7 +13,6 @@ dapptestTests = testGroup "Dapptest Integration Testing"
         ("testShrinking passed", solved "testShrinking"),
         ("testFuzzFixedArray passed", solved "testFuzzFixedArray"),
         ("testFuzzVariableArray passed", solved "testFuzzVariableArray"),
-        ("testFuzzVariableArray passed", solved "testFuzzVariableArray"),
         ("testFuzzBytes1 passed", solved "testFuzzBytes1"),
         ("testFuzzBytes14 passed", solved "testFuzzBytes14"),
         ("testFuzzBytes32 passed", solved "testFuzzBytes32"),