Self hosting backend service instruction #91

hiepmai-babylonchain · 2024-07-04T08:45:44Z

No description provided.

docs/user-guides/phase-1/services/staking-api.md

filippos47

Big effort, very nice work!
Suggest to add the following sections to all infra / services:

Monitoring section. For the services, let's explain that they expose Prom metrics and they can be scraped. For the infra, we can suggest a Prom exporter to use. (refs: 1, 2)
Hardware and Network requirements: We are often asked by teams how many resources does a server require, how should it be deployed etc. Suggest to add generic guidelines.

docs/user-guides/phase-1/global-params.md

docs/user-guides/phase-1/images/phase-1-overview.png

sidebars.js

docs/user-guides/phase-1/infra/rabbitmq.md

docs/user-guides/phase-1/services/overview.md

docs/user-guides/phase-1/services/staking-api.md

docs/user-guides/phase-1/infra/rabbitmq.md

docs/user-guides/phase-1/services/staking-api.md

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/services/staking-api.md

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/services/staking-indexer.md

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/deployment-overview.md

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/global-system-configuration.md

gitferry · 2024-07-05T08:06:06Z

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/global-system-configuration.md

+# Global System Configuration
+
+## Staking Parameters
+
+The Global Configuration includes a series of versioned governance parameters that greatly affect the behaviour of the system. Detailed information can be found [here](https://github.com/babylonchain/networks/tree/main/bbn-test-4/parameters).


Seems we can copy the content here other than a reference?

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/services/staking-indexer.md

vitsalis

Recommend that on markdown we have 80 character lines.

hiepmai-babylonchain · 2024-07-10T09:57:41Z

Thanks for the recommendation @vitsalis.
As I will need to prepare more documents in the future. Would you be able to explain the 80 character lines a bit more?
For example, I have the following sentence:
The Global Configuration includes a series of versioned governance parameters that greatly affect the behaviour of the system.
Would it be clearer if it were written as:

The Global Configuration includes a series of versioned governance parameters
that greatly affect the behaviour of the system.

Is this format easier for you to follow?

gitferry

LGTM!

vitsalis · 2024-07-10T14:18:14Z

Thanks for the recommendation @vitsalis. As I will need to prepare more documents in the future. Would you be able to explain the 80 character lines a bit more? For example, I have the following sentence: The Global Configuration includes a series of versioned governance parameters that greatly affect the behaviour of the system. Would it be clearer if it were written as:
The Global Configuration includes a series of versioned governance parameters
that greatly affect the behaviour of the system.
Is this format easier for you to follow?

@hiepmai-babylonchain yes, that's perfect. This is a good practice for markdown files as it is easier to review and edit.

filippos47

Great job!
Small nits.

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/global-system-configuration.md

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/services/staking-api.md

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/deployment-overview.md

vitsalis

A big set of comments. Up to you which ones you want to include.

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/deployment-overview.md

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/global-system-configuration.md

vitsalis · 2024-07-16T13:21:36Z

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/services/staking-api.md

+
+### 6.1 Create systemd service definition
+
+Run the following command, replacing `your_username` with your actual username:


What does username refer to in this context? The user of the system?

Also, doesn't this only work with Linux? We should not that.

As it's stated as Optional on the heading, should we just remove this section as it only works it Linux?

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/services/staking-api.md

vitsalis · 2024-07-16T13:23:11Z

.../user-guides/bitcoin-staking-testnet-4/backend-deployment/services/staking-expiry-checker.md

+### 1.2 Install the binary by running
+
+```bash
+cd staking-expiry-checker


Shouldn't we ask the user to decide on what version/release to use? Same for all other services.

I thought about it in the first place but didn't include the version.
The reason is if we put specific version here, we will need to update the docs frequently. Otherwise, the version is not up-to-dated.
Alternatively, we could ask users to check the release page for updates. If we go this route, we'll need to indicate in the release notes whether a particular version is recommended.

Makes sense, although this is counter-intuitive for the user though. How can the user know which versions are compatible with each other?

.../user-guides/bitcoin-staking-testnet-4/backend-deployment/services/staking-expiry-checker.md

vitsalis · 2024-07-16T13:24:07Z

.../user-guides/bitcoin-staking-testnet-4/backend-deployment/services/staking-expiry-checker.md

+
+### 4.1 Create systemd service definition
+
+Run the following command, replacing `your_username` with your actual username:


Linux only.

vitsalis

An additional round of comments after a quick look. Most major comment is that we refer to the system as the "Bitcoin Staking system" which might confuse users, as this is only the first phase, which includes a lock-only system. Additionally, it seems that some introductions and explanations of some terms are warranted.

To not delay the merge of this, no need to review again. Once my comments are resolved you can merge, and you can create some issues to track the improvements of the guide so that we can improve it in a more fine-grained manner instead of repeatedly reviewing a big PR.

vitsalis · 2024-07-27T14:08:40Z

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/deployment-overview.md

+
+![Overview of Bitcoin Staking backend deployment](images/phase-1-overview.png)
+
+The Babylon Bitcoin Staking system comprises of the following components:


Let's not call this the "Bitcoin Staking system" as this might confuse a user that this system is all there is to Bitcoin Staking or a potential Babylon blockchain. This is the phase-1 lock only system. You can get an idea of how we typically describe the phase-1 lock-only system in this PR. We should also note that this system connects to a Bitcoin network.

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/deployment-overview.md

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/hardware-requirements.md

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/overview.md

vitsalis · 2024-07-27T14:23:58Z

.../user-guides/bitcoin-staking-testnet-4/backend-deployment/services/staking-expiry-checker.md

+### 1.2 Install the binary by running
+
+```bash
+cd staking-expiry-checker


Makes sense, although this is counter-intuitive for the user though. How can the user know which versions are compatible with each other?

vitsalis · 2024-07-27T14:24:45Z

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/services/staking-indexer.md

+The staking indexer is a tool that extracts BTC staking relevant data
+from the Bitcoin blockchain, ensures that it follows the pre-requisites
+for a valid staking transaction, and determines whether
+the transaction should be active or not.


What's an active transaction? Have we defined this somewhere?

I got it from the staking-indexer README

Going to update to active stake to match with the glossary

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/services/staking-indexer.md

hiepmai-babylonchain requested review from filippos47 and jrwbabylonlab July 4, 2024 08:45

hiepmai-babylonchain commented Jul 4, 2024

View reviewed changes

docs/user-guides/phase-1/services/staking-api.md Outdated Show resolved Hide resolved

jrwbabylonlab requested a review from gitferry July 4, 2024 08:52

filippos47 reviewed Jul 4, 2024

View reviewed changes

hiepmai-babylonchain force-pushed the hiep/add-phase-1-setup branch from 6db09aa to a2107eb Compare July 5, 2024 03:45

jrwbabylonlab reviewed Jul 5, 2024

View reviewed changes

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/services/staking-api.md Show resolved Hide resolved

jrwbabylonlab reviewed Jul 5, 2024

View reviewed changes

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/services/staking-api.md Outdated Show resolved Hide resolved

jrwbabylonlab reviewed Jul 5, 2024

View reviewed changes

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/services/staking-api.md Outdated Show resolved Hide resolved

jrwbabylonlab reviewed Jul 5, 2024

View reviewed changes

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/services/staking-indexer.md Outdated Show resolved Hide resolved

gitferry reviewed Jul 5, 2024

View reviewed changes

docs/user-guides/bitcoin-staking-testnet-4/backend-deployment/services/staking-indexer.md Show resolved Hide resolved

jrwbabylonlab approved these changes Jul 10, 2024

View reviewed changes

vitsalis reviewed Jul 10, 2024

View reviewed changes

gitferry approved these changes Jul 10, 2024

View reviewed changes

filippos47 approved these changes Jul 15, 2024

View reviewed changes

vitsalis reviewed Jul 16, 2024

View reviewed changes

hiepmai-babylonchain added 11 commits July 23, 2024 11:25

Initial structure

191aff6

Add sidebars

5621171

Update structure

b66eea3

Update overview

8bac230

Update

7a7fb98

Update global-params

7281c4f

Match other docs style

bd25df2

updates

5e6aa5e

Delete services-setup

abd37db

Nits

ee67c03

Spacing

196980f

hiepmai-babylonchain added 22 commits July 23, 2024 11:25

Add overview

812ed33

updates

4f81f49

huge updates

e14931c

update hardware requirements

8ed56c9

capitals

24d177f

More updates

1cb9222

Update global-params and finality-providers download

807fb50

General guide to install rabbitmq

6e788c7

Staking-indexer updates

64f5980

Update global-params and finality-providers download

2721b1b

80 characters limit

ae439b1

finality-providers.json

2e68a16

Update generating finality-providers.json

e9d704a

markdownlint

96ea0db

Update commands

d2732c4

Typo

c1541df

Makes it easier to review

1bafd03

Review

bfba3b0

Updates

b7d21f7

Add mongodb credential

f57ff3a

Update

7911ba1

Add instruction to checkout version

205b8a2

hiepmai-babylonchain force-pushed the hiep/add-phase-1-setup branch from a1730db to 205b8a2 Compare July 23, 2024 04:26

hiepmai-babylonchain added 2 commits July 25, 2024 11:22

Update why we need concatenated finality-provider.json

a42864f

Update systemd service def

cb43c41

jrwbabylonlab approved these changes Jul 25, 2024

View reviewed changes

vitsalis reviewed Jul 27, 2024

View reviewed changes

maiquanghiep added 2 commits July 29, 2024 11:31

One of the last updates

e7f72c7

Update description for lock-only system

bbb4247

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Self hosting backend service instruction #91

Self hosting backend service instruction #91

hiepmai-babylonchain commented Jul 4, 2024

filippos47 left a comment •

edited

Loading

gitferry Jul 5, 2024

vitsalis left a comment

hiepmai-babylonchain commented Jul 10, 2024

gitferry left a comment

vitsalis commented Jul 10, 2024

filippos47 left a comment

vitsalis left a comment

vitsalis Jul 16, 2024

hiepmai-babylonchain Jul 17, 2024

vitsalis Jul 16, 2024

hiepmai-babylonchain Jul 17, 2024

vitsalis Jul 27, 2024

vitsalis Jul 16, 2024

vitsalis left a comment

vitsalis Jul 27, 2024

vitsalis Jul 27, 2024

vitsalis Jul 27, 2024

hiepmai-babylonchain Jul 29, 2024

hiepmai-babylonchain Jul 29, 2024


		### 6.1 Create systemd service definition

		Run the following command, replacing `your_username` with your actual username:


		### 4.1 Create systemd service definition

		Run the following command, replacing `your_username` with your actual username:


		![Overview of Bitcoin Staking backend deployment](images/phase-1-overview.png)

		The Babylon Bitcoin Staking system comprises of the following components:

Self hosting backend service instruction #91

Are you sure you want to change the base?

Self hosting backend service instruction #91

Conversation

hiepmai-babylonchain commented Jul 4, 2024

filippos47 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vitsalis left a comment

Choose a reason for hiding this comment

hiepmai-babylonchain commented Jul 10, 2024

gitferry left a comment

Choose a reason for hiding this comment

vitsalis commented Jul 10, 2024

filippos47 left a comment

Choose a reason for hiding this comment

vitsalis 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

vitsalis 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

filippos47 left a comment •

edited

Loading