Skip to content

Commit 0356358

Browse files
authored
Merge pull request #30 from Gravity-Tech/misc/extend-docs
Extend docs
2 parents 9845d15 + 9a34c61 commit 0356358

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ Gravity Node Data Extractor
33

44
[![Build Status](https://drone.gravityhub.org/api/badges/Gravity-Tech/gravity-node-data-extractor/status.svg)](https://drone.gravityhub.org/Gravity-Tech/gravity-node-data-extractor)
55

6-
## Common prerequisite
6+
## Abstract
77

8-
You need to have valid Binance API key data reading. (--api param)
8+
This package represents working example of Gravity Data Extractor.
99

1010
## I. Running public Docker image
1111

@@ -15,14 +15,24 @@ You need to have valid Binance API key data reading. (--api param)
1515
docker pull gravityhuborg/gravity-data-extractor:master
1616
```
1717

18-
### 2. Run it
18+
### 2. Run
1919

20-
For example, on port 8090
20+
You can run SuSy dApp extractor
2121

2222
```
2323
docker run -itd -p 8090:8090 gravityhuborg/gravity-data-extractor:master
2424
```
2525

26+
### 2.1 Run SuSy dApp extractor for EVM-based or WAVES-based chains
27+
28+
Currently, extractor supports only `EVM-chain<->WAVES` direction.
29+
So we in order to add new custom(non-EVM) chain we need to provide 4 additional params
30+
and 2 bridge implementations as well - for direct and reversal swaps.
31+
32+
So, for EVM-based tokens we run `--waves-based-to-eth-direct` and `--waves-based-to-eth-reverse`.
33+
For WAVES-based tokens we run `--eth-based-to-waves-direct` and `--eth-based-to-waves-reverse`
34+
35+
2636
## II. Running the binary
2737

2838
### 1. Install Go

0 commit comments

Comments
 (0)