Skip to content

Commit 5e6201c

Browse files
committed
fix(infra): improve flare-stake and entity guides
1 parent 05947c8 commit 5e6201c

File tree

2 files changed

+70
-42
lines changed

2 files changed

+70
-42
lines changed

docs/network/guides/using-flare-stake-tool.mdx

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,9 @@ Install the following tools:
8383
### Using Ledger (recommended)
8484

8585
1. Connect your Ledger device to your computer and unlock it.
86+
Launch the [Ledger Live](https://www.ledger.com/ledger-live) application and navigate to the **My Ledger** tab and ensure your device firmware is up-to-date.
8687

87-
2. Launch the [Ledger Live](https://www.ledger.com/ledger-live) application and navigate to the **My Ledger** tab and ensure your device firmware is up-to-date.
88-
89-
3. In the **App Catalog** tab, search for **Avalanche**, Click **Install**.
88+
2. In the **App Catalog** tab, search for **Avalanche**, Click **Install**.
9089

9190
:::info[App Size]
9291

@@ -95,17 +94,16 @@ Install the following tools:
9594

9695
:::
9796

98-
4. Exit Ledger Live and ensure the device is not connected to any other applications like MetaMask.
99-
100-
5. Open the Avalanche app on your Ledger device. The screen should display **Avalanche Ready**.
97+
3. Exit Ledger Live and ensure the device is not connected to any other applications like MetaMask.
98+
Open the Avalanche app on your Ledger device. The screen should display **Avalanche Ready**.
10199

102-
6. Open a terminal and run the following command to start the staking tool in interactive mode:
100+
4. Open a terminal and run the following command to start the staking tool in interactive mode:
103101

104102
```bash
105103
flare-stake-tool interactive
106104
```
107105

108-
7. After the welcome banner, the tool prompts you to connect your wallet:
106+
5. After the welcome banner, the tool prompts you to connect your wallet:
109107

110108
```text
111109
? How do you want to connect your wallet? (Use arrow keys)
@@ -116,7 +114,7 @@ Install the following tools:
116114

117115
Select **Ledger** using the arrow keys and press **Enter**.
118116

119-
8. The next prompt asks you to choose the network:
117+
6. The next prompt asks you to choose the network:
120118

121119
```text
122120
? Which network do you want to connect to? (Use arrow keys)
@@ -127,21 +125,23 @@ Install the following tools:
127125

128126
Select **Flare (Mainnet)** and press **Enter**. A "Fetching Addresses..." message appears briefly. Select **Ledger Live** on the address derivation screen.
129127

130-
9. The tool will then display a list of addresses linked to your Ledger device, select the desired address and press **Enter**.
128+
7. The tool will then display a list of addresses linked to your Ledger device, select the desired address and press **Enter**.
131129
Ensure this address has a sufficient `FLR` balance for transaction fees and staking. Funds can be transferred later if needed.
132130

133-
10. The main menu will now appear:
134-
```text
135-
? What do you want to do? (Use arrow keys)
136-
View chain addresses
137-
> Check on-chain balance
138-
Get network info
139-
Get validator info
140-
Move assets from C-chain to P-chain
141-
Move assets from P-chain to C-chain
142-
Add a validator node
143-
```
144-
As an example, select **Check on-chain balance** and press **Enter**. The tool displays the C-chain and P-chain balances before exiting.
131+
The main menu will now appear:
132+
133+
```text
134+
? What do you want to do? (Use arrow keys)
135+
View chain addresses
136+
> Check on-chain balance
137+
Get network info
138+
Get validator info
139+
Move assets from C-chain to P-chain
140+
Move assets from P-chain to C-chain
141+
Add a validator node
142+
```
143+
144+
As an example, select **Check on-chain balance** and press **Enter**. The tool displays the C-chain and P-chain balances before exiting.
145145

146146
:::tip[Account Persistence]
147147

docs/run-node/5-flare-entity.mdx

Lines changed: 48 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -618,56 +618,84 @@ With prerequisites met, registrations complete, and FDC/FTSO components configur
618618

619619
3. Carefully edit the `.env` file, providing the correct values gathered during the previous setup stages.
620620
While reviewing `env.example` for _all_ possible settings is recommended (defaults may not suit all environments), ensure these key variables are correctly set based on your Registration, FDC, and FTSO setup:
621-
- `NODE_RPC_URL`, `NODE_API_KEY` (optional): Your RPC Node or a [private RPC provider](/network/developer-tools#rpcs).
622-
- `IDENTITY`: Public `Identity` address from [FSP addresses](#register-and-fund-fsp-addresses).
623-
- `SUBMIT_PK`, `SIGNATURES_PK`, `SIGNING_PK`: Private keys from [FSP addresses](#register-and-fund-fsp-addresses).
624-
- `VALUE_PROVIDER_URL`: URL of the feed value provider in [Setup FTSO](#setup-ftso).
625-
- `FAST_UPDATES_ACCOUNTS`: Private keys of the [Fast Updates accounts](#create-fast-updates-accounts).
626-
- `FAST_UPDATES_SORTITION_PRIVATE_KEY`: Private key of the [sortition key](#register-sortition-key).
627-
- FDC Verifier URLs (`<NETWORK>_<ATTESTATION_TYPE>_URL`): URLs for each FDC [verifier services](#start-indexers-and-verifiers) you deployed (e.g., `BTC_PAYMENT_URL=http://<verifier-ip>:port`).
628-
- FDC Verifier API Keys (`<NETWORK>_<ATTESTATION_TYPE>_API_KEY`, Optional): API keys configured for your FDC verifiers, if any.
629-
- Set `COMPOSE_PROFILES=fsp,fast-updates` to enable both the FSP and Fast Updates profiles.
630-
- By default, you need at least `10000000` blocks of node history.
631-
You can adjust this by modifying [`c-chain-indexer.template.toml`](https://github.com/flare-foundation/flare-systems-deployment/blob/main/template-configs/c-chain-indexer.template.toml) to a value near the head of your node.
621+
- **RPC**
622+
- `NODE_RPC_URL`: Your RPC Node or a [private RPC provider](/network/developer-tools#rpcs).
623+
- `NODE_API_KEY` (optional): If your RPC provider requires it.
624+
- **Identity & Keys:**
625+
- `IDENTITY`: Public `Identity` address from [FSP addresses](#register-and-fund-fsp-addresses).
626+
- `SUBMIT_PK`, `SIGNATURES_PK`, `SIGNING_PK`: Private keys from [FSP addresses](#register-and-fund-fsp-addresses).
627+
- **FTSO:**
628+
- `VALUE_PROVIDER_URL`: URL of the feed value provider in [Setup FTSO](#setup-ftso).
629+
- `FAST_UPDATES_ACCOUNTS`: Private keys of the [Fast Updates accounts](#create-fast-updates-accounts).
630+
- `FAST_UPDATES_SORTITION_PRIVATE_KEY`: Private key of the [sortition key](#register-sortition-key).
631+
- **FDC:**
632+
- `<NETWORK>_<ATTESTATION_TYPE>_URL`: URLs for each FDC [verifier services](#start-indexers-and-verifiers) you deployed, e.g. `BTC_PAYMENT_URL=http://<verifier-ip>:port`
633+
- `<NETWORK>_<ATTESTATION_TYPE>_API_KEY` (optional): API keys configured for your FDC verifiers, if any.
632634

633635
<br></br>
634636

635637
:::danger[Secure Your `.env` File]
636638

637-
This `.env` file contains **highly sensitive private keys and API keys**. Protect this file rigorously:
639+
This file contains **highly sensitive** private keys and API keys.
640+
Compromise of these keys can lead to loss of funds, unauthorized actions, and a compromised entity.
638641
- Set strict file permissions (e.g., `chmod 600 .env`) so only the owner can read/write.
639642
- Ensure it's **never** committed to Git or any version control system.
640643
- Limit access to the server and user account running the deployment.
641-
Compromise of these keys can lead to loss of funds, unauthorized actions, and a compromised entity.
642644

643645
:::
644646

645-
4. Run the provided script. This uses your `.env` file to populate the specific configuration files used internally by each Docker service.
647+
4. Update your `.env` to include all services:
648+
649+
```plaintext
650+
COMPOSE_PROFILES=fsp,fast-updates
651+
```
652+
653+
5. (Optional) By default, the `c-chain-indexer` requires 10 million blocks (≈20 days) of node history.
654+
- To shorten this window, edit [`template-configs/c-chain-indexer.template.toml`](https://github.com/flare-foundation/flare-systems-deployment/blob/main/template-configs/c-chain-indexer.template.toml) to a value closer to the head of your node.
655+
- **Do not** go below 350,000 blocks (≈7 days / 2 reward epochs), or the FTSO client may fail.
656+
657+
6. Run the helper script to apply your `.env` settings to each Docker service:
646658

647659
```bash
648660
./populate_config.sh
649661
```
650662

651663
_Remember to **re-run this script** every time you make changes to your `.env` file._
652664

653-
5. Use Docker Compose to start all Flare Entity services defined in `docker-compose.yaml` in detached mode (`-d`).
665+
7. Launch the Flare Entity stack in detached mode:
654666

655667
```bash
656668
docker compose up -d
657669
```
658670

659-
_Note: The first run will download all necessary Docker images, which may take several minutes depending on image sizes and network speed._
671+
_Note: The first startup will pull all required images. This may take several minutes depending on your network speed._
660672

661673
### Verify deployment success
662674

663-
After starting, confirm the containers are running (`docker ps`). Crucially, monitor the initial logs of key components to ensure they start correctly, connect to necessary services (RPC node, database, verifiers, Feed Value Provider), and enter their operational loops. Use `docker compose logs -f <service_name>` to tail logs in real-time.
675+
Once your services are up, follow these steps to confirm everything is running smoothly:
664676

665-
Key services to check include: `system-client`, `c-chain-indexer`, `fast-updates-client`, `ftso-client`, `fdc-client`.
677+
1. Check running containers:
666678

667-
Look for successful connections, registration messages (if applicable for the current reward epoch timing), and absence of repeating critical errors.
679+
```bash
680+
docker ps
681+
```
668682

669-
If your Flare Entity is working correctly, congratulations!
683+
Ensure these key containers appear in the list and have `Up` status:
684+
- `system-client`
685+
- `c-chain-indexer`
686+
- `fast-updates-client` (if enabled)
687+
- `ftso-client`
688+
- `fdc-client`
670689

690+
2. For each critical service, open a live log stream in a separate terminal:
691+
692+
```bash
693+
docker compose logs -f <service_name>
694+
```
695+
696+
Replace `<service_name>` with the actual service name (e.g., `system-client`, `c-chain-indexer`, etc.).
697+
698+
If your Flare Entity is working correctly, congratulations!
671699
Refer to the [Troubleshooting](#troubleshooting) and [FAQs](#faqs) sections for common issues and ongoing checks.
672700

673701
## Update Flare Entity

0 commit comments

Comments
 (0)