From 54e61d9c9295e776b73a03698985cb654ebff626 Mon Sep 17 00:00:00 2001 From: Darko Kolev Date: Tue, 16 May 2023 17:42:59 +0200 Subject: [PATCH] chore: fixing outdated request-toolbox README (#1099) --- packages/toolbox/README.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/packages/toolbox/README.md b/packages/toolbox/README.md index 072f779b07..0ea1ce0dd9 100644 --- a/packages/toolbox/README.md +++ b/packages/toolbox/README.md @@ -31,6 +31,28 @@ yarn request-toolbox request create yarn request-toolbox request create 12 ``` +or if ran from the `/toolbox` folder + +```bash +yarn cli request create +yarn cli request create 12 +``` + +#### CLI Troubleshooting + +If you receive the following error + +```bash +error Command "request-toolbox" not found. +``` + +then build the toolbox package like bellow: + +```bash +cd packages/toolbox +yarn --check-files +``` + ### Conversion paths #### Adding & removing aggregators @@ -49,9 +71,9 @@ It will suggest pairs of currencies: The following commands are also available: -- `yarn cli addAggregator` can be used if you have all information about an aggregator you want to add -- `yarn cli removeAggregator` will set the given currency pair to the 0x00[...]00 address. -- `yarn cli listMissingAggregators ` (where `name` is a valid Request Finance currency list, [https://api.request.network/currency/list/name]() should be valid) will display missing aggregators for that list on all networks. +- `yarn request-toolbox addAggregator` can be used if you have all information about an aggregator you want to add +- `yarn request-toolbox removeAggregator` will set the given currency pair to the 0x00[...]00 address. +- `yarn request-toolbox listMissingAggregators ` (where `name` is a valid Request Finance currency list, [https://api.request.network/currency/list/name]() should be valid) will display missing aggregators for that list on all networks. Use `--help` for details about each command.