Skip to content

Commit a87fadf

Browse files
authored
Merge pull request #141 from bitlayer-org/feature/v2-doc
move YBTC introduction
2 parents 38d209c + d4a7892 commit a87fadf

16 files changed

Lines changed: 74 additions & 72 deletions

docs/BitVMBridge/BBN/001-understanding-bbn.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ A key example is the **BitVM Coordinator**, a protocol contract that plays a cru
4040

4141
A primary function of the BitVM Coordinator is to manage the **attesting committee** for each new BitVM smart contract. This committee is a group of nodes that pre-signs the transaction graph. The Coordinator streamlines this process by:
4242

43-
1. **Electing the Pre-Signing Committee:** For each new contract, the Coordinator selects committee members from a pool of trusted and eligible candidates.
43+
1. **Electing the Attesting Committee:** For each new contract, the Coordinator selects committee members from a pool of trusted and eligible candidates.
4444
2. **Implementing Incentives:** To ensure liveness and discourage malicious behavior, the Coordinator manages an incentive structure. Honest committee members are rewarded for their participation, while malicious actors are penalized through slashing.
4545
3. **Coordinating Signatures:** Once the committee is formed, the Coordinator orchestrates the signing process to ensure all members contribute their signatures in a timely and coordinated manner.
4646

47-
To leverage this functionality, applications must run an **attester node**. For example, a BitVM bridge requires its attester node to verify the format of each transaction in the graph, sign it, and submit the signature to the Coordinator.
47+
To leverage this functionality, applications must run their own **attester node**. For example, a BitVM bridge requires its attester node to verify the format of each transaction in the graph, sign it, and submit the signature to the Coordinator.
4848

4949
### Watcher Coordination
5050

docs/BitVMBridge/BBN/002-joining-bbn.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ If you’re interested in getting involved, feel free to contact us via email at
1717
The BitVM Bridge Broker role can appeal to various entities for different purposes. Below are some examples of how participants might engage as Brokers:
1818

1919
- Type 1: Providing Liquidity Services to End Users
20-
You might operate as a Broker to generate revenue by servicing the peg-out requests of end-users and charging transaction fees.
20+
You might operate as a Broker to generate revenue by servicing the peg-out requests of end-users and charging transaction fees.
2121
- Type 2: Supporting Your Business Operations
22-
You might operate as a Broker if you run a business (such as DeFi protocols or other services) that integrates YBTC (a highly secure bridged BTC asset) and you require the BitVM Bridge to balance your BTC/YBTC positions. The flexible peg-out feature of the Bitlayer BitVM Bridge allows participants with such needs to achieve this cost-effectively.
22+
You might operate as a Broker if you run a business (such as DeFi protocols or other services) that integrates YBTC and you require the BitVM Bridge to balance your BTC/YBTC positions. The flexible peg-out feature of the Bitlayer BitVM Bridge allows participants with such needs to achieve this cost-effectively.
2323

2424
Regardless of the specific motivation, all prospective Brokers must meet the following requirements:
2525

@@ -31,13 +31,13 @@ Regardless of the specific motivation, all prospective Brokers must meet the fol
3131

3232
2. Long-Term Collateral:
3333

34-
All brokers are required to provide long-term liquidity as collateral. A minimum of 0.5 BTC is necessary to participate in a single bridge instance.
34+
All brokers are required to provide long-term liquidity as collateral. A certain amount (denoted as `minimum_collateral_per_reclaim`) of BTC is necessary to participate in a single bridge instance.
3535

3636
Note: This collateral will be refunded once the corresponding bridge funds are reclaimed. The duration for this refund depends on the timing of user requests and the reclaim process.
3737

3838
3. Short-Term Liquidity (Especially for User-Facing Services):
3939

40-
Brokers, particularly those aiming to provide liquidity services to end-users (as in Example 1), will need readily available short-term liquidity to front peg-out requests. A minimum of 2 BTC is recommended for this purpose.
40+
Brokers, particularly those aiming to provide liquidity services to end-users (as in Type 1), will need readily available short-term liquidity to front peg-out requests. A minimum of 2 BTC is recommended for this purpose.
4141

