> For the complete documentation index, see [llms.txt](https://support.safeheron.com/help-center/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.safeheron.com/help-center/jian-ti-zhong-wen/chan-pin/shen-ru-safeheron/auto-sweep.md).

# Auto Sweep

## <mark style="color:green;">Auto Sweep 流程</mark>

<figure><img src="/files/oIfvW7OTy6vOjGkOSBd3" alt=""><figcaption></figcaption></figure>

## <mark style="color:green;">准备工作</mark>

### 1. 对接 Safeheron API

通过 API 创建钱包，并在创建时为需要匹配 Auto Sweep 策略的钱包进行打标，标签为：Deposit Wallet

如果想针对已有钱包进行打标或取消打标，也可以通过 API 进行操作。

### 2. 配置 API Co-Signer

如果想配置 Auto Sweep 策略，必须首先对 API Key 配置 API Co-Signer，用于自动化审批及 MPC 签名。

对接 API 及 配置 API Co-Signer 教程，详见 API 文档及开发者站点。

API 文档：<https://docs.safeheron.com/api/en.html>

开发者站点：<https://developer.safeheron.com/>

## <mark style="color:green;">登录 Web 控制台，配置 Auto Sweep 策略</mark>

### 1. 入口及权限

客户使用 App 扫码登录 Safeheron Web 控制台 <https://www.safeheron.com/console/> ，可在应用菜单找到 Auto Sweep 应用入口。

在团队中，管理员角色及拥有管理交易策略权限的成员，才可以访问 Auto Sweep 应用。

<figure><img src="/files/6UhefKjmvE5hwYGqfraW" alt=""><figcaption></figcaption></figure>

### 2. 按照步骤及页面提示，完成 Auto Sweep 策略配置

如下图，需要按照步骤，先选择区块链网络，再依次完成归集目标钱包地址、触发条件、归集频率、网络费用上限、交易审批及签名人等字段配置。

其中，支持 Token 的区块链网络，还需要配置预留 Gas，并选择是否开启 Gas Station。如果开启 Gas Station，需要配置 Gas Station 钱包、单次补充 Gas 数量。

<figure><img src="/files/L6WK4LGA2Da0sGm3mqWR" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/SvzYiRCy6BOrXwBVb7uw" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/rZbpolFUlf5YT2xYgKGZ" alt=""><figcaption></figcaption></figure>

### 3. 配置完成，提交审批

配置完成后，可以直接提交审批。或者先保存后，再去策略列表集中提交审批。

<figure><img src="/files/KOS2C328z4SgWq6bzv4b" alt=""><figcaption></figcaption></figure>

### 4. 团队管理员在 App 进行审批

审批通过后，策略生效。团队管理员需要把 App 升级到最新版本( V1.2.7 及以上)，才可以进行审批。

<figure><img src="/files/rFwa3tt6OFz0mzT27JQj" alt="" width="188"><figcaption></figcaption></figure>

## <mark style="color:green;">注意事项</mark>

### 1. 支持删除及修改 Auto Sweep 策略

删除及修改均可以在 Auto Sweep 应用中的策略列表发起，并由团队管理员审批通过后生效。

删除及修改的审批，均需要确保没有正在处理的归集任务。如果要执行 Auto Sweep 策略的删除或修改，建议提前暂停平台相应网络的冲币服务，并在归集任务完成后，再进行删除或修改。

### 2. 配置项详细说明

| 配置项             | 名词解释                                                                                                        | 补充说明                                                                       |
| --------------- | ----------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| 区块链网络           | 即需要配置 Auto Sweep 策略的区块链网络，1 个区块链网络仅限添加 1 条策略。                                                               | 无                                                                          |
| 被归集钱包           | 即哪些钱包会根据策略被归集。                                                                                              | 通过 API 创建钱包，并在创建时为需要匹配 Auto Sweep 策略的钱包打标，标签为 Deposit Wallet               |
| 归集目标钱包          | 即资产归集到哪里，可以选择资产钱包或者白名单。                                                                                     | 根据客户平台的业务特点设置，一般归集到用于处理平台提币业务的热钱包。                                         |
| 触发条件            | 触发归集任务的条件，需要设定一个最低价值。                                                                                       | 根据不同的区块链网络 Gas 情况，设定触发条件，Gas 费用低廉的网络可以低一些，比如 10 USD；Gas 费用昂贵的网络可以高一些。      |
| 归集频率            | 即针对 Deposit Wallet 钱包的冲币入账，多久检测一次是否满足归集的触发条件。                                                               | 需要根据区块链网络的出块间隔以及自身业务特征进行配置。                                                |
| 网络费用上限          | 以设定交易的网络费用上限，如果链上 Gas 超过您设定的上限时，归集交易、补充 Gas 交易将延迟到账。                                                        | 可以根据一段时间的 Gas 波动情况，进行网络费用上限设定，太低可能会到账缓慢，太高可能会带来较多 Gas 成本。                  |
| 预留 Gas          | 当要归集的币种为所选区块链网络的主网币种且该网络支持 Token 时，可以配置要预留不归集的主网币种数量，这样当该钱包地址有 Token 入账时，无需再给该地址转入 Gas 即可完成 Token 归集，可降低成本。 | 建议预留足够 2-3 次归集的 Gas，即网络费用上限的 2 倍或 3 倍。如果不需要预留可以设置 0。不支持 Token 的区块链网络不支持设置。 |
| 预留最小单位 TRC20 币种 | 根据 TRON 能量模型特性，转账 TRC20 币种时，若收款钱包已存有对应币种余额，Gas 消耗将减少。在被归集钱包中预留最小单位余额，有助于降低用户充值时的成本。                         | 若您需降低您的用户往被归集钱包充值 TRC20 币种时的 Gas 费消耗，可开启该功能。                               |
| Gas Station     | 当被归集的钱包 Gas 不足时，从 Gas Station 为该钱包补充 Gas。                                                                   | 不支持 Token 的区块链网络不支持设置。                                                     |
| Gas Station 钱包  | 从该钱包，为需要归集的钱包补充 Gas。                                                                                        | 该钱包需要保证 Gas 币种的余额充足，建议监控该钱包，不足时及时补充。                                       |
| 单次补充 Gas 数量     | 单次为需要归集的钱包，补充的 Gas 具体数量。                                                                                    | 建议单次补充足够完成 2-3 次归集的 Gas，即网络费用上限的 2 倍或 3 倍，从而避免频繁补充 Gas，有效降低成本。             |
| 交易审批及签名人        | 选择配置了 API Co-Signer 的 API Key，自动化完成交易审批及 MPC 签名。                                                            | 如果配置多个 API Co-Signer，归集服务运行将更稳定。                                           |

如果您有建议或其他使用问题，欢迎跟 Safeheron Support 团队进行反馈。