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

Update docs about 'getPreviousValidOrders' only working on Eth

README.md

@@ -45,9 +45,24 @@ 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/)) 
+- Docker ([Managed as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/))
-- A Unix based operating system (Mac or Linux) 
+- 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
 
@@ -76,9 +91,10 @@ async function init() {
   return ocean
 }
 ```
+
 ### Beginners Guide
 
-This introduction is aimed at developers who are completely new to blockchain, no coding experience is required. 
+This introduction is aimed at developers who are completely new to blockchain, no coding experience is required.
 
 [Go to beginners guide](docs/beginners_guide.md)
 
@@ -96,15 +112,15 @@ This batteries-included flow includes metadata, multiple services for one datato
 
 ### 📖 Learn more
 
--   [Get test OCEAN](docs/get-test-OCEAN.md) - from rinkeby
+- [Get test OCEAN](docs/get-test-OCEAN.md) - from rinkeby
--   [Understand config parameters](docs/parameters.md) - envvars vs files
+- [Understand config parameters](docs/parameters.md) - envvars vs files
--   [Learn about off-chain services](docs/services.md) - Ocean Provider for data services, Aquarius metadata store
+- [Learn about off-chain services](docs/services.md) - Ocean Provider for data services, Aquarius metadata store
--   [Learn about wallets](docs/wallets.md) - on generating, storing, and accessing private keys
+- [Learn about wallets](docs/wallets.md) - on generating, storing, and accessing private keys
--   [Get an overview of ocean.js](docs/overview.md) - key modules and functions
+- [Get an overview of ocean.js](docs/overview.md) - key modules and functions
 
 If you have any difficulties with the quickstarts, or if you have further questions about how to use ocean.js please reach out to us on [Discord](https://discord.gg/TnXjkR5).
 
-If you notice any bugs or issues with Ocean.js please [open an issue on github](https://github.com/oceanprotocol/ocean.js/issues/new?assignees=&labels=bug&template=bug_report.md&title=). 
+If you notice any bugs or issues with Ocean.js please [open an issue on github](https://github.com/oceanprotocol/ocean.js/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
 
 ## 🦑 Development
 
@@ -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,