docs: register stake to Babylon chain #105
Conversation
docs/transition-phase-2.md
Outdated
| ### Babylon Configuration | ||
| ```toml | ||
| [babylon] | ||
| Key = "btc-staker" # Your Babylon key name |
There was a problem hiding this comment.
Do we need to instruct user how to create this key?
There was a problem hiding this comment.
It looks like the instructions can be found here: https://github.com/babylonlabs-io/btc-staker/blob/6d25cf181be58531fff2ed32d2b0625887b9ff6a/README.md#create-a-babylon-keyring-keyring-backend-test-with-funds. Can we somehow tell users that they need to use the key created in this step?
There was a problem hiding this comment.
https://github.com/babylonlabs-io/btc-staker?tab=readme-ov-file#3-btc-staker-installation - we link to this at the beginning, which specifies the account within the guide. Maybe I should mention the babylon account in the prerequisites as its seemingly not clear enough
There was a problem hiding this comment.
In general lgtm. Some high-level comments:
- We should be consistent with babylonlabs-io/babylon@f1ae78e where we use registration other than transition. So we need to change the tone a bit.
- We should stick with
Phase-1orPhase-2other thanphase-1orphase-2
vitsalis
changed the title
docs/register-phase-1-stake.md
Outdated
| Parameters: | ||
| - `global-parameters-file`: The path to the global parameters file. | ||
| - `your-phase1-tx-hash`: The original hash of your Bitcoin staking transaction. | ||
| - `your-btc-address`: BTC address of the staker in hex. |
There was a problem hiding this comment.
hex? This is weird. Shouldn't it be the normal address?
There was a problem hiding this comment.
--staker-address [btcStakerAddrHex] this is what is required in the cli
There was a problem hiding this comment.
How will the staker be able to find their address in hex format? This is a bit weird. Can we verify that indeed a hex is required and not a normal address?
There was a problem hiding this comment.
ahh the description --staker-address [btcStakerAddrHex] is laying, the address must be bech32 btc encoded address - https://github.com/babylonlabs-io/btc-staker/blob/main/stakerservice/service.go#L142
Maybe you can fix it in this pr ?
There was a problem hiding this comment.
Ah makes sense! made the change
No description provided.