@hivehub/rulebook 4.2.2 → 4.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (340) hide show
  1. package/.claude/commands/continue.md +33 -33
  2. package/.claude/commands/ralph-config.md +112 -112
  3. package/.claude/commands/ralph-history.md +110 -110
  4. package/.claude/commands/ralph-init.md +72 -72
  5. package/.claude/commands/ralph-pause-resume.md +105 -105
  6. package/.claude/commands/ralph-run.md +101 -101
  7. package/.claude/commands/ralph-status.md +76 -76
  8. package/.claude/commands/rulebook-memory-save.md +48 -48
  9. package/.claude/commands/rulebook-memory-search.md +47 -47
  10. package/.claude/commands/rulebook-task-apply.md +67 -67
  11. package/.claude/commands/rulebook-task-archive.md +70 -70
  12. package/.claude/commands/rulebook-task-create.md +93 -93
  13. package/.claude/commands/rulebook-task-list.md +42 -42
  14. package/.claude/commands/rulebook-task-show.md +52 -52
  15. package/.claude/commands/rulebook-task-validate.md +53 -53
  16. package/.claude-plugin/marketplace.json +28 -28
  17. package/.claude-plugin/plugin.json +8 -8
  18. package/README.md +15 -1
  19. package/dist/cli/commands.d.ts.map +1 -1
  20. package/dist/cli/commands.js +43 -18
  21. package/dist/cli/commands.js.map +1 -1
  22. package/dist/core/claude-mcp.d.ts +10 -2
  23. package/dist/core/claude-mcp.d.ts.map +1 -1
  24. package/dist/core/claude-mcp.js +48 -9
  25. package/dist/core/claude-mcp.js.map +1 -1
  26. package/dist/core/config-manager.d.ts.map +1 -1
  27. package/dist/core/config-manager.js +1 -2
  28. package/dist/core/config-manager.js.map +1 -1
  29. package/dist/core/generator.d.ts +13 -0
  30. package/dist/core/generator.d.ts.map +1 -1
  31. package/dist/core/generator.js +283 -28
  32. package/dist/core/generator.js.map +1 -1
  33. package/dist/core/indexer/background-indexer.d.ts.map +1 -1
  34. package/dist/core/indexer/background-indexer.js +10 -3
  35. package/dist/core/indexer/background-indexer.js.map +1 -1
  36. package/dist/core/workspace/workspace-manager.d.ts.map +1 -1
  37. package/dist/core/workspace/workspace-manager.js +2 -6
  38. package/dist/core/workspace/workspace-manager.js.map +1 -1
  39. package/dist/index.js +1 -3
  40. package/dist/index.js.map +1 -1
  41. package/dist/mcp/rulebook-server.d.ts.map +1 -1
  42. package/dist/mcp/rulebook-server.js +23 -10
  43. package/dist/mcp/rulebook-server.js.map +1 -1
  44. package/package.json +21 -22
  45. package/templates/agents/accessibility-reviewer.md +43 -0
  46. package/templates/agents/api-designer.md +42 -0
  47. package/templates/agents/architect.md +51 -0
  48. package/templates/agents/build-engineer.md +36 -0
  49. package/templates/agents/code-reviewer.md +47 -0
  50. package/templates/agents/database-architect.md +41 -0
  51. package/templates/agents/devops-engineer.md +42 -0
  52. package/templates/agents/docs-writer.md +38 -0
  53. package/templates/agents/i18n-engineer.md +42 -0
  54. package/templates/agents/implementer.md +38 -35
  55. package/templates/agents/migration-engineer.md +42 -0
  56. package/templates/agents/performance-engineer.md +49 -0
  57. package/templates/agents/refactoring-agent.md +41 -0
  58. package/templates/agents/researcher.md +38 -34
  59. package/templates/agents/security-reviewer.md +40 -0
  60. package/templates/agents/team-lead.md +37 -34
  61. package/templates/agents/tester.md +45 -42
  62. package/templates/agents/ux-reviewer.md +43 -0
  63. package/templates/ci/rulebook-review.yml +26 -26
  64. package/templates/cli/AIDER.md +49 -49
  65. package/templates/cli/AMAZON_Q.md +25 -25
  66. package/templates/cli/AUGGIE.md +32 -32
  67. package/templates/cli/CLAUDE.md +117 -117
  68. package/templates/cli/CLINE.md +99 -99
  69. package/templates/cli/CODEBUDDY.md +20 -20
  70. package/templates/cli/CODEIUM.md +20 -20
  71. package/templates/cli/CODEX.md +21 -21
  72. package/templates/cli/CONTINUE.md +34 -34
  73. package/templates/cli/CURSOR_CLI.md +62 -62
  74. package/templates/cli/FACTORY.md +18 -18
  75. package/templates/cli/GEMINI.md +35 -35
  76. package/templates/cli/KILOCODE.md +18 -18
  77. package/templates/cli/OPENCODE.md +18 -18
  78. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  79. package/templates/commands/rulebook-memory-save.md +48 -48
  80. package/templates/commands/rulebook-memory-search.md +47 -47
  81. package/templates/commands/rulebook-task-apply.md +67 -67
  82. package/templates/commands/rulebook-task-archive.md +94 -94
  83. package/templates/commands/rulebook-task-create.md +93 -93
  84. package/templates/commands/rulebook-task-list.md +42 -42
  85. package/templates/commands/rulebook-task-show.md +52 -52
  86. package/templates/commands/rulebook-task-validate.md +53 -53
  87. package/templates/core/AGENTS_LEAN.md +25 -25
  88. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  89. package/templates/core/AGENT_AUTOMATION.md +288 -288
  90. package/templates/core/DAG.md +304 -304
  91. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  92. package/templates/core/MULTI_AGENT.md +74 -74
  93. package/templates/core/PLANS.md +28 -28
  94. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  95. package/templates/core/RALPH.md +471 -471
  96. package/templates/core/RULEBOOK.md +1935 -1935
  97. package/templates/frameworks/ANGULAR.md +36 -36
  98. package/templates/frameworks/DJANGO.md +83 -83
  99. package/templates/frameworks/ELECTRON.md +147 -147
  100. package/templates/frameworks/FLASK.md +38 -38
  101. package/templates/frameworks/FLUTTER.md +55 -55
  102. package/templates/frameworks/JQUERY.md +32 -32
  103. package/templates/frameworks/LARAVEL.md +38 -38
  104. package/templates/frameworks/NESTJS.md +43 -43
  105. package/templates/frameworks/NEXTJS.md +127 -127
  106. package/templates/frameworks/NUXT.md +40 -40
  107. package/templates/frameworks/RAILS.md +66 -66
  108. package/templates/frameworks/REACT.md +38 -38
  109. package/templates/frameworks/REACT_NATIVE.md +47 -47
  110. package/templates/frameworks/SPRING.md +39 -39
  111. package/templates/frameworks/SYMFONY.md +36 -36
  112. package/templates/frameworks/VUE.md +36 -36
  113. package/templates/frameworks/ZEND.md +35 -35
  114. package/templates/git/CI_CD_PATTERNS.md +661 -661
  115. package/templates/git/GITHUB_ACTIONS.md +728 -728
  116. package/templates/git/GITLAB_CI.md +730 -730
  117. package/templates/git/GIT_WORKFLOW.md +1157 -1157
  118. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  119. package/templates/hooks/COMMIT_MSG.md +530 -530
  120. package/templates/hooks/POST_CHECKOUT.md +546 -546
  121. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  122. package/templates/hooks/PRE_COMMIT.md +414 -414
  123. package/templates/hooks/PRE_PUSH.md +601 -601
  124. package/templates/ides/CONTINUE_RULES.md +16 -16
  125. package/templates/ides/COPILOT.md +37 -37
  126. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  127. package/templates/ides/CURSOR.md +43 -43
  128. package/templates/ides/GEMINI_RULES.md +17 -17
  129. package/templates/ides/JETBRAINS_AI.md +35 -35
  130. package/templates/ides/REPLIT.md +36 -36
  131. package/templates/ides/TABNINE.md +29 -29
  132. package/templates/ides/VSCODE.md +40 -40
  133. package/templates/ides/WINDSURF.md +36 -36
  134. package/templates/ides/WINDSURF_RULES.md +14 -14
  135. package/templates/ides/ZED.md +32 -32
  136. package/templates/ides/cursor-mdc/go.mdc +24 -24
  137. package/templates/ides/cursor-mdc/python.mdc +24 -24
  138. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  139. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  140. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  141. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  142. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  143. package/templates/languages/C.md +333 -333
  144. package/templates/languages/CPP.md +743 -743
  145. package/templates/languages/CSHARP.md +417 -417
  146. package/templates/languages/ELIXIR.md +454 -454
  147. package/templates/languages/ERLANG.md +361 -361
  148. package/templates/languages/GO.md +645 -645
  149. package/templates/languages/HASKELL.md +177 -177
  150. package/templates/languages/JAVA.md +607 -607
  151. package/templates/languages/JAVASCRIPT.md +631 -631
  152. package/templates/languages/JULIA.md +97 -97
  153. package/templates/languages/KOTLIN.md +511 -511
  154. package/templates/languages/LISP.md +100 -100
  155. package/templates/languages/LUA.md +74 -74
  156. package/templates/languages/OBJECTIVEC.md +90 -90
  157. package/templates/languages/PHP.md +416 -416
  158. package/templates/languages/PYTHON.md +682 -682
  159. package/templates/languages/RUBY.md +421 -421
  160. package/templates/languages/RUST.md +477 -477
  161. package/templates/languages/SAS.md +73 -73
  162. package/templates/languages/SCALA.md +348 -348
  163. package/templates/languages/SOLIDITY.md +580 -580
  164. package/templates/languages/SQL.md +137 -137
  165. package/templates/languages/SWIFT.md +466 -466
  166. package/templates/languages/TYPESCRIPT.md +591 -591
  167. package/templates/languages/ZIG.md +265 -265
  168. package/templates/modules/ATLASSIAN.md +255 -255
  169. package/templates/modules/CONTEXT7.md +54 -54
  170. package/templates/modules/FIGMA.md +267 -267
  171. package/templates/modules/GITHUB_MCP.md +64 -64
  172. package/templates/modules/GRAFANA.md +328 -328
  173. package/templates/modules/MEMORY.md +126 -126
  174. package/templates/modules/NOTION.md +247 -247
  175. package/templates/modules/PLAYWRIGHT.md +90 -90
  176. package/templates/modules/RULEBOOK_MCP.md +156 -156
  177. package/templates/modules/SERENA.md +337 -337
  178. package/templates/modules/SUPABASE.md +223 -223
  179. package/templates/modules/SYNAP.md +69 -69
  180. package/templates/modules/VECTORIZER.md +63 -63
  181. package/templates/modules/sequential-thinking.md +42 -42
  182. package/templates/ralph/ralph-history.bat +4 -4
  183. package/templates/ralph/ralph-history.sh +5 -5
  184. package/templates/ralph/ralph-init.bat +5 -5
  185. package/templates/ralph/ralph-init.sh +5 -5
  186. package/templates/ralph/ralph-pause.bat +5 -5
  187. package/templates/ralph/ralph-pause.sh +5 -5
  188. package/templates/ralph/ralph-run.bat +5 -5
  189. package/templates/ralph/ralph-run.sh +5 -5
  190. package/templates/ralph/ralph-status.bat +4 -4
  191. package/templates/ralph/ralph-status.sh +5 -5
  192. package/templates/services/AZURE_BLOB.md +184 -184
  193. package/templates/services/CASSANDRA.md +239 -239
  194. package/templates/services/DATADOG.md +26 -26
  195. package/templates/services/DOCKER.md +124 -124
  196. package/templates/services/DOCKER_COMPOSE.md +168 -168
  197. package/templates/services/DYNAMODB.md +308 -308
  198. package/templates/services/ELASTICSEARCH.md +347 -347
  199. package/templates/services/GCS.md +178 -178
  200. package/templates/services/HELM.md +194 -194
  201. package/templates/services/INFLUXDB.md +265 -265
  202. package/templates/services/KAFKA.md +341 -341
  203. package/templates/services/KUBERNETES.md +208 -208
  204. package/templates/services/MARIADB.md +183 -183
  205. package/templates/services/MEMCACHED.md +242 -242
  206. package/templates/services/MINIO.md +201 -201
  207. package/templates/services/MONGODB.md +268 -268
  208. package/templates/services/MYSQL.md +358 -358
  209. package/templates/services/NEO4J.md +247 -247
  210. package/templates/services/OPENTELEMETRY.md +25 -25
  211. package/templates/services/ORACLE.md +290 -290
  212. package/templates/services/PINO.md +24 -24
  213. package/templates/services/POSTGRESQL.md +326 -326
  214. package/templates/services/PROMETHEUS.md +33 -33
  215. package/templates/services/RABBITMQ.md +286 -286
  216. package/templates/services/REDIS.md +292 -292
  217. package/templates/services/S3.md +298 -298
  218. package/templates/services/SENTRY.md +23 -23
  219. package/templates/services/SQLITE.md +294 -294
  220. package/templates/services/SQLSERVER.md +294 -294
  221. package/templates/services/WINSTON.md +30 -30
  222. package/templates/skills/cli/aider/SKILL.md +59 -59
  223. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  224. package/templates/skills/cli/auggie/SKILL.md +42 -42
  225. package/templates/skills/cli/claude/SKILL.md +42 -42
  226. package/templates/skills/cli/cline/SKILL.md +42 -42
  227. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  228. package/templates/skills/cli/codeium/SKILL.md +30 -30
  229. package/templates/skills/cli/codex/SKILL.md +31 -31
  230. package/templates/skills/cli/continue/SKILL.md +44 -44
  231. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  232. package/templates/skills/cli/factory/SKILL.md +28 -28
  233. package/templates/skills/cli/gemini/SKILL.md +45 -45
  234. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  235. package/templates/skills/cli/opencode/SKILL.md +28 -28
  236. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  237. package/templates/skills/core/dag/SKILL.md +314 -314
  238. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  239. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  240. package/templates/skills/core/rulebook/SKILL.md +176 -176
  241. package/templates/skills/dev/accessibility/SKILL.md +17 -0
  242. package/templates/skills/dev/api-design/SKILL.md +15 -0
  243. package/templates/skills/dev/architect/SKILL.md +17 -0
  244. package/templates/skills/dev/build-fix/SKILL.md +17 -0
  245. package/templates/skills/dev/db-design/SKILL.md +15 -0
  246. package/templates/skills/dev/debug/SKILL.md +16 -0
  247. package/templates/skills/dev/deploy/SKILL.md +17 -0
  248. package/templates/skills/dev/docs/SKILL.md +17 -0
  249. package/templates/skills/dev/migrate/SKILL.md +15 -0
  250. package/templates/skills/dev/perf/SKILL.md +17 -0
  251. package/templates/skills/dev/refactor/SKILL.md +17 -0
  252. package/templates/skills/dev/research/SKILL.md +14 -0
  253. package/templates/skills/dev/review/SKILL.md +18 -0
  254. package/templates/skills/dev/security-audit/SKILL.md +17 -0
  255. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  256. package/templates/skills/frameworks/django/SKILL.md +93 -93
  257. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  258. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  259. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  260. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  261. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  262. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  263. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  264. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  265. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  266. package/templates/skills/frameworks/react/SKILL.md +48 -48
  267. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  268. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  269. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  270. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  271. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  272. package/templates/skills/ides/copilot/SKILL.md +47 -47
  273. package/templates/skills/ides/cursor/SKILL.md +53 -53
  274. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  275. package/templates/skills/ides/replit/SKILL.md +46 -46
  276. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  277. package/templates/skills/ides/vscode/SKILL.md +50 -50
  278. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  279. package/templates/skills/ides/zed/SKILL.md +42 -42
  280. package/templates/skills/languages/c/SKILL.md +343 -343
  281. package/templates/skills/languages/cpp/SKILL.md +753 -753
  282. package/templates/skills/languages/csharp/SKILL.md +427 -427
  283. package/templates/skills/languages/elixir/SKILL.md +464 -464
  284. package/templates/skills/languages/erlang/SKILL.md +371 -371
  285. package/templates/skills/languages/go/SKILL.md +655 -655
  286. package/templates/skills/languages/haskell/SKILL.md +187 -187
  287. package/templates/skills/languages/java/SKILL.md +617 -617
  288. package/templates/skills/languages/javascript/SKILL.md +641 -641
  289. package/templates/skills/languages/julia/SKILL.md +107 -107
  290. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  291. package/templates/skills/languages/lisp/SKILL.md +110 -110
  292. package/templates/skills/languages/lua/SKILL.md +84 -84
  293. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  294. package/templates/skills/languages/php/SKILL.md +426 -426
  295. package/templates/skills/languages/python/SKILL.md +692 -692
  296. package/templates/skills/languages/ruby/SKILL.md +431 -431
  297. package/templates/skills/languages/rust/SKILL.md +487 -487
  298. package/templates/skills/languages/sas/SKILL.md +83 -83
  299. package/templates/skills/languages/scala/SKILL.md +358 -358
  300. package/templates/skills/languages/solidity/SKILL.md +590 -590
  301. package/templates/skills/languages/sql/SKILL.md +147 -147
  302. package/templates/skills/languages/swift/SKILL.md +476 -476
  303. package/templates/skills/languages/typescript/SKILL.md +302 -302
  304. package/templates/skills/languages/zig/SKILL.md +275 -275
  305. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  306. package/templates/skills/modules/context7/SKILL.md +64 -64
  307. package/templates/skills/modules/figma/SKILL.md +277 -277
  308. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  309. package/templates/skills/modules/grafana/SKILL.md +338 -338
  310. package/templates/skills/modules/memory/SKILL.md +73 -73
  311. package/templates/skills/modules/notion/SKILL.md +257 -257
  312. package/templates/skills/modules/playwright/SKILL.md +100 -100
  313. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  314. package/templates/skills/modules/serena/SKILL.md +347 -347
  315. package/templates/skills/modules/supabase/SKILL.md +233 -233
  316. package/templates/skills/modules/synap/SKILL.md +79 -79
  317. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  318. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  319. package/templates/skills/services/cassandra/SKILL.md +249 -249
  320. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  321. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  322. package/templates/skills/services/gcs/SKILL.md +188 -188
  323. package/templates/skills/services/influxdb/SKILL.md +275 -275
  324. package/templates/skills/services/kafka/SKILL.md +351 -351
  325. package/templates/skills/services/mariadb/SKILL.md +193 -193
  326. package/templates/skills/services/memcached/SKILL.md +252 -252
  327. package/templates/skills/services/minio/SKILL.md +211 -211
  328. package/templates/skills/services/mongodb/SKILL.md +278 -278
  329. package/templates/skills/services/mysql/SKILL.md +368 -368
  330. package/templates/skills/services/neo4j/SKILL.md +257 -257
  331. package/templates/skills/services/oracle/SKILL.md +300 -300
  332. package/templates/skills/services/postgresql/SKILL.md +336 -336
  333. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  334. package/templates/skills/services/redis/SKILL.md +302 -302
  335. package/templates/skills/services/s3/SKILL.md +308 -308
  336. package/templates/skills/services/sqlite/SKILL.md +304 -304
  337. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  338. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  339. package/templates/skills/workflows/ralph/install.sh +87 -87
  340. package/templates/skills/workflows/ralph/manifest.json +158 -158
