Merge pull request #239 from 0xPhaze/fix-style

Fix inconsistent styling

Author: montyly

.github/workflows/check_links.yml

@@ -8,13 +8,13 @@ on:
   pull_request:
   schedule:
     # run CI at 09:00, on day 1 of the month even if no PRs/merges occur
-    - cron:  '0 9 1 * *'
+    - cron: "0 9 1 * *"
 
 jobs:
   markdown-link-check:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
-    - uses: gaurav-nelson/github-action-markdown-link-check@v1
-      with:
-        use-quiet-mode: 'yes'
+      - uses: actions/checkout@master
+      - uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          use-quiet-mode: "yes"

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ on:
   pull_request:
   schedule:
     # run CI every day even if no PRs/merges occur
-    - cron:  '0 12 * * *'
+    - cron: "0 12 * * *"
 
 jobs:
   tests:
@@ -20,18 +20,18 @@ jobs:
       matrix:
         type: ["slither", "manticore"]
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v4
-      with:
-        python-version: 3.8
-    - name: Install dependencies
-      run: |
-        pip install solc-select
-        solc-select install 0.5.11
-        solc-select use 0.5.11
-    - name: Run Tests
-      env:
-        TEST_TYPE: ${{ matrix.type }}
-      run: |
-        bash program-analysis/${TEST_TYPE}/scripts/gh_action_test.sh
+      - uses: actions/checkout@v3
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.8
+      - name: Install dependencies
+        run: |
+          pip install solc-select
+          solc-select install 0.5.11
+          solc-select use 0.5.11
+      - name: Run Tests
+        env:
+          TEST_TYPE: ${{ matrix.type }}
+        run: |
+          bash program-analysis/${TEST_TYPE}/scripts/gh_action_test.sh

.github/workflows/deploy.yml

@@ -15,18 +15,18 @@ jobs:
       CARGO_TERM_COLOR: always
 
     steps:
-    - uses: actions/checkout@v3
-      with:
-        fetch-depth: 0
-    - name: Install mdbook
-      run: |
-        cargo install --git https://github.com/montyly/mdBook.git mdbook || true
-    - name: Build artifacts
-      run: mdbook build
-    - name: Upload artifact
-      uses: actions/upload-pages-artifact@v1
-      with:
-        path: ./book
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Install mdbook
+        run: |
+          cargo install --git https://github.com/montyly/mdBook.git mdbook || true
+      - name: Build artifacts
+        run: mdbook build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: ./book
   deploy:
     permissions:
       pages: write
@@ -39,4 +39,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v1
+        uses: actions/deploy-pages@v1

.github/workflows/echidna.yml

@@ -12,7 +12,7 @@ on:
   pull_request:
   schedule:
     # run CI every day even if no PRs/merges occur
-    - cron:  '0 12 * * *'
+    - cron: "0 12 * * *"
 
 jobs:
   tests:
@@ -45,7 +45,7 @@ jobs:
             workdir: program-analysis/echidna/exercises/exercise4/
             files: solution.sol
             config: config.yaml
-            contract: Token
+            contract: TestToken
             outcome: failure
             expected: 'transfer(address,uint256):\s*failed'
           - name: Exercise 5
@@ -83,7 +83,7 @@ jobs:
             files: gas.sol
             config: gas.yaml
             outcome: success
-            expected: 'f(42,123,'
+            expected: "f(42,123,"
             flaky: true
           - name: Multi
             workdir: program-analysis/echidna/example/
@@ -131,59 +131,59 @@ jobs:
             expected: 'test_flag_is_false():\s*failed'
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3
 
-    - name: Checkout Damn Vulnerable DeFi solutions
-      uses: actions/checkout@v3
-      if: startsWith(matrix.workdir, 'dvdefi')
-      with:
-        repository: crytic/damn-vulnerable-defi-echidna
-        ref: solutions
-        path: ${{ matrix.workdir }}
+      - name: Checkout Damn Vulnerable DeFi solutions
+        uses: actions/checkout@v3
+        if: startsWith(matrix.workdir, 'dvdefi')
+        with:
+          repository: crytic/damn-vulnerable-defi-echidna
+          ref: solutions
+          path: ${{ matrix.workdir }}
 
-    - name: Set up Nodejs
-      uses: actions/setup-node@v3
-      if: startsWith(matrix.workdir, 'dvdefi')
-      with:
-        node-version: 16
+      - name: Set up Nodejs
+        uses: actions/setup-node@v3
+        if: startsWith(matrix.workdir, 'dvdefi')
+        with:
+          node-version: 16
 
