docs: finality provider setup and registration for users #375

samricotta · 2024-11-12T15:20:58Z

Summary

With testnet 5 coming up we need information for developers to join the network. This doc explains the Finality Providers setup.

samricotta · 2024-11-12T20:51:21Z

bbn-test-5/finality-providers/README.md

+
+The following graphic demonstrates the interconnections for parts of the above
+programs.
+


TODO: Insert new graphic when ready

filippos47

Would it make sense to split the EOTS and FP doc like before? This is a pretty big doc to read.

Adding some initial comments.

It'd also be useful to include monitoring sections for both programs, like here.

filippos47 · 2024-11-13T17:29:18Z

bbn-test-5/finality-providers/README.md

+and can operate on standard mid-sized machines running a UNIX-flavored operating
+system. It consists of the following programs:
+
+- _Babylon full node_: An instance of a Babylon node connecting to the Babylon


Line breaks - same for lists on other parts of the doc :)

ah yes chucked it into the 80character script :/

filippos47 · 2024-11-13T17:31:28Z

bbn-test-5/finality-providers/README.md

+stakers, and can earn commission from the staking rewards denominated in Babylon
+tokens.
+
+The finality provider toolset does not have any special hardware requirements


This will soon change as we're working on a secure keyring setup for EOTS manager.
We could include a note for this, as it's a very common question by collaborators.

filippos47 · 2024-11-13T17:32:47Z

bbn-test-5/finality-providers/README.md

+~/.profile 
+```
+
+## Install Babylon Binary


How about pointing to the babylond guide for the babylon node installation, instead of re-writing everything?

Lazar955

lgtm! Overall well-written content-wise from my perspective. But you should reformat sections bellow:

Lazar955 · 2024-11-13T19:26:00Z

bbn-test-5/finality-providers/README.md

+  configuration ...
+```
+
+If you're having issues, you might not have successfully saved in your `gopath`


Suggested change

If you're having issues, you might not have successfully saved in your `gopath`

If you're having issues, you might not have successfully saved in your `$GOPATH`

Lazar955 · 2024-11-13T19:26:16Z

bbn-test-5/finality-providers/README.md

+
+If you're having issues, you might not have successfully saved in your `gopath`
+
+If it hasn't saved successfully in your `gopath` then it might have saved in the


Suggested change

If it hasn't saved successfully in your `gopath` then it might have saved in the

If it hasn't saved successfully in your `$GOPATH` then it might have saved in the

Lazar955 · 2024-11-13T19:28:51Z

bbn-test-5/finality-providers/README.md

+terminal with the following command.
+
+```shell 
+wget https://github.com/babylonlabs-io/networks/raw/main/bbn-test-5/genesis.tar.bz2


As I get:

wget https://github.com/babylonlabs-io/networks/raw/main/bbn-test-5/genesis.tar.bz2 --2024-11-13 19:27:38-- https://github.com/babylonlabs-io/networks/raw/main/bbn-test-5/genesis.tar.bz2 Resolving github.com (github.com)... 20.205.243.166 Connecting to github.com (github.com)|20.205.243.166|:443... connected. HTTP request sent, awaiting response... 404 Not Found 2024-11-13 19:27:39 ERROR 404: Not Found.

ah yes because this isn't the correct link yet ill put in a reminder to change

Lazar955 · 2024-11-13T19:31:13Z

bbn-test-5/finality-providers/README.md

+We can use the basic start command below:
+
+``` shell
+fpd start \ --home ./fp \ 


Suggested change

fpd start \ --home ./fp \

fpd start --home ./fp

Lazar955 · 2024-11-13T19:31:48Z

bbn-test-5/finality-providers/README.md

+creation process:
+
+``` shell
+2024-11-08T08:41:54.901105Z     info    successfully connected to a remote


this is a bit unreadable with linebreak at 80

Lazar955 · 2024-11-13T19:32:27Z

bbn-test-5/finality-providers/README.md

+- Creates a Babylon account to receive staking rewards
+
+``` shell
+fpd create-finality-provider \ --daemon-address 127.0.0.1:12581 \ --chain-id


nit: format this

Lazar955 · 2024-11-13T19:32:50Z

bbn-test-5/finality-providers/README.md

+    "description": {
+	"moniker": "MyFinalityProvider", "website":
+	"https://myfinalityprovider.com", "security_contact":
+	"[email protected]", "details": "finality provider for the


this as well

samricotta · 2024-11-13T20:26:00Z

Would it make sense to split the EOTS and FP doc like before? This is a pretty big doc to read.

Adding some initial comments.

It'd also be useful to include monitoring sections for both programs, like here.

So this one is difficult because we wanted to change the structure of the old docs to avoid going back and forth between the pages. I found this personally pretty confusing and prefer a straight forward instructions where I can find my place. As long as there is a table of contents (which I think I might be missing) then I think it is good. Otherwise we could separate the EOTS and FP into two separate readmes in the finality provider folder? Anyways lmk your thoughts!

samricotta · 2024-11-14T09:53:51Z

bbn-test-5/finality-providers/README.md

+When a finality provider is created, it's associated with two key elements:
+
+**a) BTC Public Key:** - This serves as the unique identifier for the finality
+provider.  - It's derived from a Bitcoin private key, likely using the secp256k1


