Merge branch 'master' into dev-ffi-cheatcode

Author: montyly

.github/workflows/deploy.yml

@@ -28,7 +28,7 @@ jobs:
       - name: Build artifacts
         run: mdbook build
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v2
         with:
           path: ./book
   deploy:

.github/workflows/echidna.yml

@@ -115,15 +115,15 @@ jobs:
             config: Popsicle.yaml
             contract: PopsicleFixed
             outcome: success
-            expected: 'totalBalanceAfterTransferIsPreserved(address,uint256):\s*passed'
+            expected: 'totalBalanceAfterTransferIsPreserved(address,uint256):\s*passing'
           - name: TestDepositWithPermit
             workdir: program-analysis/echidna/example/
             files: TestDepositWithPermit.sol
             solc-version: 0.8.0
             config: testdeposit.yaml
             contract: TestDepositWithPermit
             outcome: success
-            expected: 'testERC20PermitDeposit(uint256):\s*passed'
+            expected: 'testERC20PermitDeposit(uint256):\s*passing'
           - name: MultiABI
             workdir: program-analysis/echidna/example/
             files: multiabi.sol

.github/workflows/lint_links.yml

@@ -12,14 +12,15 @@ on:
       - ".github/workflows/lint_links.yml"
       - "**.md"
   schedule:
-    # run CI at 09:00, on day 1 of the month even if no PRs/merges occur
-    - cron: "0 9 1 * *"
+    # run CI at 09:00 every Tuesday even if no PRs/merges occur
+    - cron: "0 9 * * 2"
 
 jobs:
   markdown-link-check:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v3
       - uses: gaurav-nelson/github-action-markdown-link-check@v1
         with:
           use-quiet-mode: "yes"
+          check-modified-files-only: ${{ (github.event_name == 'pull_request' && 'yes') || 'no' }}

.gitignore

@@ -1 +1,2 @@
 .DS_Store
+node_modules

CONTRIBUTING.md

@@ -10,7 +10,7 @@ Bug reports and feature suggestions can be submitted to our issue tracker. For b
 
 ## Questions
 
-Questions can be submitted to the issue tracker, but you may get a faster response if you ask in our [chat room](https://empireslacking.herokuapp.com/) (in the #ethereum channel).
+Questions can be submitted to the issue tracker, but you may get a faster response if you ask in our [chat room](https://slack.empirehacking.nyc/) (in the #ethereum channel).
 
 ## Code
 

README.md

@@ -16,6 +16,7 @@ We welcome contributions, and you can contribute by following our [contributing
 - [Learn EVM](./learn_evm): EVM technical knowledge
   - [EVM Opcodes](./learn_evm/evm_opcodes.md): Details on all EVM opcodes
   - [Transaction Tracing](./learn_evm/tracing.md): Helper scripts and guidance for generating and navigating transaction traces
+  - [Arithmetic Checks](./learn_evm/arithmetic-checks.md): A guide to performing arithmetic checks in the EVM
   - [Yellow Paper Guidance](./learn_evm/yellow-paper.md): Symbol reference for more easily reading the Ethereum yellow paper
   - [Forks <> EIPs](./learn_evm/eips_forks.md): Summarize the EIPs included in each Ethereum fork
     - [Forks <> CIPs](./learn_evm/cips_forks.md): Summarize the CIPs and EIPs included in each Celo fork _(EVM-compatible chain)_

SUMMARY.md

@@ -10,6 +10,7 @@
 - [Learn EVM](./learn_evm/README.md)
   - [EVM Opcode Reference](./learn_evm/evm_opcodes.md)
   - [Transaction Tracing](./learn_evm/tracing.md)
+  - [Arithmetic Checks](./learn_evm/arithmetic-checks.md)
   - [Yellow Paper Guidance](./learn_evm/yellow-paper.md):
     - [Forks <> EIPs](./learn_evm/eips_forks.md)
     - [Forks <> CIPs](./learn_evm/cips_forks.md)
@@ -79,6 +80,7 @@
       - [How to test bytecode-only contracts](./program-analysis/echidna/advanced/testing-bytecode.md)
       - [How to use hevm cheats to test permit](./program-analysis/echidna/advanced/hevm-cheats-to-test-permit.md)
       - [How to seed Echidna with unit tests](./program-analysis/echidna/advanced/end-to-end-testing.md)
+      - [How to fuzz contracts with external libraries](./program-analysis/echidna/advanced/working-with-libraries.md)
       - [Understanding and using `multi-abi`](./program-analysis/echidna/advanced/using-multi-abi.md)
       - [Interacting with off-chain data via FFI cheatcode](./program-analysis/echidna/advanced/interacting-with-offchain-data-via-ffi.md)
     - [Fuzzing tips](./program-analysis/echidna/fuzzing_tips.md)

book

@@ -15,6 +15,7 @@ no-section-label = true
 additional-css = ["static/custom.css"]
 additional-js = ["static/script.js"]
 default-theme = "light"
+mathjax-support = true
 
 [output.html.fold]
 enable = true

book.toml

@@ -1,6 +1,6 @@
-List of smart contract development best practices
+List of Best Practices for Smart Contract Development
 
-- [High-level best practices](./guidelines.md): High-level best-practices for all smart contracts
-- [Token integration checklist](./token_integration.md): What to check when interacting with arbitrary tokens
-- [Incident Response Recommendations](./incident_response.md): Guidelines on how to formulate an incident response plan
-- [Secure development workflow](./workflow.md): A rough, high-level process to follow while you write code
+- [High-Level Best Practices](./guidelines.md): Essential high-level best practices for all smart contracts
+- [Token Integration Checklist](./token_integration.md): Important aspects to consider when interacting with various tokens
+- [Incident Response Recommendations](./incident_response.md): Guidelines on establishing an effective incident response plan
+- [Secure Development Workflow](./workflow.md): A recommended high-level process to adhere to while writing code