-    - name: Install dependencies and compile
-      if: startsWith(matrix.workdir, 'dvdefi')
-      run: |
-        yarn install --frozen-lockfile
-        npx hardhat compile --force
-      working-directory: ${{ matrix.workdir }}
+      - name: Install dependencies and compile
+        if: startsWith(matrix.workdir, 'dvdefi')
+        run: |
+          yarn install --frozen-lockfile
+          npx hardhat compile --force
+        working-directory: ${{ matrix.workdir }}
 
-    - name: Run Echidna
-      uses: crytic/echidna-action@v2
-      id: echidna
-      continue-on-error: true
-      with:
-        files: ${{ matrix.files }}
-        contract: ${{ matrix.contract }}
-        config: ${{ matrix.config }}
-        output-file: ${{ matrix.files }}.out
-        solc-version: ${{ matrix.solc-version || '0.5.11' }}
-        echidna-workdir: ${{ matrix.workdir }}
-        echidna-version: edge
-        crytic-args: ${{ matrix.crytic-args || '' }}
+      - name: Run Echidna
+        uses: crytic/echidna-action@v2
+        id: echidna
+        continue-on-error: true
+        with:
+          files: ${{ matrix.files }}
+          contract: ${{ matrix.contract }}
+          config: ${{ matrix.config }}
+          output-file: ${{ matrix.files }}.out
+          solc-version: ${{ matrix.solc-version || '0.5.11' }}
+          echidna-workdir: ${{ matrix.workdir }}
+          echidna-version: edge
+          crytic-args: ${{ matrix.crytic-args || '' }}
 
-    - name: Verify that the exit code is correct
-      run: |
-        if [[ ${{ steps.echidna.outcome }} = ${{ matrix.outcome }} ]]; then
-          echo "Outcome matches"
-        else
-          echo "Outcome mismatch. Expected ${{ matrix.outcome }} but got ${{ steps.echidna.outcome }}"
-          exit 1
-        fi
+      - name: Verify that the exit code is correct
+        run: |
+          if [[ ${{ steps.echidna.outcome }} = ${{ matrix.outcome }} ]]; then
+            echo "Outcome matches"
+          else
+            echo "Outcome mismatch. Expected ${{ matrix.outcome }} but got ${{ steps.echidna.outcome }}"
+            exit 1
+          fi
 
-    - name: Verify that the output is correct
-      run: |
-        if grep -q "${{ matrix.expected }}" "${{ steps.echidna.outputs.output-file }}"; then
-          echo "Output matches"
-        else
-          echo "Output mismatch. Expected something matching '${{ matrix.expected }}'. Got the following:"
-          cat "${{ steps.echidna.outputs.output-file }}"
-          exit 1
-        fi
+      - name: Verify that the output is correct
+        run: |
+          if grep -q "${{ matrix.expected }}" "${{ steps.echidna.outputs.output-file }}"; then
+            echo "Output matches"
+          else
+            echo "Output mismatch. Expected something matching '${{ matrix.expected }}'. Got the following:"
+            cat "${{ steps.echidna.outputs.output-file }}"
+            exit 1
+          fi

.prettierrc

@@ -0,0 +1,11 @@
+{
+  "tabWidth": 2,
+  "printWidth": 80,
+  "embeddedLanguageFormatting": "off",
+  "plugins": ["prettier-plugin-solidity"],
+  "overrides":
+    [
+      { "files": "*.sol", "options": { "tabWidth": 4, "printWidth": 120 } },
+      { "files": ["*.json", ".prettierrc"], "options": { "tabWidth": 2, "printWidth": 120, "trailingComma": "none" } }
+    ]
+}

CONTRIBUTING.md

@@ -1,15 +1,19 @@
 # Contributing to Building-secure-contracts
+
 First, thanks for your interest in contributing to Building-secure-contracts! We welcome and appreciate all contributions, including bug reports, feature suggestions, tutorials/blog posts, and code improvements.
 
 If you're unsure where to start, we recommend our [`good first issue`](https://github.com/crytic/building-secure-contracts/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and [`help wanted`](https://github.com/crytic/building-secure-contracts/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) issue labels.
 
 ## Bug reports and feature suggestions
+
 Bug reports and feature suggestions can be submitted to our issue tracker. For bug reports, attaching the contract that caused the bug will help us in debugging and resolving the issue quickly. If you find a security vulnerability, do not open an issue; email opensource@trailofbits.com instead.
 
 ## 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).
 
 ## Code
+
 building-secure-contracts 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/).
 
 Some pull request guidelines:
