nevermined-contracts 1.0.0rc1

Smart Contracts for Nevermined Data platform

Nevermined Smart Contracts

💧 Smart Contracts implementation of Nevermined in Solidity nevermined.io

Table of Contents

• Nevermined Smart Contracts
  • Table of Contents
  • Get Started
    • Docker
    • Local development
  • Testing
    • Code Linting
  • Networks
    • Testnets
      • Integration Testnet
      • Staging Testnet
    • Mainnets
    • Production Mainnet
  • Packages
  • Documentation
  • Prior Art
  • Attribution
  • License

---

Get Started

For local development of nevermined-contracts you can either use Docker, or setup the development environment on your machine.

Docker

The simplest way to get started with is using the Nevermined Tools, a docker compose application to run all the Nevermined stack.

Local development

As a pre-requisite, you need:

• Node.js
• yarn

Note: For MacOS, make sure to have node@10 installed.

Clone the project and install all dependencies:

git clone [e-mail]:nevermined-io/contracts.git
cd nevermined-contracts/

Install dependencies:

yarn

Compile the solidity contracts:

yarn compile

In a new terminal, launch an Ethereum RPC client, e.g. ganache-cli:

npx ganache-cli@~6.9.1 > ganache-cli.log &

Switch back to your other terminal and deploy the contracts:

yarn test:fast

For redeployment run this instead

yarn clean
yarn compile
yarn test:fast

Upgrade contracts [optional]:

yarn upgrade

Testing

Run tests with yarn test, e.g.:

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

Code Linting

Linting is setup for JavaScript with ESLint & Solidity with Ethlint.

Code style is enforced through the CI test process, builds will fail if there're any linting errors.

yarn lint

Networks

Testnets

Rinkeby Testnet

The contract addresses deployed on Nevermined Rinkeby Test Network:

Contract	Version	Address
AccessCondition	v0.6.0	0xA5910a44C88cF4B576F11b07719C8dD05b5a78a5
AgreementStoreManager	v0.6.0	0x4C08EEA6A721b4DF66B6BD5479089b1CE18B0159
ComputeExecutionCondition	v0.6.0	0xdD70eec059d810Ac77d42038Ea3979Eba1af2d52
ConditionStoreManager	v0.6.0	0x8e023fDDe4400f93B2ae2db5512Cd9d3C9A544Db
DIDRegistry	v0.6.0	0x7d1789644b70C802e597cf5542e21bAA06a7b1dC
DIDRegistryLibrary	v0.6.0	0x534AFb339c9D78EcBB26eef4f02744530d06e647
Dispenser	v0.6.0	0xbC8f58230D0D7BfC6871dec5df327895DB6496b5
EpochLibrary	v0.6.0	0x8816b25b5DB2b4A92aEC480E0A7302aAC3878BF5
EscrowAccessSecretStoreTemplate	v0.6.0	0xE91472719B4a401063322C1b15A02D0f63D02790
EscrowComputeExecutionTemplate	v0.6.0	0x4d296c095e8a060A611ff8F48f22c563A2AB36Eb
EscrowReward	v0.6.0	0x3B8D1fD7778D498ca0A683512a962907BC9EAb70
HashLockCondition	v0.6.0	0xE92Ea1A9bCa9f62b23c1941bB189Fa1bF09e3f2e
LockRewardCondition	v0.6.0	0x2873FDCdF6d11c24499C1bdeBd5292fb98260D9b
NeverminedToken	v0.6.0	0xB8b367394F3A1b8ddC705306026e993097461F8D
ProvenanceRegistry	v0.5.0	0xec3b7A08206c5f5062503cee1DAE83beea2Bd5AA
ProvenanceRegistryLibrary	v0.5.0	0xF38176FfD1ee5Af8DaCA0521323e660C49573178
SignCondition	v0.6.0	0xf3a006ba80f53B139182F5abDF01C5A547587fCD
TemplateStoreManager	v0.6.0	0x0a0f1b35949fab5b37C017fD1281B05792Edf713
ThresholdCondition	v0.6.0	0xCA3b806DeD9BB7812347c4Bb09741b25459A5B96
WhitelistingCondition	v0.6.0	0x6D24f8C24694C3c9376b7954A22A88B4842CFDa3

Integration Testnet

The contract addresses deployed on Nevermined Integration Test Network:

Contract	Version	Address
-	-	-

Staging Testnet

The contract addresses deployed on Nevermined Staging Test Network:

Contract	Version	Address
-	-	-

Mainnets

Production Mainnet

The contract addresses deployed on Production Mainnet:

Contract	Version	Address
-	-	-

Packages

To facilitate the integration of nevermined-contracts there are Python, JavaScript and Java packages ready to be integrated. Those libraries include the Smart Contract ABI's. Using these packages helps to avoid compiling the Smart Contracts and copying the ABI's manually to your project. In that way the integration is cleaner and easier. The packages provided currently are:

• JavaScript NPM package - As part of the @nevermined-io npm organization, the npm nevermined-contracts package provides the ABI's to be imported from your JavaScript code.
• Python Pypi package - The Pypi nevermined-contracts package provides the same ABI's to be used from Python.
• Java Maven package - The Maven nevermined-contracts package provides the same ABI's to be used from Java.

The packages contains all the content from the doc/ and artifacts/ folders.

In JavaScript they can be used like this:

Install the nevermined-contracts npm package.

npm install @nevermined-io/contracts

Load the ABI of the NeverminedToken contract on the staging network:

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

The structure of the artifacts is:

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

Documentation

• Contracts Documentation
• Release process
• Packaging of libraries
• Upgrading of contracts
• Template lifecycle

Prior Art

This project builds on top of the work done in open source projects:

• zeppelinos/zos
• OpenZeppelin/openzeppelin-eth

Attribution

This project is based in the Ocean Protocol Keeper Contracts. It keeps the same Apache v2 License and adds some improvements. See NOTICE file.

License

Copyright 2020 Keyko GmbH
This product includes software developed at
BigchainDB GmbH and Ocean Protocol (https://www.oceanprotocol.com/)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

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

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.