Skip to content

Commit daf72a9

Browse files
refactor(docs): sentence newline
1 parent f99604d commit daf72a9

3 files changed

Lines changed: 43 additions & 30 deletions

File tree

docs/fdc/guides/foundry/06-weather-insurance.mdx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,13 @@ With that, we can describe the process of using the Weather Insurance dApp.
4949
If no insurer has accepted the policy by the time it comes into effect (before its start timestamp), the policy can be retired.
5050

5151
3. The policy is resolved.
52-
This happens in three ways: - The policy has expired because no insurer accepted it in the allotted time.
53-
The contract returns the premium to the policyholder. - An insurer has accepted the policy, and proof has been provided to the contract, demonstrating that a loss has occurred (in this case, that the temperature at the specified location fell below the agreed-upon threshold).
54-
The contract pays out the deposited loss coverage amount to the policyholder. - An insurer has accepted the policy, and the expiration timestamp has been reached without valid proof having been provided.
55-
The contract returns the loss coverage deposit to the insurer.
52+
This happens in three ways:
53+
- The policy has expired because no insurer accepted it in the allotted time.
54+
The contract returns the premium to the policyholder.
55+
- An insurer has accepted the policy, and proof has been provided to the contract, demonstrating that a loss has occurred (in this case, that the temperature at the specified location fell below the agreed-upon threshold).
56+
The contract pays out the deposited loss coverage amount to the policyholder.
57+
- An insurer has accepted the policy, and the expiration timestamp has been reached without valid proof having been provided.
58+
The contract returns the loss coverage deposit to the insurer.
5659

5760
With that we can now focus on the technical aspects of the procedure described above, starting with the main smart contract.
5861

