@oceanprotocol/lib 2.6.0 → 2.6.3

package/CHANGELOG.md

@@ -4,8 +4,42 @@ 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).
 
+#### [v2.6.3](https://github.com/oceanprotocol/ocean.js/compare/v2.6.2...v2.6.3)
+
+- add macOS readme message [`#1697`](https://github.com/oceanprotocol/ocean.js/pull/1697)
+
+#### [v2.6.2](https://github.com/oceanprotocol/ocean.js/compare/v2.6.1...v2.6.2)
+
+> 7 February 2023
+
+- Bump @truffle/hdwallet-provider from 2.1.4 to 2.1.5 [`#1689`](https://github.com/oceanprotocol/ocean.js/pull/1689)
+- Bump http-cache-semantics from 4.1.0 to 4.1.1 [`#1691`](https://github.com/oceanprotocol/ocean.js/pull/1691)
+- Set withMint default to true [`#1693`](https://github.com/oceanprotocol/ocean.js/pull/1693)
+- Bump decimal.js from 10.4.2 to 10.4.3 [`#1687`](https://github.com/oceanprotocol/ocean.js/pull/1687)
+- Bump mocha from 10.1.0 to 10.2.0 [`#1690`](https://github.com/oceanprotocol/ocean.js/pull/1690)
+- Bump json5 from 1.0.1 to 1.0.2 [`#1681`](https://github.com/oceanprotocol/ocean.js/pull/1681)
+- Release 2.6.2 [`956a000`](https://github.com/oceanprotocol/ocean.js/commit/956a0009c78739f0d8dda56707ffbbeb9eea1cc3)
+
+#### [v2.6.1](https://github.com/oceanprotocol/ocean.js/compare/v2.6.0...v2.6.1)
+
+> 6 January 2023
+
+- Fix download when content disposition header missing [`#1680`](https://github.com/oceanprotocol/ocean.js/pull/1680)
+- Bump prettier from 2.7.1 to 2.8.1 [`#1676`](https://github.com/oceanprotocol/ocean.js/pull/1676)
+- Bump @types/node from 18.8.0 to 18.11.18 [`#1675`](https://github.com/oceanprotocol/ocean.js/pull/1675)
+- Bump release-it from 15.5.0 to 15.6.0 [`#1674`](https://github.com/oceanprotocol/ocean.js/pull/1674)
+- Bump @truffle/hdwallet-provider from 2.1.2 to 2.1.4 [`#1677`](https://github.com/oceanprotocol/ocean.js/pull/1677)
+- Bump @typescript-eslint/eslint-plugin from 5.45.0 to 5.47.1 [`#1678`](https://github.com/oceanprotocol/ocean.js/pull/1678)
+- Adding instructions on how to use ERC725 in the CodeExamples file [`#1672`](https://github.com/oceanprotocol/ocean.js/pull/1672)
+- Min 30gwei polygon main and mumbai fees [`#1671`](https://github.com/oceanprotocol/ocean.js/pull/1671)
+- Combining tests and checking that the data received is correct [`39ac4a4`](https://github.com/oceanprotocol/ocean.js/commit/39ac4a40462938c5f1b1f482eaf05bce2812c360)
+- Updating assertion failure messages [`5d3bcde`](https://github.com/oceanprotocol/ocean.js/commit/5d3bcde5bd66588f18efdacc7cd1aafe1c158f0e)
+- Updating guide and formatting [`726e34c`](https://github.com/oceanprotocol/ocean.js/commit/726e34c8fc013523d7db6bad7a86687c9a462f2d)
+
 #### [v2.6.0](https://github.com/oceanprotocol/ocean.js/compare/v2.5.2...v2.6.0)
 
+> 19 December 2022
+
 - Add missing symbol and name helper on datatoken [`#1667`](https://github.com/oceanprotocol/ocean.js/pull/1667)
 - add headers [`#1665`](https://github.com/oceanprotocol/ocean.js/pull/1665)
 - Compute Example Readme flow [`#1615`](https://github.com/oceanprotocol/ocean.js/pull/1615)
@@ -15,6 +49,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Bump @typescript-eslint/eslint-plugin from 5.38.1 to 5.45.0 [`#1657`](https://github.com/oceanprotocol/ocean.js/pull/1657)
 - Bump @truffle/hdwallet-provider from 2.1.0 to 2.1.2 [`#1656`](https://github.com/oceanprotocol/ocean.js/pull/1656)
 - Bump web3 from 1.8.0 to 1.8.1 [`#1659`](https://github.com/oceanprotocol/ocean.js/pull/1659)
+- Release 2.6.0 [`94fd276`](https://github.com/oceanprotocol/ocean.js/commit/94fd276d6b34b3e4d620871d06e7e23271be6868)
 
 #### [v2.5.2](https://github.com/oceanprotocol/ocean.js/compare/v2.5.1...v2.5.2)
 
@@ -267,21 +302,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Bump typedoc from 0.22.15 to 0.22.17 [`#1514`](https://github.com/oceanprotocol/ocean.js/pull/1514)
 - Release 1.1.3 [`7772e93`](https://github.com/oceanprotocol/ocean.js/commit/7772e9387ef9d63f98ea80cfd4eefbea963dd0ad)
 
-#### [v1.1.2](https://github.com/oceanprotocol/ocean.js/compare/v1.1.1...v1.1.2)
-
-> 15 June 2022
-
-- Release 1.1.2 [`85bf271`](https://github.com/oceanprotocol/ocean.js/commit/85bf2716e26d8691aeb9d5504e563d557419dc2e)
-- manual bump fix [`5674a54`](https://github.com/oceanprotocol/ocean.js/commit/5674a547d1d367ce88b3595f0be8ebbf12274266)
-
-#### [v1.1.1](https://github.com/oceanprotocol/ocean.js/compare/v1.1.0...v1.1.1)
-
-> 15 June 2022
-
-- Release 1.1.1 [`ea48e01`](https://github.com/oceanprotocol/ocean.js/commit/ea48e015ac8299f71d57a929f8f30c5d1a8446e7)
-- manual bump fix [`a362410`](https://github.com/oceanprotocol/ocean.js/commit/a36241004b1d9578ec5c02d9d6e64d9750c53a7b)
-
-#### [v1.1.0](https://github.com/oceanprotocol/ocean.js/compare/v1.0.0...v1.1.0)
+#### [v1.1.2](https://github.com/oceanprotocol/ocean.js/compare/v1.0.0...v1.1.2)
 
 > 15 June 2022
 
@@ -289,7 +310,9 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Bump @types/node from 17.0.35 to 17.0.44 [`#1513`](https://github.com/oceanprotocol/ocean.js/pull/1513)
 - Bump eslint-config-oceanprotocol from 1.5.0 to 2.0.1 [`#1466`](https://github.com/oceanprotocol/ocean.js/pull/1466)
 - update to new schema & compute fixes [`#1510`](https://github.com/oceanprotocol/ocean.js/pull/1510)
-- Release 1.1.0 [`112c27e`](https://github.com/oceanprotocol/ocean.js/commit/112c27edab58ef0681ea3e87fb09978411924753)
+- Release 1.1.2 [`85bf271`](https://github.com/oceanprotocol/ocean.js/commit/85bf2716e26d8691aeb9d5504e563d557419dc2e)
+- manual bump fix [`5674a54`](https://github.com/oceanprotocol/ocean.js/commit/5674a547d1d367ce88b3595f0be8ebbf12274266)
+- manual bump fix [`a362410`](https://github.com/oceanprotocol/ocean.js/commit/a36241004b1d9578ec5c02d9d6e64d9750c53a7b)
 
 #### [v1.0.0](https://github.com/oceanprotocol/ocean.js/compare/v1.0.0-next.45...v1.0.0)
 

package/CodeExamples.md

@@ -677,6 +677,53 @@ Let's check we received the download URL ok
   
 ```
 
+## 8. Using ERC725 Key-Value Store
+
+Data NFTs can store arbitrary key-value pairs on-chain. This opens up their usage for a broad variety of applications, such as comments & ratings, attestations, and privately sharing data (when the value is encrypted).
+
+Let's see how!
+
+Here are the steps:
+
+1. Setup (same as above)
+2. Publish data NFT (same as above)
+3. Add key-value pair to data NFT (use the `setData` method)
+4. Retrieve value from data NFT (use the `getData` method)
+
+  ### 8.1 Add key-value pair to data NFT
+Let's start by using the `setData` method to update the nft key value store with some data
+```Typescript
+    const nft = new Nft(web3)
+    const data = 'SomeData'
+    try {
+      await nft.setData(freNftAddress, publisherAccount, '1', data)
+    } catch (e) {
+      assert.fail('Failed to set data in NFT ERC725 key value store', e)
+    }
+```
+
+Under the hood, this uses [ERC725](https://erc725alliance.org/), which augments ERC721 with a well-defined way to set and get key-value pairs.
+
+### 8.2 get the key-value pair data from the NFT'
+
+Use the `getData` method to get the data stored in the nft key value store
+
+```Typescript
+    try {
+      const response = await nft.getData(freNftAddress, '1')
+      console.log('getData response: ', response)
+      assert(
+        response === data,
+        'Wrong data received when getting data from NFT ERC725 key value store'
+      )
+    } catch (e) {
+      assert.fail('Failed to get data from NFT ERC725 key value store', e)
+    }
+```
+
+That's it! Note the simplicity. All data was stored and retrieved from on-chain. We don't need Ocean Provider or Ocean Aquarius for these use cases (though the latter can help for fast querying & retrieval).
+  
+
 
 ## Editing this file
 Please note that CodeExamples.md is an autogenerated file, you should not edit it directly.

package/README.md

@@ -128,6 +128,8 @@ npm run test:integration
 npm run test:integration:cover
 ```
 
+> Note: On macOS, changes to the `provider`, `metadataCache` and `subgraph` URLs are required, as their default `barge` IPs can not be accessed due to network constraints on macOS. Instead use `http://127.0.0.1` for each direct call to the mentioned services, but keep the internal `provider` URL (`http://172.15.0.4:8030`) hardcoded inside all DDO's `serviceEndpoint`, and when calling `nft.setMetadata()`.
+
 ## 🛳 Production
 
 To create a production build, run from the root of the project: