Skip to content

Commit 4f9e10c

Browse files
committed
Merge branch 'GPT-root' of github.com:crytic/building-secure-contracts into GPT-root
2 parents 5526482 + aa6302c commit 4f9e10c

File tree

4 files changed

+111
-24
lines changed

4 files changed

+111
-24
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ Here's a basic overview of Building-Secure-Contracts' structure:
2929

3030
```text
3131
.
32-
├── development-guidelnes # High-level best practices for all smart contracts
32+
├── development-guidelines # High-level best practices for all smart contracts
3333
├── learn_evm # EVM technical knowledge
3434
├── not-so-smart-contracts # Examples of common smart contract issues, including descriptions, examples, and recommendations
35-
├── program-analysis # How to utilize automated tools for securing contracts
35+
├── program-analysis # How to utilize automated tools to secure contracts
3636
├── resources # Various online resources
3737
└── ...
3838
```

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
![](https://github.com/crytic/building-secure-contracts/workflows/CI/badge.svg) ![](https://github.com/crytic/building-secure-contracts/workflows/Echidna/badge.svg)
44

5-
Brought to you by [Trail of Bits](https://www.trailofbits.com/), this repository offers guidelines and best practices for developing secure smart contracts. Contributions are welcome, so please participate by adhering to our [contributing guidelines](https://github.com/crytic/building-secure-contracts/blob/master/CONTRIBUTING.md).
5+
Brought to you by [Trail of Bits](https://www.trailofbits.com/), this repository offers guidelines and best practices for developing secure smart contracts. Contributions are welcome, you can contribute by following our [contributing guidelines](https://github.com/crytic/building-secure-contracts/blob/master/CONTRIBUTING.md).
66

77
**Table of Contents:**
88

99
- [Development Guidelines](./development-guidelines)
10-
- [High-Level Best Practices](./development-guidelines/guidelines.md): Essential practices for all smart contracts
11-
- [Incident Response Recommendations](./development-guidelines/incident_response.md): Advice for creating an incident response plan
10+
- [High-Level Best Practices](./development-guidelines/guidelines.md): Best practices for all smart contracts
11+
- [Incident Response Recommendations](./development-guidelines/incident_response.md): Guidelines for creating an incident response plan
1212
- [Secure Development Workflow](./development-guidelines/workflow.md): A high-level process to follow during code development
1313
- [Token Integration Checklist](./development-guidelines/token_integration.md): What to check when interacting with arbitrary tokens
14-
- [Learn EVM](./learn_evm): Technical knowledge about EVM
14+
- [Learn EVM](./learn_evm): Technical knowledge about the EVM
1515
- [EVM Opcodes](./learn_evm/evm_opcodes.md): Information on all EVM opcodes
1616
- [Transaction Tracing](./learn_evm/tracing.md): Helper scripts and guidance for generating and navigating transaction traces
1717
- [Arithmetic Checks](./learn_evm/arithmetic-checks.md): A guide to performing arithmetic checks in the EVM
@@ -29,13 +29,13 @@ Brought to you by [Trail of Bits](https://www.trailofbits.com/), this repository
2929
- [Program Analysis](./program-analysis): Using automated tools to secure contracts
3030
- [Echidna](./program-analysis/echidna): A fuzzer that checks your contract's properties
3131
- [Slither](./program-analysis/slither): A static analyzer with both CLI and scriptable interfaces
32-
- [Manticore](./program-analysis/manticore): A symbolic execution engine that proves correctness properties
33-
- Each tool comes with:
32+
- [Manticore](./program-analysis/manticore): A symbolic execution engine that proves the correctness of properties
33+
- For each tool, this training material provides:
3434
- A theoretical introduction, an API walkthrough, and a set of exercises
3535
- Exercises that take approximately two hours to gain practical understanding
3636
- [Resources](./resources): Assorted online resources
3737
- [Trail of Bits Blog Posts](./resources/tob_blogposts.md): A list of blockchain-related blog posts created by Trail of Bits
3838

3939
# License
4040

41-
Secure-contracts and building-secure-contracts are licensed and distributed under the [AGPLv3 license](https://github.com/crytic/building-secure-contracts/blob/master/LICENSE). Please contact us if you require an exception to the terms.
41+
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.

SUMMARY.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212
- [Transaction Tracing](./learn_evm/tracing.md)
1313
- [Arithmetic Checks](./learn_evm/arithmetic-checks.md)
1414
- [Yellow Paper Guidance](./learn_evm/yellow-paper.md):
15-
- [Forks and EIPs](./learn_evm/eips_forks.md)
16-
- [Forks and CIPs](./learn_evm/cips_forks.md)
17-
- [Upgrades and TIPs](./learn_evm/tips_upgrades.md)
18-
- [Forks and BEPs](./learn_evm/beps_forks.md)
19-
- [Not So Smart Contracts](./not-so-smart-contracts/README.md)
15+
- [Forks <> EIPs](./learn_evm/eips_forks.md)
16+
- [Forks <> CIPs](./learn_evm/cips_forks.md)
17+
- [Upgrades <> TIPs](./learn_evm/tips_upgrades.md)
18+
- [Forks <> BEPs](./learn_evm/beps_forks.md)
19+
- [Not so smart contracts](./not-so-smart-contracts/README.md)
2020
- [Algorand](./not-so-smart-contracts/algorand/README.md)
2121
- [Rekeying](./not-so-smart-contracts/algorand/rekeying/README.md)
2222
- [Unchecked Transaction Fees](./not-so-smart-contracts/algorand/unchecked_transaction_fee/README.md)
@@ -83,7 +83,9 @@
8383
- [How to test bytecode-only contracts](./program-analysis/echidna/advanced/testing-bytecode.md)
8484
- [How to use hevm cheats to test permit](./program-analysis/echidna/advanced/hevm-cheats-to-test-permit.md)
8585
- [How to seed Echidna with unit tests](./program-analysis/echidna/advanced/end-to-end-testing.md)
86-
- [Understanding and using `multi-abi`](./program-analysis/echidna/advanced/using-multi-abi.md)
86+
- [Understanding and using `allContracts`](./program-analysis/echidna/advanced/using-all-contracts.md)
87+
- [How to fuzz contracts with external libraries](./program-analysis/echidna/advanced/working-with-libraries.md)
88+
- [Interacting with off-chain data via FFI cheatcode](./program-analysis/echidna/advanced/interacting-with-offchain-data-via-ffi.md)
8789
- [Fuzzing tips](./program-analysis/echidna/fuzzing_tips.md)
8890
- [Frequently Asked Questions](./program-analysis/echidna/frequently_asked_questions.md)
8991
- [Exercises](./program-analysis/echidna/exercises/README.md)
@@ -96,10 +98,10 @@
9698
- [Exercise 7](./program-analysis/echidna/exercises/Exercise-7.md)
9799
- [Exercise 8](./program-analysis/echidna/exercises/Exercise-8.md)
98100
- [Manticore](./program-analysis/manticore/README.md)
99-
- [Introduction to Symbolic Execution](./program-analysis/manticore/symbolic-execution-introduction.md):
100-
- [Running with Manticore](./program-analysis/manticore/running_under_manticore.md)
101-
- [Finding Throwing Paths](./program-analysis/manticore/getting_throwing_paths.md)
102-
- [Adding Constraints](./program-analysis/manticore/adding_constraints.md)
101+
- [Introduction to symbolic execution](./program-analysis/manticore/symbolic-execution-introduction.md):
102+
- [Running under Manticore](./program-analysis/manticore/running-under-manticore.md)
103+
- [Getting throwing paths](./program-analysis/manticore/getting-throwing-paths.md)
104+
- [Adding constraints](./program-analysis/manticore/adding-constraints.md)
103105
- [Exercises](./program-analysis/manticore/exercises/README.md)
104106
- [Example](./program-analysis/manticore/exercises/example.md)
105107
- [Exercise 1](./program-analysis/manticore/exercises/exercise1.md)

0 commit comments

Comments
 (0)