@keyko-io/nevermind-contracts

Nevermind Smart Contracts

💧 Nevermind implementation of Ocean Protocol in Solidity keyko.io

Table of Contents

• Nevermind 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 nevermind-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 Nevermind Tools, a docker compose application to run all the Nevermind stack.

Local development

As a pre-requisite, you need:

• Node.js
• npm

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

Clone the project and install all dependencies:

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

# install dependencies
npm i

# install RPC client globally
npm install -g ganache-cli

Compile the solidity contracts:

npm run compile

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

ganache-cli

Switch back to your other terminal and deploy the contracts:

npm run deploy:development

# for redeployment run this instead
npm run clean
npm run compile
npm run deploy:development

Upgrade contracts [optional]:

npm run upgrade

Testing

Run tests with npm run test, e.g.:

npm run 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.

Networks

Testnets

Integration Testnet

The contract addresses deployed on Nevermind Integration Test Network:

Contract	Version	Address
-	-	-

Staging Testnet

The contract addresses deployed on Nevermind 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 the Ocean Protocol's keeper-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 @keyko-io npm organization, the npm nevermind-contracts package provides the ABI's to be imported from your JavaScript code.
• Python Pypi package - The Pypi nevermind-contracts package provides the same ABI's to be used from Python.
• Java Maven package - The Maven nevermind-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 nevermind-contracts npm package.

npm install @keyko-io/nevermind-contracts

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

const OceanToken = require('@keyko-io/nevermind-contracts/artifacts/OceanToken.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.

Changelog

v0.1.3

29 April 2020

• adding NOTICE 6e13331
• deleting not necessary stuff e9a9f78
• Update templates d065804