diff --git a/docs/.gitbook/assets/8 (1).png b/docs/.gitbook/assets/8 (1).png new file mode 100644 index 0000000..6fa0d65 Binary files /dev/null and b/docs/.gitbook/assets/8 (1).png differ diff --git a/docs/.gitbook/assets/Screenshot 2025-04-18 at 11.28.03 AM (1).png b/docs/.gitbook/assets/Screenshot 2025-04-18 at 11.28.03 AM (1).png new file mode 100644 index 0000000..196a606 Binary files /dev/null and b/docs/.gitbook/assets/Screenshot 2025-04-18 at 11.28.03 AM (1).png differ diff --git a/docs/.gitbook/assets/aggregate (1) (1).png b/docs/.gitbook/assets/aggregate (1) (1).png new file mode 100644 index 0000000..609e47e Binary files /dev/null and b/docs/.gitbook/assets/aggregate (1) (1).png differ diff --git a/docs/README.md b/docs/README.md index 13cd80c..06bd7b8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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:** diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 62f9968..ea7398e 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -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 - - -- [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) - - +* [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) \ No newline at end of file +* [Official Links](official-links.md) +* [Security Audits](https://docs.brotocol.xyz/developers/brotocol-contracts/security-audits) +* [Terms and Conditions](resources/terms-and-conditions.md) diff --git a/docs/bonbori/README.md b/docs/bonbori/README.md index d3c75ba..69cb9ff 100644 --- a/docs/bonbori/README.md +++ b/docs/bonbori/README.md @@ -1,6 +1,6 @@ # What is Bonbori? -
+
Bonbori is a cross-chain messaging and consensus layer designed specifically for Bitcoin's off-chain computation ecosystem. The system: diff --git a/docs/bonbori/bonbori-consensus-model.md b/docs/bonbori/bonbori-consensus-model.md index 2f9c1a2..211ff62 100644 --- a/docs/bonbori/bonbori-consensus-model.md +++ b/docs/bonbori/bonbori-consensus-model.md @@ -1,6 +1,6 @@ # Bonbori Consensus Model -
+
Bonbori uses '**Flexible Threshold-based Consensus Model**' which empowers Bitcoin builders with a customizable consensus framework that balances security needs with practical considerations: diff --git a/docs/brotocol/README.md b/docs/brotocol/README.md index 585fbeb..d5e0808 100644 --- a/docs/brotocol/README.md +++ b/docs/brotocol/README.md @@ -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. +* **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) -
+
All Brotocol audits are available here: [**Brotocol Audit Reports**](../../developers/security-audits.md) diff --git a/docs/getting-started/active-notifications.md b/docs/getting-started/active-notifications.md index 3ebebc6..2a8802f 100644 --- a/docs/getting-started/active-notifications.md +++ b/docs/getting-started/active-notifications.md @@ -1,16 +1,16 @@ # Active Notifications -
+
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. -
+
-If you have at least one pending notification, your '[**Explorer**](./)' button will be updated to look like the screenshot above. +If you have at least one pending notification, your '[**Explorer**](broken-reference)' button will be updated to look like the screenshot above. -
+
By clicking 'My records only', you will be able to see the status of your transaction. diff --git a/docs/reserves/README.md b/docs/reserves/README.md index b41a23e..44546ad 100644 --- a/docs/reserves/README.md +++ b/docs/reserves/README.md @@ -1,6 +1,6 @@ # Reserves -
+
Click here to access or monitor the reserves real-time at the [**Brotocol Reserve**](https://app.xlink.network/bridge/reserve). diff --git a/docs/resources/terms-and-conditions.md b/docs/resources/terms-and-conditions.md new file mode 100644 index 0000000..27390d9 --- /dev/null +++ b/docs/resources/terms-and-conditions.md @@ -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.