@oceanprotocol/lib 5.0.3 → 5.0.5

package/CHANGELOG.md

@@ -4,12 +4,36 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v5.0.5](https://github.com/oceanprotocol/ocean.js/compare/v5.0.4...v5.0.5)
+
+- Deps/bump_contracts_to_2_5_0 [`#2016`](https://github.com/oceanprotocol/ocean.js/pull/2016)
+- export addrs functions [`#2018`](https://github.com/oceanprotocol/ocean.js/pull/2018)
+- Feature/fix enterprise fee [`#2014`](https://github.com/oceanprotocol/ocean.js/pull/2014)
+- Feature/add enterprisefee getters [`#2010`](https://github.com/oceanprotocol/ocean.js/pull/2010)
+- fix resources & add queue [`#2009`](https://github.com/oceanprotocol/ocean.js/pull/2009)
+- add escrow address to config [`#2008`](https://github.com/oceanprotocol/ocean.js/pull/2008)
+- Update docs [`#2006`](https://github.com/oceanprotocol/ocean.js/pull/2006)
+- update codeowners [`#2005`](https://github.com/oceanprotocol/ocean.js/pull/2005)
+
+#### [v5.0.4](https://github.com/oceanprotocol/ocean.js/compare/v5.0.3...v5.0.4)
+
+> 17 October 2025
+
+- add envs and termination details [`#2004`](https://github.com/oceanprotocol/ocean.js/pull/2004)
+- Add Cheatsheet. [`#2001`](https://github.com/oceanprotocol/ocean.js/pull/2001)
+- Add support for BASE network. [`#2002`](https://github.com/oceanprotocol/ocean.js/pull/2002)
+- Bump ddo.js to 0.1.4. [`#1996`](https://github.com/oceanprotocol/ocean.js/pull/1996)
+- Release 5.0.4 [`59f305b`](https://github.com/oceanprotocol/ocean.js/commit/59f305b906c02f9d7dad7863733e0d516f8d6f9e)
+
 #### [v5.0.3](https://github.com/oceanprotocol/ocean.js/compare/v5.0.2...v5.0.3)
 
+> 23 September 2025
+
 - Bump sha.js from 2.4.11 to 2.4.12 [`#1989`](https://github.com/oceanprotocol/ocean.js/pull/1989)
 - Bump @types/node from 22.15.29 to 24.3.0 [`#1992`](https://github.com/oceanprotocol/ocean.js/pull/1992)
 - extend metadata interface [`#1993`](https://github.com/oceanprotocol/ocean.js/pull/1993)
 - Bump tmp and @inquirer/editor [`#1985`](https://github.com/oceanprotocol/ocean.js/pull/1985)
+- Release 5.0.3 [`d046872`](https://github.com/oceanprotocol/ocean.js/commit/d046872003bab4092d6cc50de4d32d2cdf72dc4c)
 
 #### [v5.0.2](https://github.com/oceanprotocol/ocean.js/compare/v5.0.1...v5.0.2)
 
@@ -61,7 +85,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Feature/contracts_240 [`#1979`](https://github.com/oceanprotocol/ocean.js/pull/1979)
 - Release 5.0.0-next.2 [`fedd4c2`](https://github.com/oceanprotocol/ocean.js/commit/fedd4c273d86fb3f85990d7a289be4c3a4270832)
 
-#### [v5.0.0-next.1](https://github.com/oceanprotocol/ocean.js/compare/v4.3.3...v5.0.0-next.1)
+#### [v5.0.0-next.1](https://github.com/oceanprotocol/ocean.js/compare/v4.3.6...v5.0.0-next.1)
 
 > 1 August 2025
 
@@ -72,6 +96,30 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Feature/update ethers [`#1969`](https://github.com/oceanprotocol/ocean.js/pull/1969)
 - Release 5.0.0-next.1 [`cf92038`](https://github.com/oceanprotocol/ocean.js/commit/cf92038208679177ab6af112526f5547feb0f11e)
 
+#### [v4.3.6](https://github.com/oceanprotocol/ocean.js/compare/v4.3.5...v4.3.6)
+
+> 24 November 2025
+
+- export util addrs functions [`#2017`](https://github.com/oceanprotocol/ocean.js/pull/2017)
+- Release 4.3.6 [`b28db44`](https://github.com/oceanprotocol/ocean.js/commit/b28db446144939e9ed864cc11559f718104d094b)
+
+#### [v4.3.5](https://github.com/oceanprotocol/ocean.js/compare/v4.3.4...v4.3.5)
+
+> 17 November 2025
+
+- V4/feature/enterprise fee collector [`#2011`](https://github.com/oceanprotocol/ocean.js/pull/2011)
+- Release 4.3.5 [`2953f4a`](https://github.com/oceanprotocol/ocean.js/commit/2953f4ac49d56ac8b066ad8fa7a71b6bbc0df005)
+- remove typo [`f199f4a`](https://github.com/oceanprotocol/ocean.js/commit/f199f4af809eb85249fe0c59303fcc3207d8e7a7)
+- export EnterpriseFeeCollector [`68712a2`](https://github.com/oceanprotocol/ocean.js/commit/68712a2af17824bb8fc78824842376e35f582487)
+
+#### [v4.3.4](https://github.com/oceanprotocol/ocean.js/compare/v4.3.3...v4.3.4)
+
+> 15 November 2025
+
+- add EnterpriseFee [`b502882`](https://github.com/oceanprotocol/ocean.js/commit/b502882d05375eda326166608730a11e779c6f42)
+- Release 4.3.4 [`e45a7de`](https://github.com/oceanprotocol/ocean.js/commit/e45a7defa239f6800eb68a13e1a9a3d9662f509d)
+- bump contracts [`0b226a1`](https://github.com/oceanprotocol/ocean.js/commit/0b226a107f309c6b200249d498ae7568343fcb92)
+
 #### [v4.3.3](https://github.com/oceanprotocol/ocean.js/compare/v4.3.2...v4.3.3)
 
 > 1 August 2025

package/Cheatsheet.md

@@ -0,0 +1,326 @@
+# Ocean.js Cheatsheet
+
+## Prerequisites
+- Git, Node.js, Docker
+- Install Git: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
+- Node.js: https://nodejs.org/en/download/
+- Docker: https://docs.docker.com/get-docker/
+
+### Installation & Usage
+
+```bash
+npm init
+npm install @oceanprotocol/lib crypto-js ethers typescript @types/node ts-node
+```
+
+### Configuration
+
+```bash
+export NODE_URL='https://compute1.oceanprotocol.com'
+export PRIVATE_KEY=<replace_me>
+export RPC=<replace_me>
+```
+
+### Publish Flow
+
+1. Define DDO object
+```javascript
+
+const genericAsset: DDO = {
+    '@context': ['https://w3id.org/did/v1'],
+    id: 'did:op',
+    version: '4.1.0',
+    chainId: 8996,
+    nftAddress: '0x0',
+    metadata: {
+      created: '2021-12-20T14:35:20Z',
+      updated: '2021-12-20T14:35:20Z',
+      type: 'dataset',
+      name: 'dataset-name',
+      description: 'Ocean protocol test dataset description',
+      author: 'oceanprotocol-team',
+      license: 'MIT',
+      tags: ['white-papers'],
+      additionalInformation: { 'test-key': 'test-value' },
+      links: ['http://data.ceda.ac.uk/badc/ukcp09/']
+    },
+    services: [
+      {
+        id: 'db164c1b981e4d2974e90e61bda121512e6909c1035c908d68933ae4cfaba6b0',
+        type: 'access',
+        files: '',
+        datatokenAddress: '0xa15024b732A8f2146423D14209eFd074e61964F3',
+        serviceEndpoint: 'http://127.0.0.1:8001',
+        timeout: 0
+      }
+    ]
+  }
+```
+2. Create NFT + datatoken + dispenser/FRE:
+
+```javascript
+
+const { chainId } = await publisherAccount.provider.getNetwork()
+    const factory = new NftFactory(
+      addresses.ERC721Factory,
+      publisherAccount,
+      Number(chainId)
+    )
+
+    const nftParams: NftCreateData = {
+      name: FRE_NFT_NAME,
+      symbol: FRE_NFT_SYMBOL,
+      templateIndex: 1,
+      tokenURI: '',
+      transferable: true,
+      owner: await publisherAccount.getAddress()
+    }
+
+    const datatokenParams: DatatokenCreateParams = {
+      templateIndex: 1,
+      cap: '100000',
+      feeAmount: '0',
+      paymentCollector: ZERO_ADDRESS,
+      feeToken: ZERO_ADDRESS,
+      minter: await publisherAccount.getAddress(),
+      mpFeeAddress: ZERO_ADDRESS
+    }
+
+    const freParams: FreCreationParams = {
+      fixedRateAddress: addresses.FixedPrice,
+      baseTokenAddress: addresses.Ocean,
+      owner: await publisherAccount.getAddress(),
+      marketFeeCollector: await publisherAccount.getAddress(),
+      baseTokenDecimals: 18,
+      datatokenDecimals: 18,
+      fixedRate: '1',
+      marketFee: '0.001',
+      allowedConsumer: ZERO_ADDRESS,
+      withMint: true
+    }
+
+    const bundleNFT = await factory.createNftWithDatatokenWithFixedRate(
+      nftParams,
+      datatokenParams,
+      freParams
+    )
+
+```
+### Consume Flow
+As a prerequisite for this flow, publish flow needs to be executed before.
+```javascript
+const fixedRate = new FixedRateExchange(freAddress, consumerAccount, Number(chainId))
+await fixedRate.buyDatatokens(freId, '1', '2')
+
+const resolvedDDO = await aquarius.waitForIndexer(fixedDDO.id)
+assert(resolvedDDO, 'Cannot fetch DDO from Aquarius')
+
+// Initialize - obtain proof for ordering assets
+
+const initializeData = await ProviderInstance.initialize(
+    resolvedDDO.id,
+    resolvedDDO.services[0].id,
+    0,
+    await consumerAccount.getAddress(),
+    providerUrl
+)
+
+const providerFees: ProviderFees = {
+    providerFeeAddress: initializeData.providerFee.providerFeeAddress,
+    providerFeeToken: initializeData.providerFee.providerFeeToken,
+    providerFeeAmount: initializeData.providerFee.providerFeeAmount,
+    v: initializeData.providerFee.v,
+    r: initializeData.providerFee.r,
+    s: initializeData.providerFee.s,
+    providerData: initializeData.providerFee.providerData,
+    validUntil: initializeData.providerFee.validUntil
+}
+// Starting order after retriving provider fees
+const tx = await datatoken.startOrder(
+    freDatatokenAddress,
+    await consumerAccount.getAddress(),
+    0,
+    providerFees
+)
+const orderTx = await tx.wait()
+const orderStartedTx = getEventFromTx(orderTx, 'OrderStarted')
+console.log(`Order started, tx: ${orderStartedTx.transactionHash}`)
+
+const downloadURL = await ProviderInstance.getDownloadUrl(
+      fixedDDO.id,
+      fixedDDO.services[0].id,
+      0,
+      orderStartedTx.transactionHash,
+      providerUrl,
+      consumerAccount
+    )
+
+// Lets check that the download URL was successfully received
+console.log(`Download URL: ${downloadURL}`)
+
+```
+For better UX, it is recommended to have installed VSCode extension.
+### Get compute environments
+
+```javascript
+
+
+// Fetch compute envrionments first
+const computeEnvs = await ProviderInstance.getComputeEnvironments(providerUrl)
+
+```
+For `free start compute` it is not necessary publish flow.
+
+
+### Free Start Compute
+
+```javascript
+
+// Let's have 5 minute of compute access
+const mytime = new Date()
+const computeMinutes = 5
+mytime.setMinutes(mytime.getMinutes() + computeMinutes)
+
+// Let's prepare the dataset and algorithm assets to be used in the compute job
+const assets: ComputeAsset[] = [
+{
+    documentId: resolvedDatasetDdo.id,
+    serviceId: resolvedDatasetDdo.services[0].id
+}
+]
+
+const algo: ComputeAlgorithm = {
+documentId: resolvedAlgorithmDdo.id,
+serviceId: resolvedAlgorithmDdo.services[0].id,
+meta: resolvedAlgorithmDdo.metadata.algorithm
+}
+
+// Let's start the free compute job
+const computeJobs = await ProviderInstance.freeComputeStart(
+providerUrl,
+consumerAccount,
+computeEnv.id,
+assets,
+algo
+)
+
+```
+
+### Paid Start Compute
+
+
+```javascript
+
+
+const mytime = new Date()
+const computeMinutes = 5
+mytime.setMinutes(mytime.getMinutes() + computeMinutes)
+const computeValidUntil = Math.floor(mytime.getTime() / 1000)
+
+const resources: ComputeResourceRequest[] = [
+{
+    id: 'cpu',
+    amount: 2
+},
+{
+    id: 'ram',
+    amount: 2
+},
+{
+    id: 'disk',
+    amount: 0
+}
+]
+const assets: ComputeAsset[] = [
+{
+    documentId: resolvedDatasetDdo.id,
+    serviceId: resolvedDatasetDdo.services[0].id
+}
+]
+const dtAddressArray = [resolvedDatasetDdo.services[0].datatokenAddress]
+const algo: ComputeAlgorithm = {
+    documentId: resolvedAlgorithmDdo.id,
+    serviceId: resolvedAlgorithmDdo.services[0].id,
+    meta: resolvedAlgorithmDdo.metadata.algorithm
+}
+
+const providerInitializeComputeResults = await ProviderInstance.initializeCompute(
+    assets,
+    algo,
+    computeEnv.id,
+    paymentToken,
+    computeValidUntil,
+    providerUrl,
+    consumerAccount,
+    resources,
+    Number(chainId)
+)
+// Initialize payment contract
+const escrow = new EscrowContract(
+    getAddress(providerInitializeComputeResults.payment.escrowAddress),
+    consumerAccount
+)
+const amountToDeposit = (providerInitializeComputeResults.payment.amount * 2).toString()
+await escrow.verifyFundsForEscrowPayment(
+    paymentToken,
+    computeEnv.consumerAddress,
+    await unitsToAmount(consumerAccount, paymentToken, amountToDeposit),
+    providerInitializeComputeResults.payment.amount.toString(),
+    providerInitializeComputeResults.payment.minLockSeconds.toString(),
+    '10'
+)
+
+algo.transferTxId = await handleOrder(
+    providerInitializeComputeResults.algorithm,
+    resolvedAlgorithmDdo.services[0].datatokenAddress,
+    consumerAccount,
+    computeEnv.consumerAddress,
+    0
+)
+for (let i = 0; i < providerInitializeComputeResults.datasets.length; i++) {
+    assets[i].transferTxId = await handleOrder(
+        providerInitializeComputeResults.datasets[i],
+        dtAddressArray[i],
+        consumerAccount,
+        computeEnv.consumerAddress,
+        0
+    )
+}
+
+const computeJobs = await ProviderInstance.computeStart(
+    providerUrl,
+    consumerAccount,
+    computeEnv.id,
+    assets,
+    algo,
+    computeValidUntil,
+    paymentToken,
+    resources,
+    Number(chainId)
+)
+```
+
+### Get compute job status
+
+```javascript
+
+const jobStatus = await ProviderInstance.computeStatus(
+        providerUrl,
+        await consumerAccount.getAddress(),
+        computeJobId
+      )
+```
+
+### Get download compute results URL
+
+```javascript
+
+const downloadURL = await ProviderInstance.getComputeResultUrl(
+        providerUrl,
+        consumerAccount,
+        computeJobId,
+        0
+    )
+
+
+```

package/CodeExamples.md

@@ -45,7 +45,7 @@ We start by initializing the services. To do this, we clone the Barge repository
 ```bash
 git clone https://github.com/oceanprotocol/barge.git
 cd barge/
-./start_ocean.sh --with-provider2 --no-dashboard
+./start_ocean.sh
 ```
 
 ## 2. Create a new node.js project
@@ -66,7 +66,7 @@ cat > marketplace.js
 Install dependencies running the following command in your terminal:
 
 ```bash
-npm install @oceanprotocol/lib crypto-js ethers@5.7.2 typescript @types/node ts-node
+npm install @oceanprotocol/lib crypto-js ethers
 ```
 
 ## 4. Import dependencies and add variables and constants

package/ComputeExamples.md

@@ -35,7 +35,7 @@ We start by initializing the services. To do this, we clone the Barge repository
 ```bash
 git clone https://github.com/oceanprotocol/barge.git
 cd barge/
-./start_ocean.sh --with-provider2 --no-dashboard --with-c2d
+./start_ocean.sh
 ```
 
 ## 2. Create a new Node.js project with TypeScript
@@ -106,7 +106,7 @@ node dist/compute.js
 Install dependencies running the following command in your terminal:
 
 ```bash
-npm install @oceanprotocol/lib crypto-js ethers@5.7.2 typescript @types/node ts-node
+npm install @oceanprotocol/lib crypto-js ethers
 ```
 
 ## 4. Import dependencies and add variables, constants and helper methods
@@ -792,7 +792,7 @@ let's select compute environment which have free and paid resources
         },
         {
           id: 'ram',
-          amount: 1000000000
+          amount: 2
         },
         {
           id: 'disk',

package/README.md

@@ -13,9 +13,11 @@
 
 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](https://web3js.readthedocs.io/en/v1.2.9/web3-eth-contract.html) etc.
+- **Publish** data services: downloadable files or compute-to-data (C2D). Create an ERC721 **data NFT** for each service, and ERC20 **datatoken** for access (1.0 datatokens to access).
+- **Consume** data: download files or run compute-to-data jobs on datasets while preserving data privacy.
+- **Sell** datatokens via fixed-rate exchanges or dispense them for free.
+- **Manage pricing**: create fixed-rate exchanges, dispensers, or use dynamic pricing mechanisms for your assets.
+- **Compute-to-Data**: run algorithms on the ocean network.
 
 ocean.js is part of the [Ocean Protocol](https://oceanprotocol.com) toolset.
 
@@ -23,6 +25,7 @@ This is in alpha state. If you run into problems, please open up a [new issue](h
 
 - [📚 Prerequisites](#-prerequisites)
 - [🏗 Installation & Usage](#-installation--usage)
+- [📖 Documentation](#-documentation)
 - [🦑 Development](#-development)
 - [✨ Code Style](#-code-style)
 - [👩‍🔬 Testing](#-testing)
@@ -46,7 +49,7 @@ This is in alpha state. If you run into problems, please open up a [new issue](h
 npm install @oceanprotocol/lib
 ```
 
-- Checkout our [code examples](CodeExamples.md) or [compute to data examples](C2DExamples.md) to see how you can use ocean.js.
+- Checkout our [code examples](CodeExamples.md), [compute-to-data examples](ComputeExamples.md), or [quick reference cheatsheet](Cheatsheet.md) to see how you can use ocean.js.
 - Refer to the [Ocean Protocol documentation](https://docs.oceanprotocol.com/) for more guides and tutorials.
 - Visit the [Ocean Protocol website](https://docs.oceanprotocol.com/) 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](https://discord.gg/TnXjkR5).
@@ -61,6 +64,29 @@ npm install @oceanprotocol/lib
 ```
 - If using Next.js, they may need "moduleResolution": "bundler" for better compatibility.
 
+## 📖 Documentation
+
+### Quick Start Guides
+
+- **[Code Examples](CodeExamples.md)**: Complete walkthrough of publishing and consuming datasets
+  - Creating Data NFTs and Datatokens
+  - Setting up fixed-rate exchanges and dispensers
+  - Buying and consuming data assets
+  - Using ERC725 key-value store
+
+- **[Compute-to-Data Examples](ComputeExamples.md)**: Comprehensive guide to C2D features
+  - Publishing datasets and algorithms for compute
+  - Starting free compute jobs
+  - Running paid compute jobs with custom resources
+  - Checking compute status and retrieving results
+
+- **[Cheatsheet](Cheatsheet.md)**: Quick reference for common operations
+  - Publishing datasets
+  - Consuming data
+  - Free and paid compute workflows
+  - Getting compute job status
+
+
 ## 🦑 Development
 
 The project is authored with TypeScript and compiled with `tsc`.
@@ -88,13 +114,13 @@ npm run format
 
 Test suite for unit & integration tests is setup with [Mocha](https://mochajs.org) as test runner, and [nyc](https://github.com/istanbuljs/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](https://github.com/oceanprotocol/barge), which also runs a `ganache-cli` instance:
+Running all tests requires running Ocean Protocol components beforehand with [Barge](https://github.com/oceanprotocol/barge), which also runs a local blockchain instance:
 
 ```bash
 git clone https://github.com/oceanprotocol/barge
 cd barge
 
-./start_ocean.sh --with-provider2 --no-dashboard --with-c2d
+./start_ocean.sh 
 ```
 
 You can then proceed to run in another terminal.
@@ -199,7 +225,7 @@ Further releases afterwards can be done with `npm run release` again and selecti
 ## 🏛 License
 
 ```
-Copyright ((C)) 2023 Ocean Protocol Foundation
+Copyright ((C)) 2025 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.