Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

banner

contracts-v4

🦑 Smart contracts for Ocean Protocol v4. https://oceanprotocol.com Ocean v4 is part of the Ocean Protocol toolset.

This is in beta state and you can expect running into problems. If you run into them, please open up a new issue.

📚 Installation

For quick installation of the contract ABIs:

Javascript/Typescript

npm install @oceanprotocol/contracts

Python

pip3 install ocean-contracts

⚙️ Usage

By default, Python does not support importing json files directly, so it is recommended to use json-sempai package in order to automatically importing ABIs/json artifacts.

pip3 install json-sempai
# install the ocean-contracts package.
from jsonsempai import magic
from artifacts import address

Overview

image

🏄 Quickstart

Features

  • Base IP is now represented by an NFT, from which a datapublisher can create multiple ERC20s representing different type of access for the same dataset.

  • Help Ocean Community Monetize: there's a swap fee for the Ocean Community, if Ocean or allied tokens are the basetoken in a pool, Ocean Community will receive 0.1% swap fee, otherwhise it will be 0.2%.

Flexibility

  • Based on ERC721 and ERC20 templates to provide different features

  • Introduce an advanced Fee Structure both for Market and Provider runners.

  • Roles Administration: there are now multiple roles for a more flexible administation both at NFT and ERC20 levels

  • Key-value store in the NFT contract : NFT contract can be used to store custom key-value pairs (ERC725Y standard)

  • Multiple NFT template support: the Factory can deploy different types of NFT templates

  • Multiple datatoken template support: the Factory can deploy different types of Datatoken templates

Publisher Flow

Interaction flow from DataPublisher point of view.

Go to publisher flow

Roles Diagram

How roles are handled in the v4.

Go to roles diagram

Functions you will need

Selection of most common functions.

Go to functions

Bundle functions

Helper functions which can perform multiple steps in 1 call.

Go to helpers

If you have any difficulties with the quickstarts, or if you have further questions about how to use the contracts please reach out to us on Discord.

If you notice any bugs or issues with this repo please open an issue on github. -->

The ocean.js and ocean.py libraries wrap contracts in JavaScript and Python respectively. They each have quickstart guides.

🦑 Development and Testing

Run hardhat in a new terminal:

export ALCHEMY_URL="https://eth-mainnet.alchemyapi.io/v2/XXXXXXXX"
npm install
npx hardhat node

Open a new terminal to run the tests:

export ALCHEMY_URL="https://eth-mainnet.alchemyapi.io/v2/XXXXXXXX"

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

Unit Tests

You can execute just unit tests with:

npm run test:unit

Flow Tests

You can execute just flow tests with:

npm run test:flow

🏛 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.

Metadata

Release files for ocean-contracts 3.2.0rc0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ocean-contracts 3.2.0rc0
File Size Uploaded Provenance Actions
ocean_contracts-3.2.0rc0.tar.gz 462.8 kB Without provenance Details for ocean_contracts-3.2.0rc0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ocean-contracts 3.2.0rc0
File Interpreter ABI Platform Actions
ocean_contracts-3.2.0rc0-py3-none-any.whl Python 3 none any Details for ocean_contracts-3.2.0rc0-py3-none-any.whl

Total release size: 988.1 kB

Release files / ocean_contracts-3.2.0rc0.tar.gz

Download URL ocean_contracts-3.2.0rc0.tar.gz
Size 462.8 kB
Tags Source
SHA-256 checksum
How to use checksums
7d85cc0902d1ee6e776e9e4027889068bc3c0324893694ac8b33b88e721cef92
BLAKE2b-256 checksum
How to use checksums
6353af0a98c1a5e2b3b2d3f9256938f9a0b90f75a921b9a716a123f0039f499c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / ocean_contracts-3.2.0rc0-py3-none-any.whl

Download URL ocean_contracts-3.2.0rc0-py3-none-any.whl
Size 525.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c7a8d51dce66b4cbd82b998022e4f18a820ffbc6b8b6e50eca0aed10b8a8cec4
BLAKE2b-256 checksum
How to use checksums
ccf3c34df0bbec4de67c82ff5f1bb8f73bb1842018a629f2d88291fb87590cfd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Security for ocean-contracts 3.2.0rc0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page