chore: clean-up repo directories

This commit is contained in:
sofinico
2025-04-29 20:31:05 +02:00
parent 05f6e8f12e
commit a18ff68213
17 changed files with 45 additions and 65 deletions

View File

@@ -35,18 +35,6 @@ Brotocol Bridge is a MPC-based hybrid bi-directional bridge that acts as a 'conn
Brotocol plays a crucial role in projects building on Bitcoin, offering a 'native-like' DeFi experience by enabling users to interact with smart contracts on L2s using native BTC or other Bitcoin L1 assets.
## Types of blockchain bridges
Not all bridges work the same way, and understanding the differences can help you determine which one best suits your needs:
* `Trust-based Bridges`: These are operated by a centralized entity, requiring users to trust that entity to manage and safeguard their assets. While these bridges can offer faster and more straightforward operations, they introduce a single point of failure, as the security of the entire system depends on the integrity of the operator.
* `Decentralized Bridges`: These rely on smart contracts and a distributed group of validators to ensure smooth and secure operations without needing a central authority. Although they avoid centralization issues, they can sometimes be slower or more costly due to the additional security checks involved.
* `Hybrid Bridges`: Hybrid bridges combine elements of both trusted and decentralized models, using centralized intermediaries alongside decentralized smart contracts or consensus systems. This approach aims to balance efficiency and security, providing a flexible solution for cross-chain asset transfers.
* `Two-way Bridges`: Bi-directional bridges enable the transfer of assets in both directions between two blockchains, making it easy to move your tokens in either direction.
* `One-way Bridges`: As the name suggests, these bridges allow the transfer of assets from one blockchain to another but do not support transfers in the opposite direction. Theyre useful in cases where you only need to transfer tokens once, such as when moving assets to a chain where they will remain and be used.
Brotocol's type is **`Two-way Bridges` .** 
## Support
For assistance, feel free to join our community on [Discord](https://discord.com/invite/xlink).

View File

@@ -2,33 +2,33 @@
## Overview
- [What is Brotocol?](README.md)
- [ Brotocol 101](introduction/readme/brotocol-101.md)
- [What is Bonbori?](introduction/what-is-bonbori/README.md)
- [Why Bonbori?](introduction/what-is-bonbori/why-bonbori.md)
- [Bonbori Consensus Model](introduction/what-is-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](introduction/getting-started/README.md) -->
<!-- * [Getting Started](./getting-started/README.md) -->
- [How to Connect your Wallet](introduction/getting-started/prerequisites/how-to-connect-your-wallet.md)
- [Supported Wallets](introduction/getting-started/prerequisites/README.md)
- [How to Connect your Wallet](./getting-started/how-to-connect-your-wallet.md)
- [Supported Wallets](./getting-started/supported-wallets.md)
## Features
- [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)
- [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)
- [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)
- [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)
## Resources
- [Official Links](media-kits/official-links.md)
- [Official Links](./official-links.md)
- [Security Audits](https://coinfabrik.gitbook.io/brotocol-devs/security-audits)

View File

@@ -0,0 +1,11 @@
# Types of blockchain bridges
Not all bridges work the same way, and understanding the differences can help you determine which one best suits your needs:
* `Trust-based Bridges`: These are operated by a centralized entity, requiring users to trust that entity to manage and safeguard their assets. While these bridges can offer faster and more straightforward operations, they introduce a single point of failure, as the security of the entire system depends on the integrity of the operator.
* `Decentralized Bridges`: These rely on smart contracts and a distributed group of validators to ensure smooth and secure operations without needing a central authority. Although they avoid centralization issues, they can sometimes be slower or more costly due to the additional security checks involved.
* `Hybrid Bridges`: Hybrid bridges combine elements of both trusted and decentralized models, using centralized intermediaries alongside decentralized smart contracts or consensus systems. This approach aims to balance efficiency and security, providing a flexible solution for cross-chain asset transfers.
* `Two-way Bridges`: Bi-directional bridges enable the transfer of assets in both directions between two blockchains, making it easy to move your tokens in either direction.
* `One-way Bridges`: As the name suggests, these bridges allow the transfer of assets from one blockchain to another but do not support transfers in the opposite direction. Theyre useful in cases where you only need to transfer tokens once, such as when moving assets to a chain where they will remain and be used.
Brotocol's type is **`Two-way Bridges` .**&#x20;

View File

@@ -26,9 +26,9 @@ With L1s and L2s multiplying, Brotocol makes cross-chain bridging simple, afford
### What is Brotocol?
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.
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.
### **Why Brotocol?**
### Why Brotocol?
<figure><img src="../../.gitbook/assets/2.png" alt=""><figcaption></figcaption></figure>

View File

@@ -1,13 +0,0 @@
# Official Links
Website: [https://brotocol.xyz/](https://brotocol.xyz/)
Medium: [https://medium.brotocol.xyz/](https://medium.brotocol.xyz/)
Discord: [https://discord.gg/brotocol](https://discord.gg/brotocol)
Telegram: [https://t.me/Brotocol\_xyz](https://t.me/Brotocol_xyz)
𝕏: [https://x.com/Brotocol\_xyz ](https://x.com/Brotocol_xyz)
Download Brotocol Media Kit: [https://cdn.brotocol.xyz/brotocol/Brotocol\_mediakit.zip](https://cdn.brotocol.xyz/brotocol/Brotocol_mediakit.zip)

13
docs/official-links.md Normal file
View File

@@ -0,0 +1,13 @@
# Official Links
🌐 Website: [https://brotocol.xyz/](https://brotocol.xyz/)
📝 Medium: [https://medium.brotocol.xyz/](https://medium.brotocol.xyz/)
🎮 Discord: [https://discord.gg/brotocol](https://discord.gg/brotocol)
💬 Telegram: [https://t.me/Brotocol_xyz](https://t.me/Brotocol_xyz)
🐦 𝕏: [https://x.com/Brotocol_xyz](https://x.com/Brotocol_xyz)
🎨 Download Brotocol Media Kit: [https://cdn.brotocol.xyz/brotocol/Brotocol_mediakit.zip](https://cdn.brotocol.xyz/brotocol/Brotocol_mediakit.zip)

View File

@@ -1,3 +0,0 @@
# Networks
Deployed contract addresses.

View File

@@ -1,16 +0,0 @@
# Security Audits
As with all crypto technology, risk is real whether using a centralized or decentralized bridge. Some of the more novel decentralized bridges are relatively untested and even those that have been tested are still subject to exploits.
Brotocol is audited by CoinFabrik, covering both the contracts and the backends.
* [2022-12 Bridge Endpoints](https://cdn.xlink.network/pdf/ALEX_Audit_bridge_coinfabrik_202212.pdf)
* [2023-04 Bridge Backend and Endpoints](https://cdn.xlink.network/pdf/ALEX_Audit_Bridge_2023-04.pdf)
* [2023-10 Bitcoin Oracle and Bridge](https://cdn.xlink.network/pdf/ALEX_Audit_202310_Bitcoin_Oracle_and_Bridge.pdf)
* [2024-11 Brotocol Staking Manager](https://cdn.xlink.network/pdf/XLINK_Staking_Audit_2024_11_final.pdf)
* [2024-11 Brotocol Peg-out Endpoints](https://cdn.xlink.network/pdf/XLINK_Peg-out_Endpoints_Audit%2011-2024.pdf)
* [2024-11 Brotocol Peg-in Endpoints](https://cdn.xlink.network/pdf/XLINK_Peg-in_Endpoints_Audit_11-2024.pdf)
* [2025-3 Endpoint Update](https://cdn.brotocol.xyz/pdf/XLink_Endpoits_Update_Audit_2025-03.pdf)
* [2025-4 EVM Endpoints](https://cdn.brotocol.xyz/pdf/XLink_EVM_Endpoint_Audit_2025-04.pdf)
The smart contracts are also subject to our [bug bounty](https://immunefi.com/bounty/alex/) programme on Immunefi.