@@ -1,590 +1,590 @@
1
- ---
2
- name: "Solidity"
3
- description: "Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow)."
4
- version: "1.0.0"
5
- category: "languages"
6
- author: "Rulebook"
7
- tags: ["languages", "language"]
8
- dependencies: []
9
- conflicts: []
10
- ---
11
- <!-- SOLIDITY:START -->
12
- # Solidity Project Rules
13
-
14
- ## Agent Automation Commands
15
-
16
- **CRITICAL**: Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow).
17
-
18
- ```bash
19
- # Complete quality check sequence (Hardhat):
20
- npx hardhat compile # Compilation check
21
- npx hardhat test # All tests (100% pass)
22
- npx hardhat coverage # Coverage check
23
- npx slither . # Security analysis
24
-
25
- # Or with Foundry:
26
- forge build # Compilation
27
- forge test # All tests
28
- forge coverage # Coverage
29
- slither . # Security scan
30
-
31
- # Gas optimization check:
32
- npx hardhat test --gas
33
- ```
34
-
35
- ## Solidity Configuration
36
-
37
- **CRITICAL**: Use Solidity 0.8.20+ with strict compiler settings and comprehensive testing.
38
-
39
- - **Version**: Solidity 0.8.20+
40
- - **Recommended**: Solidity 0.8.26+
41
- - **Framework**: Hardhat or Foundry
42
- - **Testing**: Hardhat tests or Foundry tests
43
- - **Linter**: Solhint
44
- - **Formatter**: Prettier with prettier-plugin-solidity
45
- - **Security**: Slither, Mythril for static analysis
46
-
47
- ### hardhat.config.js Requirements
48
-
49
- ```javascript
50
- require("@nomicfoundation/hardhat-toolbox");
51
- require("hardhat-gas-reporter");
52
- require("solidity-coverage");
53
-
54
- module.exports = {
55
- solidity: {
56
- version: "0.8.26",
57
- settings: {
58
- optimizer: {
59
- enabled: true,
60
- runs: 200
61
- },
62
- viaIR: true,
63
- outputSelection: {
64
- "*": {
65
- "*": ["storageLayout"]
66
- }
67
- }
68
- }
69
- },
70
- networks: {
71
- hardhat: {
72
- chainId: 31337
73
- },
74
- localhost: {
75
- url: "http://127.0.0.1:8545"
76
- }
77
- },
78
- gasReporter: {
79
- enabled: true,
80
- currency: "USD",
81
- outputFile: "gas-report.txt"
82
- },
83
- paths: {
84
- sources: "./contracts",
85
- tests: "./test",
86
- cache: "./cache",
87
- artifacts: "./artifacts"
88
- }
89
- };
90
- ```
91
-
92
- ### foundry.toml Requirements (Alternative)
93
-
94
- ```toml
95
- [profile.default]
96
- src = "src"
97
- out = "out"
98
- libs = ["lib"]
99
- solc = "0.8.26"
100
- optimizer = true
101
- optimizer_runs = 200
102
- via_ir = true
103
- verbosity = 3
104
-
105
- [profile.ci]
106
- fuzz = { runs = 10000 }
107
- invariant = { runs = 1000 }
108
-
109
- [fmt]
110
- line_length = 100
111
- tab_width = 4
112
- bracket_spacing = true
113
- int_types = "long"
114
- quote_style = "double"
115
- number_underscore = "thousands"
116
- ```
117
-
118
- ## Code Quality Standards
119
-
120
- ### Mandatory Quality Checks
121
-
122
- **CRITICAL**: After implementing ANY feature, you MUST run these commands in order.
123
-
124
- **IMPORTANT**: These commands MUST match your GitHub Actions workflows to prevent CI/CD failures!
125
-
126
- ```bash
127
- # Pre-Commit Checklist - Hardhat (MUST match .github/workflows/*.yml)
128
-
129
- # 1. Format check (matches workflow)
130
- npx prettier --check 'contracts/**/*.sol' 'test/**/*.js'
131
-
132
- # 2. Lint (MUST pass with no warnings - matches workflow)
133
- npx solhint 'contracts/**/*.sol'
134
-
135
- # 3. Compile (matches workflow)
136
- npx hardhat compile
137
-
138
- # 4. Run all tests (MUST pass 100% - matches workflow)
139
- npx hardhat test
140
-
141
- # 5. Gas report (matches workflow)
142
- REPORT_GAS=true npx hardhat test
143
-
144
- # 6. Coverage (MUST meet threshold - matches workflow)
145
- npx hardhat coverage
146
-
147
- # 7. Security analysis (matches workflow)
148
- slither .
149
- # or: mythril analyze contracts/MyContract.sol
150
-
151
- # Pre-Commit Checklist - Foundry (MUST match .github/workflows/*.yml)
152
-
153
- # 1. Format check (matches workflow)
154
- forge fmt --check
155
-
156
- # 2. Build (matches workflow)
157
- forge build
158
-
159
- # 3. Run all tests (MUST pass 100% - matches workflow)
160
- forge test -vvv
161
-
162
- # 4. Coverage (matches workflow)
163
- forge coverage
164
-
165
- # 5. Gas snapshot (matches workflow)
166
- forge snapshot --check
167
-
168
- # 6. Security analysis (matches workflow)
169
- slither .
170
-
171
- # If ANY fails: ❌ DO NOT COMMIT - Fix first!
172
- ```
173
-
174
- **If ANY of these fail, you MUST fix the issues before committing.**
175
-
176
- **Why This Matters:**
177
- - Running different commands locally than in CI causes deployment failures
178
- - Smart contract bugs can lead to financial losses
179
- - Example: Using `prettier --write` locally but `prettier --check` in CI = failure
180
- - Example: Skipping security analysis locally = vulnerabilities deployed to mainnet
181
- - Example: Missing gas optimization = expensive contract operations
182
-
183
- ### Security Best Practices
184
-
185
- **CRITICAL**: Smart contracts handle real value - security is paramount!
186
-
187
- ```solidity
188
- // ✅ GOOD: Secure patterns
189
- pragma solidity 0.8.26;
190
-
191
- import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
192
- import "@openzeppelin/contracts/access/Ownable.sol";
193
-
194
- contract SecureVault is ReentrancyGuard, Ownable {
195
- mapping(address => uint256) private balances;
196
-
197
- event Deposit(address indexed user, uint256 amount);
198
- event Withdrawal(address indexed user, uint256 amount);
199
-
200
- // Checks-Effects-Interactions pattern
201
- function withdraw(uint256 amount) external nonReentrant {
202
- // Checks
203
- require(amount > 0, "Amount must be positive");
204
- require(balances[msg.sender] >= amount, "Insufficient balance");
205
-
206
- // Effects
207
- balances[msg.sender] -= amount;
208
- emit Withdrawal(msg.sender, amount);
209
-
210
- // Interactions
211
- (bool success, ) = msg.sender.call{value: amount}("");
212
- require(success, "Transfer failed");
213
- }
214
-
215
- function deposit() external payable {
216
- require(msg.value > 0, "Must deposit positive amount");
217
- balances[msg.sender] += msg.value;
218
- emit Deposit(msg.sender, msg.value);
219
- }
220
-
221
- function getBalance(address user) external view returns (uint256) {
222
- return balances[user];
223
- }
224
- }
225
-
226
- // ❌ BAD: Vulnerable to reentrancy
227
- contract InsecureVault {
228
- mapping(address => uint256) public balances;
229
-
230
- function withdraw(uint256 amount) external {
231
- require(balances[msg.sender] >= amount);
232
-
233
- // DANGER: External call before state update!
234
- (bool success, ) = msg.sender.call{value: amount}("");
235
- require(success);
236
-
237
- balances[msg.sender] -= amount; // TOO LATE - already reentered!
238
- }
239
- }
240
- ```
241
-
242
- ### Testing
243
-
244
- - **Framework**: Hardhat (Mocha/Chai) or Foundry (Forge)
245
- - **Location**: `/test` directory
246
- - **Coverage**: Must meet threshold (90%+)
247
- - **Invariant Testing**: Use property-based testing
248
- - **Fork Testing**: Test against mainnet forks
249
-
250
- Example Hardhat test:
251
- ```javascript
252
- const { expect } = require("chai");
253
- const { ethers } = require("hardhat");
254
-
255
- describe("SecureVault", function () {
256
- let vault;
257
- let owner;
258
- let addr1;
259
- let addr2;
260
-
261
- beforeEach(async function () {
262
- [owner, addr1, addr2] = await ethers.getSigners();
263
-
264
- const Vault = await ethers.getContractFactory("SecureVault");
265
- vault = await Vault.deploy();
266
- await vault.deployed();
267
- });
268
-
269
- describe("Deployment", function () {
270
- it("Should set the right owner", async function () {
271
- expect(await vault.owner()).to.equal(owner.address);
272
- });
273
- });
274
-
275
- describe("Deposits", function () {
276
- it("Should accept deposits", async function () {
277
- const depositAmount = ethers.utils.parseEther("1.0");
278
-
279
- await expect(vault.connect(addr1).deposit({ value: depositAmount }))
280
- .to.emit(vault, "Deposit")
281
- .withArgs(addr1.address, depositAmount);
282
-
283
- expect(await vault.getBalance(addr1.address)).to.equal(depositAmount);
284
- });
285
-
286
- it("Should reject zero deposits", async function () {
287
- await expect(
288
- vault.connect(addr1).deposit({ value: 0 })
289
- ).to.be.revertedWith("Must deposit positive amount");
290
- });
291
- });
292
-
293
- describe("Withdrawals", function () {
294
- beforeEach(async function () {
295
- await vault.connect(addr1).deposit({ value: ethers.utils.parseEther("2.0") });
296
- });
297
-
298
- it("Should allow withdrawals", async function () {
299
- const withdrawAmount = ethers.utils.parseEther("1.0");
300
-
301
- await expect(vault.connect(addr1).withdraw(withdrawAmount))
302
- .to.emit(vault, "Withdrawal")
303
- .withArgs(addr1.address, withdrawAmount);
304
-
305
- expect(await vault.getBalance(addr1.address))
306
- .to.equal(ethers.utils.parseEther("1.0"));
307
- });
308
-
309
- it("Should prevent withdrawal of more than balance", async function () {
310
- await expect(
311
- vault.connect(addr1).withdraw(ethers.utils.parseEther("10.0"))
312
- ).to.be.revertedWith("Insufficient balance");
313
- });
314
- });
315
- });
316
- ```
317
-
318
- Example Foundry test:
319
- ```solidity
320
- // SPDX-License-Identifier: MIT
321
- pragma solidity 0.8.26;
322
-
323
- import "forge-std/Test.sol";
324
- import "../src/SecureVault.sol";
325
-
326
- contract SecureVaultTest is Test {
327
- SecureVault public vault;
328
- address public alice;
329
- address public bob;
330
-
331
- function setUp() public {
332
- vault = new SecureVault();
333
- alice = makeAddr("alice");
334
- bob = makeAddr("bob");
335
-
336
- vm.deal(alice, 100 ether);
337
- vm.deal(bob, 100 ether);
338
- }
339
-
340
- function testDeposit() public {
341
- vm.startPrank(alice);
342
- vault.deposit{value: 1 ether}();
343
-
344
- assertEq(vault.getBalance(alice), 1 ether);
345
- vm.stopPrank();
346
- }
347
-
348
- function testWithdraw() public {
349
- vm.startPrank(alice);
350
- vault.deposit{value: 2 ether}();
351
-
352
- uint256 balanceBefore = alice.balance;
353
- vault.withdraw(1 ether);
354
-
355
- assertEq(vault.getBalance(alice), 1 ether);
356
- assertEq(alice.balance, balanceBefore + 1 ether);
357
- vm.stopPrank();
358
- }
359
-
360
- function testCannotWithdrawMoreThanBalance() public {
361
- vm.startPrank(alice);
362
- vault.deposit{value: 1 ether}();
363
-
364
- vm.expectRevert("Insufficient balance");
365
- vault.withdraw(2 ether);
366
- vm.stopPrank();
367
- }
368
-
369
- // Fuzz testing
370
- function testFuzzDeposit(uint256 amount) public {
371
- vm.assume(amount > 0 && amount < 100 ether);
372
-
373
- vm.deal(alice, amount);
374
- vm.prank(alice);
375
- vault.deposit{value: amount}();
376
-
377
- assertEq(vault.getBalance(alice), amount);
378
- }
379
-
380
- // Invariant testing
381
- function invariant_totalBalanceMatchesContract() public {
382
- assertEq(address(vault).balance, vault.totalDeposits());
383
- }
384
- }
385
- ```
386
-
387
- ## Security Auditing
388
-
389
- **CRITICAL**: Run multiple security tools before deployment!
390
-
391
- ### Static Analysis Tools
392
-
393
- ```bash
394
- # Slither (comprehensive)
395
- slither . --exclude-optimization --exclude-informational
396
-
397
- # Mythril (symbolic execution)
398
- myth analyze contracts/MyContract.sol
399
-
400
- # Manticore (symbolic execution)
401
- manticore contracts/MyContract.sol
402
-
403
- # Echidna (fuzzing)
404
- echidna-test contracts/MyContract.sol --contract MyContract
405
-
406
- # Solhint (linting with security rules)
407
- solhint 'contracts/**/*.sol'
408
- ```
409
-
410
- ### Manual Review Checklist
411
-
412
- - [ ] Reentrancy protection (ReentrancyGuard or Checks-Effects-Interactions)
413
- - [ ] Integer overflow protection (use Solidity 0.8+)
414
- - [ ] Access control (Ownable, AccessControl)
415
- - [ ] Input validation (require statements)
416
- - [ ] Gas optimization reviewed
417
- - [ ] Event emissions for all state changes
418
- - [ ] No use of tx.origin (use msg.sender)
419
- - [ ] No use of block.timestamp for critical logic
420
- - [ ] No delegatecall to untrusted contracts
421
- - [ ] No selfdestruct in upgradeable contracts
422
-
423
- ## Gas Optimization
424
-
425
- ```solidity
426
- // ✅ GOOD: Gas-optimized patterns
427
- contract Optimized {
428
- // Use immutable for constants set in constructor
429
- address public immutable owner;
430
-
431
- // Pack struct variables
432
- struct User {
433
- uint128 balance; // 16 bytes
434
- uint64 lastUpdated; // 8 bytes
435
- uint64 nonce; // 8 bytes
436
- // Total: 32 bytes (1 storage slot)
437
- }
438
-
439
- // Cache storage variables
440
- function processUsers(uint256[] calldata ids) external {
441
- User storage user; // Declare once
442
- for (uint256 i = 0; i < ids.length; i++) {
443
- user = users[ids[i]]; // Cache
444
- user.balance += 100;
445
- }
446
- }
447
-
448
- // Use calldata for read-only arrays
449
- function sum(uint256[] calldata numbers) external pure returns (uint256) {
450
- uint256 total = 0;
451
- for (uint256 i = 0; i < numbers.length; i++) {
452
- total += numbers[i];
453
- }
454
- return total;
455
- }
456
- }
457
-
458
- // ❌ BAD: Gas-inefficient
459
- contract Inefficient {
460
- address public owner; // Should be immutable!
461
-
462
- struct User {
463
- uint256 balance; // 32 bytes
464
- uint256 lastUpdated; // 32 bytes
465
- uint256 nonce; // 32 bytes
466
- // Total: 96 bytes (3 storage slots!)
467
- }
468
-
469
- // Repeated storage access
470
- function processUsers(uint256[] memory ids) external {
471
- for (uint256 i = 0; i < ids.length; i++) {
472
- users[ids[i]].balance += 100; // SLOAD every iteration!
473
- }
474
- }
475
- }
476
- ```
477
-
478
- ## Best Practices
479
-
480
- ### DO's ✅
481
-
482
- - **USE** OpenZeppelin contracts for standard functionality
483
- - **USE** ReentrancyGuard for functions with external calls
484
- - **USE** SafeMath patterns or Solidity 0.8+ (automatic overflow checks)
485
- - **EMIT** events for all state changes
486
- - **VALIDATE** all inputs with require statements
487
- - **TEST** with mainnet forks for realistic scenarios
488
- - **OPTIMIZE** gas usage
489
- - **DOCUMENT** all public functions with NatSpec
490
-
491
- ### DON'Ts ❌
492
-
493
- - **NEVER** use tx.origin for authorization
494
- - **NEVER** use block.timestamp for critical randomness
495
- - **NEVER** make external calls before state updates (reentrancy!)
496
- - **NEVER** use delegatecall without extreme caution
497
- - **NEVER** deploy without security audit
498
- - **NEVER** use floating pragma (`pragma solidity ^0.8.0`)
499
- - **NEVER** skip test coverage
500
- - **NEVER** ignore Slither warnings
501
-
502
- ## NatSpec Documentation
503
-
504
- ```solidity
505
- /// @title Secure Vault Contract
506
- /// @author Your Name
507
- /// @notice This contract allows users to deposit and withdraw ETH
508
- /// @dev Uses ReentrancyGuard to prevent reentrancy attacks
509
- contract SecureVault is ReentrancyGuard {
510
-
511
- /// @notice Deposits ETH into the vault
512
- /// @dev Emits Deposit event on success
513
- /// @return success Boolean indicating if deposit was successful
514
- function deposit() external payable returns (bool success) {
515
- require(msg.value > 0, "Must deposit positive amount");
516
- balances[msg.sender] += msg.value;
517
- emit Deposit(msg.sender, msg.value);
518
- return true;
519
- }
520
-
521
- /// @notice Withdraws ETH from the vault
522
- /// @dev Uses Checks-Effects-Interactions pattern
523
- /// @param amount The amount of ETH to withdraw
524
- /// @custom:security Protected against reentrancy
525
- function withdraw(uint256 amount) external nonReentrant {
526
- require(amount > 0, "Amount must be positive");
527
- require(balances[msg.sender] >= amount, "Insufficient balance");
528
-
529
- balances[msg.sender] -= amount;
530
- emit Withdrawal(msg.sender, amount);
531
-
532
- (bool success, ) = msg.sender.call{value: amount}("");
533
- require(success, "Transfer failed");
534
- }
535
- }
536
- ```
537
-
538
- ## CI/CD Requirements
539
-
540
- Must include GitHub Actions workflows:
541
-
542
- 1. **Testing** (`solidity-test.yml`):
543
- - Run Hardhat/Foundry tests
544
- - Fork testing against mainnet
545
- - Coverage reporting (90%+ required)
546
-
547
- 2. **Security** (`solidity-security.yml`):
548
- - Slither static analysis
549
- - Mythril symbolic execution
550
- - Gas optimization check
551
-
552
- 3. **Linting** (`solidity-lint.yml`):
553
- - Solhint checks
554
- - Prettier formatting
555
- - Compile verification
556
-
557
- ## Deployment Checklist
558
-
559
- **CRITICAL**: Before mainnet deployment!
560
-
561
- - [ ] All tests passing (100%)
562
- - [ ] Coverage > 90%
563
- - [ ] Slither audit clean
564
- - [ ] Mythril audit clean
565
- - [ ] External security audit completed
566
- - [ ] Gas optimization reviewed
567
- - [ ] All functions have NatSpec comments
568
- - [ ] Deployed to testnet and verified
569
- - [ ] Contract verified on Etherscan
570
- - [ ] Multi-sig wallet setup for admin functions
571
- - [ ] Emergency pause mechanism tested
572
- - [ ] Upgrade path documented (if upgradeable)
573
-
574
- ## Publishing to NPM (Hardhat)
575
-
576
- ```bash
577
- # 1. Run all quality checks
578
- npm run lint
579
- npm test
580
- npx hardhat coverage
581
-
582
- # 2. Update version
583
- npm version minor
584
-
585
- # 3. Publish
586
- npm publish
587
- ```
588
-
589
- <!-- SOLIDITY:END -->
590
-
1
+ ---
2
+ name: "Solidity"
3
+ description: "Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow)."
4
+ version: "1.0.0"
5
+ category: "languages"
6
+ author: "Rulebook"
7
+ tags: ["languages", "language"]
8
+ dependencies: []
9
+ conflicts: []
10
+ ---
11
+ <!-- SOLIDITY:START -->
12
+ # Solidity Project Rules
13
+
14
+ ## Agent Automation Commands
15
+
16
+ **CRITICAL**: Execute these commands after EVERY implementation (see AGENT_AUTOMATION module for full workflow).
17
+
18
+ ```bash
19
+ # Complete quality check sequence (Hardhat):
20
+ npx hardhat compile # Compilation check
21
+ npx hardhat test # All tests (100% pass)
22
+ npx hardhat coverage # Coverage check
23
+ npx slither . # Security analysis
24
+
25
+ # Or with Foundry:
26
+ forge build # Compilation
27
+ forge test # All tests
28
+ forge coverage # Coverage
29
+ slither . # Security scan
30
+
31
+ # Gas optimization check:
32
+ npx hardhat test --gas
33
+ ```
34
+
35
+ ## Solidity Configuration
36
+
37
+ **CRITICAL**: Use Solidity 0.8.20+ with strict compiler settings and comprehensive testing.
38
+
39
+ - **Version**: Solidity 0.8.20+
40
+ - **Recommended**: Solidity 0.8.26+
41
+ - **Framework**: Hardhat or Foundry
42
+ - **Testing**: Hardhat tests or Foundry tests
43
+ - **Linter**: Solhint
44
+ - **Formatter**: Prettier with prettier-plugin-solidity
45
+ - **Security**: Slither, Mythril for static analysis
46
+
47
+ ### hardhat.config.js Requirements
48
+
49
+ ```javascript
50
+ require("@nomicfoundation/hardhat-toolbox");
51
+ require("hardhat-gas-reporter");
52
+ require("solidity-coverage");
53
+
54
+ module.exports = {
55
+ solidity: {
56
+ version: "0.8.26",
57
+ settings: {
58
+ optimizer: {
59
+ enabled: true,
60
+ runs: 200
61
+ },
62
+ viaIR: true,
63
+ outputSelection: {
64
+ "*": {
65
+ "*": ["storageLayout"]
66
+ }
67
+ }
68
+ }
69
+ },
70
+ networks: {
71
+ hardhat: {
72
+ chainId: 31337
73
+ },
74
+ localhost: {
75
+ url: "http://127.0.0.1:8545"
76
+ }
77
+ },
78
+ gasReporter: {
79
+ enabled: true,
80
+ currency: "USD",
81
+ outputFile: "gas-report.txt"
82
+ },
83
+ paths: {
84
+ sources: "./contracts",
85
+ tests: "./test",
86
+ cache: "./cache",
87
+ artifacts: "./artifacts"
88
+ }
89
+ };
90
+ ```
91
+
92
+ ### foundry.toml Requirements (Alternative)
93
+
94
+ ```toml
95
+ [profile.default]
96
+ src = "src"
97
+ out = "out"
98
+ libs = ["lib"]
99
+ solc = "0.8.26"
100
+ optimizer = true
101
+ optimizer_runs = 200
102
+ via_ir = true
103
+ verbosity = 3
104
+
105
+ [profile.ci]
106
+ fuzz = { runs = 10000 }
107
+ invariant = { runs = 1000 }
108
+
109
+ [fmt]
110
+ line_length = 100
111
+ tab_width = 4
112
+ bracket_spacing = true
113
+ int_types = "long"
114
+ quote_style = "double"
115
+ number_underscore = "thousands"
116
+ ```
117
+
118
+ ## Code Quality Standards
119
+
120
+ ### Mandatory Quality Checks
121
+
122
+ **CRITICAL**: After implementing ANY feature, you MUST run these commands in order.
123
+
124
+ **IMPORTANT**: These commands MUST match your GitHub Actions workflows to prevent CI/CD failures!
125
+
126
+ ```bash
127
+ # Pre-Commit Checklist - Hardhat (MUST match .github/workflows/*.yml)
128
+
129
+ # 1. Format check (matches workflow)
130
+ npx prettier --check 'contracts/**/*.sol' 'test/**/*.js'
131
+
132
+ # 2. Lint (MUST pass with no warnings - matches workflow)
133
+ npx solhint 'contracts/**/*.sol'
134
+
135
+ # 3. Compile (matches workflow)
136
+ npx hardhat compile
137
+
138
+ # 4. Run all tests (MUST pass 100% - matches workflow)
139
+ npx hardhat test
140
+
141
+ # 5. Gas report (matches workflow)
142
+ REPORT_GAS=true npx hardhat test
143
+
144
+ # 6. Coverage (MUST meet threshold - matches workflow)
145
+ npx hardhat coverage
146
+
147
+ # 7. Security analysis (matches workflow)
148
+ slither .
149
+ # or: mythril analyze contracts/MyContract.sol
150
+
151
+ # Pre-Commit Checklist - Foundry (MUST match .github/workflows/*.yml)
152
+
153
+ # 1. Format check (matches workflow)
154
+ forge fmt --check
155
+
156
+ # 2. Build (matches workflow)
157
+ forge build
158
+
159
+ # 3. Run all tests (MUST pass 100% - matches workflow)
160
+ forge test -vvv
161
+
162
+ # 4. Coverage (matches workflow)
163
+ forge coverage
164
+
165
+ # 5. Gas snapshot (matches workflow)
166
+ forge snapshot --check
167
+
168
+ # 6. Security analysis (matches workflow)
169
+ slither .
170
+
171
+ # If ANY fails: ❌ DO NOT COMMIT - Fix first!
172
+ ```
173
+
174
+ **If ANY of these fail, you MUST fix the issues before committing.**
175
+
176
+ **Why This Matters:**
177
+ - Running different commands locally than in CI causes deployment failures
178
+ - Smart contract bugs can lead to financial losses
179
+ - Example: Using `prettier --write` locally but `prettier --check` in CI = failure
180
+ - Example: Skipping security analysis locally = vulnerabilities deployed to mainnet
181
+ - Example: Missing gas optimization = expensive contract operations
182
+
183
+ ### Security Best Practices
184
+
185
+ **CRITICAL**: Smart contracts handle real value - security is paramount!
186
+
187
+ ```solidity
188
+ // ✅ GOOD: Secure patterns
189
+ pragma solidity 0.8.26;
190
+
191
+ import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
192
+ import "@openzeppelin/contracts/access/Ownable.sol";
193
+
194
+ contract SecureVault is ReentrancyGuard, Ownable {
195
+ mapping(address => uint256) private balances;
196
+
197
+ event Deposit(address indexed user, uint256 amount);
198
+ event Withdrawal(address indexed user, uint256 amount);
199
+
200
+ // Checks-Effects-Interactions pattern
201
+ function withdraw(uint256 amount) external nonReentrant {
202
+ // Checks
203
+ require(amount > 0, "Amount must be positive");
204
+ require(balances[msg.sender] >= amount, "Insufficient balance");
205
+
206
+ // Effects
207
+ balances[msg.sender] -= amount;
208
+ emit Withdrawal(msg.sender, amount);
209
+
210
+ // Interactions
211
+ (bool success, ) = msg.sender.call{value: amount}("");
212
+ require(success, "Transfer failed");
213
+ }
214
+
215
+ function deposit() external payable {
216
+ require(msg.value > 0, "Must deposit positive amount");
217
+ balances[msg.sender] += msg.value;
218
+ emit Deposit(msg.sender, msg.value);
219
+ }
220
+
221
+ function getBalance(address user) external view returns (uint256) {
222
+ return balances[user];
223
+ }
224
+ }
225
+
226
+ // ❌ BAD: Vulnerable to reentrancy
227
+ contract InsecureVault {
228
+ mapping(address => uint256) public balances;
229
+
230
+ function withdraw(uint256 amount) external {
231
+ require(balances[msg.sender] >= amount);
232
+
233
+ // DANGER: External call before state update!
234
+ (bool success, ) = msg.sender.call{value: amount}("");
235
+ require(success);
236
+
237
+ balances[msg.sender] -= amount; // TOO LATE - already reentered!
238
+ }
239
+ }
240
+ ```
241
+
242
+ ### Testing
243
+
244
+ - **Framework**: Hardhat (Mocha/Chai) or Foundry (Forge)
245
+ - **Location**: `/test` directory
246
+ - **Coverage**: Must meet threshold (90%+)
247
+ - **Invariant Testing**: Use property-based testing
248
+ - **Fork Testing**: Test against mainnet forks
249
+
250
+ Example Hardhat test:
251
+ ```javascript
252
+ const { expect } = require("chai");
253
+ const { ethers } = require("hardhat");
254
+
255
+ describe("SecureVault", function () {
256
+ let vault;
257
+ let owner;
258
+ let addr1;
259
+ let addr2;
260
+
261
+ beforeEach(async function () {
262
+ [owner, addr1, addr2] = await ethers.getSigners();
263
+
264
+ const Vault = await ethers.getContractFactory("SecureVault");
265
+ vault = await Vault.deploy();
266
+ await vault.deployed();
267
+ });
268
+
269
+ describe("Deployment", function () {
270
+ it("Should set the right owner", async function () {
271
+ expect(await vault.owner()).to.equal(owner.address);
272
+ });
273
+ });
274
+
275
+ describe("Deposits", function () {
276
+ it("Should accept deposits", async function () {
277
+ const depositAmount = ethers.utils.parseEther("1.0");
278
+
279
+ await expect(vault.connect(addr1).deposit({ value: depositAmount }))
280
+ .to.emit(vault, "Deposit")
281
+ .withArgs(addr1.address, depositAmount);
282
+
283
+ expect(await vault.getBalance(addr1.address)).to.equal(depositAmount);
284
+ });
285
+
286
+ it("Should reject zero deposits", async function () {
287
+ await expect(
288
+ vault.connect(addr1).deposit({ value: 0 })
289
+ ).to.be.revertedWith("Must deposit positive amount");
290
+ });
291
+ });
292
+
293
+ describe("Withdrawals", function () {
294
+ beforeEach(async function () {
295
+ await vault.connect(addr1).deposit({ value: ethers.utils.parseEther("2.0") });
296
+ });
297
+
298
+ it("Should allow withdrawals", async function () {
299
+ const withdrawAmount = ethers.utils.parseEther("1.0");
300
+
301
+ await expect(vault.connect(addr1).withdraw(withdrawAmount))
302
+ .to.emit(vault, "Withdrawal")
303
+ .withArgs(addr1.address, withdrawAmount);
304
+
305
+ expect(await vault.getBalance(addr1.address))
306
+ .to.equal(ethers.utils.parseEther("1.0"));
307
+ });
308
+
309
+ it("Should prevent withdrawal of more than balance", async function () {
310
+ await expect(
311
+ vault.connect(addr1).withdraw(ethers.utils.parseEther("10.0"))
312
+ ).to.be.revertedWith("Insufficient balance");
313
+ });
314
+ });
315
+ });
316
+ ```
317
+
318
+ Example Foundry test:
319
+ ```solidity
320
+ // SPDX-License-Identifier: MIT
321
+ pragma solidity 0.8.26;
322
+
323
+ import "forge-std/Test.sol";
324
+ import "../src/SecureVault.sol";
325
+
326
+ contract SecureVaultTest is Test {
327
+ SecureVault public vault;
328
+ address public alice;
329
+ address public bob;
330
+
331
+ function setUp() public {
332
+ vault = new SecureVault();
333
+ alice = makeAddr("alice");
334
+ bob = makeAddr("bob");
335
+
336
+ vm.deal(alice, 100 ether);
337
+ vm.deal(bob, 100 ether);
338
+ }
339
+
340
+ function testDeposit() public {
341
+ vm.startPrank(alice);
342
+ vault.deposit{value: 1 ether}();
343
+
344
+ assertEq(vault.getBalance(alice), 1 ether);
345
+ vm.stopPrank();
346
+ }
347
+
348
+ function testWithdraw() public {
349
+ vm.startPrank(alice);
350
+ vault.deposit{value: 2 ether}();
351
+
352
+ uint256 balanceBefore = alice.balance;
353
+ vault.withdraw(1 ether);
354
+
355
+ assertEq(vault.getBalance(alice), 1 ether);
356
+ assertEq(alice.balance, balanceBefore + 1 ether);
357
+ vm.stopPrank();
358
+ }
359
+
360
+ function testCannotWithdrawMoreThanBalance() public {
361
+ vm.startPrank(alice);
362
+ vault.deposit{value: 1 ether}();
363
+
364
+ vm.expectRevert("Insufficient balance");
365
+ vault.withdraw(2 ether);
366
+ vm.stopPrank();
367
+ }
368
+
369
+ // Fuzz testing
370
+ function testFuzzDeposit(uint256 amount) public {
371
+ vm.assume(amount > 0 && amount < 100 ether);
372
+
373
+ vm.deal(alice, amount);
374
+ vm.prank(alice);
375
+ vault.deposit{value: amount}();
376
+
377
+ assertEq(vault.getBalance(alice), amount);
378
+ }
379
+
380
+ // Invariant testing
381
+ function invariant_totalBalanceMatchesContract() public {
382
+ assertEq(address(vault).balance, vault.totalDeposits());
383
+ }
384
+ }
385
+ ```
386
+
387
+ ## Security Auditing
388
+
389
+ **CRITICAL**: Run multiple security tools before deployment!
390
+
391
+ ### Static Analysis Tools
392
+
393
+ ```bash
394
+ # Slither (comprehensive)
395
+ slither . --exclude-optimization --exclude-informational
396
+
397
+ # Mythril (symbolic execution)
398
+ myth analyze contracts/MyContract.sol
399
+
400
+ # Manticore (symbolic execution)
401
+ manticore contracts/MyContract.sol
402
+
403
+ # Echidna (fuzzing)
404
+ echidna-test contracts/MyContract.sol --contract MyContract
405
+
406
+ # Solhint (linting with security rules)
407
+ solhint 'contracts/**/*.sol'
408
+ ```
409
+
410
+ ### Manual Review Checklist
411
+
412
+ - [ ] Reentrancy protection (ReentrancyGuard or Checks-Effects-Interactions)
413
+ - [ ] Integer overflow protection (use Solidity 0.8+)
414
+ - [ ] Access control (Ownable, AccessControl)
415
+ - [ ] Input validation (require statements)
416
+ - [ ] Gas optimization reviewed
417
+ - [ ] Event emissions for all state changes
418
+ - [ ] No use of tx.origin (use msg.sender)
419
+ - [ ] No use of block.timestamp for critical logic
420
+ - [ ] No delegatecall to untrusted contracts
421
+ - [ ] No selfdestruct in upgradeable contracts
422
+
423
+ ## Gas Optimization
424
+
425
+ ```solidity
426
+ // ✅ GOOD: Gas-optimized patterns
427
+ contract Optimized {
428
+ // Use immutable for constants set in constructor
429
+ address public immutable owner;
430
+
431
+ // Pack struct variables
432
+ struct User {
433
+ uint128 balance; // 16 bytes
434
+ uint64 lastUpdated; // 8 bytes
435
+ uint64 nonce; // 8 bytes
436
+ // Total: 32 bytes (1 storage slot)
437
+ }
438
+
439
+ // Cache storage variables
440
+ function processUsers(uint256[] calldata ids) external {
441
+ User storage user; // Declare once
442
+ for (uint256 i = 0; i < ids.length; i++) {
443
+ user = users[ids[i]]; // Cache
444
+ user.balance += 100;
445
+ }
446
+ }
447
+
448
+ // Use calldata for read-only arrays
449
+ function sum(uint256[] calldata numbers) external pure returns (uint256) {
450
+ uint256 total = 0;
451
+ for (uint256 i = 0; i < numbers.length; i++) {
452
+ total += numbers[i];
453
+ }
454
+ return total;
455
+ }
456
+ }
457
+
458
+ // ❌ BAD: Gas-inefficient
459
+ contract Inefficient {
460
+ address public owner; // Should be immutable!
461
+
462
+ struct User {
463
+ uint256 balance; // 32 bytes
464
+ uint256 lastUpdated; // 32 bytes
465
+ uint256 nonce; // 32 bytes
466
+ // Total: 96 bytes (3 storage slots!)
467
+ }
468
+
469
+ // Repeated storage access
470
+ function processUsers(uint256[] memory ids) external {
471
+ for (uint256 i = 0; i < ids.length; i++) {
472
+ users[ids[i]].balance += 100; // SLOAD every iteration!
473
+ }
474
+ }
475
+ }
476
+ ```
477
+
478
+ ## Best Practices
479
+
480
+ ### DO's ✅
481
+
482
+ - **USE** OpenZeppelin contracts for standard functionality
483
+ - **USE** ReentrancyGuard for functions with external calls
484
+ - **USE** SafeMath patterns or Solidity 0.8+ (automatic overflow checks)
485
+ - **EMIT** events for all state changes
486
+ - **VALIDATE** all inputs with require statements
487
+ - **TEST** with mainnet forks for realistic scenarios
488
+ - **OPTIMIZE** gas usage
489
+ - **DOCUMENT** all public functions with NatSpec
490
+
491
+ ### DON'Ts ❌
492
+
493
+ - **NEVER** use tx.origin for authorization
494
+ - **NEVER** use block.timestamp for critical randomness
495
+ - **NEVER** make external calls before state updates (reentrancy!)
496
+ - **NEVER** use delegatecall without extreme caution
497
+ - **NEVER** deploy without security audit
498
+ - **NEVER** use floating pragma (`pragma solidity ^0.8.0`)
499
+ - **NEVER** skip test coverage
500
+ - **NEVER** ignore Slither warnings
501
+
502
+ ## NatSpec Documentation
503
+
504
+ ```solidity
505
+ /// @title Secure Vault Contract
506
+ /// @author Your Name
507
+ /// @notice This contract allows users to deposit and withdraw ETH
508
+ /// @dev Uses ReentrancyGuard to prevent reentrancy attacks
509
+ contract SecureVault is ReentrancyGuard {
510
+
511
+ /// @notice Deposits ETH into the vault
512
+ /// @dev Emits Deposit event on success
513
+ /// @return success Boolean indicating if deposit was successful
514
+ function deposit() external payable returns (bool success) {
515
+ require(msg.value > 0, "Must deposit positive amount");
516
+ balances[msg.sender] += msg.value;
517
+ emit Deposit(msg.sender, msg.value);
518
+ return true;
519
+ }
520
+
521
+ /// @notice Withdraws ETH from the vault
522
+ /// @dev Uses Checks-Effects-Interactions pattern
523
+ /// @param amount The amount of ETH to withdraw
524
+ /// @custom:security Protected against reentrancy
525
+ function withdraw(uint256 amount) external nonReentrant {
526
+ require(amount > 0, "Amount must be positive");
527
+ require(balances[msg.sender] >= amount, "Insufficient balance");
528
+
529
+ balances[msg.sender] -= amount;
530
+ emit Withdrawal(msg.sender, amount);
531
+
532
+ (bool success, ) = msg.sender.call{value: amount}("");
533
+ require(success, "Transfer failed");
534
+ }
535
+ }
536
+ ```
537
+
538
+ ## CI/CD Requirements
539
+
540
+ Must include GitHub Actions workflows:
541
+
542
+ 1. **Testing** (`solidity-test.yml`):
543
+ - Run Hardhat/Foundry tests
544
+ - Fork testing against mainnet
545
+ - Coverage reporting (90%+ required)
546
+
547
+ 2. **Security** (`solidity-security.yml`):
548
+ - Slither static analysis
549
+ - Mythril symbolic execution
550
+ - Gas optimization check
551
+
552
+ 3. **Linting** (`solidity-lint.yml`):
553
+ - Solhint checks
554
+ - Prettier formatting
555
+ - Compile verification
556
+
557
+ ## Deployment Checklist
558
+
559
+ **CRITICAL**: Before mainnet deployment!
560
+
561
+ - [ ] All tests passing (100%)
562
+ - [ ] Coverage > 90%
563
+ - [ ] Slither audit clean
564
+ - [ ] Mythril audit clean
565
+ - [ ] External security audit completed
566
+ - [ ] Gas optimization reviewed
567
+ - [ ] All functions have NatSpec comments
568
+ - [ ] Deployed to testnet and verified
569
+ - [ ] Contract verified on Etherscan
570
+ - [ ] Multi-sig wallet setup for admin functions
571
+ - [ ] Emergency pause mechanism tested
572
+ - [ ] Upgrade path documented (if upgradeable)
573
+
574
+ ## Publishing to NPM (Hardhat)
575
+
576
+ ```bash
577
+ # 1. Run all quality checks
578
+ npm run lint
579
+ npm test
580
+ npx hardhat coverage
581
+
582
+ # 2. Update version
583
+ npm version minor
584
+
585
+ # 3. Publish
586
+ npm publish
587
+ ```
588
+
589
+ <!-- SOLIDITY:END -->
590
+