4242
Note: This liquidity will be reclaimed from the BitVM smart contract after the broker has fronted the peg-out request. The typical duration for this reclaim is the challenge window, which is generally one week.
4343

docs/BitVMBridge/BBN/003-bbn-governance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The governance of the BitVM Bridge Network will be centered around the **Bitlaye
1212

1313
**Key Features:**
1414

15-
- **Governance Platform:** The core governance smart contracts will be deployed on the **Bitlayer Network** (the L2 scaling solution for Bitcoin). You can find more information about Bitlayer Network at [https://www.bitlayer.org/](https://www.bitlayer.org/).
15+
- **Governance Platform:** The core governance smart contracts will be deployed on the **Bitlayer Network**. You can find more information about Bitlayer Network at [https://www.bitlayer.org/](https://www.bitlayer.org/).
1616
- **Membership:** Any individual or entity holding a specified minimum amount of BTR tokens will be eligible to participate as a governance member. The exact threshold will be defined in the forthcoming governance framework.
1717
- **Proposal Submission:** Any eligible governance member can create new proposals and initiate the voting process.
1818
- **Discussion Forum:** A dedicated governance forum (currently under construction) will serve as the primary platform for discussing proposals, debating ideas, and fostering community consensus before formal voting.

docs/BitVMBridge/Concepts/098-roadmap.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ slug: roadmap
55

66
# Roadmap
77

8-
![Roadmap](/img/BitvmBridge/introduction/roadmap1.png)
8+
![Roadmap](/img/BitvmBridge/introduction/roadmap.png)
99

1010
## **DEC.2024**
1111

@@ -19,8 +19,9 @@ slug: roadmap
1919

2020
## **July 2025**
2121

22-
- Mainnet Beta Launch
22+
- Mainnet Beta Launch (Ethereum)
2323

2424
## **H2. 2025**
2525

26-
- Support for Additional Chains
26+
- Mainnet Launch (SUI)
27+
- Support more Blockchains

docs/BitVMBridge/DevGuides/001-introduction-ybtc.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

docs/BitVMBridge/DevGuides/002-build-with-ybtc.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/BitVMBridge/DevGuides/_category_.json

Lines changed: 0 additions & 6 deletions
This file was deleted.

docs/BitVMBridge/Multi-Chain/002-integrating-target-chain.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ slug: integrating-target-chain
88

99
## Introduction to Bitlayer's BitVM Bridge
1010

11-
Bitlayer's BitVM Bridge is a cutting-edge solution designed to facilitate the movement of Bitcoin assets to a diverse array of blockchain ecosystems. This interoperability unlocks a multitude of decentralized finance (DeFi) and yielding opportunities for Bitcoin holders. The bridge supports a multi-chain architecture, encompassing both Layer 1 (L1) blockchains such as Ethereum, Cardano, Sui, Plume, Sonic SVM, and Solana, as well as Layer 2 (L2) solutions including Bitlayer Network, Base, Arbitrum, and Starknet, among others.
11+
Bitlayer's BitVM Bridge is a cutting-edge solution designed to facilitate the movement of Bitcoin assets to a diverse array of blockchain ecosystems. This interoperability unlocks a multitude of decentralized finance (DeFi) and yielding opportunities for Bitcoin holders. The bridge supports a multi-chain architecture, encompassing both Layer 1 (L1) blockchains such as Ethereum, Cardano, Sui, Plume, Sonic, and Solana, as well as Layer 2 (L2) solutions including Bitlayer Network, Base, Arbitrum, and Starknet, among others.
1212

1313
The core strength of the BitVM Bridge lies in its extensible design, which simplifies the process of integrating new target chains. This document provides a comprehensive guide for developers from the Bitlayer community who wish to extend the bridge's capabilities by adding support for a new target blockchain.
1414

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
{
2-
"label": "YBTC.B",
3-
"position": 10,
4-
"link": null,
5-
"collapsed": false
6-
7-
}
2+
"label": "YBTC.B",
3+
"position": 10,
4+
"link": null,
5+
"collapsed": false
6+
}
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"label": "YBTC",
3+
"position": 11,
4+
"link": null,
5+
"collapsed": false
6+
}

0 commit comments

Comments
 (0)