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
🏄 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.
Roles Diagram
How roles are handled in the v4.
Functions you will need
Selection of most common functions.
Bundle functions
Helper functions which can perform multiple steps in 1 call.
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.
1 maintainer
Metadata
1 maintainer
Release files for ocean-contracts 3.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ocean_contracts-3.0.0.tar.gz | 431.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ocean_contracts-3.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 917.9 kB
Release files / ocean_contracts-3.0.0.tar.gz
| Download URL | ocean_contracts-3.0.0.tar.gz |
|---|---|
| Size | 431.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
46b358ba6c64bb9a33fddad4ced2211fbc4e22dd8fffadc002bafcf880d4af4f
|
|
BLAKE2b-256 checksum How to use checksums |
bfe5ba72c82bf3befa977e003e7c3ba7ee848a0abad15d555762454a2a7eb013
|
| 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.0.0-py3-none-any.whl
| Download URL | ocean_contracts-3.0.0-py3-none-any.whl |
|---|---|
| Size | 486.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ed3f68298ffe4c08c8da497fa2a4a04069c33cf0a67206a054622ebb65fd2f25
|
|
BLAKE2b-256 checksum How to use checksums |
49f9ea9c390351fcd171dd4177d4c48c102729650019d238039ee9085ebe4ea1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
