Skip to content

Commit ed8e25f

Browse files
committed
docs: add defi exchange
1 parent d985c77 commit ed8e25f

File tree

12 files changed

+57
-11
lines changed

12 files changed

+57
-11
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@
22

33
<h1 align="center">XCoin</h1>
44

5-
<h4 align="center">Next Generation Trading Bot</h4>
5+
<h4 align="center">Next Generation Trading Bot Based On Nodejs,CCXT,DEFI</h4>
66

77
**A simple and powerful trading bot based on nodejs**
88

99
> server side: nodejs+mongodb;
1010
>
1111
> client side: Android,Ios, Linux, macOS and Windows.
12+
>
13+
> support exchagne: CCXT, binance and mexc...;DEFI,uniswap and pancakeswap...
1214
1315
## Screenshots
1416

@@ -26,6 +28,8 @@
2628

2729
- Support all exchanges supported by [ccxt](https://github.com/ccxt/ccxt), [Binance](https://www.binance.com),[BinanceUsdm](https://www.binance.com), [Mexc](https://www.mexc.com/) have been fully tested.
2830

31+
- Support defi exchanges like [Pancakeswap](https://www.pancakeswap.finance),[Uniswap](https://www.uniswap.org),easy to extend your custom defi exchange.
32+
2933
- Support all trading strategies supported by [technicalindicators](https://github.com/anandanand84/technicalindicators), easily extend new strategies through JSON files.
3034

3135
- Supports futures trading and can control whether it is long or short or both trading.
@@ -38,6 +42,8 @@
3842

3943
- Support real transactions, virtual transactions and backtest transactions
4044

45+
- Support blacklist and whitelist, ensure orderly progress of quantitative and non quantitative transactions
46+
4147
- Support all mobile devices and desktop devices through [Panacea](https://github.com/markmind/panacea-api), control all the states and operations of the bot in real time
4248

4349
- Based on [Zenbot](https://github.com/DeviaVir/zenbot), Supports most of the functions of zenbot.

README.zh-CN.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
> 服务器端: nodejs+mongodb ;
1010
>
1111
> 可选客户端: Android,Ios, Linux, macOS and Windows.
12+
>
13+
> 支持交易所: CCXT 如 binance与mexc;DEFI,如uniswap 与 pancakeswap.
1214
1315
## 屏幕截图
1416

@@ -26,6 +28,8 @@
2628

2729
- 支持 [ccxt](https://github.com/ccxt/ccxt) 支持的所有交易所,[Binance](https://www.binance.com),[BinanceUsdm](https://www.binance.com),[Mexc](https://www.mexc.com/)已完整测试.
2830

31+
- 支持 defi 支持交易所,[Pancakeswap](https://www.pancakeswap.finance),[Uniswap](https://www.uniswap.org),可轻松扩展第三方DEFI交易所.
32+
2933
- 支持 [technicalindicators](https://github.com/anandanand84/technicalindicators) 支持的所有交易策略,轻松通过JSON文件扩展新的策略.
3034

3135
- 支持期货交易并可控制是多空双方还是仅交易多方,空方.
@@ -38,6 +42,8 @@
3842

3943
- 支持真实交易,虚拟交易及对交易进行回测
4044

45+
- 支持黑名单,白名单,让量化交易与非量化交易有序进行
46+
4147
- 通过 [灵丹](https://github.com) 支持所有移动设备与桌面设备,实时控制机器人的全部状态与操作
4248

4349
- 基于 [Zenbot](https://github.com/DeviaVir/zenbot) ,支持 zenbot 的绝大部分功能.

docs/config.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,18 @@ The basic configuration file is located in the /confg directory, and the file na
459459
type: "textarea",
460460
value: '',
461461
placeholder: true,
462-
}
462+
},
463+
{
464+
name: "watch_with_white_list",//use whitelist
465+
type: "bool",
466+
value: false
467+
},
468+
{
469+
name: "white_list",//white list
470+
type: "textarea",
471+
value: "",
472+
placeholder: true
473+
}
463474
],
464475
paper: [//Simulated transaction related
465476
{

docs/developer.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ You can get more help at [API](api.md)
1212

1313
The exchange extension provides the data source for the bot to trade. By default, the extension provided by ccxt is used. ccxt provides a large number of exchange data interfaces. If you need to develop an exchange-specific interface, you can create it under extensions Own exchange interface.
1414

15+
The defi exchange is the main interface for defi, now including uniswap and pancakeswap. If you need to develop an exchange-specific interface, you can create it under extensions Own exchange interface.
16+
1517
The sim exchange is the main interface for simulated trading, including paper and sim. The former uses real exchange data for simulated trading, and the latter uses historical data for backtesting transactions.
1618

1719
You can get more help at [exchangse](exchange.md)

docs/exchange.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ We are also considering adding a DEFI type exchange based on pancakswap, so stay
1212

1313
Supports nearly a hundred mainstream exchanges that obtain data through the [ccxt](https://github.com/ccxt/ccxt) module. Through the api key provided by the user, the exchange can pass through three modes: anonymous, user authentication, and websocket authentication Get the data, you can call it conveniently as needed
1414

15+
### Defi
16+
17+
Support Defi exchanges such as [pancakeswap](https://www.pancakeswap.finance) And [uniswap](https://www.uniswap.org). Support real-time automatic addition of new active tokens. You can also easily expand other defi exchanges as needed
18+
1519
### sim
1620

1721
Simulated exchange, used to support simulated and backtested transactions

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ layout: home
44
hero:
55
name: XCoin
66
text: Next Gerneration Trading Bot
7-
tagline: A Simple and Powerful Trading Robot Based on Nodejs.
7+
tagline: A Simple and Powerful Trading Bot Support Based on Nodejs, CCXT and DEFI.
88
image:
99
src: /images/screenshot.jpg
1010
alt: XCoin
@@ -21,7 +21,7 @@ features:
2121
- title: Unlimited trading pairs
2222
details: Support trading multiple trading pairs at the same time, you can trade all pairs at the same time.
2323
- title: Unlimited exchanges
24-
details: Support all exchanges supported by ccxt, easily add custom exchanges.
24+
details: Support all exchanges supported by ccxt, support defi exchange like pancakeswap and uniswap,easily extend custom exchange.
2525
- title: New Strategy Framework
2626
details: Support all trading strategies supported by technicalindicators, and easily extend new strategies through JSON files.
2727
- title: Support long and short trading

docs/start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ node ./xcoin strategies
5757
Get your assets on an exchange
5858

5959
```bash
60-
node ./xcoin exchange binance --balance
60+
node ./xcoin exchange uniswap --balance
6161
```
6262

6363
## Run XCoin
@@ -71,7 +71,7 @@ node ./xcoin trade binance --watch-symbols binance.BTC-USDT,ETH-USDt --paper
7171
You can also use the yarn command directly, both have the same effect
7272

7373
```bash
74-
yarn trade binance --watch-symbols binance.BTC-USDT,ETH-USDt --paper
74+
yarn trade pancakeswap --watch-symbols binance.BTC-USDT,ETH-USDt --paper
7575
```
7676

7777
Use the `--paper` flag to decide whether to trade live or paper.

docs/zh/config.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -462,6 +462,17 @@ XCoin通过配置文件初始化机器人,包括以下几类配置文件
462462
type: "textarea",
463463
value: '',
464464
placeholder: true,
465+
},
466+
{
467+
name: "watch_with_white_list",//是否使用白名单
468+
type: "bool",
469+
value: false
470+
},
471+
{
472+
name: "white_list",//白名单
473+
type: "textarea",
474+
value: "",
475+
placeholder: true
465476
}
466477
],
467478
paper: [//模拟交易相关

docs/zh/developer.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ XCoin提供一些基础扩展来强化功能,开发者也可以通过扩展模
88

99
## 交易所扩展 /extensions/exchanges
1010

11-
交易所扩展提供了供机器人进行交易的数据来源,默认情况下使用ccxt提供的扩展,ccxt了提供大量的交易所数据接口,如果您需要开发某一交易所特定的接口,您可以在extensions下创建自己的交易所接口。
11+
交易所扩展提供了供机器人进行交易的数据来源,默认情况下使用ccxt提供的扩展,ccxt了提供大量的交易所数据接口,如果您需要开发某一交易所特定的接口,您可以在extensions下创建自己的交易所接口。
12+
13+
defi交易所提供基于DEFI的交易所扩展,目前提供了Uniswap与Pancakeswap交易所的扩展,如果您需要开发某一交易所特定的接口,您可以在extensions下创建自己的交易所接口。
1214

1315
sim交易所是模拟交易的主接口,包括paper与sim两种模式,前者使用真实交易所数据进行模拟交易,后者使用历史数据回测交易。
1416

docs/zh/exchange.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ XCoin支持 [ccxt](https://github.com/ccxt/ccxt) 支持的所有交易所(超
1010

1111
支持通过 [ccxt](https://github.com/ccxt/ccxt) 模块获取数据的近百个主流交易所,通过用户提供的api key,交易所可通过匿名,用户认证,websocket认证三种模式获得数据,您可以根据需要便捷地进行调用
1212

13+
### defi
14+
15+
支持主流Defi交易所如 [pancakeswap](https://www.pancakeswap.finance)[uniswap](https://www.uniswap.org),支持实时自动添加新的活跃代币。 您也可以根据需要便捷地扩展其它defi交易所
16+
1317
### sim
1418

1519
模拟交易所,用于支持模拟与回测交易

0 commit comments

Comments
 (0)