npm

npm’s 2019 JavaScript ecosystem survey analysis is now available! Get your copy here »

@oceanprotocol/keeper-contracts

0.9.3 • Public • Published

banner

keeper-contracts

💧 Integration of SEAs, DID and OceanToken in Solidity oceanprotocol.com

Dockerhub TravisCI Ascribe Greenkeeper
Docker Build Status Build Status js ascribe Greenkeeper badge

🐲🦑 THERE BE DRAGONS AND SQUIDS. This is in alpha state and you can expect running into problems. If you run into them, please open up a new issue. 🦑🐲


Table of Contents


Get Started

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

Docker

The simplest way to get started with is barge, a docker compose application to run Ocean Protocol.

Local development

As a pre-requisite, you need:

  • Node.js
  • npm

Clone the project and install all dependencies:

git clone git@github.com:oceanprotocol/keeper-contracts.git
cd keeper-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.

Testnets

Duero Testnet

The contract addresses deployed on Ocean's Duero Test Network:

Contract Version Address
AccessSecretStoreCondition v0.9.3 0x99FFC24B6749512F6DE6D24c5dBCC390359af4E3
AgreementStoreManager v0.9.3 0xfC6DB8141144831a8B7d858f356D0d1148d8F11d
ConditionStoreManager v0.9.3 0xe6CeA58707df303b6d9D1DF5BA8Bf88fF4A5920D
DIDRegistry v0.9.3 0x4878e1dfd4105b8FF3A879C5896495d5DE3274B5
DIDRegistryLibrary v0.9.3 0x663C7CF54a15fb23aF1dCab15bfa968B8be5903D
Dispenser v0.9.3 0xF7B1be190A13bDD9157d9493dF9F4BFD0c8a097F
EpochLibrary v0.9.3 0xBDFeAc66c022165Bdb320264398977bf8A54e3C0
EscrowAccessSecretStoreTemplate v0.9.3 0xdAAb92eABB4F2D7fC51948E44A88aa4fd986EDa9
EscrowReward v0.9.3 0xb8D436b29CBF1ef690DD3b0972Cce2090ECb09bc
HashLockCondition v0.9.3 0xA2Ab4153F9df4Cccb859d54Aea7A47298Bc83DF6
LockRewardCondition v0.9.3 0x518cf43258Ece569D5Cd19e6C0Cee41156FB6aED
OceanToken v0.9.3 0x5e29AcdE5285E24eb7A211d9F4313E5a9Ed07F36
SignCondition v0.9.3 0x8c4a2cC4572B6CD68c58BFc220f04CD1143230a0
TemplateStoreManager v0.9.3 0xF454Ec72eCed751ffAD94B11ae7c0323670dd976

Nile Beta Network

The contract addresses deployed on Ocean's Nile Beta Network:

Contract Version Address
AccessSecretStoreCondition v0.9.3 0x45DE141F8Efc355F1451a102FB6225F1EDd2921d
AgreementStoreManager v0.9.3 0x62f84700b1A0ea6Bfb505aDC3c0286B7944D247C
ConditionStoreManager v0.9.3 0x39b0AA775496C5ebf26f3B81C9ed1843f09eE466
DIDRegistry v0.9.3 0x4A0f7F763B1A7937aED21D63b2A78adc89c5Db23
DIDRegistryLibrary v0.9.3 0x7E51692679F0d67723E82f69437B6F64C080B3A4
Dispenser v0.9.3 0x865396b7ddc58C693db7FCAD1168E3BD95Fe3368
EpochLibrary v0.9.3 0xAA2C7e6237c22901533400AA9E381327A7B7982F
EscrowAccessSecretStoreTemplate v0.9.3 0xfA16d26e9F4fffC6e40963B281a0bB08C31ed40C
EscrowReward v0.9.3 0xeD4Ef53376C6f103d2d7029D7E702e082767C6ff
HashLockCondition v0.9.3 0xB5f2e45e8aD4a1339D542f2defd5095B98054590
LockRewardCondition v0.9.3 0xE30FC30c678437e0e8F78C52dE9db8E2752781a0
OceanToken v0.9.3 0x9861Da395d7da984D5E8C712c2EDE44b41F777Ad
SignCondition v0.9.3 0x5a4301F8a7a8A13485621b9B4C82B1E66c112ee2
TemplateStoreManager v0.9.3 0x9768c8ae44f1dc81cAA98F48792aA5730cAd2F73

Kovan Testnet

The contract addresses deployed on Kovan testnet:

Contract Version Address
AccessSecretStoreCondition v0.9.3 0x9Ee06Ac392FE11f1933a51B48D1d07dd97f1dec7
AgreementStoreManager v0.9.3 0x412d4F57425b41FE027e06b9f37D569dcAE2eAa4
ConditionStoreManager v0.9.3 0xA5f5BaB34DE3782A71D37d0B334217Ded341cd64
DIDRegistry v0.9.3 0x9254f7c8f1176C685871E7A8A99E11e96775F488
DIDRegistryLibrary v0.9.3 0xf22aEF1421CCd4f0A0D0BB1f7fe03233384c69B4
Dispenser v0.9.3 0x5B92243133094210F504dF6B9D54fD70E7B281DC
EpochLibrary v0.9.3 0x44Ca6882823a2d7864376893A4BCF3eB377693e4
EscrowAccessSecretStoreTemplate v0.9.3 0xe0Afe9a948f9Fa39524c8d29a98d75409018ABf0
EscrowReward v0.9.3 0xa182ff844c71803Bf767c3AB4180B3bfFADa6B2B
HashLockCondition v0.9.3 0x11ef2D50868c1f1063ba0141aCD53691A0293c25
LockRewardCondition v0.9.3 0x2a2A2C5fF51C5f1c84547FC7a194c00F82763432
OceanToken v0.9.3 0xB57C4D626548eB8AC0B82b086721516493E2908d
SignCondition v0.9.3 0x7B8B2756de9Ab474ddbCc87047117a2A16419194
TemplateStoreManager v0.9.3 0xD20307e2620Bb8a60991f43c52b64f981103A829

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:

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

In JavaScript they can be used like this:

Install the keeper-contracts npm package.

npm install @oceanprotocol/keeper-contracts

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

const OceanToken = require('@oceanprotocol/keeper-contracts/artifacts/OceanToken.nile.json')

The structure of the artifacts is:

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

Deployments, Upgrades, New Versions, New Releases

See RELEASE_PROCESS.md

Documentation

Contributing

See the page titled "Ways to Contribute" in the Ocean Protocol documentation.

Prior Art

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

License

Copyright 2018 Ocean Protocol Foundation

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.

Keywords

none

install

npm i @oceanprotocol/keeper-contracts

Downloadsweekly downloads

127

version

0.9.3

license

Apache-2.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability