You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/relayer/register.md
+9-4Lines changed: 9 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
sidebar_position: 2
3
3
---
4
4
5
-
# Run a Relayer Node(v2)
5
+
# Run a Relayer Node
6
6
7
7
## Overview
8
8
@@ -16,7 +16,7 @@ Prerequisites:
16
16
2. Register as a Relayer on the Helix UI, which involves staking a certain amount of collateral.
17
17
3. Pull the client code to your local environment, configure bridge information, and compile and run the code.
18
18
19
-
Now, let's run a Relayer Node on the testnet using the example of (arbitrum-sepolia -> sepolia, USDC).
19
+
Now, let's run a Relayer Node (v2 opposite type for example) on the testnet using the example of (arbitrum-sepolia -> sepolia, USDC).
20
20
21
21
## Registration
22
22
@@ -113,13 +113,18 @@ The configuration information for the Relayer is stored in the file `.maintain/c
113
113
-**feeLimit**: Controls the maximum cost of a relay operation, protecting the relayer from excessive gas fees
114
114
-**reorgThreshold**: It's an assumption about the block confirmation of transactions initiated by users on the source chain – the larger, the safer
115
115
-**bridgeType**: Indicates the type of bridge, currently taking values of `lnv2-default`, `lnv2-opposite`, and `lnv3`, consistent with the type displayed during relayer registration
-**maxProfit[optional]**: Relayer's maximum profit expected, both minProfit and maxProfix configured, then when the profit range jumps out of the interval [minProfit, maxProfit], it is automatically adjusted to (minProfit+maxProfit)/2.
116
118
-**tokens**: List the addresses of token pairs on the source and target chains, as well as the exchange rate for the native token on the target chain.
117
119
:::info{title=swapRate}
118
-
The swapRate is the conversion rate from the native token on the target chain to the transfer token. For example, the native token on Ethereum is ETH, and the token to be transferred is USDC, the conversion rate might be approximately 2500 at 16/01/2024. As prices fluctuate, the Relayer needs to periodically adjust this ratio.
120
+
Parameter swapRate is the conversion rate from the native token on the target chain to the transfer token. For example, the native token on Ethereum is ETH, and the token to be transferred is USDC, the conversion rate might be approximately 2500 at 16/01/2024. As prices fluctuate, the Relayer needs to periodically adjust this ratio.
119
121
:::
120
122
:::info{title=withdrawLiquidity}
121
123
For the lnv3 bridge, the relayer can set two parameters in this section, including withdrawLiquidityAmountThreshold and withdrawLiquidityCountThreshold. The relayer client will check every 6 hours, and if either threshold is met, the relayer client will initiate the settlement process.
122
124
:::
125
+
:::info{title=useDynamicBaseFee}
126
+
This parameter useDynamicBaseFee is only valid for LnbridgeV2 of type opposite, and needs to be used in conjunction with the minProfit parameter. When it is true, the relayer will query the cost of the current relay from the target chain in real time, and convert it into a dynamic cost signature on the source chain for the user.
127
+
:::
123
128
124
129
### SafeWallet
125
130
@@ -170,4 +175,4 @@ Return to the Relayer Dashboard page on the UI, enter the **Manage** page, and y
170
175
171
176
## Tips
172
177
173
-
If the token bridge is the `Default` type, there will be slight differences in the registration process, and in the client's configuration, the bridgeType should be modified to lnv2-default.
178
+
If the token bridge is the `Default` type, there will be slight differences in the registration process, and in the client's configuration, the bridgeType should be modified to lnv2-default. Or if the token bridge is the `v3` type, the bridgeType should be modified to `lnv3`.
Copy file name to clipboardExpand all lines: docs/user-guide/fee.md
+1-7Lines changed: 1 addition & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,7 @@ sidebar_position: 3
4
4
5
5
# Fee
6
6
7
-
## Fee for CBA Model
8
-
9
-
Under the CBA model, Helix relies on generic cross-chain messaging channel to transmit cross-chain information, with the cost of the underlying messaging being the primary factor contributing to the transfer expenses. Currently, Helix Bridge does not charge protocol fees. Therefore, in this type of token bridge, the fees incurred by users are limited to the cost associated with executing the messaging channel, typically paid using native tokens.
10
-
11
-
## Fee for LnBridge
12
-
13
-
For LnBridge, the fee structure consists of two components: a base fee to cover the gas fees incurred by the LnProvider when executing transactions on the target chain and a liquidity fee designed to compensate the LnProvider for the loss of liquidity.
7
+
The fee structure consists of two components: a base fee to cover the gas fees incurred by the LnProvider when executing transactions on the target chain and a liquidity fee designed to compensate the LnProvider for the loss of liquidity.
Copy file name to clipboardExpand all lines: docs/user-guide/transfer.md
-2Lines changed: 0 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,9 @@ sidebar_position: 1
8
8
9
9
- Visit Helix Bridge at [mainnet](https://helixbridge.app/) or [testnet](https://helix-stg-test.vercel.app/).
10
10
- Select source chain, target chain and token you want to transfer.
11
-
12
11
- Switch wallet to the source chain and connect wallet.
13
12
- Fill the transfer amount, and then you can find the transfer information include fee, estimated time if there are bridges avaliable.
14
13
- Click `Transfer` and you will receive a popup for transfer confirmation. Then click `Confirm` after every detail is checked.
15
-
16
14
- Then you will be prompted to confirm the transaction in your wallet. After confirming in your wallet, you have submitted the transaction. You can track the transfer progress by clicking on the `transaction history` in the pop-up window.
17
15
- All the transfer histories can be found in `Explorer`, and you can filter the history by account address or transaction hash. Click the record, you can see the detail of the transfer.
0 commit comments