fix the formatting

vitsalis · 2024-11-14T11:19:26Z

Shouldn't this be in the finality provider repository?

samricotta · 2024-11-14T11:48:32Z

bbn-test-5/finality-providers/README.md

@@ -0,0 +1,591 @@
+## Introduction


TODO: add a table of contents and add sentence on how FPs must register after chain launches and launch the finality provider program

vitsalis · 2024-11-14T13:38:38Z

bbn-test-5/finality-providers/README.md

+./build/babylond
+```
+
+## Setup your node, home directory and configure


The node setup instructions should not be in the finality provider setup guide. Indeed, we do need to have documentation on how to set up a node, but this document is not the place. I recommend that in this document we note that the finality provider program needs to be connected to a Babylon node with it being highly recommended for the finality provider to set up their own one. This guide should be in the networks repository as it is network specific.

vitsalis · 2024-11-14T13:48:24Z

bbn-test-5/finality-providers/README.md

+eotsd init --home <path> 
+```
+
+#### Add an EOTS key


We should specify to the reader that they have the option to either create a new EOTS key or import an existing one and provide instructions for both cases.

A phase-1 finality provider reading this guide will be instructed to create a new key instead of using the one for which they have all the stakes delegated for phase-1. Let's explore what exactly finality providers have after completing their registration and phase-1 operation and make sure that the guide reflects support for their effective transition

samricotta added 2 commits November 12, 2024 17:20

Create README.md

9b0b4bc

Update README.md

45430fd

samricotta marked this pull request as draft November 12, 2024 16:00

update formatting

3d20dea

samricotta force-pushed the sam/finality-provider branch from 306c8aa to 8864920 Compare November 12, 2024 16:21

Update README.md

43a2144

samricotta force-pushed the sam/finality-provider branch from 8864920 to 43a2144 Compare November 12, 2024 16:32

samricotta marked this pull request as ready for review November 12, 2024 16:32

samricotta marked this pull request as draft November 12, 2024 20:50

samricotta commented Nov 12, 2024

View reviewed changes

samricotta marked this pull request as ready for review November 12, 2024 20:51

samricotta changed the base branch from main to sam/bbn-test-5 November 12, 2024 20:58

filippos47 reviewed Nov 13, 2024

View reviewed changes

Lazar955 approved these changes Nov 13, 2024

View reviewed changes

samricotta commented Nov 14, 2024

View reviewed changes

vitsalis self-requested a review November 14, 2024 13:30

vitsalis reviewed Nov 14, 2024

View reviewed changes

samricotta closed this Nov 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: finality provider setup and registration for users #375

docs: finality provider setup and registration for users #375

samricotta commented Nov 12, 2024 •

edited by filippos47

Loading

samricotta Nov 12, 2024

filippos47 left a comment •

edited

Loading

filippos47 Nov 13, 2024

samricotta Nov 13, 2024

filippos47 Nov 13, 2024

filippos47 Nov 13, 2024

Lazar955 left a comment

Lazar955 Nov 13, 2024

Lazar955 Nov 13, 2024

Lazar955 Nov 13, 2024

samricotta Nov 15, 2024

Lazar955 Nov 13, 2024

Lazar955 Nov 13, 2024

Lazar955 Nov 13, 2024

Lazar955 Nov 13, 2024

samricotta commented Nov 13, 2024

samricotta Nov 14, 2024

vitsalis commented Nov 14, 2024

samricotta Nov 14, 2024 •

edited

Loading

vitsalis Nov 14, 2024

vitsalis Nov 14, 2024


		The following graphic demonstrates the interconnections for parts of the above
		programs.

	If you're having issues, you might not have successfully saved in your `gopath`
	If you're having issues, you might not have successfully saved in your `$GOPATH`


		If you're having issues, you might not have successfully saved in your `gopath`

		If it hasn't saved successfully in your `gopath` then it might have saved in the

docs: finality provider setup and registration for users #375

docs: finality provider setup and registration for users #375

Conversation

samricotta commented Nov 12, 2024 • edited by filippos47 Loading

Summary

Choose a reason for hiding this comment

filippos47 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Lazar955 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

samricotta commented Nov 13, 2024

Choose a reason for hiding this comment

vitsalis commented Nov 14, 2024

samricotta Nov 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

samricotta commented Nov 12, 2024 •

edited by filippos47

Loading

filippos47 left a comment •

edited

Loading

samricotta Nov 14, 2024 •

edited

Loading