mirror of
https://github.com/Brotocol-xyz/xlink-docs.git
synced 2026-01-13 06:50:47 +08:00
docs: add final ajustments on structure
This commit is contained in:
sofinico
@@ -13,20 +13,23 @@
|
||||
|
||||
## Getting Started
|
||||
|
||||
<!-- * [Getting Started](./getting-started/README.md) -->
|
||||
<!-- - [Getting Started](./getting-started/README.md) -->
|
||||
|
||||
- [How to Connect your Wallet](./getting-started/how-to-connect-your-wallet.md)
|
||||
- [Supported Wallets](./getting-started/supported-wallets.md)
|
||||
- [How to Connect Your Wallet](./getting-started/how-to-connect-your-wallet.md)
|
||||
- [Supported Wallets](./getting-started/supported-wallets.md)
|
||||
- [Active Notifications](./getting-started/active-notifications.md)
|
||||
|
||||
## Features
|
||||
## What Can You Do
|
||||
|
||||
- [BroSwap](./features/broswap/README.md)
|
||||
- [DEX Aggregation](./features/broswap/dex-aggregation.md)
|
||||
- [How to swap Non-bridgeable Tokens?](./features/broswap/how-to-swap-non-bridgeable-tokens.md)
|
||||
- [Key Concepts](./features/broswap/key-concepts.md)
|
||||
- [How to Swap](./features/broswap/how-to-swap.md)
|
||||
- [How to Swap Non-Bridgeable Tokens](./features/broswap/how-to-swap-non-bridgeable-tokens.md)
|
||||
- [BroBridge](./features/brobridge/README.md)
|
||||
- [How Brotocol Bridge Works?](./features/brobridge/how-xlink-works.md)
|
||||
- [Explorer](./features/explorer/README.md)
|
||||
- [Active Notifications](./features/explorer/active-notifications.md)
|
||||
- [Key Concepts](./features/brobridge/key-concepts.md)
|
||||
- [How to Bridge Assets](./features/brobridge/how-to-bridge.md)
|
||||
|
||||
<!-- - [Explorer](./features/explorer/README.md) -->
|
||||
|
||||
## Resources
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
description: 'Brotocol: Bridge Better, Bro—Best Rates, Seamless Security!'
|
||||
cover: ../../.gitbook/assets/gbbanner.png
|
||||
cover: ../.gitbook/assets/gbbanner.png
|
||||
coverY: 0
|
||||
layout:
|
||||
cover:
|
||||
@@ -22,7 +22,7 @@ layout:
|
||||
|
||||
With L1s and L2s multiplying, Brotocol makes cross-chain bridging simple, affordable, and secure—no matter your preferred blockchain. Get the **best rates** with Brotocol Bridge!
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Bro_L1_L2.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/Bro_L1_L2.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
### What is Brotocol?
|
||||
|
||||
@@ -30,7 +30,7 @@ Brotocol [BroBridge](../features/brobridge/README.md) is a **MPC-based hybrid bi
|
||||
|
||||
### Why Brotocol?
|
||||
|
||||
<figure><img src="../../.gitbook/assets/2.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/2.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
Bridging shouldn’t suck—high fees and sketchy paths are out. Brotocol’s your **crypto bro**, offering:
|
||||
|
||||
@@ -43,13 +43,13 @@ Bridging shouldn’t suck—high fees and sketchy paths are out. Brotocol’s yo
|
||||
|
||||
If you are bridging 1 $BTC—how much do you keep, let’s see the table below:
|
||||
|
||||
<figure><img src="../../.gitbook/assets/3.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/3.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
_**🔴:** No direct bridge but requires the use of CEX deposit/withdrawal and does not include withdrawal fees_
|
||||
|
||||
Beyond the savings, Brotocol has the most BTC-friendly route possible!
|
||||
|
||||
<figure><img src="../../.gitbook/assets/m.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/m.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
### How does Brotocol Work?
|
||||
|
||||
@@ -64,7 +64,7 @@ When you want to move assets (like Bitcoin) from one network to another, Brotoco
|
||||
|
||||
### Brotocol by the Numbers!
|
||||
|
||||
<figure><img src="../../.gitbook/assets/5.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/5.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
**Here are Brotocol numbers by the numbers (As of 25th March):**
|
||||
|
||||
@@ -78,7 +78,7 @@ When you want to move assets (like Bitcoin) from one network to another, Brotoco
|
||||
|
||||
### Bridge Challenges Today
|
||||
|
||||
<figure><img src="../../.gitbook/assets/6.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/6.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
* **Limited Network Support:** Most centralized exchanges (CEXs) don’t support depositing $WBTC on Arbitrum or other low-TVL EVM chains, reducing liquidity and options.
|
||||
* **High and Unpredictable Costs:** Moving $BTC across EVM and non-EVM chains is expensive and inconsistent due to fees (bridging, swapping, withdrawals) and liquidity issues.
|
||||
@@ -86,7 +86,7 @@ When you want to move assets (like Bitcoin) from one network to another, Brotoco
|
||||
* **Lack of Bridge Options:** Popular bridges (e.g., Wormhole, Stargate) rarely offer consistent paths between chains like Arbitrum, BNB, or Ethereum for $BTC variants.
|
||||
* **Poor User Experience:** Different $BTC versions vary in support, cost, and ease of movement, creating a confusing and inefficient onboarding process that limits chain adoption.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/7.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/7.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
Let’s take Arbitrum’s $WBTC as a quick example.
|
||||
|
||||
@@ -101,6 +101,6 @@ Demand for EVM BTC is huge—Brotocol makes it flow.
|
||||
|
||||
To check Brotocol’s Proof of Reserve, you can visit here: [https://brotocol.xyz/bridge/reserve](https://brotocol.xyz/bridge/reserve)
|
||||
|
||||
<figure><img src="../../.gitbook/assets/8.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src="../.gitbook/assets/8.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
All Brotocol audits are available here: [**Brotocol Audit Reports**](../../developers/security-audits.md)
|
||||
|
||||
@@ -1,125 +1,23 @@
|
||||
---
|
||||
description: BroBridge is the best place to bridge from Bitcoin to any chains for lowest fees!
|
||||
---
|
||||
|
||||
# BroBridge
|
||||
|
||||
<figure><img src="../../.gitbook/assets/bridgzz.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
BroBridge is the best place to bridge from Bitcoin to any chains for lowest fees!
|
||||
|
||||
If you have not try BroBridge, try it now via here: [https://brotocol.xyz/bridge/cross-bridge](https://brotocol.xyz/bridge/cross-bridge)
|
||||
|
||||
Follow these steps to bridge your assets between chains using Brotocol!
|
||||
If you have not try BroBridge, try it now here: [https://brotocol.xyz/bridge/cross-bridge](https://brotocol.xyz/bridge/cross-bridge)
|
||||
|
||||
{% hint style="info" %}
|
||||
**Important:** Users can only bridge tokens that represent the **same asset** across different blockchains. For example, BTC can be transferred to its equivalent, WBTC, when moving from Bitcoin to an EVM network, as both represent the same asset on different chains.
|
||||
{% endhint %}
|
||||
|
||||
### Step 0: Connecting your Wallet
|
||||
## Explore
|
||||
|
||||
Before using the bridge, you need to connect a wallet for the blockchain you are bridging from, as well as one for the blockchain you are bridging to (e.g., **Stacks Chain**, **Bitcoin Chain**, or **EVM Chain**).
|
||||
|
||||
{% hint style="info" %}
|
||||
See the [Prerequisites](../../introduction/getting-started/prerequisites/) section for the list of **Supported Wallets** and their installation guides.
|
||||
{% endhint %}
|
||||
|
||||
You can connect your wallet by clicking the **Wallet Manager** located in the top right corner of the Brotocol app. This is where you’ll manage all your wallet connections.
|
||||
|
||||
|
||||
|
||||
In some cases, you can use the same wallet for both blockchains, but you must connect it separately for each blockchain to specify the source and destination accounts.
|
||||
|
||||
In this example, we will use [Xverse](https://www.xverse.app/), as it supports both the Bitcoin and Stacks networks. Since we are bridging from native BTC to Arbitrum's WBTC, we also need to connect an EVM wallet; in this example, we are using [Rabby Wallet](https://rabby.io/).
|
||||
|
||||
{% hint style="info" %}
|
||||
For a detailed explanation on how to connect your wallet, check our guide: [**How to Connect your Wallet**](../../introduction/getting-started/prerequisites/how-to-connect-your-wallet.md).
|
||||
{% endhint %}
|
||||
|
||||
Once you have connected both wallets, you will see them active in the **Wallet Manager**.
|
||||
|
||||
|
||||
|
||||
#### Step 1: Select the Source Blockchain and Token
|
||||
|
||||
To start, click on the '**From Asset Selection**'.
|
||||
|
||||
|
||||
|
||||
Next, choose the **source blockchain** from which you want to bridge your assets (e.g., **Stacks Chain**). 
|
||||
|
||||
Then, select the **source token** you would like to bridge (e.g., **aUSD**).
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-18 at 12.28.20 PM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
{% hint style="info" %}
|
||||
Bridgable tokens for a specific blockchain are identified by the double arrow icon ⮂. You will only be able to select these tokens for bridging with the selected blockchain.
|
||||
{% endhint %}
|
||||
|
||||
#### Step 2: Select the Destination Blockchain and Token
|
||||
|
||||
First, click on the '**To Asset Selection**'.
|
||||
|
||||
|
||||
|
||||
Next, select the **destination blockchain** where you brindge the assets (e.g., Native BTC -> Arbitrum's WBTC). 
|
||||
|
||||
Then, choose the corresponding **destination token** on this chain (e.g., **WBTC Arbitrum ERC-20**).
|
||||
|
||||
{% hint style="info" %}
|
||||
While you need to select the same bridge asset for the swap, **aUSD can still be bridged to USDT or USDC—and back again!**
|
||||
{% endhint %}
|
||||
|
||||
|
||||
|
||||
Important to remember, whichever chain you want to bridge to, you will be able to know if its available to bridge or not based on the green highlight shown above. 
|
||||
|
||||
If you do not see the '<mark style="color:orange;">**⮂ ₿**</mark>' icon, it's mean it's not supported / available to bridge to. 
|
||||
|
||||
#### Step 3: Input the Amount to Bridge
|
||||
|
||||
Enter the amount of tokens you would like to bridge. 
|
||||
|
||||
You can also use the **Max** button to select your full balance.
|
||||
|
||||
|
||||
|
||||
If you would like to customize the network fee, you can do it so too as shown above!
|
||||
|
||||
#### Step 4: Initiate the Bridge
|
||||
|
||||
After confirming the selected blockchains and token amounts, click the **Bridge** button to begin the process.
|
||||
|
||||
|
||||
|
||||
Before you click Bridge, if you need to check how much the fee breakdown and time required for the bridge, you can scroll down to check as shown below.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-18 at 12.42.34 PM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
#### Step 5: Confirm the Transaction
|
||||
|
||||
You will be prompted to confirm the bridging transaction. 
|
||||
|
||||
Review the details, ensure everything is correct, and click Confirm to proceed.
|
||||
|
||||
|
||||
|
||||
#### Step 6: Confirm Transaction
|
||||
|
||||
After you click Confirm, you will be required to confirm the transaction on-chain by clicking "**Confirm**" on the Xverse Review Transaction pop-up page.
|
||||
|
||||
|
||||
|
||||
### Step 7: Wait for Confirmation
|
||||
|
||||
Finally, wait for the transaction to be confirmed on the blockchain. 
|
||||
|
||||
The confirmation time can take anywhere from 10 to 30 minutes, depending on network conditions. 
|
||||
|
||||
Once the transaction is broadcasted, you should see the bridged tokens deposited in your destination wallet.
|
||||
|
||||
|
||||
|
||||
{% hint style="info" %}
|
||||
You can monitor your transaction in real time by clicking the **Explorer** page or "<mark style="color:orange;">**1 Pending**</mark>" as shown in the screenshot above.
|
||||
{% endhint %}
|
||||
{% content-ref url="key-concepts.md" %} [key-concepts.md](key-concepts.md) {% endcontent-ref %}
|
||||
{% content-ref url="how-to-bridge.md" %} [how-to-bridge.md](how-to-bridge.md) {% endcontent-ref %}
|
||||
<!-- {% content-ref url="faqs.md" %} [faqs.md](faqs.md) {% endcontent-ref %} -->
|
||||
|
||||
## Support
|
||||
|
||||
For assistance, please reach out to our Community Managers on [Discord](https://discord.com/invite/xlink).
|
||||
For assistance, please reach out to our Community Managers on [Discord](https://discord.gg/brotocol).
|
||||
|
||||
117
docs/features/brobridge/how-to-bridge.md
Normal file
117
docs/features/brobridge/how-to-bridge.md
Normal file
@@ -0,0 +1,117 @@
|
||||
---
|
||||
description: Follow these steps to bridge your assets between chains using Brotocol!
|
||||
---
|
||||
|
||||
# How to Bridge Assets
|
||||
|
||||
### Step 0: Connecting your Wallet
|
||||
|
||||
Before using the bridge, you need to connect a wallet for the blockchain you are bridging from, as well as one for the blockchain you are bridging to (e.g., **Stacks Chain**, **Bitcoin Chain**, or **EVM Chain**).
|
||||
|
||||
{% hint style="info" %}
|
||||
See the [Prerequisites](../../introduction/getting-started/prerequisites/) section for the list of **Supported Wallets** and their installation guides.
|
||||
{% endhint %}
|
||||
|
||||
You can connect your wallet by clicking the **Wallet Manager** located in the top right corner of the Brotocol app. This is where you’ll manage all your wallet connections.
|
||||
|
||||
|
||||
|
||||
In some cases, you can use the same wallet for both blockchains, but you must connect it separately for each blockchain to specify the source and destination accounts.
|
||||
|
||||
In this example, we will use [Xverse](https://www.xverse.app/), as it supports both the Bitcoin and Stacks networks. Since we are bridging from native BTC to Arbitrum's WBTC, we also need to connect an EVM wallet; in this example, we are using [Rabby Wallet](https://rabby.io/).
|
||||
|
||||
{% hint style="info" %}
|
||||
For a detailed explanation on how to connect your wallet, check our guide: [**How to Connect your Wallet**](../../introduction/getting-started/prerequisites/how-to-connect-your-wallet.md).
|
||||
{% endhint %}
|
||||
|
||||
Once you have connected both wallets, you will see them active in the **Wallet Manager**.
|
||||
|
||||
|
||||
|
||||
#### Step 1: Select the Source Blockchain and Token
|
||||
|
||||
To start, click on the '**From Asset Selection**'.
|
||||
|
||||
|
||||
|
||||
Next, choose the **source blockchain** from which you want to bridge your assets (e.g., **Stacks Chain**). 
|
||||
|
||||
Then, select the **source token** you would like to bridge (e.g., **aUSD**).
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-18 at 12.28.20 PM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
{% hint style="info" %}
|
||||
Bridgable tokens for a specific blockchain are identified by the double arrow icon ⮂. You will only be able to select these tokens for bridging with the selected blockchain.
|
||||
{% endhint %}
|
||||
|
||||
#### Step 2: Select the Destination Blockchain and Token
|
||||
|
||||
First, click on the '**To Asset Selection**'.
|
||||
|
||||
|
||||
|
||||
Next, select the **destination blockchain** where you brindge the assets (e.g., Native BTC -> Arbitrum's WBTC). 
|
||||
|
||||
Then, choose the corresponding **destination token** on this chain (e.g., **WBTC Arbitrum ERC-20**).
|
||||
|
||||
{% hint style="info" %}
|
||||
While you need to select the same bridge asset for the swap, **aUSD can still be bridged to USDT or USDC—and back again!**
|
||||
{% endhint %}
|
||||
|
||||
|
||||
|
||||
Important to remember, whichever chain you want to bridge to, you will be able to know if its available to bridge or not based on the green highlight shown above. 
|
||||
|
||||
If you do not see the '<mark style="color:orange;">**⮂ ₿**</mark>' icon, it's mean it's not supported / available to bridge to. 
|
||||
|
||||
#### Step 3: Input the Amount to Bridge
|
||||
|
||||
Enter the amount of tokens you would like to bridge. 
|
||||
|
||||
You can also use the **Max** button to select your full balance.
|
||||
|
||||
|
||||
|
||||
If you would like to customize the network fee, you can do it so too as shown above!
|
||||
|
||||
#### Step 4: Initiate the Bridge
|
||||
|
||||
After confirming the selected blockchains and token amounts, click the **Bridge** button to begin the process.
|
||||
|
||||
|
||||
|
||||
Before you click Bridge, if you need to check how much the fee breakdown and time required for the bridge, you can scroll down to check as shown below.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-18 at 12.42.34 PM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
#### Step 5: Confirm the Transaction
|
||||
|
||||
You will be prompted to confirm the bridging transaction. 
|
||||
|
||||
Review the details, ensure everything is correct, and click Confirm to proceed.
|
||||
|
||||
|
||||
|
||||
#### Step 6: Confirm Transaction
|
||||
|
||||
After you click Confirm, you will be required to confirm the transaction on-chain by clicking "**Confirm**" on the Xverse Review Transaction pop-up page.
|
||||
|
||||
|
||||
|
||||
### Step 7: Wait for Confirmation
|
||||
|
||||
Finally, wait for the transaction to be confirmed on the blockchain. 
|
||||
|
||||
The confirmation time can take anywhere from 10 to 30 minutes, depending on network conditions. 
|
||||
|
||||
Once the transaction is broadcasted, you should see the bridged tokens deposited in your destination wallet.
|
||||
|
||||
|
||||
|
||||
{% hint style="info" %}
|
||||
You can monitor your transaction in real time by clicking the **Explorer** page or "<mark style="color:orange;">**1 Pending**</mark>" as shown in the screenshot above.
|
||||
{% endhint %}
|
||||
|
||||
## Support
|
||||
|
||||
For assistance, please reach out to our Community Managers on [Discord](https://discord.gg/brotocol).
|
||||
@@ -1,4 +1,6 @@
|
||||
# How Brotocol Bridge Works?
|
||||
# Key Concepts
|
||||
|
||||
## How Brotocol Bridge Works?
|
||||
|
||||
The Brotocol Bridge is a hybrid bi-directional bridge that acts as a '**connector**' between Bitcoin and other blockchains. 
|
||||
|
||||
@@ -8,9 +8,9 @@ description: >-
|
||||
|
||||
<figure><img src="../../.gitbook/assets/swap.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
With BroSwap, you would initiate a swap directly from your Bitcoin wallet to any assets you would like to swap to. 
|
||||
With BroSwap, you would initiate a swap directly from your Bitcoin wallet to any assets you would like to swap to.
|
||||
|
||||
**BroSwap currently supports:** 
|
||||
**BroSwap currently supports:**
|
||||
|
||||
* Bitcoin native network
|
||||
* BRC-20
|
||||
@@ -20,90 +20,13 @@ Swap from BTC to aUSD (Wrapped version of USDT) back and forth or even purchase
|
||||
|
||||
If you haven't try BroSwap, try it now here: [https://brotocol.xyz/bitcoin/swap](https://brotocol.xyz/bitcoin/swap)
|
||||
|
||||
{% hint style="info" %}
|
||||
Be sure to [connect your wallet first](../../introduction/getting-started/prerequisites/how-to-connect-your-wallet.md) before using BroSwap! 
|
||||
{% endhint %}
|
||||
## Explore
|
||||
|
||||
#### Step #1: Select the Asset You'd Like to Swap From 
|
||||
{% content-ref url="key-concepts.md" %} [key-concepts.md](key-concepts.md) {% endcontent-ref %}
|
||||
{% content-ref url="how-to-swap.md" %} [how-to-swap.md](how-to-swap.md) {% endcontent-ref %}
|
||||
{% content-ref url="how-to-swap-non-bridgeable-tokens.md" %} [how-to-swap-non-bridgeable-tokens.md](how-to-swap-non-bridgeable-tokens.md) {% endcontent-ref %}
|
||||
<!-- {% content-ref url="faqs.md" %} [faqs.md](faqs.md) {% endcontent-ref %} -->
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-17 at 12.51.03 PM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
BroSwap currently supports up to three different networks to swap to and from:
|
||||
|
||||
* Bitcoin
|
||||
* BRC-20
|
||||
* Runes
|
||||
|
||||
To start, click on the Asset Selection A (The first option) as shown in the screenshot above) to pick the asset you want to swap from. 
|
||||
|
||||
#### Step #2: Select the Asset You'd Like to Swap To
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-17 at 12.51.27 PM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
After you have selected the asset you want to swap from, click on the Asset Selection (The second option) as shown in the screenshot above) to pick the asset you want to want to swap to. 
|
||||
|
||||
#### Step #3: Choose the Token you want to Swap From / To
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-17 at 12.52.10 PM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
In the Asset Selection pop-up (as shown in the screenshot above), you’ll notice a ‘<mark style="color:orange;">**⮂ ₿**</mark>’ symbol next to certain assets.
|
||||
|
||||
This indicates that the asset is available for swapping. In our example, I have selected $BTC -> $aUSD; Native Bitcoin network to BRC-20's $aUSD. 
|
||||
|
||||
If the symbol is not shown, that asset cannot be swapped to.
|
||||
|
||||
#### Step #4: Checking the Rate, Network Fees, Slippages and Minimum Received
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-18 at 11.17.31 AM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
Once you’ve selected the assets you want to swap from and to, you can enter the amount you'd like to swap.\
|
||||
BroSwap will then display an estimate of what you'll receive based on your input.
|
||||
|
||||
On the same page, you can also adjust settings like **Network Fees**, **Slippage**, and **Route**.
|
||||
|
||||
{% hint style="success" %}
|
||||
By default, BroSwap selects the most optimal route and network fee to ensure you get the best value for your swap!
|
||||
{% endhint %}
|
||||
|
||||
#### (Optional) Step #5: Double Check your Fee Estimates, Price Impact and Minimum Received
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-18 at 11.20.10 AM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
Before you click Swap, you can check the section below the Swap button to get a good idea on how much you would receive for the Swap. 
|
||||
|
||||
**Important to note:** Our UI sets a default slippage of 4%, which may cause a slight difference between the _Minimum Received_ and the _Estimated_ amount shown. However, most transactions typically go through with less than 1% slippage—for example, swaps like $BTC <> $aUSD.
|
||||
|
||||
#### Step #6: Swap it! 
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-18 at 11.20.47 AM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
We’ll show you the details from Step #5 again before you click **Confirm** to swap.
|
||||
|
||||
If you're not satisfied with the estimates, you can go back and adjust the slippage or network fee.
|
||||
|
||||
Once you're happy with the rate, click **Confirm** to proceed.
|
||||
|
||||
#### Step #7: Approve the Transaction on your Wallet
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-18 at 11.25.19 AM.png" alt="" width="375"><figcaption><p>Xverse Transaction Confirmation Breakdown</p></figcaption></figure>
|
||||
|
||||
On your wallet’s confirmation screen, you’ll see the amount that will be spent for the bridge.
|
||||
|
||||
Depending on the wallet you’re using, the estimated fees will also be displayed.
|
||||
|
||||
If everything looks good, go ahead and click **Confirm** to proceed.
|
||||
|
||||
#### Step #8: All done! Just wait for your Swap to Complete!
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-17 at 12.58.21 PM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
You’ve successfully initiated your first swap! 🎉
|
||||
|
||||
A pop-up will appear in the upper-right corner of your screen, letting you know there’s a pending transaction.
|
||||
|
||||
You’ll also notice the [**Explorer**](../explorer/) button changes to '**1 Pending'**, indicating an active swap is in progress.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-18 at 11.28.17 AM.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
If you clicked 'My Records only' , you will be able to see your pending transactions and all you have to do now, is just wait until it's completed, that's all! 
|
||||
## Support
|
||||
|
||||
For assistance, please reach out to our Community Managers on [Discord](https://discord.gg/brotocol).
|
||||
@@ -1,4 +1,4 @@
|
||||
# How to swap Non-bridgeable Tokens?
|
||||
# How to Swap Non-Bridgeable Tokens
|
||||
|
||||
In some cases, certain tokens may not be supported by the Brotocol bridge due to compatibility limitations. If you are attempting to bridge a token that is not compatible with the Brotocol bridge, it is recommended to use **ALEX Swap** to exchange it for a bridgeable token. 
|
||||
|
||||
|
||||
92
docs/features/broswap/how-to-swap.md
Normal file
92
docs/features/broswap/how-to-swap.md
Normal file
@@ -0,0 +1,92 @@
|
||||
# How to Swap
|
||||
|
||||
{% hint style="info" %}
|
||||
Be sure to [connect your wallet first](../../getting-started/how-to-connect-your-wallet.md) before using BroSwap!
|
||||
{% endhint %}
|
||||
|
||||
### Step 1: Select the Asset You'd Like to Swap From
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-17 at 12.51.03 PM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
BroSwap currently supports up to three different networks to swap to and from:
|
||||
|
||||
* Bitcoin
|
||||
* BRC-20
|
||||
* Runes
|
||||
|
||||
To start, click on the Asset Selection A (The first option) as shown in the screenshot above) to pick the asset you want to swap from.
|
||||
|
||||
### Step 2: Select the Asset You'd Like to Swap To
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-17 at 12.51.27 PM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
After you have selected the asset you want to swap from, click on the Asset Selection (The second option) as shown in the screenshot above) to pick the asset you want to want to swap to.
|
||||
|
||||
### Step 3: Choose the Token you want to Swap From / To
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-17 at 12.52.10 PM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
In the Asset Selection pop-up (as shown in the screenshot above), you’ll notice a ‘<mark style="color:orange;">**⮂ ₿**</mark>’ symbol next to certain assets.
|
||||
|
||||
This indicates that the asset is available for swapping. In our example, I have selected $BTC -> $aUSD; Native Bitcoin network to BRC-20's $aUSD.
|
||||
|
||||
If the symbol is not shown, that asset cannot be swapped to.
|
||||
|
||||
### Step 4: Checking the Rate, Network Fees, Slippages and Minimum Received
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-18 at 11.17.31 AM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
Once you’ve selected the assets you want to swap from and to, you can enter the amount you'd like to swap.\
|
||||
BroSwap will then display an estimate of what you'll receive based on your input.
|
||||
|
||||
On the same page, you can also adjust settings like **Network Fees**, **Slippage**, and **Route**.
|
||||
|
||||
{% hint style="success" %}
|
||||
By default, BroSwap selects the most optimal route and network fee to ensure you get the best value for your swap!
|
||||
{% endhint %}
|
||||
|
||||
### (Optional) Step 5: Double Check your Fee Estimates, Price Impact and Minimum Received
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-18 at 11.20.10 AM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
Before you click Swap, you can check the section below the Swap button to get a good idea on how much you would receive for the Swap.
|
||||
|
||||
**Important to note:** Our UI sets a default slippage of 4%, which may cause a slight difference between the _Minimum Received_ and the _Estimated_ amount shown. However, most transactions typically go through with less than 1% slippage—for example, swaps like $BTC <> $aUSD.
|
||||
|
||||
### Step 6: Swap it!
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-18 at 11.20.47 AM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
We’ll show you the details from Step #5 again before you click **Confirm** to swap.
|
||||
|
||||
If you're not satisfied with the estimates, you can go back and adjust the slippage or network fee.
|
||||
|
||||
Once you're happy with the rate, click **Confirm** to proceed.
|
||||
|
||||
### Step 7: Approve the Transaction on your Wallet
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-18 at 11.25.19 AM.png" alt="" width="375"><figcaption><p>Xverse Transaction Confirmation Breakdown</p></figcaption></figure>
|
||||
|
||||
On your wallet’s confirmation screen, you’ll see the amount that will be spent for the bridge.
|
||||
|
||||
Depending on the wallet you’re using, the estimated fees will also be displayed.
|
||||
|
||||
If everything looks good, go ahead and click **Confirm** to proceed.
|
||||
|
||||
### Step 8: All done! Just wait for your Swap to Complete!
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-17 at 12.58.21 PM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
You’ve successfully initiated your first swap! 🎉
|
||||
|
||||
A pop-up will appear in the upper-right corner of your screen, letting you know there’s a pending transaction.
|
||||
|
||||
You’ll also notice the [**Explorer**](../explorer/) button changes to '**1 Pending'**, indicating an active swap is in progress.
|
||||
|
||||
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-18 at 11.28.17 AM.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
If you clicked 'My Records only', you will be able to see your pending transactions and all you have to do now, is just wait until it's completed, that's all!
|
||||
|
||||
## Support
|
||||
|
||||
For assistance, please reach out to our Community Managers on [Discord](https://discord.gg/brotocol).
|
||||
@@ -1,4 +1,6 @@
|
||||
# DEX Aggregation
|
||||
# Key Concepts
|
||||
|
||||
## DEX Aggregation
|
||||
|
||||
<figure><img src="../../.gitbook/assets/aggregate.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
@@ -1,24 +1,3 @@
|
||||
# Explorer
|
||||
|
||||
<figure><img src="../../.gitbook/assets/8.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
Click here to access the [**Brotocol Reserve**](https://brotocol.xyz/bridge/reserve).
|
||||
|
||||
The Brotocol **Reserve** currently holds approximately 16 different assets, which include:
|
||||
|
||||
* [aBTC](../../reserves/what-is-abtc.md)
|
||||
* uBTC
|
||||
* [aUSD](../../reserves/what-is-ausd.md)
|
||||
* ALEX
|
||||
* STX
|
||||
* vLiaBTC
|
||||
* CHAX
|
||||
* $B20
|
||||
* ORDG
|
||||
* ORNJ
|
||||
* TRIO
|
||||
* TX20
|
||||
* DOG•GO•TO•THE•MOON
|
||||
* BILLION•DOLLAR•CAT
|
||||
* PUPS•WORLD•PEACE
|
||||
* TANUKI•WISDOM
|
||||
<!-- Add explorer main page -->
|
||||
@@ -1,4 +1,4 @@
|
||||
# How to Connect your Wallet
|
||||
# How to Connect Your Wallet
|
||||
|
||||
Follow these steps to connect your wallet to Brotocol App.
|
||||
|
||||
@@ -8,7 +8,7 @@ Follow these steps to connect your wallet to Brotocol App.
|
||||
|
||||
First, click on the **Wallet Manager** located in the top right corner of the Brotocol app. This is where you’ll manage all your wallet connections.
|
||||
|
||||
|
||||
|
||||
|
||||
### Step 2: Choose the Blockchain and Wallet
|
||||
|
||||
@@ -18,25 +18,25 @@ Supported wallets include Leather, Xverse, and others listed in [Supported Walle
|
||||
|
||||
For this example we will choose **Bitcoin Chain** and **Leather** wallet.
|
||||
|
||||
|
||||
|
||||
|
||||
### Step 3: Enter Your Password
|
||||
|
||||
After selecting your wallet, you will be prompted to enter your wallet’s password.
|
||||
|
||||
|
||||
|
||||
|
||||
### Step 4: Select Your Account
|
||||
|
||||
Once the password is entered, choose the specific account you want to connect. This account will be used for executing transactions on the bridge.
|
||||
|
||||
|
||||
|
||||
|
||||
### Step 5: Confirm Your Connection
|
||||
|
||||
Once the wallet is successfully connected, you will notice the blockchain icon colored in the top right corner of the screen, confirming that your wallet has been successfully linked.
|
||||
|
||||
|
||||
|
||||
|
||||
{% hint style="info" %}
|
||||
Keep in mind that, for bridging, you will need to connect wallets for both the source and destination blockchains (e.g., Stacks, Bitcoin, and EVM). Once connected, you will see the respective blockchain icons in the top right corner of the app.
|
||||
|
||||
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user