From 9126ef19b4cd3a8077df9d82054f56e5dc0782f1 Mon Sep 17 00:00:00 2001 From: Jamie Hewitt Date: Mon, 14 Jun 2021 16:08:26 +0300 Subject: [PATCH 1/3] updating readme --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index f0a238a6..6042d582 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,17 @@ This is in alpha state and you can expect running into problems. If you run into - 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 From 3cfd3e4db4d7cdff9b1389a870559ffca3deab8d Mon Sep 17 00:00:00 2001 From: Jamie Hewitt Date: Mon, 14 Jun 2021 16:10:25 +0300 Subject: [PATCH 2/3] fixing formatting --- README.md | 31 +++++++++++++++++++------------ 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 6042d582..7795bc4d 100644 --- a/README.md +++ b/README.md @@ -45,12 +45,15 @@ 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: +- 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: ). This includes: + - searchPoolforDT() - getPoolsbyCreator() - getPoolSharesByAddress() @@ -60,6 +63,7 @@ Any function that uses `getPastEvents()` will only work on Eth (see: https://git - getExchangesbyCreator() - getExchangeSwaps() - getAllExchangesSwaps() + ## 🏗 Installation ```bash @@ -87,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) @@ -107,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 -- [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 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 test OCEAN](docs/get-test-OCEAN.md) - from rinkeby +- [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 wallets](docs/wallets.md) - on generating, storing, and accessing private keys +- [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 @@ -156,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 ``` From a71666d236c607de877338aa2088d2ccf926343d Mon Sep 17 00:00:00 2001 From: Jamie Hewitt Date: Mon, 14 Jun 2021 16:15:35 +0300 Subject: [PATCH 3/3] commenting on the code --- src/datatokens/Datatokens.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/src/datatokens/Datatokens.ts b/src/datatokens/Datatokens.ts index bd625424..15f67745 100644 --- a/src/datatokens/Datatokens.ts +++ b/src/datatokens/Datatokens.ts @@ -462,6 +462,7 @@ export class DataTokens { * @param {String} address consumer Address * @return {Promise} string */ + // Note that getPreviousValidOrders() only works on Eth (see: https://github.com/oceanprotocol/ocean.js/issues/741) public async getPreviousValidOrders( dataTokenAddress: string, amount: string,