kylefang/xlink-docs
1
0
Fork 0
mirror of https://github.com/Brotocol-xyz/xlink-docs.git synced 2026-01-12 22:25:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

GITBOOK-7: No subject

Browse Source
This commit is contained in:
Alex Daddy
2025-07-02 20:47:28 +00:00
committed by gitbook-bot
parent 0c1c6c1a28
commit 8ce499ba7e
11 changed files with 43 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/.gitbook/assets/8 (1).png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.9 MiB

BIN
docs/.gitbook/assets/Screenshot 2025-04-18 at 11.28.03 AM (1).png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 140 KiB

BIN
docs/.gitbook/assets/aggregate (1) (1).png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 894 KiB

18
docs/README.md
View File

@@ -1,25 +1,11 @@
---
cover: .gitbook/assets/gbbanner.png
coverY: 0
layout:
cover:
visible: true
size: hero
title:
visible: true
description:
visible: true
tableOfContents:
visible: true
outline:
visible: true
pagination:
visible: true
---
# What is Brotocol?
# Introduction
Brotocol Bridge is a MPC-based hybrid bi-directional bridge that acts as a 'connector' between Bitcoin and other blockchains, enabling seamless asset transfers and swaps between Bitcoin and its Layer 2 networks (L2s) as well as other blockchain ecosystems. 
Brotocol Bridge is a MPC-based hybrid bi-directional bridge that acts as a 'connector' between Bitcoin and other blockchains, enabling seamless asset transfers and swaps between Bitcoin and its Layer 2 networks (L2s) as well as other blockchain ecosystems.
**Brotocol currently offers two key features:**

45
docs/SUMMARY.md
View File