docs/ftso/1-getting-started.mdx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,13 @@ contract FtsoV2FeedConsumer {
9191

9292
- **State Variables**:
9393

94-
- `ftsoV2`: This is a state variable of type `TestFtsoV2Interface`.
95-
96-
It will hold the address of the FTSO V2 contract once initialized. - `feedIndexes`: An array of indexes corresponding to different price feeds.
97-
In this example: - Index 0 corresponds to FLR/USD - Index 2 corresponds to BTC/USD - Index 9 corresponds to ETH/USD
94+
- `ftsoV2`: This is a state variable of type `TestFtsoV2Interface`.
95+
It will hold the address of the FTSO V2 contract once initialized.
96+
- `feedIndexes`: An array of indexes corresponding to different price feeds.
97+
In this example:
98+
- Index 0 corresponds to FLR/USD
99+
- Index 2 corresponds to BTC/USD
100+
- Index 9 corresponds to ETH/USD
98101

99102
- **Constructor**:
100103

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

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -223,21 +223,24 @@ This key pair is used for the FTSOv2 Fast Updates protocol.
223223
}
224224
```
225225

226-
2. Register public key: - 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). - If you used **Manual Registration** (Method 2) or need to register manually: 1. Create a signature proving your `Identity` address owns the generated sortition private key.
227-
Use the `keygen` command again, providing the `PrivateKey` (from Step 1) and your `Identity` address.
228-
229-
```bash
230-
# Replace placeholders with your actual values
231-
docker run --rm ghcr.io/flare-foundation/fast-updates/go-client:latest keygen \
232-
--key PrivateKey \ # <-- REPLACE WITH YOUR GENERATED PrivateKey
233-
--address Identity # <-- REPLACE WITH YOUR Identity ADDRESS
234-
```
226+
2. Register public key:
227+
- 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).
228+
- If you used **Manual Registration** (Method 2) or need to register manually:
229+
1. Create a signature proving your `Identity` address owns the generated sortition private key.
230+
Use the `keygen` command again, providing the `PrivateKey` (from Step 1) and your `Identity` address.
235231

236-
This will generate a signature of the form:
232+
```bash
233+
# Replace placeholders with your actual values
234+
docker run --rm ghcr.io/flare-foundation/fast-updates/go-client:latest keygen \
235+
--key PrivateKey \ # <-- REPLACE WITH YOUR GENERATED PrivateKey
236+
--address Identity # <-- REPLACE WITH YOUR Identity ADDRESS
237+
```
237238

238-
```plaintext
239-
Signature generated: 0x10b0f6b68acf899944ce9406c807f38e904401dcf962d7fdd9943b0dee0222321f6863ed9f46d048695942793f1c16158b9a886b6ff2120390f5ddcbbdb0d3b02d8fff2c8f0583c8269650f97a169f5c5ea04ce3bdd91ca959188ac2cf2ff517
240-
```
239+
This will generate a signature of the form:
240+
241+
```plaintext
242+
Signature generated: 0x10b0f6b68acf899944ce9406c807f38e904401dcf962d7fdd9943b0dee0222321f6863ed9f46d048695942793f1c16158b9a886b6ff2120390f5ddcbbdb0d3b02d8fff2c8f0583c8269650f97a169f5c5ea04ce3bdd91ca959188ac2cf2ff517
243+
```
241244

242245
2. Call the [`registerPublicKey`](/network/fsp/solidity-reference/IEntityManager#registerpublickey) method from your `Identity` address.
243246
Provide the `PublicKeyX`, `PublicKeyY` (from Step 1), and the `Signature` (from Step 2a) as arguments.
@@ -407,15 +410,19 @@ Configuration for the indexer and verifier services is managed centrally via the
407410

408411
Now, carefully edit the `.env` file, providing values for all variables relevant to the FDC components you are deploying.
409412

410-
Pay close attention to: - **RPC Node Connection Details (`*_URL`, `*_RPC_USERNAME`, `*_RPC_PASSWORD` / `*_RPC_AUTH`)**: Provide the full URL and credentials for connecting to each required blockchain node. - 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). - If using _external_ nodes (your own or third-party), use their publicly accessible RPC endpoint URL and associated credentials.
411-
412-
- **Start Block Number (`*_START_BLOCK_NUMBER`)**: Crucial for the first run only.
413-
414-
Set this for each UTXO indexer (BTC, DOGE, XRP) to a block number finalized approximately **14 days prior** to the current date.
415-
(Tip: Use a blockchain explorer for the respective chain to find a block number from around that time).
416-
This limits initial indexing duration. - **Testnet Mode (`TESTNET`):** Set to `true` if deploying for Coston/Coston2, otherwise `false` (or omit). - **Verifier API Keys (`VERIFIER_API_KEYS`)**: Set one or more comma-separated **secret keys**.
417-
These keys grant access to your verifier API servers and will be needed by the FDC Client (in the main Flare Entity deployment).
418-
Generate strong, unique keys. - **Database Passwords (`*_DB_PASSWORD`)**: Set secure, random passwords for the internal indexer databases.
413+
Pay close attention to:
414+
- **RPC Node Connection Details (`*_URL`, `*_RPC_USERNAME`, `*_RPC_PASSWORD` / `*_RPC_AUTH`)**: Provide the full URL and credentials for connecting to each required blockchain node.
415+
- 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).
416+
- If using _external_ nodes (your own or third-party), use their publicly accessible RPC endpoint URL and associated credentials.
417+
- **Start Block Number (`*_START_BLOCK_NUMBER`)**: Crucial for the first run only.
418+
Set this for each UTXO indexer (BTC, DOGE, XRP) to a block number finalized approximately **14 days prior** to the current date.
419+
(Tip: Use a blockchain explorer for the respective chain to find a block number from around that time).
420+
This limits initial indexing duration.
421+
- **Testnet Mode (`TESTNET`):** Set to `true` if deploying for Coston/Coston2, otherwise `false` (or omit).
422+
- **Verifier API Keys (`VERIFIER_API_KEYS`)**: Set one or more comma-separated **secret keys**.
423+
These keys grant access to your verifier API servers and will be needed by the FDC Client (in the main Flare Entity deployment).
424+
Generate strong, unique keys.
425+
- **Database Passwords (`*_DB_PASSWORD`)**: Set secure, random passwords for the internal indexer databases.
419426

420427
2. After saving your `.env` file, run the provided script.
421428
This injects your `.env` values into the configuration templates used by the individual services.

0 commit comments

Comments
 (0)