@oceanprotocol/lib 4.3.3 → 5.0.0-next.2

package/CHANGELOG.md

@@ -4,7 +4,9 @@ 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).
 
-#### [v4.3.3](https://github.com/oceanprotocol/ocean.js/compare/v5.0.0-next.1...v4.3.3)
+#### [v5.0.0-next.2](https://github.com/oceanprotocol/ocean.js/compare/v5.0.0-next.1...v5.0.0-next.2)
+
+- Feature/contracts_240 [`#1979`](https://github.com/oceanprotocol/ocean.js/pull/1979)
 
 #### [v5.0.0-next.1](https://github.com/oceanprotocol/ocean.js/compare/v4.3.2...v5.0.0-next.1)
 

package/CodeExamples.md

@@ -78,7 +78,7 @@ Start by importing all of the necessary dependencies
 ```Typescript
 import fs from 'fs'
 
-import { ethers, providers, Signer } from 'ethers'
+import { ethers, formatEther, getAddress, JsonRpcProvider, Signer, toBeHex } from 'ethers'
 import crypto from 'crypto-js'
 import { homedir } from 'os'
 import {
@@ -119,7 +119,7 @@ describe('Marketplace flow tests
 Now we define the variables which we will need later
 
 ```Typescript
-  let provider: ethers.providers.JsonRpcProvider
+  let provider: JsonRpcProvider
   let config: Config
   let aquarius: Aquarius
   let datatoken: Datatoken
@@ -197,7 +197,7 @@ Next, we define the metadata that will describe our data asset. This is what we
 ## 5. Load the configuration, initialize accounts and deploy contracts
 ```Typescript
   
-    provider = new providers.JsonRpcProvider(
+    provider = new JsonRpcProvider(
       process.env.NODE_URI || configHelperNetworks[1].nodeUri
     )
     publisherAccount = (await provider.getSigner(0)) as Signer
@@ -252,7 +252,7 @@ you need to mint oceans to mentioned accounts only if you are using barge to tes
     ]
 
     const tokenContract = new ethers.Contract(addresses.Ocean, minAbi, publisherAccount)
-    const estGasPublisher = await tokenContract.estimateGas.mint(
+    const estGasPublisher = await tokenContract.mint.estimateGas(
       await publisherAccount.getAddress(),
       amountToUnits(null, null, '1000', 18)
     )
@@ -290,10 +290,11 @@ you need to mint oceans to mentioned accounts only if you are using barge to tes
 
   ### 6.1 Publish a dataset (create NFT + Datatoken) with a fixed rate exchange
 ```Typescript
+    const { chainId } = await publisherAccount.provider.getNetwork()
     const factory = new NftFactory(
       addresses.ERC721Factory,
       publisherAccount,
-      await publisherAccount.getChainId()
+      Number(chainId)
     )
 
     const nftParams: NftCreateData = {
@@ -357,10 +358,8 @@ Now let's console log each of those values to check everything is working
 
   ### 6.2 Set metadata in the fixed rate exchange NFT
 ```Typescript
-    const nft = new Nft(
-      publisherAccount,
-      (await publisherAccount.provider.getNetwork()).chainId
-    )
+    const { chainId } = await publisherAccount.provider.getNetwork()
+    const nft = new Nft(publisherAccount, Number(chainId))
 
     fixedDDO = { ...genericAsset }
 
@@ -368,10 +367,9 @@ Now let's console log each of those values to check everything is working
 Now we are going to update the ddo and set the did
 ```Typescript
 
-    fixedDDO.chainId = (await publisherAccount.provider.getNetwork()).chainId
+    fixedDDO.chainId = Number(chainId)
     fixedDDO.id =
-      'did:op:' +
-      SHA256(ethers.utils.getAddress(freNftAddress) + fixedDDO.chainId.toString(10))
+      'did:op:' + SHA256(getAddress(freNftAddress) + fixedDDO.chainId.toString(10))
     fixedDDO.nftAddress = freNftAddress
 
 ```
@@ -410,7 +408,7 @@ Now let's console log the DID to check everything is working
       0,
       providerUrl,
       '',
-      ethers.utils.hexlify(2),
+      toBeHex(2),
       encryptedDDO,
       isAssetValid.hash
     )
@@ -419,11 +417,8 @@ Now let's console log the DID to check everything is working
 
   ### 6.3 Marketplace displays fixed rate asset for sale
 ```Typescript
-    const fixedRate = new FixedRateExchange(
-      freAddress,
-      publisherAccount,
-      await publisherAccount.getChainId()
-    )
+    const { chainId } = await publisherAccount.provider.getNetwork()
+    const fixedRate = new FixedRateExchange(freAddress, publisherAccount, Number(chainId))
     const oceanAmount = await (
       await fixedRate.calcBaseInGivenDatatokensOut(freId, '1')
     ).baseTokenAmount
@@ -438,7 +433,8 @@ Now that the market has fetched those values it can display the asset on the fro
 
   ### 7.1 Consumer buys a fixed rate asset data asset, and downloads it
 ```Typescript
-    datatoken = new Datatoken(publisherAccount, await publisherAccount.getChainId())
+    const { chainId } = await publisherAccount.provider.getNetwork()
+    datatoken = new Datatoken(publisherAccount, Number(chainId))
     const DATATOKEN_AMOUNT = '10000'
 
     await datatoken.mint(
@@ -448,7 +444,7 @@ Now that the market has fetched those values it can display the asset on the fro
     )
 
     const consumerBalance = await provider.getBalance(await consumerAccount.getAddress())
-    const consumerETHBalance = ethers.utils.formatEther(consumerBalance)
+    const consumerETHBalance = formatEther(consumerBalance)
 
 ```
 Let's do a quick check of the consumer ETH balance before the swap
@@ -487,11 +483,7 @@ Before we call the contract we have to call `approve` so that the contract can m
       DATATOKEN_AMOUNT
     )
 
-    const fixedRate = new FixedRateExchange(
-      freAddress,
-      consumerAccount,
-      await consumerAccount.getChainId()
-    )
+    const fixedRate = new FixedRateExchange(freAddress, consumerAccount, Number(chainId))
 
 ```
 Now we can make the contract call
@@ -548,7 +540,7 @@ Next, we need to initialize the provider
       providerFees.providerFeeAmount
     )
 
-    datatoken = new Datatoken(consumerAccount, await consumerAccount.getChainId())
+    datatoken = new Datatoken(consumerAccount, Number(chainId))
 
 ```
 Lets now make the payment
@@ -609,10 +601,11 @@ Lets check that the download URL was successfully received
 
   ### 8.1 Publish a dataset (create NFT + Datatoken) with a dispenser
 ```Typescript
+    const { chainId } = await publisherAccount.provider.getNetwork()
     const factory = new NftFactory(
       addresses.ERC721Factory,
       publisherAccount,
-      await publisherAccount.getChainId()
+      Number(chainId)
     )
 
     const nftParams: NftCreateData = {
@@ -667,19 +660,16 @@ Lets check that we managed to received all of those values without any problems
 -->
   ### 8.2 Set metadata in the dispenser NFT
 ```Typescript
-    const nft = new Nft(
-      publisherAccount,
-      (await publisherAccount.provider.getNetwork()).chainId
-    )
+    const { chainId } = await publisherAccount.provider.getNetwork()
+    const nft = new Nft(publisherAccount, Number(chainId))
 
 ```
 Lets start by updating the ddo and setting the did
 ```Typescript
-    fixedDDO.chainId = (await publisherAccount.provider.getNetwork()).chainId
+    fixedDDO.chainId = Number(chainId)
 
     fixedDDO.id =
-      'did:op:' +
-      SHA256(ethers.utils.getAddress(dispenserNftAddress) + fixedDDO.chainId.toString(10))
+      'did:op:' + SHA256(getAddress(dispenserNftAddress) + fixedDDO.chainId.toString(10))
     fixedDDO.nftAddress = dispenserNftAddress
 ```
 Now we need to encrypt file(s) using provider
@@ -712,7 +702,7 @@ Now we need to encrypt file(s) using provider
       0,
       providerUrl,
       '',
-      ethers.utils.hexlify(2),
+      toBeHex(2),
       encryptedDDO,
       isAssetValid.hash
     )
@@ -725,12 +715,9 @@ Now we need to encrypt file(s) using provider
 
   ### 9.1 Consumer gets a dispenser data asset, and downloads it
 ```Typescript
-    datatoken = new Datatoken(publisherAccount, await publisherAccount.getChainId())
-    const dispenser = new Dispenser(
-      addresses.Dispenser,
-      consumerAccount,
-      await consumerAccount.getChainId()
-    )
+    const { chainId } = await publisherAccount.provider.getNetwork()
+    datatoken = new Datatoken(publisherAccount, Number(chainId))
+    const dispenser = new Dispenser(addresses.Dispenser, consumerAccount, Number(chainId))
 
     let consumerDTBalance = await balance(
       consumerAccount,
@@ -759,7 +746,7 @@ Now we need to encrypt file(s) using provider
     const resolvedDDO = await aquarius.waitForIndexer(fixedDDO.id)
     assert(resolvedDDO, 'Cannot fetch DDO from Aquarius')
 
-    datatoken = new Datatoken(consumerAccount, await consumerAccount.getChainId())
+    datatoken = new Datatoken(consumerAccount, Number(chainId))
 
 ```
 At this point we need to encrypt file(s) using provider
@@ -843,7 +830,8 @@ Here are the steps:
   ### 10.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(publisherAccount, await publisherAccount.getChainId())
+    const { chainId } = await publisherAccount.provider.getNetwork()
+    const nft = new Nft(publisherAccount, Number(chainId))
     const data = 'SomeData'
     try {
       await nft.setData(

package/ComputeExamples.md

@@ -121,7 +121,7 @@ Start by importing all of the necessary dependencies
 import fs from 'fs'
 import { homedir } from 'os'
 
-import { ethers, providers, Signer } from 'ethers'
+import { ethers, getAddress, JsonRpcProvider, parseEther, Signer, toBeHex } from 'ethers'
 import {
   ProviderInstance,
   Aquarius,
@@ -152,6 +152,7 @@ import {
 import crypto from 'crypto-js'
 import { DDO } from '@oceanprotocol/ddo-js'
 import { EscrowContract } from '../../src/contracts/Escrow.js'
+import BigNumber from 'bignumber.js'
 const { SHA256 } = crypto
 ```
 
@@ -307,17 +308,12 @@ async function createAssetHelper(
   ddo: DDO,
   providerUrl: string
 ) {
-  const nft = new Nft(owner, (await owner.provider.getNetwork()).chainId)
+  const { chainId } = await owner.provider.getNetwork()
+  const nft = new Nft(owner, Number(chainId))
 
-  const nftFactory = new NftFactory(
-    addresses.ERC721Factory,
-    owner,
-    await owner.getChainId()
-  )
-
-  const chain = (await owner.provider.getNetwork()).chainId
+  const nftFactory = new NftFactory(addresses.ERC721Factory, owner, Number(chainId))
 
-  ddo.chainId = parseInt(chain.toString(10))
+  ddo.chainId = Number(chainId)
   const nftParamsAsset: NftCreateData = {
     name,
     symbol,
@@ -351,14 +347,22 @@ async function createAssetHelper(
   // create the files encrypted string
   assetUrl.datatokenAddress = datatokenAddressAsset
   assetUrl.nftAddress = nftAddress
-  ddo.services[0].files = await ProviderInstance.encrypt(assetUrl, chain, providerUrl)
+  ddo.services[0].files = await ProviderInstance.encrypt(
+    assetUrl,
+    Number(chainId),
+    providerUrl
+  )
   ddo.services[0].datatokenAddress = datatokenAddressAsset
   ddo.services[0].serviceEndpoint = providerUrl
 
   ddo.nftAddress = nftAddress
-  ddo.id = 'did:op:' + SHA256(ethers.utils.getAddress(nftAddress) + chain.toString(10))
+  ddo.id = 'did:op:' + SHA256(ethers.getAddress(nftAddress) + chainId.toString(10))
 
-  const encryptedResponse = await ProviderInstance.encrypt(ddo, chain, providerUrl)
+  const encryptedResponse = await ProviderInstance.encrypt(
+    ddo,
+    Number(chainId),
+    providerUrl
+  )
   const validateResult = await aquariusInstance.validate(ddo, owner, providerUrl)
   await nft.setMetadata(
     nftAddress,
@@ -366,7 +370,7 @@ async function createAssetHelper(
     0,
     providerUrl,
     '',
-    ethers.utils.hexlify(2),
+    toBeHex(2),
     encryptedResponse,
     validateResult.hash
   )
@@ -431,7 +435,7 @@ describe('Compute-to-data example tests
 We need to load the configuration. Add the following code into your `run(){ }` function
 ```Typescript
   
-    const provider = new providers.JsonRpcProvider(
+    const provider = new JsonRpcProvider(
       process.env.NODE_URI || configHelperNetworks[1].nodeUri
     )
     publisherAccount = (await provider.getSigner(0)) as Signer
@@ -490,7 +494,7 @@ you need to mint oceans to mentioned accounts only if you are using barge to tes
     ]
 
     const tokenContract = new ethers.Contract(addresses.Ocean, minAbi, publisherAccount)
-    const estGasPublisher = await tokenContract.estimateGas.mint(
+    const estGasPublisher = await tokenContract.mint.estimateGas(
       await publisherAccount.getAddress(),
       amountToUnits(null, null, '1000', 18)
     )
@@ -575,10 +579,8 @@ Now, let's check that we successfully published a algorithm (create NFT + Datato
 
   ### 8.1 Mint dataset and algorithm datatokens to publisher
 ```Typescript
-    const datatoken = new Datatoken(
-      publisherAccount,
-      (await publisherAccount.provider.getNetwork()).chainId
-    )
+    const { chainId } = await publisherAccount.provider.getNetwork()
+    const datatoken = new Datatoken(publisherAccount, Number(chainId))
     await datatoken.mint(
       resolvedDatasetDdo.services[0].datatokenAddress,
       await publisherAccount.getAddress(),
@@ -612,10 +614,8 @@ Now, let's check that we successfully published a algorithm (create NFT + Datato
 
   ### 10.1 Start a compute job using a free C2D environment
 <!--
-    datatoken = new Datatoken(
-      consumerAccount,
-      (await consumerAccount.provider.getNetwork()).chainId
-    )
+    const { chainId } = await consumerAccount.provider.getNetwork()
+    datatoken = new Datatoken(consumerAccount, Number(chainId))
 -->
 
 let's check the free compute environment
@@ -754,10 +754,8 @@ let's check the free compute environment
 
   ### 12.1 Start a compute job using a paid C2D resources
 <!--
-    datatoken = new Datatoken(
-      consumerAccount,
-      (await consumerAccount.provider.getNetwork()).chainId
-    )
+    const { chainId } = await consumerAccount.provider.getNetwork()
+    datatoken = new Datatoken(consumerAccount, Number(chainId))
 -->
 
 let's select compute environment which have free and paid resources
@@ -826,9 +824,7 @@ let's select compute environment which have free and paid resources
         providerUrl,
         consumerAccount,
         resources,
-        (
-          await consumerAccount.provider.getNetwork()
-        ).chainId
+        Number(chainId)
       )
 
       console.log(
@@ -845,7 +841,7 @@ let's select compute environment which have free and paid resources
   Let's check funds for escrow payment
   ```Typescript
       const escrow = new EscrowContract(
-        ethers.utils.getAddress(providerInitializeComputeResults.payment.escrowAddress),
+        getAddress(providerInitializeComputeResults.payment.escrowAddress),
         consumerAccount
       )
       const paymentTokenPublisher = new Datatoken(publisherAccount)
@@ -854,18 +850,18 @@ let's select compute environment which have free and paid resources
         await publisherAccount.getAddress()
       )
       assert(
-        ethers.utils.parseEther(balancePublisherPaymentToken) > ethers.BigNumber.from(0),
+        new BigNumber(parseEther(balancePublisherPaymentToken)).isGreaterThan(0),
         'Balance should be higher than 0'
       )
       const tx = await publisherAccount.sendTransaction({
         to: computeEnv.consumerAddress,
-        value: ethers.utils.parseEther('1.5')
+        value: parseEther('1.5')
       })
       await tx.wait()
 
       await paymentTokenPublisher.transfer(
         paymentToken,
-        ethers.utils.getAddress(computeEnv.consumerAddress),
+        getAddress(computeEnv.consumerAddress),
         (Number(balancePublisherPaymentToken) / 2).toString()
       )
       const amountToDeposit = (
@@ -913,9 +909,7 @@ let's select compute environment which have free and paid resources
         computeValidUntil,
         paymentToken,
         resources,
-        (
-          await consumerAccount.provider.getNetwork()
-        ).chainId
+        Number(chainId)
       )
   ```