This is in beta state and you can expect running into problems. If you run into them, please open up a new issue.
🏄Quickstart 🦑Development and testing
- Known issues
For quick installation of the contract
npm install @oceanprotocol/contracts
pip3 install ocean-contracts
By default, Python does not support importing
json files directly, so it is recommended to use
json-sempai package in order to automatically importing
pip3 install json-sempai # install the ocean-contracts package.
from jsonsempai import magic from artifacts import address
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. (Link to NFT blog)
An automated Datatoken Staking and Vesting contract helps with the initial DTs distribution and price stability. Goodbye rug pulls! More info on how it works: (Link to SideStaking blog)
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%. More details here: (Link to blog post on Ocean community monetization)
Introduce an advanced Fee Structure both for Market and Provider runners. (add link to fee post/docs when available)
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
Interaction flow from DataPublisher point of view.
How roles are handled in the v4.
Functions you will need
Selection of most common 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. -->
🦑 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
You can execute just unit tests with:
npm run test:unit
You can execute just flow tests with:
npm run test:flow
- when (vestingAmount/vestedBlocks) is a Periodic number, there’s a rounding issue of 1 wei. So if a publisher will call it once per day, over a period of 2 years, you may have a rounding error combined of 730 Weis. That is a neglectable amount.
Copyright ((C)) 2022 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.