ocean.js

JavaScript library to privately & securely publish, exchange, and consume data.

With ocean.js, you can:

• Publish data services: downloadable files or compute-to-data. Create an ERC721 data NFT for each service, and ERC20 datatoken for access (1.0 datatokens to access).
• Sell datatokens for a fixed price. Sell data NFTs.
• Transfer data NFTs & datatokens to another owner, and all other ERC721 & ERC20 actions using web3.js etc.

ocean.js is part of the Ocean Protocol toolset.

This is in alpha state. If you run into problems, please open up a new issue.

• 📚 Prerequisites
• 🏗 Installation & Usage
• 🦑 Development
• ✨ Code Style
• 👩‍🔬 Testing
  • Unit Tests
  • Integration Tests
• 🛳 Production
• ⬆️ Releases
  • Production
  • Pre-Releases
• 🏛 License

📚 Prerequisites

• node.js (Install from here)
• Docker (Managed as a non-root user)
• A Unix based operating system (Mac or Linux)

🏗 Installation & Usage

npm install @oceanprotocol/lib

• Checkout our code examples or compute to data examples to see how you can use ocean.js.
• Refer to the Ocean Protocol documentation for more guides and tutorials.
• Visit the Ocean Protocol website for general information about Ocean Protocol.
• If you have any difficulties or if you have further questions about how to use ocean.js please reach out to us on Discord.
• If you notice any bugs or issues with ocean.js please open an issue on github.

🦑 Development

The project is authored with TypeScript and compiled with tsc.

To start compiler in watch mode:

npm install
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 the coverage GitHub Actions job.

Running all tests requires running Ocean Protocol components beforehand with Barge, which also runs a ganache-cli instance:

git clone https://github.com/oceanprotocol/barge
cd barge

./start_ocean.sh --with-provider2 --no-dashboard --with-c2d

You can then proceed to run in another terminal.

Let ocean.js know where to pickup the smart contract addresses, which has been written out by Barge in this location:

export ADDRESS_FILE="${HOME}/.ocean/ocean-contracts/artifacts/address.json"

Build metadata:

npm run build:metadata

Executing linting, type checking, unit, and integration tests with coverage reporting all in one go:

npm test

Unit Tests

You can execute the unit tests individually with:

npm run test:unit
# same thing, but with coverage reporting
npm run test:unit:cover

Integration Tests

You can execute the integration tests individually with:

npm run test:integration
# same thing, but with coverage reporting
npm run test:integration:cover

Sapphire Integration Tests

We are currently using the live Oasis Sapphire Test network for the integration tests. Please export the PRIVATE_KEY and PRIVATE_KEY_CONSUMER before running the tests.

export PRIVATE_KEY='0x<YOUR_PRIVATE_KEY>'
export PRIVATE_KEY_CONSUMER='0x<YOUR_CONSUMER_PRIVATE_KEY>'

Then, you can execute the tests individually with:

npm run test:sapphire

Note: On macOS, changes to the provider, metadataCache and subgraph URLs are required, as their default barge IPs can not be accessed due to network constraints on macOS. Instead use http://127.0.0.1 for each direct call to the mentioned services, but keep the internal provider URL (http://172.15.0.4:8030) hardcoded inside all DDO's serviceEndpoint, and when calling nft.setMetadata().

🛳 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 the release task bumping the version accordingly based on semantic versioning:

npm run release

The 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 a GitHub Action workflow to do a npm release

For the GitHub releases steps a GitHub personal access token, exported as GITHUB_TOKEN is required. Setup

Pre-Releases

For pre-releases, this is required for the first one like v0.18.0-next.0:

./node_modules/.bin/release-it major|minor|patch --preRelease=next

Further releases afterwards can be done with npm run release again and selecting the appropriate next version, in this case v0.18.0-next.1 and so on.

🏛 License

Copyright ((C)) 2023 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.