forge-guard 0.3.6

Pre-deployment smart contract auditing framework for Foundry
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
# ROLE


You are a Principal Smart Contract Security Engineer, Principal Rust Engineer, Principal Foundry Contributor, and Senior Blockchain Architect.Your task is to design and implement a production-ready, open-source MIT licensed Foundry extension named `forge-guard`.

The goal is NOT to build another static analyzer. The goal is to build the most comprehensive pre-deployment smart contract auditing framework for Foundry.

The project must be production-ready, extensible, modular, highly performant, and designed to become the standard security layer for Foundry.

---

# PROJECT GOALS


The framework must:

* perform comprehensive offline security auditinfg
* prevent unsafe deployments
* support multi-chain functionality
* support plugin-based architectures
* support future AI integrations
* support CI/CD pipelines
* support exploit simulations
* support fuzzing
* support invariant testing
* support deterministic deployment analysis
* support proxy analysis
* support bytecode analysis
* support AST analysis
* support gas analysis
* support dependency analysis
* support deployment simulations

The framework must support:

```text
Ethereum
Base
Arbitrum
Optimism
Polygon
BNB
Avalanche
Scroll
Linea
Unichain
ZKSync
HyperEVM
Monad
Sonic
Blast
Mantle
Robinhood

future support:

Solana
Tron
Sui
Aptos
```

The architecture MUST use:

```text
EVM Core

↓

Plugin Architecture

↓

Chain Plugins

↓

Security Engine

↓

Deployment Guard

↓

Report Engine

↓

Foundry Integration

↓

Future AI Layer
```

---

# LICENSE


Use:

```text
MIT
```

The entire project must be:

```text
100% Open Source
```

---

# MINIMUM REQUIREMENTS


Only support:

```text
Solidity >=0.8.20
```

Do NOT support legacy Solidity versions.

---

# TECH STACK


Use:

```text
Rust
```

for:

```text
security engine

AST analysis

bytecode analysis

dependency analysis

deployment guard

plugin system

report generation

CI integrations

multi-chain support
```

Use:

```text
Foundry
```

for:

```text
tests

fuzzing

invariants

deployment simulation

scripts
```

Use:

```text
Solc
```

for:

```text
AST generation

IR generation

YUL analysis
```

Use:

```text
LLVM

where useful.
```

Use:

```text
SQLite
```

for:

```text
caching

local databases

vulnerability indexes
```

---

# COMMANDS


Implement:

```bash
forge audit

forge deploy

forge deploy-safe

forge fuzz

forge invariant

forge simulate

forge gas

forge report

forge verify

forge doctor

forge watch

forge ci

forge benchmark

forge scan

forge upgrade-check

forge plugins

forge chain

forge security
```

Examples:

```bash
forge audit

forge audit --full

forge audit --chain ethereum

forge audit --chain base

forge audit --chain arbitrum

forge audit --chain solana

forge audit --json

forge audit --markdown

forge audit --exploit

forge audit --gas

forge audit --offline

forge audit --strict

forge audit --production

forge audit --report
```

---

# DEPLOYMENT GUARD


Unsafe deployments MUST be blocked by default.

Example:

```bash
forge deploy
```

must automatically execute:

```text
Compilation

↓

Tests

↓

Security Audit

↓

Fuzzing

↓

Invariant Testing

↓

Dependency Analysis

↓

Gas Analysis

↓

Proxy Analysis

↓

CREATE2 Analysis

↓

Deployment Simulation

↓

Security Score

↓

Risk Analysis

↓

PASS ?

↓

YES

↓

DEPLOY

or

NO

↓

BLOCK DEPLOYMENT
```

Users may bypass deployment protection using:

```bash
forge deploy --force
```

Warnings MUST still be displayed.

---

# SECURITY ENGINE


Implement:

```text
HIGH

Reentrancy

Access Control

Delegatecall

tx.origin

CREATE2

DOS

Storage Collision

Unsafe Assembly

Selfdestruct

Proxy Vulnerabilities

Upgradeability Issues

Oracle Manipulation

Signature Vulnerabilities

Replay Attacks

ERC20 Issues

ERC721 Issues

ERC1155 Issues

ERC4626 Issues

ERC6909 Issues

ERC4337 Issues

EIP7702 Issues

Bridge Vulnerabilities

DEX Vulnerabilities

Staking Vulnerabilities

DAO Vulnerabilities

Flash Loan Issues

Liquidity Issues

MEV Issues

Sandwich Vulnerabilities

Frontrunning

Cross Chain Issues

Dependency Vulnerabilities

Unsafe Imports

Unsafe Ownership Transfers

Unsafe Initializers

Unsafe Upgrade Paths

CREATE Vulnerabilities

Clone Vulnerabilities

Minimal Proxy Issues

Beacon Proxy Issues

Transparent Proxy Issues

UUPS Issues
```

Implement:

```text
MEDIUM

Gas Problems

Unsafe Casting

Timestamp Manipulation

Poor Access Patterns

Storage Inefficiencies

Unsafe Events

Poor Visibility Definitions

Bad Modifiers

Unsafe Math Patterns
```

Implement:

