neverminedio/geth-localnet

Nevermined智能合约镜像

概述

Nevermined智能合约镜像是基于Solidity实现的Nevermined智能合约开发环境，提供本地开发、编译、部署和测试的完整工具链。通过Docker可快速搭建Nevermined技术栈，支持开发者高效构建和测试基于Nevermined的去中心化应用（DApp）。

核心功能

• Docker快速部署：集成Nevermined Tools，通过Docker Compose一键启动包含geth节点、智能合约及配套组件的完整开发环境。
• 合约全生命周期支持：提供Solidity合约编译、部署、升级工具，支持本地测试节点（如Hardhat）和公共网络部署。
• 测试与质量保障：内置单元测试框架，支持JavaScript/TypeScript测试用例执行，集成ESLint和Ethlint实现代码风格与语法检查。
• 多网络适配：合约部署信息与Artifacts仓库同步，支持本地开发网络和公共***网络部署。

使用场景

• Nevermined智能合约的本地开发与调试。
• 智能合约公共网络部署前的功能验证与性能测试。
• 基于Nevermined协议的DApp开发过程中的合约交互测试。
• 智能合约代码质量自动化检查与持续集成流程构建。

使用方法

Docker快速启动

通过Nevermined Tools（Docker Compose应用）快速部署开发环境：

1. 克隆Nevermined Tools仓库：

   bash
   git clone https://github.com/nevermined-io/tools.git
   cd tools
   

2. 启动完整技术栈：

   bash
   docker-compose up -d
   

   该命令将自动部署geth节点、智能合约及Nevermined生态其他组件，适合快速上手开发。

本地开发环境配置

前置依赖

• Node.js
• yarn包管理器

环境搭建步骤

1. 克隆合约项目代码：

   bash
   git clone git@github.com:nevermined-io/contracts.git
   cd contracts/
   

2. 安装项目依赖：

   bash
   yarn
   

3. 编译Solidity合约：

   bash
   yarn compile
   

4. 启动本地***RPC节点（如Hardhat）：

   bash
   npx hardhat node --port 18545
   

5. 部署合约至本地节点：

   bash
   yarn deploy:external
   

6. 合约升级（可选）：

   bash
   yarn upgrade:external
   

7. 重新部署流程：

   bash
   yarn clean && yarn compile && yarn deploy:external
   

测试与质量检查

测试执行

运行指定测试文件或全量测试：

bash
# 执行单个测试文件
yarn test test/unit/agreements/AgreementStoreManager.Test.js

# 执行所有测试
yarn test

代码Linting

通过ESLint和Ethlint检查代码规范：

bash
yarn lint

注：代码风格检查为CI流程强制要求，存在lint错误将导致构建失败。

网络部署

• 本地测试网络：通过Hardhat节点部署，参考「本地开发环境配置」步骤。
• 公共*网络**：部署前需参考https://github.com/nevermined-io/contracts/blob/main/docs/ReleaseProcess.md%EF%BC%8C%E7%A1%AE%E4%BF%9D%E5%90%88%E7%BA%A6%E7%89%88%E6%9C%AC%E4%B8%8EArtifacts%E4%BB%93%E5%BA%93%E5%90%8C%E6%AD%A5%E3%80%82

文档资源

• https://github.com/nevermined-io/contracts/blob/main/doc/contracts/README.md
• https://github.com/nevermined-io/contracts/blob/main/doc/RELEASE_PROCESS.md
• https://github.com/nevermined-io/contracts/blob/main/doc/UPGRADES.md
• https://github.com/nevermined-io/contracts/blob/main/doc/TEMPLATE_LIFE_CYCLE.md

许可协议

本项目基于Apache License 2.0许可协议，详情参见https://github.com/nevermined-io/contracts/blob/main/LICENSE%E3%80%82