rutts-cred commited on
Commit
a0e0e88
·
1 Parent(s): 4a84f42

Update LICENSE

Browse files
Files changed (2) hide show
  1. LICENSE +21 -1
  2. README.md +34 -2
LICENSE CHANGED
@@ -1 +1,21 @@
1
- MIT
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ MIT License
2
+
3
+ Copyright (c) 2025 credshields/Solidity-CodeGen-v0.1
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
README.md CHANGED
@@ -12,13 +12,45 @@ tags:
12
  - credshields
13
  ---
14
  # Solidity-CodeGen-v0.1
15
-
16
  Solidity-CodeGen-v0.1 is a fine-tuned LLM specialized for generating Solidity smart contracts with modern OpenZeppelin patterns. It works best when paired with the OpenZeppelin Contracts MCP (Model Context Protocol) to produce canonical ERC and Governor implementations.
17
 
18
  - Base: Qwen3 (tuned for Solidity codegen)
19
  - Context length: Served via vLLM (up to 32k with server)
20
  - Recommended: Use with OpenZeppelin MCP locally for highest-quality results
21
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
22
  ## How to Load
23
  Transformers:
24
  ```
@@ -78,4 +110,4 @@ No burn, no pause, no permit
78
  - Generated code: user responsibility; OpenZeppelin Contracts are MIT-licensed.
79
 
80
  ## Note
81
- Note: This preview focuses on tailored scaffolds for common patterns and may omit end‑to‑end features; treat outputs as starting points to be completed, validated, and audited.
 
12
  - credshields
13
  ---
14
  # Solidity-CodeGen-v0.1
 
15
  Solidity-CodeGen-v0.1 is a fine-tuned LLM specialized for generating Solidity smart contracts with modern OpenZeppelin patterns. It works best when paired with the OpenZeppelin Contracts MCP (Model Context Protocol) to produce canonical ERC and Governor implementations.
16
 
17
  - Base: Qwen3 (tuned for Solidity codegen)
18
  - Context length: Served via vLLM (up to 32k with server)
19
  - Recommended: Use with OpenZeppelin MCP locally for highest-quality results
20
 
21
+ ## Why Solidity-CodeGen-v0.1?
22
+
23
+ Traditional LLMs often produce generic code that may contain security vulnerabilities or deviate from best practices. Solidity-CodeGen-v0.1 is different—it's a domain-expert model trained specifically for smart contract development. Instead of generating random code snippets, it creates structured templates using OpenZeppelin-compliant logic and predictable design patterns when paired with OpenZeppelin MCP.
24
+
25
+ Every generated contract follows OZ v5 conventions, ensuring:
26
+ - **Canonical ERC implementations** (ERC20, ERC721, ERC1155)
27
+ - **Consistent inheritance patterns**
28
+ - **Reproducible function behavior**
29
+ - **Built-in security considerations**
30
+
31
+ <p align="center">
32
+ <a href="https://solidityscan.com/" target="_blank">
33
+ <img src="https://cdn-uploads.huggingface.co/production/uploads/685934bed73d6881647be295/CL6wjrU6gKYv3_Itc4iAO.png" alt="SolidityScan CredShields Banner" width="75%">
34
+ </a>
35
+ </p>
36
+
37
+ The model is inspired by [SolidityScan's Web3HackHub](https://solidityscan.com/web3hackhub)—a comprehensive database tracking blockchain security incidents since 2011—and **[OWASP Smart Contract Top 10](https://scs.owasp.org/sctop10/)**.
38
+ The OWASP Smart Contract Security Project plays a critical role in shaping secure development practices across the Web3 ecosystem. It serves as a foundational framework that educates developers on the most prevalent and high-impact vulnerabilities affecting smart contracts.
39
+ The model adheres to OpenZeppelin-compliant patterns and aims to align with OWASP best practices.
40
+
41
+ ## Complete Security Workflow
42
+
43
+ While Solidity-CodeGen-v0.1 generates secure code foundations, comprehensive security requires additional validation. [SolidityScan](https://solidityscan.com) provides the perfect complement—an AI-powered smart contract scanner that identifies vulnerabilities and security risks in your code.
44
+
45
+ **Together, they create a complete security pipeline:**
46
+ 1. **Generate** contract templates with Solidity-CodeGen-v0.1
47
+ 2. **Scan** for vulnerabilities with SolidityScan's advanced analysis
48
+ 3. **Deploy** with confidence, knowing your contracts meet industry standards
49
+
50
+ [Explore SolidityScan](https://solidityscan.com) to discover how AI-powered scanning can enhance your smart contract security workflow.
51
+
52
+ ---
53
+
54
  ## How to Load
55
  Transformers:
56
  ```
 
110
  - Generated code: user responsibility; OpenZeppelin Contracts are MIT-licensed.
111
 
112
  ## Note
113
+ Note: This preview focuses on tailored scaffolds for common patterns and may omit end‑to‑end features; treat outputs as starting points to be completed, validated, and audited and hence Solidity-CodeGen-v0.1 is not a substitute for human review, formal verification, or security audits.