@@ -2,36 +2,33 @@
## Overview
- [Introduction](./README.md)
- [What is Brotocol?](./brotocol/README.md)
- [What is Bonbori?](./bonbori/README.md)
- [Why Bonbori?](./bonbori/why-bonbori.md)
- [Bonbori Consensus Model](./bonbori/bonbori-consensus-model.md)
- [Reserves](./reserves/README.md)
- [What is aBTC?](./reserves/what-is-abtc.md)
- [What is aUSD?](./reserves/what-is-ausd.md)
* [Introduction](README.md)
* [What is Brotocol?](brotocol/README.md)
* [What is Bonbori?](bonbori/README.md)
* [Why Bonbori?](bonbori/why-bonbori.md)
* [Bonbori Consensus Model](bonbori/bonbori-consensus-model.md)
* [Reserves](reserves/README.md)
* [What is aBTC?](reserves/what-is-abtc.md)
* [What is aUSD?](reserves/what-is-ausd.md)
## Getting Started
<!-- - [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)
- [Active Notifications](./getting-started/active-notifications.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)
## What Can You Do
- [BroSwap](./features/broswap/README.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)
- [Key Concepts](./features/brobridge/key-concepts.md)
- [How to Bridge Assets](./features/brobridge/how-to-bridge.md)
<!-- - [Explorer](./features/explorer/README.md) -->
* [BroSwap](features/broswap/README.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)
* [Key Concepts](features/brobridge/key-concepts.md)
* [How to Bridge Assets](features/brobridge/how-to-bridge.md)
## Resources
- [Official Links](./official-links.md)
- [Security Audits](https://docs.brotocol.xyz/developers/brotocol-contracts/security-audits)
* [Official Links](official-links.md)
* [Security Audits](https://docs.brotocol.xyz/developers/brotocol-contracts/security-audits)
* [Terms and Conditions](resources/terms-and-conditions.md)

2
docs/bonbori/README.md
View File

@@ -1,6 +1,6 @@
# What is Bonbori?
<figure><img src="../../.gitbook/assets/bonbori.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/bonbori.png" alt=""><figcaption></figcaption></figure>
Bonbori is a cross-chain messaging and consensus layer designed specifically for Bitcoin's off-chain computation ecosystem. The system:

2
docs/bonbori/bonbori-consensus-model.md
View File

@@ -1,6 +1,6 @@
# Bonbori Consensus Model
<figure><img src="../../.gitbook/assets/consesus.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/consesus.png" alt=""><figcaption></figcaption></figure>
Bonbori uses '**Flexible Threshold-based Consensus Model**' which empowers Bitcoin builders with a customizable consensus framework that balances security needs with practical considerations:

22
docs/brotocol/README.md
View File

@@ -2,23 +2,9 @@
description: 'Brotocol: Bridge Better, Bro—Best Rates, Seamless Security!'
cover: ../.gitbook/assets/gbbanner.png
coverY: 0
layout:
cover:
visible: true
size: hero
title:
visible: true
description:
visible: true
tableOfContents:
visible: true
outline:
visible: true
pagination:
visible: true
---
# ✨ Brotocol 101
# What is Brotocol?
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!
@@ -26,7 +12,7 @@ With L1s and L2s multiplying, Brotocol makes cross-chain bridging simple, afford
### What is Brotocol?
Brotocol [BroBridge](../features/brobridge/README.md) is a **MPC-based hybrid bi-directional bridge** that acts as a '**connector**' between Bitcoin and other blockchains, enabling anyone to move between chains beyond the limitation of just EVM-based bridges.
Brotocol [BroBridge](../features/brobridge/) is a **MPC-based hybrid bi-directional bridge** that acts as a '**connector**' between Bitcoin and other blockchains, enabling anyone to move between chains beyond the limitation of just EVM-based bridges.
### Why Brotocol?
@@ -37,7 +23,7 @@ Bridging shouldn’t suck—high fees and sketchy paths are out. Brotocol’s yo
* **Lowest Fees:** Just **0.1%** to bridge native Bitcoin to EVM chains.
* **Most Bridge Paths:** Supports **18+ networks**, including non-EVM.
* **Rock-Solid Security:** MPC-based for stress-free transfers.
* **Seamless Swaps Across Chains:** Allowing users to swap to any assets from native Bitcoin to EVM tokens back and forth.&#x20;
* **Seamless Swaps Across Chains:** Allowing users to swap to any assets from native Bitcoin to EVM tokens back and forth.
### Brotocol’s Rate is Unbeatable!
@@ -101,6 +87,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 (1).png" alt=""><figcaption></figcaption></figure>
All Brotocol audits are available here: [**Brotocol Audit Reports**](../../developers/security-audits.md)

8
docs/getting-started/active-notifications.md
View File

@@ -1,16 +1,16 @@
# Active Notifications
<figure><img src="../../.gitbook/assets/notify.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/notify.png" alt=""><figcaption></figcaption></figure>
Not all chains are lightning fast—especially for those unfamiliar with Bitcoin’s native network speed, transactions may take some time to complete.
But fret not! Brotocol includes **active notifications** to keep you informed about ongoing transactions in real time.
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-17 at 12.58.21 PM.png" alt="" width="375"><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/Screenshot 2025-04-17 at 12.58.21 PM.png" alt="" width="375"><figcaption></figcaption></figure>
If you have at least one pending notification, your '[**Explorer**](./)' button will be updated to look like the screenshot above.&#x20;
If you have at least one pending notification, your '[**Explorer**](broken-reference)' button will be updated to look like the screenshot above.&#x20;
<figure><img src="../../.gitbook/assets/Screenshot 2025-04-17 at 12.58.49 PM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/Screenshot 2025-04-17 at 12.58.49 PM.png" alt=""><figcaption></figcaption></figure>
By clicking 'My records only', you will be able to see the status of your transaction.&#x20;

2
docs/reserves/README.md
View File

@@ -1,6 +1,6 @@
# Reserves
<figure><img src="../.gitbook/assets/Bro_Rate-1.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/8.png" alt=""><figcaption></figcaption></figure>
Click here to access or monitor the reserves real-time at the [**Brotocol Reserve**](https://app.xlink.network/bridge/reserve).

9
docs/resources/terms-and-conditions.md Normal file
View File

@@ -0,0 +1,9 @@
# Terms and Conditions
IN ACCESSING AND/OR USING BROTOCOL, YOU ACKNOWLEDGE AND AGREE THAT :
(a) BROTOCOL IS/ARE PROVIDED ON AN “AS-IS” AND “AS AVAILABLE” BASIS, AND BROTOCOL (“OPERATOR”) AND ITS AFFILIATES (SAVE TO THE EXTENT PROHIBITED BY APPLICABLE LAWS) EXPRESSLY DISCLAIM ANY AND ALL REPRESENTATIONS, WARRANTIES AND/OR CONDITIONS OF ANY KIND IN RESPECT THEREOF, WHETHER EXPRESS, IMPLIED, OR STATUTORY, INCLUDING ALL WARRANTIES OR CONDITIONS OF MERCHANTABILITY, MERCHANTABLE QUALITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, QUIET ENJOYMENT, ACCURACY, OR NON-INFRINGEMENT.
(b) OPERATOR AND ITS AFFILIATES HAS NOT MADE AND MAKES NO REPRESENTATION, WARRANTY AND/OR CONDITION OF ANY KIND THAT BROTOCOL WILL MEET YOUR REQUIREMENTS, OR WILL BE AVAILABLE ON AN UNINTERRUPTED, TIMELY, SECURE, OR ERROR-FREE BASIS, OR WILL BE ACCURATE, RELIABLE, FREE OF VIRUSES OR OTHER HARMFUL CODE, COMPLETE, LEGAL, OR SAFE.
(c) YOU SHALL HAVE NO CLAIM AGAINST OPERATOR AND/OR ITS AFFILIATES IN RESPECT OF ANY LOSS SUFFERED BY YOU IN RELATION TO OR ARISING FROM YOUR ACCESS AND/OR USE OF BROTOCOL.