Skip to content

Commit 1defb4c

Browse files
committed
docs: 更新贡献指南和 README,移除多余链接
1 parent e03bedb commit 1defb4c

File tree

2 files changed

+19
-20
lines changed

2 files changed

+19
-20
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ docs: 更新 README 安装说明
111111

112112
如有问题,请:
113113

114-
- 查看 [README.md](README.md)[EXAMPLES.md](EXAMPLES.md)
114+
- 查看 [README.md](README.md)
115115
- 在 GitHub Issues 中提问
116116
- 查看现有的 Pull Requests
117117

README.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -13,32 +13,32 @@
1313

1414
### 交易工具
1515

16-
- **市价订单**:使用 HyperLiquid 原生函数优化的开仓和平仓
17-
- **限价订单**:支持 reduce-only 和自定义订单 ID 追踪
18-
- **括号订单**:一键创建带止盈止损的新仓位(OCO 行为)
19-
- **订单管理**:按 ID 或客户端 ID 取消订单、批量取消、修改订单
20-
- **仓位管理**:查看仓位、平仓(全部或部分)、获取盈亏信息
21-
- **高级止盈止损**:为现有仓位设置 OCO 止盈止损
16+
- [x] **市价订单**:使用 HyperLiquid 原生函数优化的开仓和平仓
17+
- [x] **限价订单**:支持 reduce-only 和自定义订单 ID 追踪
18+
- [x] **括号订单**:一键创建带止盈止损的新仓位(OCO 行为)
19+
- [x] **订单管理**:按 ID 或客户端 ID 取消订单、批量取消、修改订单
20+
- [x] **仓位管理**:查看仓位、平仓(全部或部分)、获取盈亏信息
21+
- [x] **高级止盈止损**:为现有仓位设置 OCO 止盈止损
2222

2323
### 账户管理
2424

25-
- **余额信息**:获取账户余额和保证金详情
26-
- **仓位跟踪**:监控所有开仓及未实现盈亏
27-
- **交易历史**:查询成交记录和交易历史
28-
- **杠杆控制**:为不同资产更新杠杆设置
29-
- **资金划转**:在现货和合约账户间转移资金
25+
- [x] **余额信息**:获取账户余额和保证金详情
26+
- [x] **仓位跟踪**:监控所有开仓及未实现盈亏
27+
- [x] **交易历史**:查询成交记录和交易历史
28+
- [x] **杠杆控制**:为不同资产更新杠杆设置
29+
- [x] **资金划转**:在现货和合约账户间转移资金
3030

3131
### 市场数据
3232

33-
- **实时价格**:获取当前市场数据,包括买卖价差
34-
- **订单簿**:获取可配置深度的实时订单簿数据
35-
- **资金费率**:访问历史资金费率信息
33+
- [x] **实时价格**:获取当前市场数据,包括买卖价差
34+
- [x] **订单簿**:获取可配置深度的实时订单簿数据
35+
- [x] **资金费率**:访问历史资金费率信息
3636

3737
### 实用工具
3838

39-
- **账户总览**:获取账户综合概览
40-
- **美元转换**:根据当前价格计算代币数量
41-
- **仓位管理**:专用的现有仓位管理工具
39+
- [x] **账户总览**:获取账户综合概览
40+
- [x] **美元转换**:根据当前价格计算代币数量
41+
- [x] **仓位管理**:专用的现有仓位管理工具
4242

4343
## 快速开始
4444

@@ -57,7 +57,7 @@ uvx --python 3.13 --from hyperliquid-mcp-python hyperliquid-mcp start
5757
uvx --python 3.13 --from hyperliquid-mcp-python hyperliquid-mcp stdio
5858
```
5959

60-
> **为什么要指定 `--python 3.13`?**
60+
> **为什么要指定 `--python 3.13`?**
6161
> 依赖包 `ckzg` 目前只提供到 Python 3.13 的预编译包,Python 3.14 还不支持。指定版本可以避免编译错误。
6262
6363
### 方式 2:本地开发安装
@@ -318,7 +318,6 @@ uv run python test_scripts/interactive_test.py
318318
- **客户端订单 ID**:必须是 128 位十六进制字符串(如 `0x1234...`
319319
- **未找到仓位**:设置止盈止损前确保仓位存在
320320
- **网络**:先用测试网:`HYPERLIQUID_TESTNET=true`
321-
- **余额为 0**:运行 `uv run python test_scripts/check_address.py` 验证地址配置
322321
- **API 钱包**:如使用 API 钱包,需在 `.env` 中设置 `HYPERLIQUID_ACCOUNT_ADDRESS` 为主账号地址
323322

324323
## 相关链接

0 commit comments

Comments
 (0)