@oceanprotocol/lib 5.0.4 → 5.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -4,12 +4,26 @@ All notable changes to this project will be documented in this file. Dates are d
4
4
 
5
5
  Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
6
6
 
7
+ #### [v5.0.5](https://github.com/oceanprotocol/ocean.js/compare/v5.0.4...v5.0.5)
8
+
9
+ - Deps/bump_contracts_to_2_5_0 [`#2016`](https://github.com/oceanprotocol/ocean.js/pull/2016)
10
+ - export addrs functions [`#2018`](https://github.com/oceanprotocol/ocean.js/pull/2018)
11
+ - Feature/fix enterprise fee [`#2014`](https://github.com/oceanprotocol/ocean.js/pull/2014)
12
+ - Feature/add enterprisefee getters [`#2010`](https://github.com/oceanprotocol/ocean.js/pull/2010)
13
+ - fix resources & add queue [`#2009`](https://github.com/oceanprotocol/ocean.js/pull/2009)
14
+ - add escrow address to config [`#2008`](https://github.com/oceanprotocol/ocean.js/pull/2008)
15
+ - Update docs [`#2006`](https://github.com/oceanprotocol/ocean.js/pull/2006)
16
+ - update codeowners [`#2005`](https://github.com/oceanprotocol/ocean.js/pull/2005)
17
+
7
18
  #### [v5.0.4](https://github.com/oceanprotocol/ocean.js/compare/v5.0.3...v5.0.4)
8
19
 
20
+ > 17 October 2025
21
+
9
22
  - add envs and termination details [`#2004`](https://github.com/oceanprotocol/ocean.js/pull/2004)
10
23
  - Add Cheatsheet. [`#2001`](https://github.com/oceanprotocol/ocean.js/pull/2001)
11
24
  - Add support for BASE network. [`#2002`](https://github.com/oceanprotocol/ocean.js/pull/2002)
12
25
  - Bump ddo.js to 0.1.4. [`#1996`](https://github.com/oceanprotocol/ocean.js/pull/1996)
26
+ - Release 5.0.4 [`59f305b`](https://github.com/oceanprotocol/ocean.js/commit/59f305b906c02f9d7dad7863733e0d516f8d6f9e)
13
27
 
14
28
  #### [v5.0.3](https://github.com/oceanprotocol/ocean.js/compare/v5.0.2...v5.0.3)
15
29
 
@@ -71,7 +85,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
71
85
  - Feature/contracts_240 [`#1979`](https://github.com/oceanprotocol/ocean.js/pull/1979)
72
86
  - Release 5.0.0-next.2 [`fedd4c2`](https://github.com/oceanprotocol/ocean.js/commit/fedd4c273d86fb3f85990d7a289be4c3a4270832)
73
87
 
74
- #### [v5.0.0-next.1](https://github.com/oceanprotocol/ocean.js/compare/v4.3.3...v5.0.0-next.1)
88
+ #### [v5.0.0-next.1](https://github.com/oceanprotocol/ocean.js/compare/v4.3.6...v5.0.0-next.1)
75
89
 
76
90
  > 1 August 2025
77
91
 
@@ -82,6 +96,30 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
82
96
  - Feature/update ethers [`#1969`](https://github.com/oceanprotocol/ocean.js/pull/1969)
83
97
  - Release 5.0.0-next.1 [`cf92038`](https://github.com/oceanprotocol/ocean.js/commit/cf92038208679177ab6af112526f5547feb0f11e)
84
98
 
99
+ #### [v4.3.6](https://github.com/oceanprotocol/ocean.js/compare/v4.3.5...v4.3.6)
100
+
101
+ > 24 November 2025
102
+
103
+ - export util addrs functions [`#2017`](https://github.com/oceanprotocol/ocean.js/pull/2017)
104
+ - Release 4.3.6 [`b28db44`](https://github.com/oceanprotocol/ocean.js/commit/b28db446144939e9ed864cc11559f718104d094b)
105
+
106
+ #### [v4.3.5](https://github.com/oceanprotocol/ocean.js/compare/v4.3.4...v4.3.5)
107
+
108
+ > 17 November 2025
109
+
110
+ - V4/feature/enterprise fee collector [`#2011`](https://github.com/oceanprotocol/ocean.js/pull/2011)
111
+ - Release 4.3.5 [`2953f4a`](https://github.com/oceanprotocol/ocean.js/commit/2953f4ac49d56ac8b066ad8fa7a71b6bbc0df005)
112
+ - remove typo [`f199f4a`](https://github.com/oceanprotocol/ocean.js/commit/f199f4af809eb85249fe0c59303fcc3207d8e7a7)
113
+ - export EnterpriseFeeCollector [`68712a2`](https://github.com/oceanprotocol/ocean.js/commit/68712a2af17824bb8fc78824842376e35f582487)
114
+
115
+ #### [v4.3.4](https://github.com/oceanprotocol/ocean.js/compare/v4.3.3...v4.3.4)
116
+
117
+ > 15 November 2025
118
+
119
+ - add EnterpriseFee [`b502882`](https://github.com/oceanprotocol/ocean.js/commit/b502882d05375eda326166608730a11e779c6f42)
120
+ - Release 4.3.4 [`e45a7de`](https://github.com/oceanprotocol/ocean.js/commit/e45a7defa239f6800eb68a13e1a9a3d9662f509d)
121
+ - bump contracts [`0b226a1`](https://github.com/oceanprotocol/ocean.js/commit/0b226a107f309c6b200249d498ae7568343fcb92)
122
+
85
123
  #### [v4.3.3](https://github.com/oceanprotocol/ocean.js/compare/v4.3.2...v4.3.3)
86
124
 
87
125
  > 1 August 2025
package/Cheatsheet.md CHANGED
@@ -10,7 +10,7 @@
10
10
 
11
11
  ```bash
12
12
  npm init
13
- npm install @oceanprotocol/lib crypto-js ethers@5.7.2 typescript @types/node ts-node
13
+ npm install @oceanprotocol/lib crypto-js ethers typescript @types/node ts-node
14
14
  ```
15
15
 
16
16
  ### Configuration
@@ -224,7 +224,7 @@ const resources: ComputeResourceRequest[] = [
224
224
  },
225
225
  {
226
226
  id: 'ram',
227
- amount: 1000000000
227
+ amount: 2
228
228
  },
229
229
  {
230
230
  id: 'disk',
package/CodeExamples.md CHANGED
@@ -45,7 +45,7 @@ We start by initializing the services. To do this, we clone the Barge repository
45
45
  ```bash
46
46
  git clone https://github.com/oceanprotocol/barge.git
47
47
  cd barge/
48
- ./start_ocean.sh --with-provider2 --no-dashboard
48
+ ./start_ocean.sh
49
49
  ```
50
50
 
51
51
  ## 2. Create a new node.js project
@@ -35,7 +35,7 @@ We start by initializing the services. To do this, we clone the Barge repository
35
35
  ```bash
36
36
  git clone https://github.com/oceanprotocol/barge.git
37
37
  cd barge/
38
- ./start_ocean.sh --with-provider2 --no-dashboard --with-c2d
38
+ ./start_ocean.sh
39
39
  ```
40
40
 
41
41
  ## 2. Create a new Node.js project with TypeScript
package/README.md CHANGED
@@ -13,9 +13,11 @@
13
13
 
14
14
  With ocean.js, you can:
15
15
 
16
- - **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).
17
- - **Sell** datatokens for a fixed price. Sell data NFTs.
18
- - **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.
16
+ - **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).
17
+ - **Consume** data: download files or run compute-to-data jobs on datasets while preserving data privacy.
18
+ - **Sell** datatokens via fixed-rate exchanges or dispense them for free.
19
+ - **Manage pricing**: create fixed-rate exchanges, dispensers, or use dynamic pricing mechanisms for your assets.
20
+ - **Compute-to-Data**: run algorithms on the ocean network.
19
21
 
20
22
  ocean.js is part of the [Ocean Protocol](https://oceanprotocol.com) toolset.
21
23
 
@@ -23,6 +25,7 @@ This is in alpha state. If you run into problems, please open up a [new issue](h
23
25
 
24
26
  - [📚 Prerequisites](#-prerequisites)
25
27
  - [🏗 Installation & Usage](#-installation--usage)
28
+ - [📖 Documentation](#-documentation)
26
29
  - [🦑 Development](#-development)
27
30
  - [✨ Code Style](#-code-style)
28
31
  - [👩‍🔬 Testing](#-testing)
@@ -46,7 +49,7 @@ This is in alpha state. If you run into problems, please open up a [new issue](h
46
49
  npm install @oceanprotocol/lib
47
50
  ```
48
51
 
49
- - Checkout our [code examples](CodeExamples.md) or [compute to data examples](C2DExamples.md) to see how you can use ocean.js.
52
+ - 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.
50
53
  - Refer to the [Ocean Protocol documentation](https://docs.oceanprotocol.com/) for more guides and tutorials.
51
54
  - Visit the [Ocean Protocol website](https://docs.oceanprotocol.com/) for general information about Ocean Protocol.
52
55
  - 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
61
64
  ```
62
65
  - If using Next.js, they may need "moduleResolution": "bundler" for better compatibility.
63
66
 
67
+ ## 📖 Documentation
68
+
69
+ ### Quick Start Guides
70
+
71
+ - **[Code Examples](CodeExamples.md)**: Complete walkthrough of publishing and consuming datasets
72
+ - Creating Data NFTs and Datatokens
73
+ - Setting up fixed-rate exchanges and dispensers
74
+ - Buying and consuming data assets
75
+ - Using ERC725 key-value store
76
+
77
+ - **[Compute-to-Data Examples](ComputeExamples.md)**: Comprehensive guide to C2D features
78
+ - Publishing datasets and algorithms for compute
79
+ - Starting free compute jobs
80
+ - Running paid compute jobs with custom resources
81
+ - Checking compute status and retrieving results
82
+
83
+ - **[Cheatsheet](Cheatsheet.md)**: Quick reference for common operations
84
+ - Publishing datasets
85
+ - Consuming data
86
+ - Free and paid compute workflows
87
+ - Getting compute job status
88
+
89
+
64
90
  ## 🦑 Development
65
91
 
66
92
  The project is authored with TypeScript and compiled with `tsc`.
@@ -88,13 +114,13 @@ npm run format
88
114
 
89
115
  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.
90
116
 
91
- Running all tests requires running Ocean Protocol components beforehand with [Barge](https://github.com/oceanprotocol/barge), which also runs a `ganache-cli` instance:
117
+ Running all tests requires running Ocean Protocol components beforehand with [Barge](https://github.com/oceanprotocol/barge), which also runs a local blockchain instance:
92
118
 
93
119
  ```bash
94
120
  git clone https://github.com/oceanprotocol/barge
95
121
  cd barge
96
122
 
97
- ./start_ocean.sh --with-provider2 --no-dashboard --with-c2d
123
+ ./start_ocean.sh
98
124
  ```
99
125
 
100
126
  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
199
225
  ## 🏛 License
200
226
 
201
227
  ```
202
- Copyright ((C)) 2023 Ocean Protocol Foundation
228
+ Copyright ((C)) 2025 Ocean Protocol Foundation
203
229
 
204
230
  Licensed under the Apache License, Version 2.0 (the "License");
205
231
  you may not use this file except in compliance with the License.