Merge pull request #842 from oceanprotocol/issue-741-update-docs-getPastEvents

Update docs about 'getPreviousValidOrders' only working on Eth

README.md

@@ -45,10 +45,25 @@ This is in alpha state and you can expect running into problems. If you run into
 - [🏛 License](#-license)
 
 ## 📚 Prerequisites
+
 - node.js ([Install from here](https://nodejs.org/en/download/))
 - Docker ([Managed as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/))
 - A Unix based operating system (Mac or Linux)
 
+### Note
+
+Any function that uses `getPastEvents()` will only work on Eth (see: <https://github.com/oceanprotocol/ocean.js/issues/741>). This includes:
+
+- searchPoolforDT()
+- getPoolsbyCreator()
+- getPoolSharesByAddress()
+- getAllPoolLogs()
+- getPreviousValidOrders()
+- searchforDT()
+- getExchangesbyCreator()
+- getExchangeSwaps()
+- getAllExchangesSwaps()
+
 ## 🏗 Installation
 
 ```bash
@@ -76,6 +91,7 @@ async function init() {
   return ocean
 }
 ```
+
 ### Beginners Guide
 
 This introduction is aimed at developers who are completely new to blockchain, no coding experience is required.
@@ -145,11 +161,13 @@ cd barge
 You can then proceed to run in another terminal.
 
 Let ocean.js know where to pickup the smartcontract addresses:
+
 ```
 export ADDRESS_FILE="${HOME}/.ocean/ocean-contracts/artifacts/address.json"
 ```
 
 Build metadata:
+
 ```
 npm run build
 ```

src/datatokens/Datatokens.ts

@@ -462,6 +462,7 @@ export class DataTokens {
    * @param {String} address consumer Address
    * @return {Promise<string>} string
    */
+  // Note that getPreviousValidOrders() only works on Eth (see: https://github.com/oceanprotocol/ocean.js/issues/741)
   public async getPreviousValidOrders(
     dataTokenAddress: string,
     amount: string,