neverminedio/contracts-spree

Nevermined智能合约

💧 Nevermined的Solidity智能合约实现
nevermined.io

目录

• Nevermined智能合约
• 目录
  • 快速开始
    • Docker
    • 本地开发
  • 测试
    • 代码 linting
  • 网络
  • 包
  • 文档
  • 先前成果
  • 归属
  • 许可证

快速开始

nevermined-contracts的本地开发可通过Docker或在本地机器上搭建开发环境实现。

Docker

最简单的入门方式是使用https://github.com/nevermined-io/tools，这是一个Docker Compose应用，可运行整个Nevermined技术栈。

公共网络开发

在公共网络部署前，请先查看ReleaseProcess.md。

本地开发

前置依赖：

• Node.js
• yarn

克隆项目并安装所有依赖：

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

安装依赖：

bash
yarn

编译Solidity合约：

bash
yarn compile

在新终端中启动*** RPC客户端（如hardhat）：

bash
npx hardhat node --port 18545

返回原终端部署合约：

bash
yarn deploy:external

如需重新部署，运行：

bash
yarn clean
yarn compile
yarn deploy:external

升级合约[可选]：

bash
yarn upgrade:external

测试

使用yarn test运行测试，例如：

bash
yarn test test/unit/agreements/AgreementStoreManager.Test.js

代码 linting

已为JavaScript配置https://eslint.org，为Solidity配置https://github.com/duaraghav8/Ethlint进行代码检查。代码风格通过CI测试流程强制实施，存在linting错误时构建将失败。

bash
yarn lint

网络

当Nevermined合约部署到不同网络时，对应版本的ABI会复制到Artifacts仓库。有关详细信息，请参阅发布流程文档。

可在此浏览已部署的不同 artifacts：http://artifacts-nevermined-rocks.s3-website-us-east-1.amazonaws.com/
完整列表也可在此查看：[***]

包

为方便集成nevermined-contracts，提供了Python和JavaScript包，包含智能合约ABI。使用这些包可避免手动编译合约和复制ABI，使集成更简洁。

当前提供的包：

• JavaScript NPM包 - 作为https://www.npmjs.com/settings/nevermined-io/packages的一部分，https://www.npmjs.com/package/@nevermined-io/contracts提供ABI，可从`JavaScript`代码中导入。
• Python Pypi包 - https://pypi.org/project/nevermined-contracts/提供相同ABI，供`Python`使用。

包包含doc/和artifacts/文件夹的所有内容。

在JavaScript中使用示例：

安装nevermined-contracts npm包：

bash
npm install @nevermined-io/contracts

加载Rinkeby网络上NeverminedToken合约的ABI：

javascript
const NeverminedToken = require('@nevermined-io/contracts/artifacts/NeverminedToken.rinkeby.json')

artifacts结构：

json
{
  "abi": "...",
  "bytecode": "0x60806040523...",
  "address": "0x45DE141F8Efc355F1451a102FB6225F1EDd2921d",
  "version": "v0.9.1"
}

文档

• 合约文档
• 发布流程
• 库打包
• 合约升级
• 模板生命周期

先前成果

本项目基于以下开源项目构建：

• https://github.com/zeppelinos/zos
• https://github.com/OpenZeppelin/openzeppelin-eth

归属

本项目基于Ocean Protocol的https://github.com/oceanprotocol/keeper-contracts开发，保留相同的Apache v2许可证并增加了部分改进。详见NOTICE文件。

许可证

text
Copyright 2022 Nevermined AG
本产品包含BigchainDB GmbH和Ocean Protocol（[***]）开发的软件

根据Apache许可证2.0版（"许可证"）授权；除非符合许可证，否则不得使用本文件。您可以在以下位置获取许可证副本：

   http://www.apache.org/licenses/LICENSE-2.0

除非适用***要求或书面同意，否则根据许可证分发的软件按"原样"分发，不附带任何明示或暗示的担保或条件。有关许可证下权限和限制的具体语言，请参阅许可证。