From be6ebe0f51aacef4435ee3d81a913bf8e8b48505 Mon Sep 17 00:00:00 2001
From: Administrator <15274802129@163.com>
Date: Mon, 11 May 2026 16:22:56 +0800
Subject: [PATCH] docs(gateApi): 更新代码注释和文档说明
---
src/main/java/com/xcong/excoin/modules/gateApi/GateConfig.java | 79 ++++++++++++++++++++++++++++++++++++++-
1 files changed, 77 insertions(+), 2 deletions(-)
diff --git a/src/main/java/com/xcong/excoin/modules/gateApi/GateConfig.java b/src/main/java/com/xcong/excoin/modules/gateApi/GateConfig.java
index ca6446c..b65d0aa 100644
--- a/src/main/java/com/xcong/excoin/modules/gateApi/GateConfig.java
+++ b/src/main/java/com/xcong/excoin/modules/gateApi/GateConfig.java
@@ -96,6 +96,8 @@
this.unrealizedPnlPriceMode = builder.unrealizedPnlPriceMode;
}
+ // ==================== REST/WS 地址 ====================
+
/**
* 根据环境返回 REST API 基础路径。
* <ul>
@@ -122,22 +124,58 @@
: "wss://ws-testnet.gate.com/v4/ws/futures/usdt";
}
+ // ==================== 认证信息 ====================
+
+ /** @return Gate API v4 密钥 */
public String getApiKey() { return apiKey; }
+ /** @return Gate API v4 签名密钥，用于 HMAC-SHA512 签名 */
public String getApiSecret() { return apiSecret; }
+
+ // ==================== 交易标的 ====================
+
+ /** @return 合约名称（如 ETH_USDT、XAU_USDT） */
public String getContract() { return contract; }
+ /** @return 杠杆倍数（如 "100" 表示 100x） */
public String getLeverage() { return leverage; }
+
+ // ==================== 持仓配置 ====================
+
+ /** @return 保证金模式（cross=全仓 / isolated=逐仓） */
public String getMarginMode() { return marginMode; }
+ /** @return 持仓模式（single=单向 / dual=双向 / dual_plus） */
public String getPositionMode() { return positionMode; }
+
+ // ==================== 策略参数 ====================
+
+ /** @return 网格间距比例（如 0.0015 表示 0.15%），用于生成价格队列和计算止盈价 */
public BigDecimal getGridRate() { return gridRate; }
+ /** @return 整体止盈阈值（USDT），累计已实现盈亏 ≥ 此值时策略停止 */
public BigDecimal getOverallTp() { return overallTp; }
+ /** @return 最大亏损阈值（USDT），累计已实现盈亏 ≤ -此值时策略停止 */
public BigDecimal getMaxLoss() { return maxLoss; }
+ /** @return 每次下单的张数（如 "1" 表示 1 张合约） */
public String getQuantity() { return quantity; }
- public boolean isProduction() { return isProduction; }
- public int getReopenMaxRetries() { return reopenMaxRetries; }
+ /** @return 网格价格队列的容量上限（超出时截断尾部） */
public int getGridQueueSize() { return gridQueueSize; }
+
+ // ==================== 风险控制 ====================
+
+ /** @return 保证金占初始本金比例上限（默认 0.2 即 20%），超限跳过开仓 */
public BigDecimal getMarginRatioLimit() { return marginRatioLimit; }
+ /** @return 补仓最大重试次数（当前版本未使用） */
+ public int getReopenMaxRetries() { return reopenMaxRetries; }
+
+ // ==================== 盈亏计算 ====================
+
+ /** @return 合约乘数（单张合约代表的基础资产数量，如 ETH_USDT=0.01） */
public BigDecimal getContractMultiplier() { return contractMultiplier; }
+ /** @return 未实现盈亏计价模式：LAST_PRICE（最新成交价）/ MARK_PRICE（标记价格） */
public PnLPriceMode getUnrealizedPnlPriceMode() { return unrealizedPnlPriceMode; }
+
+ // ==================== 环境 ====================
+
+ /** @return 是否为生产环境（true=实盘生产网 / false=模拟盘测试网） */
+ public boolean isProduction() { return isProduction; }
public static Builder builder() {
return new Builder();
@@ -145,38 +183,75 @@
/**
* GateConfig 的流式构造器，提供合理的默认值。
+ *
+ * <h3>必填项</h3>
+ * {@code apiKey} 和 {@code apiSecret} 必须设置，其余参数均有默认值。
+ *
+ * <h3>默认值</h3>
+ * BTC_USDT / 10x / cross(全仓) / dual(双向) / gridRate=0.35% /
+ * overallTp=0.5 / maxLoss=7.5 / quantity=1 / isProduction=false
*/
public static class Builder {
+ /** Gate API v4 密钥（必填） */
private String apiKey;
+ /** Gate API v4 签名密钥（必填） */
private String apiSecret;
+ /** 合约名称，默认 BTC_USDT */
private String contract = "BTC_USDT";
+ /** 杠杆倍数，默认 "10" */
private String leverage = "10";
+ /** 保证金模式，默认 "cross"（全仓） */
private String marginMode = "cross";
+ /** 持仓模式，默认 "dual"（双向） */
private String positionMode = "dual";
+ /** 网格间距比例，默认 0.0035（0.35%） */
private BigDecimal gridRate = new BigDecimal("0.0035");
+ /** 整体止盈阈值（USDT），默认 0.5 */
private BigDecimal overallTp = new BigDecimal("0.5");
+ /** 最大亏损阈值（USDT），默认 7.5 */
private BigDecimal maxLoss = new BigDecimal("7.5");
+ /** 每次下单张数，默认 "1" */
private String quantity = "1";
+ /** 是否为生产环境，默认 false（测试网） */
private boolean isProduction = false;
+ /** 补仓最大重试次数，默认 3 */
private int reopenMaxRetries = 3;
+ /** 网格队列容量，默认 50 */
private int gridQueueSize = 50;
+ /** 保证金占初始本金比例上限，默认 0.2（20%） */
private BigDecimal marginRatioLimit = new BigDecimal("0.2");
+ /** 合约乘数，默认 0.001 */
private BigDecimal contractMultiplier = new BigDecimal("0.001");
+ /** 未实现盈亏计价模式，默认 LAST_PRICE（最新成交价） */
private PnLPriceMode unrealizedPnlPriceMode = PnLPriceMode.LAST_PRICE;
+ /** 设置 API Key */
public Builder apiKey(String apiKey) { this.apiKey = apiKey; return this; }
+ /** 设置 API Secret */
public Builder apiSecret(String apiSecret) { this.apiSecret = apiSecret; return this; }
+ /** 设置合约名称 */
public Builder contract(String contract) { this.contract = contract; return this; }
+ /** 设置杠杆倍数 */
public Builder leverage(String leverage) { this.leverage = leverage; return this; }
+ /** 设置保证金模式（cross=全仓 / isolated=逐仓） */
public Builder marginMode(String marginMode) { this.marginMode = marginMode; return this; }
+ /** 设置持仓模式（single=单向 / dual=双向） */
public Builder positionMode(String positionMode) { this.positionMode = positionMode; return this; }
+ /** 设置网格间距比例 */
public Builder gridRate(BigDecimal gridRate) { this.gridRate = gridRate; return this; }
+ /** 设置整体止盈阈值（USDT） */
public Builder overallTp(BigDecimal overallTp) { this.overallTp = overallTp; return this; }
+ /** 设置最大亏损阈值（USDT） */
public Builder maxLoss(BigDecimal maxLoss) { this.maxLoss = maxLoss; return this; }
+ /** 设置每次下单张数 */
public Builder quantity(String quantity) { this.quantity = quantity; return this; }
+ /** 设置环境（true=实盘生产网 / false=模拟盘测试网） */
public Builder isProduction(boolean isProduction) { this.isProduction = isProduction; return this; }
+ /** 设置补仓最大重试次数 */
public Builder reopenMaxRetries(int reopenMaxRetries) { this.reopenMaxRetries = reopenMaxRetries; return this; }
+ /** 设置合约乘数（单张合约代表的基础资产数量） */
public Builder contractMultiplier(BigDecimal contractMultiplier) { this.contractMultiplier = contractMultiplier; return this; }
+ /** 设置未实现盈亏计价模式 */
public Builder unrealizedPnlPriceMode(PnLPriceMode mode) { this.unrealizedPnlPriceMode = mode; return this; }
public GateConfig build() {
--
Gitblit v1.9.1