Auto Sweep
Tutorial on using the Auto Sweep; All essentials to help you get started quickly
Last updated
Tutorial on using the Auto Sweep; All essentials to help you get started quickly
Last updated
Create wallets through the API, and label the wallets intended for auto-sweep policy as "Deposit Wallet" during wallet creation.
If you wish to label or untag existing wallets, you can also use API to operate.
To configure auto-sweep policies, the API Co-Signer must first be configured for the API Key for automated approvals and MPC Sign.
For how to integrate API and configure API Co-Signer, please refer to the API documentations and developer site:
API Documentations: https://docs.safeheron.com/api/en.html
Developer Site: https://developer.safeheron.com/
Use the Safeheron App to scan and log into the Safeheron Web Console (https://www.safeheron.com/console/), where the auto-sweep can be found in the “Application” on the left toolbar.
Please note that only the team admins and members with Manage Transaction Policy permission can access the auto-sweep.
As shown below, select the blockchain network first, and then complete the configurations for the target wallet address, triggering condition, sweeping frequency, network fee cap, transaction approvers and signers, etc.
For blockchain networks supporting tokens, you can also configure the reserved gas, and decide whether to enable the Gas Station. If the Gas Station is enabled, configure the gas station wallet and the amount of gas to be refueled each time.
After configuration, submit directly for approval. Or you can save all drafts, then visit the policy list to submit them for approval collectively.
Once approved, the policy takes effect. Team admins need to review and approve the request using the App upgraded to the latest version (V1.2.7 and above).
You can initiate to delete or modify auto-sweep policies in the policy list of “Auto Sweep” -> “Application” and the request will take effect once approved by team admins.
For deleting or modifying policies, please ensure there are no sweeping tasks pending. We suggest that you suspend the depositing service for relevant networks in advance if plan to delete or modify auto-sweep policies. Once sweeping is completed, you can proceed with deletion or modification.
If you have any suggestions or other questions, please feel free to provide your valuable feedback to Safeheron Support.
| Item | Definition | Tips |
|---|---|---|
Blockchain Network
The blockchain network needs the auto-sweep policy. Every blockchain network can only set up one auto-sweep policy.
None
Target Address
The target wallet for sweeping, where assets will be swept to. You can choose asset wallets or whitelists.
Configure it based on your platform's business model. Generally, assets are swept to the hot wallet used for the withdrawal service of the platform.
Triggering Condition
The condition that triggers the sweeping. It requires a minimum value.
Given different gas cases on different blockchains, for blockchains with lower gas fees, set a lower triggering threshold (e.g. 10 USD). For networks with higher gas fees, vice versa.
Sweeping Frequency
The frequency of detecting the deposit wallet to see if all deposits meet the triggering condition.
The frequency should be configured based on the block time of the blockchain and specific business needs.
Network Fee Cap
The maximum fee designated for a transaction. If the gas required for on-chain transactions exceeds this cap, it might cause delays in sweeping and gas refueling.
Given the fluctuation of gas over time, you can set an appropriate cap. Transaction may take a longer time if gas is too low, while unnecessarily high gas costs may occur if it’s too high.
Reserved Gas
For blockchains that support tokens and where the native cryptocurrency is used for gas, you can designate an amount of the mainnet coin not to be swept. This ensures that when tokens are received, there's enough native cryptocurrencies (gas) to process them without needing additional transfers, hence saving costs.
It's recommended to reserve enough gas for 2-3 sweeps (i.e. 2-3 times the network fee cap). If reserving gas is unnecessary, it can be set to 0. This setting doesn't apply to blockchains that don't support tokens.
Gas Station
When the wallet has insufficient gas, the Gas Station will fund it.
Only applicable if the blockchain supports tokens.
Gas Station Wallet
The wallet that is used to refuel the gas in the wallet to be swept.
Please ensure there's enough balance of the required coins (used for gas) in this wallet. We suggest monitoring the Gas Station wallet for timely funding.
Gas Fueling Per Time
The amount of gas to be refueled into the sweeping wallet per time.
Please ensure you set the amount to be 2-3 times the network fee cap which can support 2-3 sweeping, effectively lowering costs without frequently refueling gas.
Transaction Approver and Signer
Choose the API Key which has its corresponding API Co-Signer to automate the transaction approval and MPC Sign.
Multiple API Co-Signers can guarantee the stability of auto-sweeping.
