Skip to content

Commit 197aafa

Browse files
authored
Merge pull request #120 from bitlayer-org/feature/2025-05-28-update-mainnet-guides
Feature/2025 05 28 update mainnet guides
2 parents cde7dbf + a80f727 commit 197aafa

13 files changed

Lines changed: 225 additions & 56 deletions

docs/BitVMBridge/UserGuides/HowtoBridgeInTestnet.md

Lines changed: 61 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,66 +4,99 @@ sidebar_position: 52
44

55
# Bridge User Guide (Testnet)
66

7-
This guide will walk you through how to use **[Bridge function](https://bitvmbridge.bitlayer.org/testnet/bridge#header)**, including:
7+
This guide walks you through using the **[BitVM Bridge](https://bitvmbridge.bitlayer.org/testnet/bridge#header)** on testnet, including:
88

9-
- Bridging vBTC from **BitVMNet** to **Monad Testnet and Ethereum Sepolia** to Mint YBTC
10-
- Bridging YBTC **back to BitVMNet**
9+
- Bridging **vBTC** from **BitVMNet** to **Monad Testnet** or **Ethereum Sepolia** to mint **YBTC**
10+
- Bridging **YBTC** back to **BitVMNet**
1111

1212
---
1313

14+
## Step 1: Configure Xverse Wallet for BitVMNet
1415

15-
## Step1: Configure Xverse wallet for BitVMNet
16-
**Important:** Please make sure to manually set the **Signet BTC URL(`https://esplora.bitvmnet.org`)** in **Xverse**.
16+
> **Important:** Manually set the **Signet BTC URL** in Xverse to:
17+
> `https://esplora.bitvmnet.org`
1718
18-
<img src="/img/BitvmBridge/tutorial/bridge/xverse.png" style={{ maxWidth: '100%', height: 'auto' }} />
19+
<img src="/img/BitvmBridge/tutorial/bridge/xverse.png" style={{ maxWidth: '100%', height: 'auto' }} />
1920

20-
## Step2: Switch to Native SegWit in Xverse wallet
21+
---
22+
23+
## Step 2: Switch to Native SegWit Format in Xverse
24+
25+
In the Xverse wallet, ensure your address format is set to **Native SegWit**.
26+
27+
<img src="/img/BitvmBridge/tutorial/bridge/xverse-native-segwit.png" style={{ maxWidth: '100%', height: 'auto' }} />
28+
29+
---
2130

22-
<img src="/img/BitvmBridge/tutorial/bridge/xverse-native-segwit.png" style={{ maxWidth: '100%', height: 'auto' }} />
31+
## Step 3: Get BitVMNet BTC (vBTC) from [TheFaucet](https://www.thefaucet.org/Bitcoin/BitVMNet)
2332

33+
[BitVMNet](https://www.bitvmnet.org/) is an open Bitcoin Signet network supported by Bitlayer, designed for BitVM application development and testing.
34+
BTC on BitVMNet is referred to as **vBTC**.
2435

25-
## **Step3: Get BitVMNet BTC (vBTC) > [TheFaucet](https://www.thefaucet.org/Bitcoin/BitVMNet)**
26-
[BitVMNet](https://www.bitvmnet.org/) is an open Bitcoin Signet network sponsored by Bitlayer, designed to facilitate the development and implementation of BitVM-based applications. As a collaborative platform, it empowers developers within the BitVM ecosystem, driving the advancement and adoption of BitVM technology.
27-
BTC on BitVMNet is called **vBTC**
36+
To get vBTC:
37+
38+
- Visit [TheFaucet](https://www.thefaucet.org/Bitcoin/BitVMNet)
39+
- Enter a Bitcoin testnet address starting with `tb1q` or `tb1p`
40+
- Wait ~20 minutes for the faucet to send your vBTC
41+
42+
Once received, you can view your vBTC balance in Xverse.
2843

29-
On the [Thefaucet](https://www.thefaucet.org/Bitcoin/BitVMNet), you can enter an address starting with `tb1q` or `tb1p` to claim **vBTC**.
30-
You need to wait about **20 minutes** for Thefaucet to send you the **vBTC**. Once received, you can view your **vBTC** balance in Xverse.
3144
<img src="/img/BitvmBridge/tutorial/bridge/thefaucet.png" style={{ maxWidth: '90%', height: 'auto' }} />
3245

46+
---
3347

34-
## Step4: Confirm you have configured BitVMNet in Xverse wallet
48+
## Step 4: Verify BitVMNet Configuration in Xverse
49+
50+
Make sure your Xverse wallet is still using the correct Signet BTC URL:
51+
`https://esplora.bitvmnet.org`
3552

36-
Make sure the Signet network in Xverse is configured with the correct BTC URL: https://esplora.bitvmnet.org
3753
<img src="/img/BitvmBridge/tutorial/bridge/makesurerightbtcurl.png" style={{ maxWidth: '50%', height: 'auto' }} />
3854

39-
## **Step5: Connect your OKX wallet**
55+
---
56+
57+
## Step 5: Connect Your OKX Wallet
58+
59+
Connect your OKX Wallet to use Ethereum Sepolia or Monad Testnet as your destination network.
60+
4061
<img src="/img/BitvmBridge/tutorial/bridge/okxwallet.png" style={{ maxWidth: '50%', height: 'auto' }} />
4162

63+
---
64+
65+
## Step 6: Select Target Network
4266

43-
## **Step6: Select your target network**
44-
Ethereum Sepolia or Monad Testnet
67+
Choose either **Ethereum Sepolia** or **Monad Testnet** as your target network.
68+
69+
---
70+
71+
## Step 7: Input Amount and Target Address
72+
73+
- Enter the amount of vBTC to bridge
74+
- Confirm your EVM-compatible address
75+
- Proceed to mint **YBTC** on the selected chain
4576

46-
## **Step7: Input the amount and Target Address**
47-
Confirm to Bridge YBTC on the target chain
4877
<img src="/img/BitvmBridge/tutorial/bridge/bridge-out-confirm.png" style={{ maxWidth: '50%', height: 'auto' }} />
4978

5079
---
5180

52-
## Bridge YBTC Back to BitVMNet
81+
## Bridging YBTC Back to BitVMNet
82+
83+
### Step 1: Switch Target Chain to BitVMNet
5384

54-
**Step1: Switch your target Chain to BitVMNet**
5585
<img src="/img/BitvmBridge/tutorial/bridge/bridge-in-confirm.png" style={{ maxWidth: '50%', height: 'auto' }} />
5686

57-
**Step2: Approve and Confirm**
87+
### Step 2: Approve and Confirm
88+
89+
- Approve the transaction in your wallet
90+
- Confirm to bridge your YBTC back to **vBTC** on BitVMNet
5891

5992
---
6093

6194
## Quick Links
6295

63-
| Feature | Link |
64-
| ----------------------- | --------------------------------------------------------------------------------- |
65-
| Get BitVMNet BTC (vBTC) | [TheFaucet](https://www.thefaucet.org/Bitcoin/BitVMNet) |
66-
| Xverse Wallet Setup | [Setup Guide](https://docs.bitlayer.org/docs/BitVMBridge/UserGuides/XverseBTCUrl) |
67-
| BitVM Bridge | [BitVM Bridge ](https://bitvmbridge.bitlayer.org/testnet/bridge#header) |
96+
| Feature | Link |
97+
|---------------------------|--------------------------------------------------------------------------------------|
98+
| Get BitVMNet BTC (vBTC) | [TheFaucet](https://www.thefaucet.org/Bitcoin/BitVMNet) |
99+
| Xverse Wallet Setup Guide | [Setup Guide](https://docs.bitlayer.org/docs/BitVMBridge/UserGuides/XverseBTCUrl) |
100+
| BitVM Bridge Interface | [BitVM Bridge](https://bitvmbridge.bitlayer.org/testnet/bridge#header) |
68101

69102
---
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
sidebar_position: 42
3+
---
4+
# Howto Bridge on Mainet
5+
6+
## Bridge User Guide (Mainnet)
7+
8+
This guide will walk you through how to use the **[Bridge](https://bitvmbridge.bitlayer.org/bridge#header)** feature, including:
9+
10+
- Bridging BTC from **Bitcoin** to **Ethereum** to mint YBTC
11+
- Bridging YBTC **back to Bitcoin**
12+
13+
---
14+
15+
### **Step 1: Connect Your Wallet**
16+
17+
Connect your Bitcoin wallet to begin.
18+
19+
<img src="/img/BitvmBridge/tutorial/mainnet-bridge/connect-wallet.png" style={{ maxWidth: '100%', height: 'auto' }} />
20+
21+
---
22+
23+
### **Step 2: Enter Amount and Target Address**
24+
25+
Enter the BTC amount you wish to bridge and provide your Ethereum address.
26+
If you have already connected an EVM wallet, your receiving address will be auto-filled.
27+
28+
You can [add YBTC](https://etherscan.io/token/0xd9e3719f53b61047d5bbbe9e3fb18ea1e07b1b02) to your wallet with a single click.
29+
30+
<img src="/img/BitvmBridge/tutorial/mainnet-bridge/bridge-out-confirm.png" style={{ maxWidth: '100%', height: 'auto' }} />
31+
32+
---
33+
34+
## Bridge YBTC Back to Bitcoin
35+
36+
### **Approve and Confirm**
37+
38+
To bridge YBTC back to Bitcoin, enter the amount and your Bitcoin address.
39+
If a Bitcoin wallet is connected, the address will be auto-filled.
40+
41+
<img src="/img/BitvmBridge/tutorial/mainnet-bridge/bridge-in-confirm.png" style={{ maxWidth: '100%', height: 'auto' }} />

docs/BitVMBridge/UserGuides/HowtoMint.md

Lines changed: 52 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,47 +6,71 @@ sidebar_position: 53
66

77
## Prerequisites
88

9-
To get started, ensure you have wallets supporting BTC and EVM-compatible addresses, you can get test tokens from the [links](./GetTestToken.md).
9+
To get started, make sure you have wallets that support both BTC and EVM-compatible addresses.
10+
You can get test tokens from the following [test token faucet links](./GetTestToken.md).
1011

11-
- Bitcoin BitVMNet
12-
- Wallet: [Xverse](https://www.xverse.app/)
13-
- Ethereum Sepolia Testnet
14-
- Wallet: [MetaMask](https://metamask.io/), [OKX Web3](https://www.okx.com/web3), [Coinbase Wallet
15-
](https://www.coinbase.com/wallet)
12+
- **Bitcoin BitVMNet**
13+
- Recommended Wallet: [Xverse](https://www.xverse.app/)
14+
- **Ethereum Sepolia Testnet**
15+
- Supported Wallets: [MetaMask](https://metamask.io/), [OKX Web3](https://www.okx.com/web3), [Coinbase Wallet](https://www.coinbase.com/wallet)
1616

17-
## 1. Connect Bitcoin Wallet
17+
---
18+
19+
## 1. Connect Your Bitcoin Wallet
20+
21+
### 1.1 Open [BitVM Bridge](https://bitvmbridge.bitlayer.org/), connect to **Bitcoin BitVMNet**, and sign in.
22+
23+
<img src="/img/BitvmBridge/tutorial/mint/connect-wallet-1.png" style={{ maxWidth: '50%', height: 'auto' }} />
24+
25+
---
26+
27+
### 1.2 Configure Signet Mode in Xverse
28+
29+
Set the BTC node URL in your Xverse wallet to enable Signet mode.
30+
Follow this [setup guide](https://docs.bitlayer.org/docs/BitVMBridge/UserGuides/XverseBTCUrl/).
31+
32+
<img src="/img/BitvmBridge/tutorial/mint/xverse-btc-url.png" style={{ maxWidth: '50%', height: 'auto' }} />
33+
34+
---
35+
36+
### 1.3 Confirm Address and Amount
37+
38+
Enter an amount between **0.0002 and 0.0006 BTC**, and input your **Sepolia address**.
39+
If your EVM wallet is connected, the receiving address will be auto-filled.
40+
41+
<img src="/img/BitvmBridge/tutorial/mint/confirm-address-amount-2.png" style={{ maxWidth: '50%', height: 'auto' }} />
42+
43+
---
1844

19-
#### 1.1 Visit [BitVM Bridge](https://bitvmbridge.bitlayer.org/), Connect Bitcoin BitVMNet, and Sign in.
45+
## 2. Select Funding UTXOs
2046

21-
<img src="/img/BitvmBridge/tutorial/mint/connect-wallet-1.png" style={{ maxWidth: '50%', height: 'auto' }} />
47+
Choose UTXOs that are **not associated with derivative assets** (e.g., BRC-20).
48+
If your selected UTXOs contain more BTC than the requested mint amount, the excess will be automatically returned to your Bitcoin address.
2249

50+
<img src="/img/BitvmBridge/tutorial/mint/pick-your-funding-utxo-1.png" style={{ maxWidth: '50%', height: 'auto' }} />
2351

24-
#### 1.2 Set the BTC URL for Signet mode in your Xverse wallet, [Setup Guide](https://docs.bitlayer.org/docs/BitVMBridge/UserGuides/XverseBTCUrl/)
25-
<img src="/img/BitvmBridge/tutorial/mint/xverse-btc-url.png" style={{ maxWidth: '50%', height: 'auto' }} />
52+
---
2653

27-
#### 1.3 Confirm address and amount
54+
## 3. Generate Deposit Address
2855

29-
Enter amount within 0.0001~0.001, and input your Sepolia address(If you have connected an EVM wallet, your EVM receiving address will be automatically filled in.).
30-
<img src="/img/BitvmBridge/tutorial/mint/confirm-address-amount-2.png" style={{ maxWidth: '50%', height: 'auto' }} />
31-
## 2. Pick your funding UTXOs
56+
A unique smart contract will be generated to receive your BTC based on your peg-in request.
57+
You can preview the contract logic through a visualized diagram.
3258

33-
Please ensure the selected UTXOs are not associated with derivative assets like BRC20.
34-
If UTXOs you choosed containes more BTC than you mint, extra BTC will back to your BTC address
59+
<img src="/img/BitvmBridge/tutorial/mint/generate-address-for-deposit-1.png" style={{ maxWidth: '50%', height: 'auto' }} />
3560

36-
<img src="/img/BitvmBridge/tutorial/mint/pick-your-funding-utxo-1.png" style={{ maxWidth: '50%', height: 'auto' }} />
37-
## 3. Generate address for Deposit
61+
---
3862

39-
The BitVM Bridge Network will generate a smart contract which will accept you BTC according to your peg-in request.
40-
You can view the logic rules of this smart contract through a visualized diagram.
41-
<img src="/img/BitvmBridge/tutorial/mint/generate-address-for-deposit-1.png" style={{ maxWidth: '50%', height: 'auto' }} />
63+
## 4. Make Your BTC Deposit
4264

43-
## 4. Make your BTC Deposit
65+
Carefully review all transaction details and send your BTC to the generated address.
4466

45-
Confirm all information and transfer your BTC.
46-
<img src="/img/BitvmBridge/tutorial/mint/make-your-btc-deposit.png" style={{ maxWidth: '50%', height: 'auto' }} />
67+
<img src="/img/BitvmBridge/tutorial/mint/make-your-btc-deposit.png" style={{ maxWidth: '50%', height: 'auto' }} />
68+
69+
---
4770

48-
## 5. Mint your YBTC on Ethereum
71+
## 5. Mint YBTC on Ethereum
4972

50-
This operation will cost 20-30Mins, it is safe to close the window. Minting process will continue as a background process and will not be interrupted.
73+
The minting process takes approximately **20–30 minutes**.
74+
It’s safe to close the window — the process will continue in the background and will not be interrupted.
5175

52-
<img src="/img/BitvmBridge/tutorial/mint/mint-your-btc-on-ethereum.png" style={{ maxWidth: '50%', height: 'auto' }} />
76+
<img src="/img/BitvmBridge/tutorial/mint/mint-your-btc-on-ethereum.png" style={{ maxWidth: '50%', height: 'auto' }} />
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
sidebar_position: 43
3+
---
4+
5+
# How to Mint on Mainnet?
6+
7+
## Prerequisites
8+
9+
Before you begin, please ensure you have:
10+
11+
- A Bitcoin wallet with available UTXOs (not linked to BRC-20 or other derivative assets).
12+
- An EVM-compatible wallet (e.g., MetaMask) to receive YBTC.
13+
14+
---
15+
16+
## 1. Connect Your Bitcoin Wallet
17+
18+
#### 1.1 Visit [BitVM Bridge](https://bitvmbridge.bitlayer.org/bridge-pro/mint) and connect your Bitcoin wallet.
19+
20+
<img src="/img/BitvmBridge/tutorial/mainnet-mint/connect-btc-wallet.png" style={{ maxWidth: '100%', height: 'auto' }} />
21+
22+
---
23+
24+
#### 1.2 Confirm Amount and Ethereum Address
25+
26+
Enter the amount you want to mint (up to 5 BTC), and provide your Ethereum wallet address.
27+
If an EVM wallet is already connected, the receiving address will be auto-filled.
28+
29+
You can add [YBTC](https://etherscan.io/token/0xd9e3719f53b61047d5bbbe9e3fb18ea1e07b1b02) to your wallet with a single click.
30+
31+
<img src="/img/BitvmBridge/tutorial/mainnet-mint/confirm-address-amount.png" style={{ maxWidth: '100%', height: 'auto' }} />
32+
33+
---
34+
35+
## 2. Select Funding UTXOs
36+
37+
Choose UTXOs that are not associated with assets such as BRC-20.
38+
If the selected UTXOs contain more BTC than required, the excess will be automatically returned to your Bitcoin address.
39+
40+
<img src="/img/BitvmBridge/tutorial/mainnet-mint/pick-your-funding-utxo.png" style={{ maxWidth: '100%', height: 'auto' }} />
41+
42+
---
43+
44+
## 3. Generate Deposit Address
45+
46+
The BitVM Bridge Network will generate a custom smart contract address to receive your BTC.
47+
This contract is created based on your peg-in request.
48+
49+
<img src="/img/BitvmBridge/tutorial/mainnet-mint/generate-address-for-deposit.png" style={{ maxWidth: '100%', height: 'auto' }} />
50+
51+
---
52+
53+
## 4. Deposit BTC
54+
55+
Carefully review the deposit details, then send your BTC to the generated address.
56+
The confirmation process typically takes 60–100 minutes. You may safely close the window — the minting will continue in the background.
57+
58+
<img src="/img/BitvmBridge/tutorial/mainnet-mint/make-your-btc-deposit.png" style={{ maxWidth: '100%', height: 'auto' }} />
59+
60+
---
61+
62+
## 5. Check YBTC in Your Wallet
63+
64+
Once the minting process is complete, YBTC will appear in your EVM wallet.
65+
The official contract address for YBTC is:
66+
67+
**[0xd9E3719F53b61047D5Bbbe9E3FB18eA1E07B1B02](https://etherscan.io/token/0xd9e3719f53b61047d5bbbe9e3fb18ea1e07b1b02)**
68+
69+
<img src="/img/BitvmBridge/tutorial/mainnet-mint/ybtc-in-wallet.png" style={{ maxWidth: '50%', height: 'auto' }} />
70+
71+
396 KB
Loading
351 KB
Loading
157 KB
Loading
417 KB
Loading
311 KB
Loading
505 KB
Loading

0 commit comments

Comments
 (0)