@@ -22,6 +26,7 @@ Some pull request guidelines:
 ## Directory Structure
 
 Below is a rough outline of building-secure-contracts's structure:
+
 ```text
 .
 ├── development-guidelnes # High-level best-practices for all smart contracts
@@ -32,30 +37,35 @@ Below is a rough outline of building-secure-contracts's structure:
 └── ...
 ```
 
-## Linters
+## Linting and formatting
 
-We run [markdown-link-check](https://github.com/tcort/markdown-link-check) to ensure all the markdown links are correct. 
+To install the formatters and linters, run:
 
-To install `markdown-link-check`:
 ```bash
-$ npm install -g markdown-link-check
+npm install
 ```
 
-To run `markdown-link-check`:
+The formatter is run with:
 
 ```bash
-$ find . -name \*.md -print0 | xargs -0 -n1 markdown-link-check
+npm run format
+```
+
+The linter is run with:
+
+```bash
+npm run lint
 ```
 
 ## Create the book
 
 We use `mdbook` to generate [secure-contracts.com](https://secure-contracts.com/).
 
 To run it locally:
+
 ```
-$ cargo install --git https://github.com/montyly/mdBook.git mdbook
-$ mdbook build
+cargo install --git https://github.com/montyly/mdBook.git mdbook
+mdbook build
 ```
 
-
 Note: we use https://github.com/montyly/mdBook.git, which contains https://github.com/rust-lang/mdBook/pull/1584.

README.md

@@ -18,15 +18,15 @@ We welcome contributions, and you can contribute by following our [contributing
   - [Transaction Tracing](./learn_evm/tracing.md): Helper scripts and guidance for generating and navigating transaction traces
   - [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)*
-    - [Upgrades <> TIPs](./learn_evm/tips_upgrades.md): Summarize the TIPs included in each TRON upgrade *(EVM-compatible chain)*
-    - [Forks <> BEPs](./learn_evm/beps_forks.md): Summarize the BEPs included in each BSC fork *(EVM-compatible chain)*
+    - [Forks <> CIPs](./learn_evm/cips_forks.md): Summarize the CIPs and EIPs included in each Celo fork _(EVM-compatible chain)_
+    - [Upgrades <> TIPs](./learn_evm/tips_upgrades.md): Summarize the TIPs included in each TRON upgrade _(EVM-compatible chain)_
+    - [Forks <> BEPs](./learn_evm/beps_forks.md): Summarize the BEPs included in each BSC fork _(EVM-compatible chain)_
 - [Not so smart contracts](./not-so-smart-contracts): Examples of smart contract common issues. Each issue contains a description, an example and recommendations
-   - [Algorand](./not-so-smart-contracts/algorand)
-   - [Cairo](./not-so-smart-contracts/cairo)
-   - [Cosmos](./not-so-smart-contracts/cosmos)
-   - [Substrate](./not-so-smart-contracts/substrate)
-   - [Solana](./not-so-smart-contracts/solana)
+  - [Algorand](./not-so-smart-contracts/algorand)
+  - [Cairo](./not-so-smart-contracts/cairo)
+  - [Cosmos](./not-so-smart-contracts/cosmos)
+  - [Substrate](./not-so-smart-contracts/substrate)
+  - [Solana](./not-so-smart-contracts/solana)
 - [Program analysis](./program-analysis): How to use automated tools to secure contracts
   - [Echidna](./program-analysis/echidna): a fuzzer that will check your contract's properties.
   - [Slither](./program-analysis/slither): a static analyzer available through a CLI and scriptable interface.
@@ -35,8 +35,8 @@ We welcome contributions, and you can contribute by following our [contributing
     - a theoretical introduction, a walkthrough of its API, and a set of exercises.
     - exercises expected to require ~two hours to practically learn its operation.
 - [Resources](./resources): Various online resources
-   - [Trail of Bits blogposts](./resources/tob_blogposts.md): List of blockchain related blogposts made by Trail of Bits
-
+  - [Trail of Bits blogposts](./resources/tob_blogposts.md): List of blockchain related blogposts made by Trail of Bits
 
 # License
-secure-contracts and building-secure-contracts are licensed and distributed under the [AGPLv3 license](https://github.com/crytic/building-secure-contracts/blob/master/LICENSE). Contact us if you're looking for an exception to the terms.
+
+secure-contracts and building-secure-contracts are licensed and distributed under the [AGPLv3 license](https://github.com/crytic/building-secure-contracts/blob/master/LICENSE). Contact us if you're looking for an exception to the terms.