Skip to content

Commit 464dfdd

Browse files
kkkk666web3jenks
andauthored
Kevin/remove outdated doc (#423)
* feat(docs): update wallet integration and staking documentation - Refactored wallet integration links to point to new single document pages for Babylon and Bitcoin wallet integration. - Removed outdated sections related to Babylon Genesis Devnet from various documents. - Updated staking indexer configuration to reflect the testnet RPC address. - Enhanced clarity in the documentation by correcting links and improving formatting for better user experience. This update ensures that the documentation is aligned with the latest integration practices and provides a more streamlined user experience for developers. * feat(docs): update wallet integration and staking documentation - Refactored wallet integration links to point to new single document pages for Babylon and Bitcoin wallet integration. - Removed outdated sections related to Babylon Genesis Devnet from various documents. - Updated staking indexer configuration to reflect the testnet RPC address. - Enhanced clarity in the documentation by correcting links and improving formatting for better user experience. This update ensures that the documentation is aligned with the latest integration practices and provides a more streamlined user experience for developers. * docs: fix testnet chain ID and remove wallet category redirects --------- Co-authored-by: Jenks <jenks@babylonlabs.io>
1 parent 8c214d4 commit 464dfdd

24 files changed

Lines changed: 256 additions & 980 deletions

File tree

docs/developers/babylon_genesis_chain/chain_information.mdx

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,3 @@ import TabItem from '@theme/TabItem';
3737
| State Snapshot | [Babylon Github](https://github.com/babylonlabs-io/networks/blob/main/bbn-test-6/network-artifacts/bbn-test-6.tar.gz) [NodeStake](https://nodestake.org/babylon) |
3838
| Seed Nodes | [Babylon Github](https://github.com/babylonlabs-io/networks/tree/main/bbn-test-6/network-artifacts/seeds.txt) |
3939
| Peers | [Babylon Github](https://github.com/babylonlabs-io/networks/tree/main/bbn-test-6/network-artifacts/peers.txt) |
40-
41-
### Babylon Genesis Devnet
42-
43-
| Property | Value |
44-
|----------|-------|
45-
| Chain ID | `edge-devnet-1` |
46-
| Chain Name | `Babylon Edge Devnet` |
47-
| Binary Name | `babylond` |
48-
| Version | `v0.6.0` |
49-
| Genesis Date | `2024-10-15` |

docs/developers/babylon_genesis_chain/explorers/explorers.mdx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,3 @@ Block scanners for Phase 2 Babylon Genesis Testnet (`bbn-test-6`).
3131
| [Node Guru](https://testnet.babylon.explorers.guru/) | `https://testnet.babylon.explorers.guru/` |
3232
| [NodeStake](https://explorer.nodestake.org/babylon-testnet) | `https://explorer.nodestake.org/babylon-testnet` |
3333
| [Xangle](https://babylon-explorer.xangle.io/testnet/home) | `https://babylon-explorer.xangle.io/testnet/home` |
34-
35-
36-
### Babylon Genesis Devnet
37-
38-
| Service | URL |
39-
|---------|-----|
40-
| [Node Guru](https://devnet.babylon.explorers.guru/) | `https://devnet.babylon.explorers.guru/network` |
41-

docs/developers/babylon_genesis_chain/node_information.mdx

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,6 @@ Endpoints for Phase 2 Babylon Genesis Mainnet (`bbn-1`).
3232
| gRPC (Pruned) | `babylon-grpc.polkachu.com:20690` |
3333
| gRPC (Archive) | `babylon-archive-grpc.polkachu.com:20690` |
3434

35-
**NodeStake**
36-
| Endpoint Type | URL |
37-
|-------------|----------|
38-
| RPC | `https://rpc.babylon.nodestake.org` |
39-
| LCD | `https://api.babylon.nodestake.org` |
40-
| gRPC | `https://grpc.babylon.nodestake.org:443` |
41-
4235
### Babylon Genesis Testnet
4336

4437
Endpoints for Phase 2 Babylon Genesis Testnet (`bbn-test-6`).
@@ -59,14 +52,3 @@ Endpoints for Phase 2 Babylon Genesis Testnet (`bbn-test-6`).
5952
| RPC | `https://babylon-testnet-rpc.polkachu.com` |
6053
| LCD | `https://babylon-testnet-api.polkachu.com` |
6154
| gRPC | `http://babylon-testnet-grpc.polkachu.com:20690` |
62-
63-
### Babylon Genesis Devnet
64-
65-
Endpoints for Babylon Genesis Devnet (`edge-devnet-1`). This is a development environment for testing upcoming features.
66-
67-
**Babylon Labs**
68-
| Endpoint Type | URL |
69-
|--------------|-----|
70-
| RPC Endpoint | ` https://rpc.edge-devnet.babylonlabs.io/` |
71-
| LCD Nodes Endpoint | `https://lcd.edge-devnet.babylonlabs.io/` |
72-
| gRPC Endpoint | `https://grpc.edge-devnet.babylonlabs.io/` |

docs/developers/bitcoin_staking/staking_backend/services/staking_indexer.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Set the Babylon RPC address and connection parameters.
6363
6464
```yaml
6565
bbn:
66-
rpc-addr: https://rpc-dapp.devnet.babylonlabs.io:443
66+
rpc-addr: https://rpc-dapp.testnet.babylonlabs.io:443
6767
timeout: 30s
6868
```
6969

docs/developers/bitcoin_staking/wallet_integration/babylon_wallet_integration/babylon_wallet_integration.mdx renamed to docs/developers/bitcoin_staking/wallet_integration/babylon_wallet_integration.mdx

Lines changed: 87 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
2-
sidebar_label: Wallet Integration Guide
3-
sidebar_position: 1
2+
title: Babylon Wallet Integration
3+
sidebar_label: Babylon Wallet Integration
4+
sidebar_position: 2
45
---
56

67
# BABY Wallet & Staking Integration Guide
78

8-
The Babylon Genesis is a PoS chain built using the
9+
The Babylon Genesis is a PoS chain built using the
910
Cosmos SDK and utilises most of the vanilla Cosmos SDK functionality
1011
shared among chains developed using it. Therefore,
1112
a wallet already supporting chains built using
@@ -18,6 +19,7 @@ the Babylon Genesis blockchain into your wallet:
1819
* [Accounts, message signing, token balance, and token transfer](#accounts-message-signing-token-balance-and-token-transfer)
1920
* [Staking](#staking)
2021
* [Unbonding](#unbonding)
22+
* [Wallet Integration Recommendation](#wallet-integration-recommendation)
2123

2224
### Babylon Genesis Network Information
2325

@@ -121,9 +123,89 @@ works in practice:
121123
* **Epoch Processing**:
122124
* The unbonding transaction is queued and processed at
123125
the end of the epoch (block 300).
124-
* The users status is updated to unbonding, and the epochs
126+
* The user's status is updated to unbonding, and the epoch's
125127
state is timestamped on Bitcoin.
126128
* **Finalization**:
127129
* After ~50 hours, the Bitcoin timestamp reaches 300 confirmations.
128130
* Babylon Genesis detects this and completes the unbonding process,
129-
fully unbonds the user’s stake.
131+
fully unbonds the user's stake.
132+
133+
## Wallet Integration Recommendation
134+
135+
To provide the best experience for users here are some suggestions to wallet
136+
developers:
137+
138+
1. **Epochised Staking UI**:
139+
140+
* Show a clear indication that staking operations are queued for
141+
end-of-epoch execution
142+
143+
* Display estimated time until the end of current epoch
144+
145+
* Provide a way to view all pending staking operations
146+
147+
2. **Fast Unbonding UI**:
148+
149+
* Accurately communicate the unbonding period
150+
151+
* Indicate that unbonding leverages Bitcoin security
152+
153+
* If possible, show progress of Bitcoin confirmations for unbonding
154+
requests
155+
156+
3. **Slashing Warnings**:
157+
158+
* Include clear warnings about the slashing risk
159+
160+
* Highlight the importance of choosing reliable validators
161+
162+
### Implementation Best Practices
163+
164+
1. **Proper Error Handling**:
165+
166+
* Handle epoch transition edge cases
167+
168+
* Manage potential failures due to users spending funds before epoch
169+
processing
170+
171+
2. **Refresh Strategies**:
172+
173+
* Implement proper cache refreshing after expected epoch boundaries
174+
175+
* Update delegation status after expected unbonding completion times
176+
177+
3. **Testing**:
178+
179+
* Test thoroughly against Babylon testnet before mainnet integration
180+
181+
* Verify all epoch-based operations complete as expected
182+
183+
4. **User Communication**:
184+
185+
* Clearly explain the unique aspects of BABY staking (epochised staking,
186+
fast unbonding)
187+
188+
* Provide educational content about the relationship between Bitcoin
189+
security and BABY staking
190+
191+
### Common Integration Challenges
192+
193+
1. **Epochised Staking Transition**:
194+
195+
* Users transferring funds after staking transaction but before epoch
196+
processing
197+
198+
* Solution: Clear warnings about not transferring funds until end of epoch
199+
200+
2. **Fast Unbonding Expectations**:
201+
202+
* Managing user expectations around unbonding times, which depend on
203+
Bitcoin block times
204+
205+
* Solution: Provide estimated time ranges rather than exact times
206+
207+
3. **Validator Selection**:
208+
209+
* Helping users choose reliable validators to minimize slashing risk
210+
211+
* Solution: Display validator uptime, commission rates, and voting power

docs/developers/bitcoin_staking/wallet_integration/babylon_wallet_integration/_category_.json

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

docs/developers/bitcoin_staking/wallet_integration/babylon_wallet_integration/integration_recommendation.mdx

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

0 commit comments

Comments
 (0)