Merge pull request #1363 from crytic/lints

Fix links and typos

Author: elopez

.github/scripts/install-libff.sh

@@ -18,7 +18,7 @@ cd libff
 git checkout v0.2.1
 git submodule init && git submodule update
 
-ARGS=("-DCMAKE_INSTALL_PREFIX=$PREFIX" "-DWITH_PROCPS=OFF")
+ARGS=("-DCMAKE_INSTALL_PREFIX=$PREFIX" "-DWITH_PROCPS=OFF" "-DCMAKE_POLICY_VERSION_MINIMUM=3.5")
 CXXFLAGS=""
 if [ "$HOST_OS" = "macOS" ]; then
   OPENSSL_PREFIX=$(brew --prefix openssl)

CONTRIBUTING.md

@@ -27,7 +27,7 @@ response if you ask in our [chat room](https://slack.empirehacking.nyc/)
 
 Echidna uses the pull request contribution model. Please make an account on
 Github, fork this repo, and submit code contributions via pull request. For
-more documentation, look [here](https://guides.github.com/activities/forking/).
+more documentation, look [here](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).
 
 Some pull request guidelines:
 

README.md

@@ -4,7 +4,7 @@
 
 Echidna is a weird creature that eats bugs and is highly electrosensitive (with apologies to Jacob Stanley)
 
-More seriously, Echidna is a Haskell program designed for fuzzing/property-based testing of Ethereum smart contracts. It uses sophisticated grammar-based fuzzing campaigns based on a [contract ABI](https://solidity.readthedocs.io/en/develop/abi-spec.html) to falsify user-defined predicates or [Solidity assertions](https://solidity.readthedocs.io/en/develop/control-structures.html#id4). We designed Echidna with modularity in mind, so it can be easily extended to include new mutations or test specific contracts in specific cases.
+More seriously, Echidna is a Haskell program designed for fuzzing/property-based testing of Ethereum smart contracts. It uses sophisticated grammar-based fuzzing campaigns based on a [contract ABI](https://docs.soliditylang.org/en/develop/abi-spec.html) to falsify user-defined predicates or [Solidity assertions](https://docs.soliditylang.org/en/develop/control-structures.html#error-handling-assert-require-revert-and-exceptions). We designed Echidna with modularity in mind, so it can be easily extended to include new mutations or test specific contracts in specific cases.
 
 ## Features
 
@@ -83,9 +83,9 @@ Our tool signals each execution trace in the corpus with the following "line mar
 
 ### Support for smart contract build systems
 
-Echidna can test contracts compiled with different smart contract build systems, including [Truffle](https://truffleframework.com/) or [hardhat](https://hardhat.org/) using [crytic-compile](https://github.com/crytic/crytic-compile). To invoke echidna with the current compilation framework, use `echidna .`.
+Echidna can test contracts compiled with different smart contract build systems, including [Foundry](https://book.getfoundry.sh/), [Hardhat](https://hardhat.org/), and [Truffle](https://archive.trufflesuite.com/), using [crytic-compile](https://github.com/crytic/crytic-compile). To invoke Echidna with the current compilation framework, use `echidna .`.
 
-On top of that, Echidna supports two modes of testing complex contracts. Firstly, one can [describe an initialization procedure with Truffle and Etheno](https://github.com/crytic/building-secure-contracts/blob/master/program-analysis/echidna/end-to-end-testing.md) and use that as the base state for Echidna. Secondly, Echidna can call into any contract with a known ABI by passing in the corresponding Solidity source in the CLI. Use `allContracts: true` in your config to turn this on.
+On top of that, Echidna supports two modes of testing complex contracts. Firstly, one can [describe an initialization procedure with Truffle and Etheno](https://github.com/crytic/building-secure-contracts/blob/master/program-analysis/echidna/advanced/end-to-end-testing.md) and use that as the base state for Echidna. Secondly, Echidna can call into any contract with a known ABI by passing in the corresponding Solidity source in the CLI. Use `allContracts: true` in your config to turn this on.
 
 ### Crash course on Echidna
 
@@ -111,8 +111,8 @@ The configuration file allows users to choose EVM and test generation
 parameters. An example of a complete and annotated config file with the default
 options can be found at
 [tests/solidity/basic/default.yaml](tests/solidity/basic/default.yaml).
-More detailed documentation on the configuration options is available in our
-[wiki](https://github.com/trailofbits/echidna/wiki/Config).
+See the [documentation](https://secure-contracts.com/program-analysis/echidna/configuration.html)
+for more detailed information on the available configuration options.
 
 Echidna supports three different output drivers. There is the default `text`
 driver, a `json` driver, and a `none` driver, which should suppress all
@@ -164,7 +164,7 @@ $ less echidna.prof
 
 This produces a report file (`echidna.prof`), that shows which functions take up the most CPU and memory usage.
 
-If the basic profiling doesn't help, you can use more [advanced profiling techniques](https://input-output-hk.github.io/hs-opt-handbook.github.io/src/Measurement_Observation/Heap_Ghc/eventlog.html).
+If the basic profiling doesn't help, you can use more [advanced profiling techniques](https://haskell.foundation/hs-opt-handbook.github.io/src/Measurement_Observation/Haskell_Profiling/eventlog.html).
 
 Common causes for performance issues that we observed:
 
@@ -251,15 +251,15 @@ $ docker run -it -v `pwd`:/src echidna bash -c "solc-select install 0.5.7 && sol
 
 ### Building using Stack
 
-If you'd prefer to build from source, use [Stack](https://docs.haskellstack.org/en/stable/README/). `stack install` should build and compile `echidna` in `~/.local/bin`. You will need to link against libreadline and libsecp256k1 (built with recovery enabled), which should be installed with the package manager of your choosing. You also need to install the latest release of [libff](https://github.com/scipr-lab/libff). Refer to our [CI tests](.github/scripts/install-libff.sh) for guidance.
+If you'd prefer to build from source, use [Stack](https://docs.haskellstack.org/en/stable/). `stack install` should build and compile `echidna` in `~/.local/bin`. You will need to link against libreadline and libsecp256k1 (built with recovery enabled), which should be installed with the package manager of your choosing. You also need to install the latest release of [libff](https://github.com/scipr-lab/libff). Refer to our [CI tests](.github/scripts/install-libff.sh) for guidance.
 
 Some Linux distributions do not ship static libraries for certain things that Haskell needs, e.g. Arch Linux, which will cause `stack build` to fail with linking errors because we use the `-static` flag. In that case, use `--flag echidna:-static` to produce a dynamically linked binary.
 
 If you're getting errors building related to linking, try tinkering with `--extra-include-dirs` and `--extra-lib-dirs`.
 
 ### Building using Nix (works natively on Apple M1 systems)
 
-[Nix users](https://nixos.org/download.html) can install the latest Echidna with:
+[Nix users](https://nixos.org/download/) can install the latest Echidna with:
 
 ```sh
 $ nix-env -i -f https://github.com/crytic/echidna/tarball/master
@@ -300,14 +300,14 @@ This is a partial list of smart contracts projects that use Echidna for testing:
 * [Curvance](https://github.com/curvance/Curvance-CantinaCompetition/tree/CodeFAQAndAdjustments/tests/fuzzing)
 * [Primitive](https://github.com/primitivefinance/rmm-core/tree/main/contracts/crytic)
 * [Uniswap-v3](https://github.com/search?q=org%3AUniswap+echidna&type=commits)
-* [Balancer](https://github.com/balancer-labs/balancer-core/tree/master/echidna)
+* [Balancer](https://github.com/balancer/balancer-core/tree/master/echidna)
 * [MakerDAO vest](https://github.com/makerdao/dss-vest/pull/16)
-* [Optimism DAI Bridge](https://github.com/BellwoodStudios/optimism-dai-bridge/blob/master/contracts/test/DaiEchidnaTest.sol)
+* [Optimism DAI Bridge](https://github.com/makerdao/optimism-dai-bridge/blob/master/contracts/test/DaiEchidnaTest.sol)
 * [WETH10](https://github.com/WETH10/WETH10/tree/main/contracts/fuzzing)
 * [Yield](https://github.com/yieldprotocol/fyDai/pull/312)
 * [Convexity Protocol](https://github.com/opynfinance/ConvexityProtocol/tree/dev/contracts/echidna)
 * [Aragon Staking](https://github.com/aragon/staking/blob/82bf54a3e11ec4e50d470d66048a2dd3154f940b/packages/protocol/contracts/test/lib/EchidnaStaking.sol)
-* [Centre Token](https://github.com/centrehq/centre-tokens/tree/master/echidna_tests)
+* [Centre Token](https://github.com/circlefin/stablecoin-evm/tree/release-2024-03-15T223309/echidna_tests)
 * [Tokencard](https://github.com/tokencard/contracts/tree/master/tools/echidna)
 * [Minimalist USD Stablecoin](https://github.com/usmfum/USM/pull/41)
 
@@ -373,17 +373,17 @@ We can also use Echidna to reproduce research examples from smart contract fuzzi
 | Source | Code
 |--|--
 [Using automatic analysis tools with MakerDAO contracts](https://forum.openzeppelin.com/t/using-automatic-analysis-tools-with-makerdao-contracts/1021) | [SimpleDSChief](https://github.com/crytic/echidna/blob/master/tests/solidity/research/vera_dschief.sol)
-[Integer precision bug in Sigma Prime](https://github.com/b-mueller/sabre#example-2-integer-precision-bug) | [VerifyFunWithNumbers](https://github.com/crytic/echidna/blob/master/tests/solidity/research/solcfuzz_funwithnumbers.sol)
+[Integer precision bug in Sigma Prime](https://github.com/muellerberndt/sabre#example-2-integer-precision-bug) | [VerifyFunWithNumbers](https://github.com/crytic/echidna/blob/master/tests/solidity/research/solcfuzz_funwithnumbers.sol)
 [Learning to Fuzz from Symbolic Execution with Application to Smart Contracts](https://files.sri.inf.ethz.ch/website/papers/ccs19-ilf.pdf) | [Crowdsale](https://github.com/crytic/echidna/blob/master/tests/solidity/research/ilf_crowdsale.sol)
-[Harvey: A Greybox Fuzzer for Smart Contracts](https://arxiv.org/abs/1905.06944) | [Foo](https://github.com/crytic/echidna/blob/master/test/solidity/research/harvey_foo.sol), [Baz](https://github.com/crytic/echidna/blob/master/tests/solidity/research/harvey_baz.sol)
+[Harvey: A Greybox Fuzzer for Smart Contracts](https://arxiv.org/abs/1905.06944) | [Foo](https://github.com/crytic/echidna/blob/master/tests/solidity/research/harvey_foo.sol), [Baz](https://github.com/crytic/echidna/blob/master/tests/solidity/research/harvey_baz.sol)
 
 ### Academic Publications
 
 | Paper Title | Venue | Publication Date |
 | --- | --- | --- |
 | [echidna-parade: Diverse multicore smart contract fuzzing](https://agroce.github.io/issta21.pdf) | [ISSTA 2021](https://conf.researchr.org/home/issta-2021) | July 2021 |
 | [Echidna: Effective, usable, and fast fuzzing for smart contracts](https://agroce.github.io/issta20.pdf) | [ISSTA 2020](https://conf.researchr.org/home/issta-2020) | July 2020 |
-| [Echidna: A Practical Smart Contract Fuzzer](papers/echidna_fc_poster.pdf) | [FC 2020](https://fc20.ifca.ai/program.html) | Feb 2020 |
+| [Echidna: A Practical Smart Contract Fuzzer](https://github.com/trailofbits/publications/blob/master/papers/echidna_fc_poster.pdf) | [FC 2020](https://fc20.ifca.ai/program.html) | Feb 2020 |
 
 If you are using Echidna for academic work, consider applying to the [Crytic $10k Research Prize](https://blog.trailofbits.com/2019/11/13/announcing-the-crytic-10k-research-prize/).
 

lib/Echidna/ABI.hs

@@ -344,7 +344,7 @@ mutateAbiValue = \case
   AbiFunction v -> pure $ AbiFunction v
 
 -- | Given a 'SolCall', generate a random \"similar\" call with the same 'SolSignature'.
--- Note that this funcion will mutate a *single* argument (if any)
+-- Note that this function will mutate a *single* argument (if any)
 mutateAbiCall :: MonadRandom m => SolCall -> m SolCall
 mutateAbiCall = traverse f
   where f [] = pure []

lib/Echidna/Config.hs

@@ -32,7 +32,7 @@ instance FromJSON EConfigWithUsage where
   -- this runs the parser in a StateT monad which keeps track of the keys
   -- utilized by the config parser
   -- we can then compare the set difference between the keys found in the config
-  -- file and the keys used by the parser to comopute which keys were set in the
+  -- file and the keys used by the parser to compute which keys were set in the
   -- config and not used and which keys were unset in the config and defaulted
   parseJSON o = do
     let v' = case o of

lib/Echidna/Types/Solidity.hs

@@ -64,7 +64,7 @@ data SolConf = SolConf
   , sender          :: Set Addr         -- ^ Sender addresses to use
   , balanceAddr     :: Integer          -- ^ Initial balance of deployer and senders
   , balanceContract :: Integer          -- ^ Initial balance of contract to test
-  , codeSize        :: Integer          -- ^ Max code size for deployed contratcs (default 0xffffffff)
+  , codeSize        :: Integer          -- ^ Max code size for deployed contracts (default 0xffffffff)
   , prefix          :: Text             -- ^ Function name prefix used to denote tests
   , disableSlither  :: Bool             -- ^ Whether or not to skip running Slither
   , cryticArgs      :: [String]         -- ^ Args to pass to crytic

lib/Echidna/Types/Test.hs

@@ -34,7 +34,7 @@ data TestConf = TestConf
 -- call sequence was found.
 data TestState
   = Open
-  | Large !Int -- ^ Solved, maybe shrinable, tracking shrinks tried
+  | Large !Int -- ^ Solved, maybe shrinkable, tracking shrinks tried
   | Passed     -- ^ Presumed unsolvable
   | Solved     -- ^ Solved with no need for shrinking
   | Failed ExecException -- ^ Broke the execution environment

tests/solidity/basic/default.yaml

@@ -38,7 +38,7 @@ sender: ["0x10000", "0x20000", "0x30000"]
 balanceAddr: 0xffffffff
 #balanceContract overrides balanceAddr for the contract address
 balanceContract: 0
-#codeSize max code size for deployed contratcs (default 0xffffffff)
+#codeSize max code size for deployed contracts (default 0xffffffff)
 codeSize: 0xffffffff
 #whether or not to disable running slither (default false, uses slither)
 disableSlither: false

tests/solidity/research/solcfuzz_funwithnumbers.sol

@@ -1,4 +1,4 @@
-// Original example from https://github.com/b-mueller/sabre#example-2-integer-precision-bug
+// Original example from https://github.com/muellerberndt/sabre#example-2-integer-precision-bug
 
 contract FunWithNumbers {
     uint constant public tokensPerEth = 10;