Skip to content

Commit 205089f

Browse files
chore(docs): textlint one-sentence-per-line + prettier sweep
1 parent 16d2224 commit 205089f

60 files changed

Lines changed: 937 additions & 452 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/2-run-node.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ You can track validator status, uptime, and software versions on the [Flare Vali
6868

6969
Runs alongside a Validator to provide crucial data for Flare's FTSO and FDC protocols.
7070
Required for full reward eligibility.
71-
Requires a running [Validator Node](#validator-node). To set up a Flare Entity:
71+
Requires a running [Validator Node](#validator-node).
72+
To set up a Flare Entity:
7273

7374
<DocCardList
7475
items={[

docs/fassets/developer-guides/4-fassets-settings-node.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,8 @@ Timestamp: 1756977702
284284

285285
## Summary
286286

287-
Congratulations! You have built a TypeScript script that connects to the Coston2 network and retrieves the FAsset configuration settings and the price of XRP in USD.
287+
Congratulations!
288+
You have built a TypeScript script that connects to the Coston2 network and retrieves the FAsset configuration settings and the price of XRP in USD.
288289

289290
:::tip[What's next]
290291

docs/fdc/1-overview.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,13 @@ Operating a DA Layer is permissionless—anyone can run a DA Layer service by so
6262

6363
## Attestation Types
6464

65-
FDC currently supports seven attestation types, each serving specific verification needs. Below is an overview of these types, with detailed explanations available in their respective sections:
65+
FDC currently supports seven attestation types, each serving specific verification needs.
66+
Below is an overview of these types, with detailed explanations available in their respective sections:
6667

6768
- **AddressValidity**: Validates the format and checksum of addresses on specified chains.
6869
- **EVMTransaction**: Verifies and retrieves transaction details from EVM-compatible chains (`ETH`, `FLR`, `SGB`).
69-
- **JsonApi**: Fetches and processes any Web2 data using a JQ transformation, then returns it as ABI-encoded output. (Currently only on Coston & Coston2).
70+
- **Web2Json**: Fetches and processes any Web2 data using a JQ transformation, then returns it as ABI-encoded output.
71+
(Currently only on Coston & Coston2).
7072
- **Payment**: Confirms and fetches payment transaction details from non-EVM chains (`BTC`, `DOGE`, `XRP`).
7173
- **ConfirmedBlockHeightExists**: Verifies block existence and confirmation status.
7274
- **BalanceDecreasingTransaction**: Validates if a transaction reduces an address's balance.
@@ -124,7 +126,8 @@ Due to the waiting period between steps **2** and **3**, where the round is fina
124126
7. **Sign and Submit**: Collect signatures representing 50%+ weight and submit the Merkle root to the [`Relay`](/network/fsp/solidity-reference/IRelay) contract.
125127
8. **Serve Data**: Provide attestation responses and proofs via the DA Layer.
126128

127-
The **Flare Data Connector (FDC)** is a critical infrastructure component for the Flare ecosystem, enabling smart contracts to access **secure, attested external data** while maintaining trustless verification through **Merkle proofs**. By integrating the FDC, developers can create more **reliable, decentralized applications** across multiple blockchains.
129+
The **Flare Data Connector (FDC)** is a critical infrastructure component for the Flare ecosystem, enabling smart contracts to access **secure, attested external data** while maintaining trustless verification through **Merkle proofs**.
130+
By integrating the FDC, developers can create more **reliable, decentralized applications** across multiple blockchains.
128131

129132
## Watch the video
130133

docs/fdc/2-getting-started.mdx

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ Learn how to [deploy your first smart contract](/network/getting-started) on Fla
3333

3434
:::
3535

36-
At its core, FDC enables any smart contract on Flare to query immutable, verifiable information from supported blockchain networks. The protocol achieves consensus through the BitVote-reveal mechanism within the Flare Systems Protocol suite, allowing dapps to validate external blockchain data using Merkle proofs.
36+
At its core, FDC enables any smart contract on Flare to query immutable, verifiable information from supported blockchain networks.
37+
The protocol achieves consensus through the BitVote-reveal mechanism within the Flare Systems Protocol suite, allowing dapps to validate external blockchain data using Merkle proofs.
3738

3839
Currently supported networks include:
3940

@@ -100,7 +101,8 @@ The Data Connector operates in separate environments for mainnets and testnets,
100101
## Prepare the attestation request
101102

102103
To attest to transaction data, we need to encode it in a format that the Flare Data Connector (FDC) can process.
103-
This is done through a verifier service. While you can set up your own verifier, we'll use Flare's testnet verifier service available at `https://fdc-verifiers-testnet.flare.network/`.
104+
This is done through a verifier service.
105+
While you can set up your own verifier, we'll use Flare's testnet verifier service available at `https://fdc-verifiers-testnet.flare.network/`.
104106
You can explore the API through their Swagger interface at `https://fdc-verifiers-testnet.flare.network/verifier/api-doc`.
105107

106108
### Request structure
@@ -164,7 +166,10 @@ If consensus fails, you'll need to resubmit the request.
164166
<details>
165167
<summary>Understanding the structure of `abiEncodedRequest`.</summary>
166168

167-
The structure of `abiEncodedRequest` may seem complex, but it's essentially a concatenated hex string (with the initial 0x removed) representing different parts of the request. Each part is 32 bytes long (64 characters in hex). Here's a breakdown of the string:
169+
The structure of `abiEncodedRequest` may seem complex, but it's essentially a concatenated hex string (with the initial 0x removed) representing different parts of the request.
170+
171+
Each part is 32 bytes long (64 characters in hex).
172+
Here's a breakdown of the string:
168173

169174
```text
170175
45564d5472616e73616374696f6e000000000000000000000000000000000000
@@ -187,7 +192,10 @@ If consensus fails, you'll need to resubmit the request.
187192

188193
- **Second line:** `toHex("testETH")`
189194

190-
- **Third line:** Message Integrity Code (MIC). This is a hash of the whole response salted with a string `Flare`. It ensures the integrity of the attestation and prevents tampering.
195+
- **Third line:** Message Integrity Code (MIC).
196+
197+
This is a hash of the whole response salted with a string `Flare`.
198+
It ensures the integrity of the attestation and prevents tampering.
191199

192200
- **Remaining lines:** ABI encoded request body (as solidity struct).
193201
The structure of the body is defined in the accompanying attestation [type specification](https://github.com/flare-foundation/songbird-state-connector-protocol/blob/main/contracts/interface/types/EVMTransaction.sol#L68).
@@ -305,7 +313,8 @@ This data is now ready to be used in your smart contract to:
305313

306314
## Verify and use the data
307315

308-
Let's examine how to verify and utilize the data from the DA Layer API in your smart contract. We'll focus on a practical example: listening for and verifying USDC transfer events.
316+
Let's examine how to verify and utilize the data from the DA Layer API in your smart contract.
317+
We'll focus on a practical example: listening for and verifying USDC transfer events.
309318

310319
### Data structure
311320

@@ -387,7 +396,8 @@ Don't forget to set the EVM version to `cancun` in Remix before compiling the co
387396

388397
1. **Proof Verification**
389398

390-
The contract uses the `ContractRegistry` library to access Flare's official verifiers. The verification process:
399+
The contract uses the `ContractRegistry` library to access Flare's official verifiers.
400+
The verification process:
391401
- Retrieves the current verifier through the Flare governance-managed registry
392402
- Uses `isEVMTransactionProofValid` to verify the Merkle proof and data integrity
393403
- Requires successful verification before proceeding with any data processing

docs/fdc/6-troubleshooting.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,8 @@ If the API returns multiple fields, use `postProcessJq` to extract only the fiel
150150

151151
### Root Cause: Query Parameters Embedded in the URL
152152

153-
The [`Web2Json`](/fdc/attestation-types/web2-json) attestation type provides a dedicated `queryParams` field for query parameters. If you include query parameters directly in the `url` field (e.g., `https://api.example.com/data?key=value`), attestation providers may not process the request correctly, leading to consensus failure.
153+
The [`Web2Json`](/fdc/attestation-types/web2-json) attestation type provides a dedicated `queryParams` field for query parameters.
154+
If you include query parameters directly in the `url` field (e.g., `https://api.example.com/data?key=value`), attestation providers may not process the request correctly, leading to consensus failure.
154155

155156
### Solution: Use the `queryParams` Field
156157

docs/fdc/attestation-types/_addresses.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,8 @@ Decoded addresses have the format:
120120
#### Validation Criteria
121121

122122
1. Address contains only characters from the Base58 dictionary.
123-
2. Length is **26 to 34 characters**. Decoded hex form is **25 bytes**.
123+
2. Length is **26 to 34 characters**.
124+
Decoded hex form is **25 bytes**.
124125
3. Valid leading byte:
125126
- **Mainnet**: Starts with `D`, `A`, or `9`.
126127
- **Testnet**: Starts with `n`, `m`, or `2`.
@@ -152,7 +153,8 @@ Decoded to hexadecimal:
152153
#### Validation Criteria
153154

154155
1. Address contains only characters from the XRPL Base58 dictionary.
155-
2. Length is **25 to 35 characters**. Decoded hex form is **25 bytes**.
156+
2. Length is **25 to 35 characters**.
157+
Decoded hex form is **25 bytes**.
156158
3. Address starts with `r`.
157159
4. The checksum is valid.
158160

docs/fdc/attestation-types/address-validity.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ Assertion whether a given string represents a **valid address** on an external b
3232

3333
## Verification process
3434

35-
The address is verified against the validity criteria specific to the chain identified by `sourceId`. If the address meets all criteria:
35+
The address is verified against the validity criteria specific to the chain identified by `sourceId`.
36+
If the address meets all criteria:
3637

3738
1. `isValid` is set to `true`.
3839
2. The `standardAddress` and its `standardAddressHash` are computed.

docs/fdc/attestation-types/balance-decreasing-transaction.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ The verification process is chain-specific and can be computed with a [balance d
6565
#### Data Calculation
6666

6767
- `sourceAddress`: Address associated with the specified transaction input.
68-
- `spentAmount`: Calculated as `Sum of all inputs with sourceAddress - Sum of all outputs with sourceAddress`. The value can be negative.
68+
- `spentAmount`: Calculated as `Sum of all inputs with sourceAddress - Sum of all outputs with sourceAddress`.
69+
The value can be negative.
6970
- `blockTimestamp`: The **mediantime** of the block.
7071

7172
### Account-based chains (XRPL)
@@ -77,7 +78,8 @@ The verification process is chain-specific and can be computed with a [balance d
7778

7879
#### Data Calculation
7980

80-
- `spentAmount`: Difference between the balance of the address **after** and **before** the transaction. Can be negative.
81+
- `spentAmount`: Difference between the balance of the address **after** and **before** the transaction.
82+
Can be negative.
8183
- `blockTimestamp`: The **close_time** of the ledger, converted to Unix time.
8284
- `standardPaymentReference`: [Standard payment reference] for `Payment` transactions, otherwise zero.
8385

docs/fdc/attestation-types/json-api.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ The `JsonApi` attestation type has been update to a new version, `Web2Json`.
1212
You can find the updated version of this spec [here](/fdc/attestation-types/web2-json).
1313
:::
1414

15-
Data retrieval from **Web2 JSON APIs** with JQ transformations. This attestation type allows smart contracts to access and process external JSON data in a verifiable way.
15+
Data retrieval from **Web2 JSON APIs** with JQ transformations.
16+
This attestation type allows smart contracts to access and process external JSON data in a verifiable way.
1617

1718
:::warning[Testnet Only]
1819

docs/fdc/attestation-types/payment.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,8 @@ The payment summary for Bitcoin and Dogecoin is derived using specified indices
120120

121121
#### Data Sources
122122

123-
- For Bitcoin, all transaction details are retrieved using the `getrawtransaction` endpoint (verbosity 2) and `getblock`. This requires a Bitcoin node version ≥ 25.0.
123+
- For Bitcoin, all transaction details are retrieved using the `getrawtransaction` endpoint (verbosity 2) and `getblock`.
124+
This requires a Bitcoin node version ≥ 25.0.
124125
- For Dogecoin, since `getrawtransaction` with verbosity 2 is not supported, alternative methods must be used to access input transaction data.
125126

126127
| Field | Description |

0 commit comments

Comments
 (0)