Skip to content

Commit b034f6c

Browse files
committed
Prettier fix
1 parent e2d6465 commit b034f6c

File tree

3 files changed

+15
-0
lines changed

3 files changed

+15
-0
lines changed

docs/run-node/4-register-validator.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -322,6 +322,7 @@ You can monitor its status using an API call or a validator monitoring site.
322322
```
323323

324324
Check the following fields in the response:
325+
325326
- `uptime`: Percentage of time the queried node has reported the peer as online and validating.
326327
- `connected`: If the node is connected and tracks the network.
327328

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,13 +175,15 @@ You can proceed directly to [Fund FSP addresses](#fund-fsp-addresses).
175175
On mainnet, or if you prefer not to use the automated script on testnets, you must manually register the required FSP addresses by interacting directly with the [`EntityManager`](/network/fsp/solidity-reference/IEntityManager) contract.
176176

177177
1. Ensure you have generated the following five addresses and **securely stored their private keys**. Understand their roles:
178+
178179
- `Identity`: The central identity address. **Crucially, keep the private key secure (e.g., cold storage on mainnet).** This address initiates proposals and signs registrations.
179180
- `Submit`: Used for sending FTSO commit/reveal transactions.
180181
- `SubmitSignatures`: Used for sending FTSO result signatures (often separate from `Submit` to manage transaction nonces).
181182
- `SigningPolicy`: Used for signing FTSO data during voting and for reward epoch configurations.
182183
- `Delegation`: Public address for receiving WNat (e.g., WFLR, WC2FLR) delegations to increase vote power and collect rewards.
183184

184185
2. For each address role (`Submit`, `SubmitSignatures`, `SigningPolicy`, `Delegation`), perform the two-step propose-confirm process using the `EntityManager` contract (see [FSP Reference](/network/fsp/solidity-reference)):
186+
185187
- **Step A (Propose):** Call the relevant `propose<Role>Address` method from your `Identity` address.
186188
Provide the address you want to register for that role as the argument.
187189
- **Step B (Confirm):** Call the corresponding `confirm<Role>AddressRegistration` method from the address you are actually registering (e.g., call `confirmSubmitAddressRegistration` using the `Submit` address's private key).
@@ -226,8 +228,10 @@ This key pair is used for the FTSOv2 Fast Updates protocol.
226228
```
227229

228230
2. Register public key:
231+
229232
- If you used the **Automated Registration** script on a testnet (Method 1 above), this step is already completed, skip to [Register validator node](#register-validator-node).
230233
- If you used **Manual Registration** (Method 2) or need to register manually:
234+
231235
1. Create a signature proving your `Identity` address owns the generated sortition private key. Use the `keygen` command again, providing the `PrivateKey` (from Step 1) and your `Identity` address.
232236

233237
```bash
@@ -371,6 +375,7 @@ The [fdc-suite-deployment](https://github.com/flare-foundation/fdc-suite-deploym
371375

372376
3. To configure node authentication, navigate into the specific node's directory (e.g., `nodes-mainnet/btc`) within the cloned repo and generate credentials where required.
373377
**Keep generated credentials secure** as they will be needed for the Verifier configuration.
378+
374379
- **Bitcoin (BTC) / Dogecoin (DOGE):**
375380

376381
```bash
@@ -409,7 +414,9 @@ Configuration for the indexer and verifier services is managed centrally via the
409414
```
410415

411416
Now, carefully edit the `.env` file, providing values for all variables relevant to the FDC components you are deploying. Pay close attention to:
417+
412418
- **RPC Node Connection Details (`*_URL`, `*_RPC_USERNAME`, `*_RPC_PASSWORD` / `*_RPC_AUTH`)**: Provide the full URL and credentials for connecting to each required blockchain node.
419+
413420
- If using nodes deployed via `fdc-suite-deployment` on the _same host_, you can often use `172.17.0.1` (Docker's default bridge IP) as the hostname in the URL (e.g., `http://admin:<PASSWORD>@172.17.0.1:8332/` for BTC, using the password generated earlier).
414421
- If using _external_ nodes (your own or third-party), use their publicly accessible RPC endpoint URL and associated credentials.
415422

@@ -618,6 +625,7 @@ With prerequisites met, registrations complete, and FDC/FTSO components configur
618625

619626
3. Carefully edit the `.env` file, providing the correct values gathered during the previous setup stages.
620627
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:
628+
621629
- **RPC**
622630
- `NODE_RPC_URL`: Your RPC Node or a [private RPC provider](/network/developer-tools#rpcs).
623631
- `NODE_API_KEY` (optional): If your RPC provider requires it.
@@ -638,6 +646,7 @@ With prerequisites met, registrations complete, and FDC/FTSO components configur
638646

639647
This file contains **highly sensitive** private keys and API keys.
640648
Compromise of these keys can lead to loss of funds, unauthorized actions, and a compromised entity.
649+
641650
- Set strict file permissions (e.g., `chmod 600 .env`) so only the owner can read/write.
642651
- Ensure it's **never** committed to Git or any version control system.
643652
- Limit access to the server and user account running the deployment.
@@ -651,6 +660,7 @@ With prerequisites met, registrations complete, and FDC/FTSO components configur
651660
```
652661

653662
5. (Optional) By default, the `c-chain-indexer` requires 10 million blocks (≈20 days) of node history.
663+
654664
- 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.
655665
- **Do not** go below 350,000 blocks (≈7 days / 2 reward epochs), or the FTSO client may fail.
656666

@@ -681,6 +691,7 @@ Once your services are up, follow these steps to confirm everything is running s
681691
```
682692

683693
Ensure these key containers appear in the list and have `Up` status:
694+
684695
- `system-client`
685696
- `c-chain-indexer`
686697
- `fast-updates-client` (if enabled)
@@ -941,6 +952,7 @@ Consistent monitoring is key to maintaining performance and reward eligibility.
941952
- Check minimal conditions status via the [Flare Systems Explorer](https://flare-systems-explorer.flare.network/providers?tab=minimalConditions) or the backend API detailed previously in the FAQ.
942953

943954
- Monitor the logs of your running Docker containers (`docker compose logs <service_name>`) for errors and key operational messages:
955+
944956
- **Registration:** Look for `RegisterVoter success` messages in the `system-client` logs around the start of reward epochs.
945957

946958
```plaintext

docs/run-node/6-GCP-marketplace-nodes.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ Ensure you have:
5555
- A Google Cloud account
5656

5757
- A service account with at least the following permissions (it can be created beforehand or during the launch process using GUI):
58+
5859
- **roles/config.agent**
5960
- **roles/compute.admin**
6061
- **roles/iam.serviceAccountUser**
@@ -248,6 +249,7 @@ resource "google_compute_instance" "this" {
248249
## Troubleshooting
249250

250251
- **Deployment via UI failure due to Terraform state lock**
252+
251253
- **Symptom**: The deployment fails, and clicking **Retry** leads to Terraform state lock errors.
252254
- **Solution**: Instead of retrying, delete the failed deployment and start a new one.
253255

0 commit comments

Comments
 (0)