.github | ||
docs | ||
scripts | ||
src | ||
test | ||
.eslintrc | ||
.gitignore | ||
.npmignore | ||
.nvmrc | ||
.prettierrc | ||
.travis.yml | ||
CHANGELOG.md | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
README.md | ||
tsconfig.json |
ocean-lib-js
JavaScript library to privately & securely publish, exchange, and consume data.
With it, you can:
- Publish data services: downloadable files, streaming data, or compute-to-data. Ocean creates a new ERC20 data token for each data service or set of services.
- Mint data tokens for the service
- Consume data tokens, to access the service
- Transfer data tokens to another owner, and all other ERC20 actions using web3.js etc.
ocean-lib-js
is part of the Ocean Protocol toolset.
This is in alpha state and you can expect running into problems. If you run into them, please open up a new issue.
- 🏗 Installation
- 🏄 Quick Start
- 🦑 Development
- ✨ Code Style
- 👩🔬 Testing
- 🛳 Production
- ⬆️ Releases
- 🏛 License
🏗 Installation
npm install @oceanprotocol/lib
🏄 Quick Start
Simple Flow
This stripped-down flow shows the essence of Ocean. Just downloading, no metadata.
Marketplace Flow
This batteries-included flow includes metadata, multiple services for one datatoken, and compute-to-data.
🦑 Development
The project is authored with TypeScript and compiled with tsc
.
To start compiler in watch mode:
npm start
✨ Code Style
For linting and auto-formatting you can use from the root of the project:
# lint all js with eslint
npm run lint
# auto format all js & css with prettier, taking all configs into account
npm run format
👩🔬 Testing
Test suite for unit & integration tests is setup with Mocha as test runner, and nyc for coverage reporting. A combined coverage report is sent to CodeClimate via Travis.
Unit Tests
Running unit tests requires running Ganache beforehand:
npm i -g ganache-cli
ganache-cli
After that is running you can execute the unit tests in another terminal:
npm run test:unit
# same thing, but with coverage reporting
npm run test:unit:coverage
Integration Tests
Running integration tests requires running Ocean Protocol components beforehand with Barge:
git clone https://github.com/oceanprotocol/barge
cd barge
git checkout v3
export PROVIDER_VERSION=latest
bash -x start_ocean.sh --no-dashboard 2>&1 > start_ocean.log
After that is running you can execute the integration tests in another terminal:
npm run test:integration
# same thing, but with coverage reporting
npm run test:integration:coverage
🛳 Production
To create a production build, run from the root of the project:
npm run build
⬆️ Releases
Releases are managed semi-automatically. They are always manually triggered from a developer's machine with release scripts.
Production
From a clean main
branch you can run any release task bumping the version accordingly based on semantic versioning:
- To bump a patch version:
npm run release
- To bump a minor version:
npm run release -- minor
- To bump a major version:
npm run release -- major
Every task does the following:
- bumps the project version in
package.json
,package-lock.json
- auto-generates and updates the CHANGELOG.md file from commit messages
- creates a Git tag
- commits and pushes everything
- creates a GitHub release with commit messages as description
- Git tag push will trigger Travis to do a npm release
For the GitHub releases steps a GitHub personal access token, exported as GITHUB_TOKEN
is required. Setup
🏛 License
Copyright ((C)) 2020 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.