otherview/solgen

solgen ⚡

闪电般快速的Solidity合约Go绑定生成器。零依赖，极致简洁。

在几秒内从Solidity合约生成干净、类型安全的Go代码。生成的绑定中无外部依赖——仅包含可直接用于生产环境的纯Go代码。

✨ 核心功能

• 🚀 零依赖：生成的绑定完全独立，无需外部库
• 🎯 类型安全API：具有编译时安全的链式API
• 📦 每个合约一个包：隔离、干净的Go包结构
• ⚡ 生产就绪：内置ABI编码/解码，无外部依赖
• 🔧 方法重载：为重载函数提供智能命名
• ⚠️ 自定义错误：全面支持Solidity错误的类型安全解码
• 📊 事件日志：完整的结构化事件解析
• 🔄 流水线优先：读取solc输出，生成干净Go代码

💻 使用示例

干净、类型安全的绑定可与任何***客户端配合使用：

✨ 基础用法

go
import "yourproject/generated/simpletoken"

// 打包交易方法调用
transferData := simpletoken.Methods().TransferMethod().Pack(recipient, amount)
approveData := simpletoken.Methods().ApproveMethod().MustPack(spender, amount)

// 解码eth_call返回值  
balance := simpletoken.Methods().BalanceOfMethod().MustDecode(returnData)
success := simpletoken.Methods().TransferMethod().MustDecode(returnData)
tokenName := simpletoken.Methods().NameMethod().MustDecode(returnData)

📊 事件与错误处理

go
// 解码事件日志
transferEvent := simpletoken.Events().TransferEvent().MustDecode(logData)
fmt.Printf("转账: %s 到 %s，金额: %s ETH\n", 
    transferEvent.From, transferEvent.To, weiToEth(transferEvent.Value))

// 处理回滚交易的自定义错误  
if revertData != nil {
    error := simpletoken.Errors().InsufficientBalanceError().MustDecode(revertData)
    fmt.Printf("错误: 余额不足 - 请求 %s，可用 %s\n",
        weiToEth(error.Requested), weiToEth(error.Available))
}

🌐 ***集成

go
import "github.com/ethereum/go-ethereum/ethclient"

// 与ethclient或任何以太坊库无缝协作
client, _ := ethclient.Dial("https://mainnet.infura.io/v3/YOUR_PROJECT_ID")
contractAddr := common.HexToAddress("0x...")

// 读取合约状态
callData := simpletoken.Methods().BalanceOfMethod().MustPack(userAddress)
result, _ := client.CallContract(ctx, ethereum.CallMsg{
    To: &contractAddr, Data: callData.Bytes(),
}, nil)
balance := simpletoken.Methods().BalanceOfMethod().MustDecode(result)

// 发送交易  
tx := types.NewTransaction(nonce, contractAddr, big.NewInt(0), gasLimit, gasPrice, 
    simpletoken.Methods().TransferMethod().MustPack(recipient, amount).Bytes())

🔗 零依赖

生成的绑定完全独立：

go
// 生成代码中无需外部导入！
type Address [20]byte  // 自定义地址类型
type Hash [32]byte     // 自定义哈希类型  
type HexData string    // 便捷的十六进制处理

// 内置ABI编码/解码
// 类型安全方法调用
// 干净的错误处理

🚀 完整示例 - 查看带详细注释的完整工作示例，展示所有功能的实际应用！

🚀 快速开始

bash
# Docker（推荐）
docker pull docker.xuanyuan.run/otherview/solgen

# 或本地安装
go install github.com/otherview/solgen/cmd/solgen@latest

⚠️ Docker镜像更新：官方Solidity编译器Docker镜像已从ethereum/solc（已弃用）迁移至ghcr.io/argotorg/solc。以下所有示例使用新官方镜像。

⚡ 一行命令

bash
# 标准：合约信息 + 字节码（推荐）
solc --combined-json abi,bin,bin-runtime,hashes contracts/*.sol | \
  solgen --out generated

# 最小化：仅合约信息（无字节码功能）
solc --combined-json abi,hashes contracts/*.sol | \
  solgen --out generated

🐳 Docker流水线

bash
# 最新稳定版（开发推荐）
sh -c "docker run --rm -v $(pwd):/src ghcr.io/argotorg/solc:stable \
  --combined-json abi,bin,bin-runtime,hashes \
  --optimize /src/contracts/*.sol | \
  docker run --rm -i -v $(pwd):/src docker.xuanyuan.run/otherview/solgen --out /src/generated"

# 固定版本（生产推荐）
sh -c "docker run --rm -v $(pwd):/src ghcr.io/argotorg/solc:0.8.20 \
  --combined-json abi,bin,bin-runtime,hashes \
  --optimize /src/contracts/*.sol | \
  docker run --rm -i -v $(pwd):/src docker.xuanyuan.run/otherview/solgen --out /src/generated"

🔄 go:generate集成

go
// 使用稳定版
//go:generate sh -c "docker run --rm -v $(pwd):/src ghcr.io/argotorg/solc:stable --combined-json abi,bin,bin-runtime,hashes /src/contracts/*.sol | docker run --rm -i -v $(pwd):/src otherview/solgen --out /src/generated"

// 或使用本地solc安装
//go:generate sh -c "solc --combined-json abi,bin,bin-runtime,hashes contracts/*.sol | solgen --out generated"

📚 更多示例：查看EXAMPLES.md获取高级用法、CI/CD集成及平台特定示例

⚙️ 选项

solgen

• --out（必填）：输出目录
• --verbose：详细输出

solc（必填字段）

• 🎯 最小化：--combined-json abi,hashes（仅合约信息）
• ⚡ 标准：--combined-json abi,bin,bin-runtime,hashes（+字节码功能）
• 🔧 选项：--optimize、--optimize-runs 200

Docker镜像

• ✅ 当前：ghcr.io/argotorg/solc:stable（最新）或ghcr.io/argotorg/solc:0.8.20（固定）
• ❌ 已弃用：ethereum/solc:0.8.20（仍可工作但不推荐）

📁 生成代码

每个合约对应一个干净的Go包：

generated/
  mycontract/
    mycontract.go    # 干净、无依赖的绑定

🔄 类型映射

📋 要求

• Docker：用于ghcr.io/argotorg/solc + otherview/solgen容器
• 本地：Go 1.21+ 和 solc二进制文件

🔄 从***/solc迁移

如果您当前使用已弃用的ethereum/solc镜像：

bash
# 旧版（已弃用）
docker run --rm docker.xuanyuan.run/ethereum/solc:0.8.20 --combined-json abi,bin,bin-runtime,hashes

# 新版（推荐）
docker run --rm ***-ghcr.xuanyuan.run/argotorg/solc:0.8.20 --combined-json abi,bin,bin-runtime,hashes
# 或
docker run --rm ***-ghcr.xuanyuan.run/argotorg/solc:stable --combined-json abi,bin,bin-runtime,hashes

功能完全相同——只需替换镜像名称。

🛠️ 开发

bash
# 运行测试
go test ./...

# 从源码构建  
go build ./cmd/solgen

📄 许可证

MIT许可证 - 查看LICENSE文件。

🤝 贡献

1. Fork项目
2. 创建特性分支
3. 添加测试
4. 提交Pull Request

🔧 故障排除

流水线失败？ 使用--verbose分别测试solc和solgen
Docker权限问题？ 使用--user $(id -u):$(id -g)或生成后执行chown
包冲突？ 重命名合约——包名源自合约名（仅小写字母和数字）

🔍 详细故障排除：查看EXAMPLES.md获取分步调试、平台特定问题及高级解决方案