Skip to content

Commit

Permalink
chore: fixing outdated request-toolbox README (#1099)
Browse files Browse the repository at this point in the history
  • Loading branch information
KolevDarko committed May 16, 2023
1 parent acce3ce commit 54e61d9
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions packages/toolbox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 <name>` (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 <name>` (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.

Expand Down

0 comments on commit 54e61d9

Please sign in to comment.