@hivehub/rulebook 5.1.3 → 5.2.0

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 (374) 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-decision-create.md +55 -55
  9. package/.claude/commands/rulebook-decision-list.md +15 -15
  10. package/.claude/commands/rulebook-knowledge-add.md +41 -41
  11. package/.claude/commands/rulebook-knowledge-list.md +15 -15
  12. package/.claude/commands/rulebook-learn-capture.md +48 -48
  13. package/.claude/commands/rulebook-learn-list.md +13 -13
  14. package/.claude/commands/rulebook-memory-save.md +48 -48
  15. package/.claude/commands/rulebook-memory-search.md +47 -47
  16. package/.claude/commands/rulebook-task-apply.md +85 -67
  17. package/.claude/commands/rulebook-task-archive.md +103 -94
  18. package/.claude/commands/rulebook-task-create.md +93 -93
  19. package/.claude/commands/rulebook-task-list.md +42 -42
  20. package/.claude/commands/rulebook-task-show.md +52 -52
  21. package/.claude/commands/rulebook-task-validate.md +53 -53
  22. package/.claude-plugin/marketplace.json +28 -28
  23. package/.claude-plugin/plugin.json +8 -8
  24. package/README.md +25 -43
  25. package/dist/cli/commands.d.ts.map +1 -1
  26. package/dist/cli/commands.js +11 -0
  27. package/dist/cli/commands.js.map +1 -1
  28. package/dist/core/agent-template-engine.js +28 -28
  29. package/dist/core/generator.js +28 -28
  30. package/dist/core/task-manager.d.ts +23 -0
  31. package/dist/core/task-manager.d.ts.map +1 -1
  32. package/dist/core/task-manager.js +161 -27
  33. package/dist/core/task-manager.js.map +1 -1
  34. package/dist/index.js +0 -0
  35. package/dist/mcp/rulebook-server.js +3 -3
  36. package/dist/mcp/rulebook-server.js.map +1 -1
  37. package/dist/memory/memory-store.js +91 -91
  38. package/package.json +21 -22
  39. package/templates/agents/accessibility-reviewer.md +43 -43
  40. package/templates/agents/api-designer.md +42 -42
  41. package/templates/agents/architect.md +51 -51
  42. package/templates/agents/build-engineer.md +36 -36
  43. package/templates/agents/code-reviewer.md +47 -47
  44. package/templates/agents/compiler/codegen-debugger.md +34 -34
  45. package/templates/agents/compiler/stdlib-engineer.md +28 -28
  46. package/templates/agents/compiler/test-coverage-guardian.md +31 -31
  47. package/templates/agents/context-intelligence.md +52 -52
  48. package/templates/agents/database-architect.md +41 -41
  49. package/templates/agents/devops-engineer.md +42 -42
  50. package/templates/agents/docs-writer.md +38 -38
  51. package/templates/agents/game-engine/cpp-core-expert.md +35 -35
  52. package/templates/agents/game-engine/render-engineer.md +22 -22
  53. package/templates/agents/game-engine/shader-engineer.md +38 -38
  54. package/templates/agents/game-engine/systems-integration.md +43 -43
  55. package/templates/agents/generic/code-reviewer.md +41 -41
  56. package/templates/agents/generic/docs-writer.md +25 -25
  57. package/templates/agents/generic/project-manager.md +36 -36
  58. package/templates/agents/generic/researcher.md +34 -34
  59. package/templates/agents/generic/test-engineer.md +41 -41
  60. package/templates/agents/i18n-engineer.md +42 -42
  61. package/templates/agents/implementer.md +42 -42
  62. package/templates/agents/migration-engineer.md +42 -42
  63. package/templates/agents/mobile/platform-specialist.md +22 -22
  64. package/templates/agents/mobile/ui-engineer.md +22 -22
  65. package/templates/agents/performance-engineer.md +49 -49
  66. package/templates/agents/refactoring-agent.md +41 -41
  67. package/templates/agents/researcher.md +38 -38
  68. package/templates/agents/security-reviewer.md +40 -40
  69. package/templates/agents/team-lead.md +37 -37
  70. package/templates/agents/tester.md +48 -48
  71. package/templates/agents/ux-reviewer.md +43 -43
  72. package/templates/agents/web-app/api-designer.md +22 -22
  73. package/templates/agents/web-app/backend-engineer.md +30 -30
  74. package/templates/agents/web-app/database-engineer.md +22 -22
  75. package/templates/agents/web-app/frontend-engineer.md +29 -29
  76. package/templates/agents/web-app/security-reviewer.md +32 -32
  77. package/templates/ci/rulebook-review.yml +26 -26
  78. package/templates/cli/AIDER.md +49 -49
  79. package/templates/cli/AMAZON_Q.md +25 -25
  80. package/templates/cli/AUGGIE.md +32 -32
  81. package/templates/cli/CLAUDE.md +117 -117
  82. package/templates/cli/CLINE.md +99 -99
  83. package/templates/cli/CODEBUDDY.md +20 -20
  84. package/templates/cli/CODEIUM.md +20 -20
  85. package/templates/cli/CODEX.md +21 -21
  86. package/templates/cli/CONTINUE.md +34 -34
  87. package/templates/cli/CURSOR_CLI.md +62 -62
  88. package/templates/cli/FACTORY.md +18 -18
  89. package/templates/cli/GEMINI.md +35 -35
  90. package/templates/cli/KILOCODE.md +18 -18
  91. package/templates/cli/OPENCODE.md +18 -18
  92. package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
  93. package/templates/commands/rulebook-decision-create.md +55 -55
  94. package/templates/commands/rulebook-decision-list.md +15 -15
  95. package/templates/commands/rulebook-knowledge-add.md +41 -41
  96. package/templates/commands/rulebook-knowledge-list.md +15 -15
  97. package/templates/commands/rulebook-learn-capture.md +48 -48
  98. package/templates/commands/rulebook-learn-list.md +13 -13
  99. package/templates/commands/rulebook-memory-save.md +48 -48
  100. package/templates/commands/rulebook-memory-search.md +47 -47
  101. package/templates/commands/rulebook-task-apply.md +67 -67
  102. package/templates/commands/rulebook-task-archive.md +94 -94
  103. package/templates/commands/rulebook-task-create.md +93 -93
  104. package/templates/commands/rulebook-task-list.md +42 -42
  105. package/templates/commands/rulebook-task-show.md +52 -52
  106. package/templates/commands/rulebook-task-validate.md +53 -53
  107. package/templates/core/AGENTS_LEAN.md +25 -25
  108. package/templates/core/AGENTS_OVERRIDE.md +16 -16
  109. package/templates/core/AGENT_AUTOMATION.md +296 -296
  110. package/templates/core/DAG.md +304 -304
  111. package/templates/core/DECISIONS.md +38 -38
  112. package/templates/core/DOCUMENTATION_RULES.md +36 -36
  113. package/templates/core/KNOWLEDGE.md +49 -49
  114. package/templates/core/MULTI_AGENT.md +74 -74
  115. package/templates/core/PLANS.md +28 -28
  116. package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
  117. package/templates/core/RALPH.md +471 -471
  118. package/templates/core/RULEBOOK.md +1947 -1947
  119. package/templates/core/TIER1_PROHIBITIONS.md +154 -154
  120. package/templates/core/TOKEN_OPTIMIZATION.md +49 -49
  121. package/templates/frameworks/ANGULAR.md +36 -36
  122. package/templates/frameworks/DJANGO.md +83 -83
  123. package/templates/frameworks/ELECTRON.md +147 -147
  124. package/templates/frameworks/FLASK.md +38 -38
  125. package/templates/frameworks/FLUTTER.md +55 -55
  126. package/templates/frameworks/JQUERY.md +32 -32
  127. package/templates/frameworks/LARAVEL.md +38 -38
  128. package/templates/frameworks/NESTJS.md +43 -43
  129. package/templates/frameworks/NEXTJS.md +127 -127
  130. package/templates/frameworks/NUXT.md +40 -40
  131. package/templates/frameworks/RAILS.md +66 -66
  132. package/templates/frameworks/REACT.md +38 -38
  133. package/templates/frameworks/REACT_NATIVE.md +47 -47
  134. package/templates/frameworks/SPRING.md +39 -39
  135. package/templates/frameworks/SYMFONY.md +36 -36
  136. package/templates/frameworks/VUE.md +36 -36
  137. package/templates/frameworks/ZEND.md +35 -35
  138. package/templates/git/CI_CD_PATTERNS.md +661 -661
  139. package/templates/git/GITHUB_ACTIONS.md +728 -728
  140. package/templates/git/GITLAB_CI.md +730 -730
  141. package/templates/git/GIT_WORKFLOW.md +1192 -1192
  142. package/templates/git/SECRETS_MANAGEMENT.md +585 -585
  143. package/templates/hooks/COMMIT_MSG.md +530 -530
  144. package/templates/hooks/POST_CHECKOUT.md +546 -546
  145. package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
  146. package/templates/hooks/PRE_COMMIT.md +414 -414
  147. package/templates/hooks/PRE_PUSH.md +601 -601
  148. package/templates/ides/CONTINUE_RULES.md +16 -16
  149. package/templates/ides/COPILOT.md +37 -37
  150. package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
  151. package/templates/ides/CURSOR.md +43 -43
  152. package/templates/ides/GEMINI_RULES.md +17 -17
  153. package/templates/ides/JETBRAINS_AI.md +35 -35
  154. package/templates/ides/REPLIT.md +36 -36
  155. package/templates/ides/TABNINE.md +29 -29
  156. package/templates/ides/VSCODE.md +40 -40
  157. package/templates/ides/WINDSURF.md +36 -36
  158. package/templates/ides/WINDSURF_RULES.md +14 -14
  159. package/templates/ides/ZED.md +32 -32
  160. package/templates/ides/cursor-mdc/go.mdc +24 -24
  161. package/templates/ides/cursor-mdc/python.mdc +24 -24
  162. package/templates/ides/cursor-mdc/quality.mdc +25 -25
  163. package/templates/ides/cursor-mdc/ralph.mdc +39 -39
  164. package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
  165. package/templates/ides/cursor-mdc/rust.mdc +24 -24
  166. package/templates/ides/cursor-mdc/typescript.mdc +25 -25
  167. package/templates/languages/C.md +333 -333
  168. package/templates/languages/CPP.md +743 -743
  169. package/templates/languages/CSHARP.md +417 -417
  170. package/templates/languages/ELIXIR.md +454 -454
  171. package/templates/languages/ERLANG.md +361 -361
  172. package/templates/languages/GO.md +645 -645
  173. package/templates/languages/HASKELL.md +177 -177
  174. package/templates/languages/JAVA.md +607 -607
  175. package/templates/languages/JAVASCRIPT.md +631 -631
  176. package/templates/languages/JULIA.md +97 -97
  177. package/templates/languages/KOTLIN.md +511 -511
  178. package/templates/languages/LISP.md +100 -100
  179. package/templates/languages/LUA.md +74 -74
  180. package/templates/languages/OBJECTIVEC.md +90 -90
  181. package/templates/languages/PHP.md +416 -416
  182. package/templates/languages/PYTHON.md +682 -682
  183. package/templates/languages/RUBY.md +421 -421
  184. package/templates/languages/RUST.md +477 -477
  185. package/templates/languages/SAS.md +73 -73
  186. package/templates/languages/SCALA.md +348 -348
  187. package/templates/languages/SOLIDITY.md +580 -580
  188. package/templates/languages/SQL.md +137 -137
  189. package/templates/languages/SWIFT.md +466 -466
  190. package/templates/languages/TYPESCRIPT.md +591 -591
  191. package/templates/languages/ZIG.md +265 -265
  192. package/templates/modules/ATLASSIAN.md +255 -255
  193. package/templates/modules/CONTEXT7.md +54 -54
  194. package/templates/modules/FIGMA.md +267 -267
  195. package/templates/modules/GITHUB_MCP.md +64 -64
  196. package/templates/modules/GRAFANA.md +328 -328
  197. package/templates/modules/MEMORY.md +126 -126
  198. package/templates/modules/NOTION.md +247 -247
  199. package/templates/modules/PLAYWRIGHT.md +90 -90
  200. package/templates/modules/RULEBOOK_MCP.md +156 -156
  201. package/templates/modules/SERENA.md +337 -337
  202. package/templates/modules/SUPABASE.md +223 -223
  203. package/templates/modules/SYNAP.md +69 -69
  204. package/templates/modules/VECTORIZER.md +63 -63
  205. package/templates/modules/sequential-thinking.md +42 -42
  206. package/templates/ralph/ralph-history.bat +4 -4
  207. package/templates/ralph/ralph-history.sh +5 -5
  208. package/templates/ralph/ralph-init.bat +5 -5
  209. package/templates/ralph/ralph-init.sh +5 -5
  210. package/templates/ralph/ralph-pause.bat +5 -5
  211. package/templates/ralph/ralph-pause.sh +5 -5
  212. package/templates/ralph/ralph-run.bat +5 -5
  213. package/templates/ralph/ralph-run.sh +5 -5
  214. package/templates/ralph/ralph-status.bat +4 -4
  215. package/templates/ralph/ralph-status.sh +5 -5
  216. package/templates/rules/follow-task-sequence.md +36 -36
  217. package/templates/rules/git-safety.md +29 -29
  218. package/templates/rules/incremental-tests.md +29 -29
  219. package/templates/rules/knowledge-base-usage.md +41 -0
  220. package/templates/rules/no-deferred.md +31 -31
  221. package/templates/rules/no-shortcuts.md +30 -30
  222. package/templates/rules/research-first.md +30 -30
  223. package/templates/rules/sequential-editing.md +21 -21
  224. package/templates/rules/session-workflow.md +24 -24
  225. package/templates/rules/task-decomposition.md +32 -32
  226. package/templates/services/AZURE_BLOB.md +184 -184
  227. package/templates/services/CASSANDRA.md +239 -239
  228. package/templates/services/DATADOG.md +26 -26
  229. package/templates/services/DOCKER.md +124 -124
  230. package/templates/services/DOCKER_COMPOSE.md +168 -168
  231. package/templates/services/DYNAMODB.md +308 -308
  232. package/templates/services/ELASTICSEARCH.md +347 -347
  233. package/templates/services/GCS.md +178 -178
  234. package/templates/services/HELM.md +194 -194
  235. package/templates/services/INFLUXDB.md +265 -265
  236. package/templates/services/KAFKA.md +341 -341
  237. package/templates/services/KUBERNETES.md +208 -208
  238. package/templates/services/MARIADB.md +183 -183
  239. package/templates/services/MEMCACHED.md +242 -242
  240. package/templates/services/MINIO.md +201 -201
  241. package/templates/services/MONGODB.md +268 -268
  242. package/templates/services/MYSQL.md +358 -358
  243. package/templates/services/NEO4J.md +247 -247
  244. package/templates/services/OPENTELEMETRY.md +25 -25
  245. package/templates/services/ORACLE.md +290 -290
  246. package/templates/services/PINO.md +24 -24
  247. package/templates/services/POSTGRESQL.md +326 -326
  248. package/templates/services/PROMETHEUS.md +33 -33
  249. package/templates/services/RABBITMQ.md +286 -286
  250. package/templates/services/REDIS.md +292 -292
  251. package/templates/services/S3.md +298 -298
  252. package/templates/services/SENTRY.md +23 -23
  253. package/templates/services/SQLITE.md +294 -294
  254. package/templates/services/SQLSERVER.md +294 -294
  255. package/templates/services/WINSTON.md +30 -30
  256. package/templates/skills/cli/aider/SKILL.md +59 -59
  257. package/templates/skills/cli/amazon-q/SKILL.md +35 -35
  258. package/templates/skills/cli/auggie/SKILL.md +42 -42
  259. package/templates/skills/cli/claude/SKILL.md +42 -42
  260. package/templates/skills/cli/cline/SKILL.md +42 -42
  261. package/templates/skills/cli/codebuddy/SKILL.md +30 -30
  262. package/templates/skills/cli/codeium/SKILL.md +30 -30
  263. package/templates/skills/cli/codex/SKILL.md +31 -31
  264. package/templates/skills/cli/continue/SKILL.md +44 -44
  265. package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
  266. package/templates/skills/cli/factory/SKILL.md +28 -28
  267. package/templates/skills/cli/gemini/SKILL.md +45 -45
  268. package/templates/skills/cli/kilocode/SKILL.md +28 -28
  269. package/templates/skills/cli/opencode/SKILL.md +28 -28
  270. package/templates/skills/core/agent-automation/SKILL.md +194 -194
  271. package/templates/skills/core/dag/SKILL.md +314 -314
  272. package/templates/skills/core/documentation-rules/SKILL.md +46 -46
  273. package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
  274. package/templates/skills/core/rulebook/SKILL.md +176 -176
  275. package/templates/skills/dev/accessibility/SKILL.md +17 -17
  276. package/templates/skills/dev/api-design/SKILL.md +15 -15
  277. package/templates/skills/dev/architect/SKILL.md +17 -17
  278. package/templates/skills/dev/build-fix/SKILL.md +17 -17
  279. package/templates/skills/dev/db-design/SKILL.md +15 -15
  280. package/templates/skills/dev/debug/SKILL.md +16 -16
  281. package/templates/skills/dev/deploy/SKILL.md +17 -17
  282. package/templates/skills/dev/docs/SKILL.md +17 -17
  283. package/templates/skills/dev/migrate/SKILL.md +15 -15
  284. package/templates/skills/dev/perf/SKILL.md +17 -17
  285. package/templates/skills/dev/refactor/SKILL.md +17 -17
  286. package/templates/skills/dev/research/SKILL.md +14 -14
  287. package/templates/skills/dev/review/SKILL.md +18 -18
  288. package/templates/skills/dev/security-audit/SKILL.md +17 -17
  289. package/templates/skills/frameworks/angular/SKILL.md +46 -46
  290. package/templates/skills/frameworks/django/SKILL.md +93 -93
  291. package/templates/skills/frameworks/electron/SKILL.md +157 -157
  292. package/templates/skills/frameworks/flask/SKILL.md +48 -48
  293. package/templates/skills/frameworks/flutter/SKILL.md +65 -65
  294. package/templates/skills/frameworks/jquery/SKILL.md +42 -42
  295. package/templates/skills/frameworks/laravel/SKILL.md +48 -48
  296. package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
  297. package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
  298. package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
  299. package/templates/skills/frameworks/rails/SKILL.md +76 -76
  300. package/templates/skills/frameworks/react/SKILL.md +48 -48
  301. package/templates/skills/frameworks/react-native/SKILL.md +57 -57
  302. package/templates/skills/frameworks/spring/SKILL.md +49 -49
  303. package/templates/skills/frameworks/symfony/SKILL.md +46 -46
  304. package/templates/skills/frameworks/vue/SKILL.md +46 -46
  305. package/templates/skills/frameworks/zend/SKILL.md +45 -45
  306. package/templates/skills/ides/copilot/SKILL.md +47 -47
  307. package/templates/skills/ides/cursor/SKILL.md +53 -53
  308. package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
  309. package/templates/skills/ides/replit/SKILL.md +46 -46
  310. package/templates/skills/ides/tabnine/SKILL.md +39 -39
  311. package/templates/skills/ides/vscode/SKILL.md +50 -50
  312. package/templates/skills/ides/windsurf/SKILL.md +46 -46
  313. package/templates/skills/ides/zed/SKILL.md +42 -42
  314. package/templates/skills/languages/c/SKILL.md +343 -343
  315. package/templates/skills/languages/cpp/SKILL.md +753 -753
  316. package/templates/skills/languages/csharp/SKILL.md +427 -427
  317. package/templates/skills/languages/elixir/SKILL.md +464 -464
  318. package/templates/skills/languages/erlang/SKILL.md +371 -371
  319. package/templates/skills/languages/go/SKILL.md +655 -655
  320. package/templates/skills/languages/haskell/SKILL.md +187 -187
  321. package/templates/skills/languages/java/SKILL.md +617 -617
  322. package/templates/skills/languages/javascript/SKILL.md +641 -641
  323. package/templates/skills/languages/julia/SKILL.md +107 -107
  324. package/templates/skills/languages/kotlin/SKILL.md +521 -521
  325. package/templates/skills/languages/lisp/SKILL.md +110 -110
  326. package/templates/skills/languages/lua/SKILL.md +84 -84
  327. package/templates/skills/languages/objectivec/SKILL.md +100 -100
  328. package/templates/skills/languages/php/SKILL.md +426 -426
  329. package/templates/skills/languages/python/SKILL.md +692 -692
  330. package/templates/skills/languages/ruby/SKILL.md +431 -431
  331. package/templates/skills/languages/rust/SKILL.md +487 -487
  332. package/templates/skills/languages/sas/SKILL.md +83 -83
  333. package/templates/skills/languages/scala/SKILL.md +358 -358
  334. package/templates/skills/languages/solidity/SKILL.md +590 -590
  335. package/templates/skills/languages/sql/SKILL.md +147 -147
  336. package/templates/skills/languages/swift/SKILL.md +476 -476
  337. package/templates/skills/languages/typescript/SKILL.md +302 -302
  338. package/templates/skills/languages/zig/SKILL.md +275 -275
  339. package/templates/skills/modules/atlassian/SKILL.md +265 -265
  340. package/templates/skills/modules/context7/SKILL.md +64 -64
  341. package/templates/skills/modules/figma/SKILL.md +277 -277
  342. package/templates/skills/modules/github-mcp/SKILL.md +74 -74
  343. package/templates/skills/modules/grafana/SKILL.md +338 -338
  344. package/templates/skills/modules/memory/SKILL.md +73 -73
  345. package/templates/skills/modules/notion/SKILL.md +257 -257
  346. package/templates/skills/modules/playwright/SKILL.md +100 -100
  347. package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
  348. package/templates/skills/modules/serena/SKILL.md +347 -347
  349. package/templates/skills/modules/supabase/SKILL.md +233 -233
  350. package/templates/skills/modules/synap/SKILL.md +79 -79
  351. package/templates/skills/modules/vectorizer/SKILL.md +73 -73
  352. package/templates/skills/services/azure-blob/SKILL.md +194 -194
  353. package/templates/skills/services/cassandra/SKILL.md +249 -249
  354. package/templates/skills/services/dynamodb/SKILL.md +318 -318
  355. package/templates/skills/services/elasticsearch/SKILL.md +357 -357
  356. package/templates/skills/services/gcs/SKILL.md +188 -188
  357. package/templates/skills/services/influxdb/SKILL.md +275 -275
  358. package/templates/skills/services/kafka/SKILL.md +351 -351
  359. package/templates/skills/services/mariadb/SKILL.md +193 -193
  360. package/templates/skills/services/memcached/SKILL.md +252 -252
  361. package/templates/skills/services/minio/SKILL.md +211 -211
  362. package/templates/skills/services/mongodb/SKILL.md +278 -278
  363. package/templates/skills/services/mysql/SKILL.md +368 -368
  364. package/templates/skills/services/neo4j/SKILL.md +257 -257
  365. package/templates/skills/services/oracle/SKILL.md +300 -300
  366. package/templates/skills/services/postgresql/SKILL.md +336 -336
  367. package/templates/skills/services/rabbitmq/SKILL.md +296 -296
  368. package/templates/skills/services/redis/SKILL.md +302 -302
  369. package/templates/skills/services/s3/SKILL.md +308 -308
  370. package/templates/skills/services/sqlite/SKILL.md +304 -304
  371. package/templates/skills/services/sqlserver/SKILL.md +304 -304
  372. package/templates/skills/workflows/ralph/SKILL.md +309 -309
  373. package/templates/skills/workflows/ralph/install.sh +87 -87
  374. 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
+