```text
LOW

Naming Issues

Code Duplication

Optimization Suggestions

Architecture Suggestions

Best Practices Recommendations
```

Implement:

```text
INFORMATIONAL

Style

Readability

Architecture

Documentation

Developer Experience Suggestions
```

---

# SUPPORTED STANDARDS


Implement dedicated auditors for:

```text
ERC20

ERC721

ERC1155

ERC4626

ERC6909

ERC4337

EIP7702

CREATE2

UUPS

Transparent Proxy

Beacon Proxy

Minimal Proxy

Bridges

DEXes

DAOs

Vaults

Multisigs

Factories

Launchpads

Token Creators

Staking Protocols

Lending Protocols

AMMs

Yield Protocols
```

---

# EXPLOIT ENGINE


The framework must generate:

```text
possible exploit paths

possible attack vectors

unsafe code paths

unsafe storage paths

unsafe upgrades

unsafe deployments
```

Generate:

```text
proof of concept attacks

where possible.
```

Example:

```text
HIGH

Delegatecall vulnerability found.


Attack Path:

↓

Attacker calls:

↓

execute()

↓

delegatecall()

↓

ownership overwritten

↓

funds stolen


Severity:

HIGH


Recommended Fix:

↓

use access control modifier


Production Ready:

NO
```

---

# SECURITY SCORE


Generate:

```text
100/100
```

Categories:

```text
Access Control

Security

Fuzzing

Gas

Architecture

Upgradeability

Dependencies

Deployment

Proxy Safety

Chain Compatibility

Production Readiness

Exploit Resistance
```

Example:

```text
Security Score:

97/100

--------------------

Risk Level:

LOW

--------------------

Production Ready:

YES

--------------------

Deployment:

APPROVED
```

---

# REPORT ENGINE


Support:

```text
JSON

Markdown
```

Reports MUST include:

```text
vulnerabilities

risk score

security score

gas score

exploit demonstrations

proof of concept attacks

recommendations

unsafe patterns

deployment analysis

proxy analysis

chain analysis

dependency analysis

production readiness
```

Generate:

```text
audit.json

audit.md
```

---

# MULTI-CHAIN SUPPORT


Architecture:

```text
EVM CORE

↓

plugins/

↓

ethereum/

base/

arbitrum/

optimism/

polygon/

bnb/

avalanche/

scroll/

linea/

unichain/

zksync/

monad/

hyperliquid/

solana/

tron/

sui/

aptos/
```

Examples:

```bash
forge audit --chain ethereum

forge audit --chain base

forge audit --chain arbitrum

forge audit --chain polygon

forge audit --chain solana

forge audit --all-chains
```

Implement:

```text
chain specific analyzers

chain specific deployment analysis

gas estimations

supported standards

RPC validations

deployment validations
```

---

# DOCTOR COMMAND


Implement:

```bash
forge doctor
```

Analyze:

```text
Foundry versions

Solidity versions

unsafe dependencies

RPC configurations

proxy configurations

deployment scripts

compiler settings

optimizer settings

gas settings

project structure

security configurations
```

---

# CI/CD


Support:

```text
Github Actions

Gitlab

Bitbucket

Azure DevOps
```

Example:

```yaml
forge audit

forge fuzz

forge invariant

forge security

forge deploy
```

Deployment MUST fail if:

```text
critical vulnerabilities exist.
```

---

# PROJECT STRUCTURE


```textforge-guard/


core/

security/

plugins/

chains/

reports/

deployment/

gas/

fuzzing/

invariants/

simulation/

dependencies/

doctor/

verify/

benchmark/

ci/

utils/

examples/

tests/

docs/
```

Implement:

```text
100% test coverage

integration tests

performance benchmarks

security tests

fuzz tests

invariant tests
```

---

# FUTURE AI SUPPORT


Do NOT implement AI mode now.

However, design extension points for:

```text
GPT

Claude

Gemini

Open Source Models

Ollama

Local Models
```

Future agents:

```text
Security Auditor

↓

Gas Auditor

↓

Logic Auditor

↓

Bridge Auditor

↓

Upgradeability Auditor

↓

DeFi Auditor

↓

Lead Security Engineer

↓

Consensus Engine

↓

Final Audit Report
```

The architecture MUST support adding these agents without breaking backward compatibility.

---

# PERFORMANCE REQUIREMENTS


The framework must:

```text
use Rust for performance

use caching

support parallel execution

support incremental analysis

support large codebases

minimize memory consumption

support enterprise projects
```

---

# IMPLEMENTATION REQUIREMENTS


The implementation MUST include:

1. Complete Rust source code.
2. Complete Foundry integrations.
3. Complete plugin architecture.
4. Complete deployment guard implementation.
5. Complete security engine.
6. Complete report generation.
7. Complete CI integrations.
8. Complete exploit analysis engine.
9. Complete documentation.
10. Comprehensive tests.
11. Multi-chain support.
12. Future AI extension points.
13. Production-ready code only.
14. No placeholders or TODO implementations.
15. Security-first design decisions throughout the entire codebase.

The primary objective of this project is to make `forge-guard deploy` safe by default by transforming security auditing from an optional step into a mandatory pre-deployment process while providing developers with the most comprehensive offline smart contract auditing framework available for Foundry.