Skip to content

Commit a4dc473

Browse files
committed
chore(deps): add textlint for one-sentence-per-line enforcement
1 parent b93fed6 commit a4dc473

24 files changed

+17029
-1650
lines changed

.textlintrc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"rules": {
3+
"one-sentence-per-line": true
4+
}
5+
}

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ We welcome:
2323
- automation and docgen scripts (`automations/`, `docgen/`)
2424

2525
3. **Follow Style Guides:**
26-
- **Code/Docs:** Run [Pre-PR checks](#pre-pr-checks). Match existing code style.
26+
- **Code/Docs:** Run [Pre-PR checks](#pre-pr-checks).
27+
Match existing code style.
2728
- **Diagrams:** Adhere to the [Diagram Style Guide](#diagrams-style-guide) for consistency.
2829

2930
4. **Commit Your Changes:** We require [Conventional Commits](https://www.conventionalcommits.org/) format for clear history and automated changelogs.

docs/fdc/reference/IFdcHub.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Sourced from `IFdcHub.sol` on [GitHub](https://github.com/flare-foundation/flare
1414

1515
## Overview
1616

17-
The IFdcHub interface serves as the main entry point for applications requesting attestations from the Flare Data Connector. It provides functionality to request attestations, access configuration contracts, and handle related events.
17+
The IFdcHub interface serves as the main entry point for applications requesting attestations from the Flare Data Connector.
18+
It provides functionality to request attestations, access configuration contracts, and handle related events.
1819

1920
## Functions
2021

docs/fdc/reference/IFdcInflationConfigurations.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Sourced from `IFdcInflationConfigurations.sol` on [GitHub](https://github.com/fl
1414

1515
## Overview
1616

17-
The IFdcInflationConfigurations interface allows access to the inflation distribution settings for different attestation types and sources within the Flare Data Connector system. These configurations determine how inflation rewards are allocated to validators based on the attestation requests they process.
17+
The IFdcInflationConfigurations interface allows access to the inflation distribution settings for different attestation types and sources within the Flare Data Connector system.
18+
These configurations determine how inflation rewards are allocated to validators based on the attestation requests they process.
1819

1920
## Functions
2021

docs/fdc/reference/IFdcRequestFeeConfigurations.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,15 @@ Sourced from `IFdcRequestFeeConfigurations.sol` on [GitHub](https://github.com/f
1414

1515
## Overview
1616

17-
The IFdcRequestFeeConfigurations interface provides functionality for managing and retrieving fees associated with attestation requests in the Flare Data Connector (FDC) system. It allows for querying the base fee required for specific attestation requests.
17+
The IFdcRequestFeeConfigurations interface provides functionality for managing and retrieving fees associated with attestation requests in the Flare Data Connector (FDC) system.
18+
It allows for querying the base fee required for specific attestation requests.
1819

1920
## Functions
2021

2122
### getRequestFee
2223

23-
Method to get the base fee for an attestation request. It reverts if the request is not supported.
24+
Method to get the base fee for an attestation request.
25+
It reverts if the request is not supported.
2426

2527
```solidity
2628
function getRequestFee(

docs/fdc/reference/IFdcVerification.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Sourced from `IFdcVerification.sol` on [GitHub](https://github.com/flare-foundat
1414

1515
## Overview
1616

17-
The IFdcVerification interface provides methods to verify different types of attestations from the Flare Data Connector. Smart contracts can use these verification functions to validate proofs provided by the State Connector system, ensuring the authenticity and integrity of the external data being used.
17+
The IFdcVerification interface provides methods to verify different types of attestations from the Flare Data Connector.
18+
Smart contracts can use these verification functions to validate proofs provided by the State Connector system, ensuring the authenticity and integrity of the external data being used.
1819

1920
## Verification Functions
2021

docs/ftso/solidity-reference/FtsoV2Interface.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ import FTSOV2FeedsById from "!!raw-loader!/examples/developer-hub-solidity/FTSOV
1212
import FTSOV2FeedsByIdWei from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedsByIdWei.sol";
1313
import FTSOV2AnchorConsumer from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2AnchorConsumer.sol";
1414

15-
Primary interface for interacting with FTSOv2. This is a long-term support (LTS) interface, designed to ensure continuity even as underlying contracts evolve or protocols migrate to new versions.
15+
Primary interface for interacting with FTSOv2.
16+
This is a long-term support (LTS) interface, designed to ensure continuity even as underlying contracts evolve or protocols migrate to new versions.
1617

1718
Sourced from `FtsoV2Interface.sol` on [GitHub](https://github.com/flare-foundation/flare-smart-contracts-v2/blob/main/contracts/userInterfaces/LTS/FtsoV2Interface.sol).
1819

docs/ftso/solidity-reference/IFastUpdateIncentiveManager.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,11 @@ function getScale(
8787

8888
### offerIncentive
8989

90-
The entry point for third parties to make incentive offers. It accepts a payment and, using the contents of
90+
The entry point for third parties to make incentive offers.
91+
It accepts a payment and, using the contents of
9192
`_offer`, computes how much the expected sample size will be increased to apply the requested (but capped) range
92-
increase. If the ultimate value of the range exceeds the cap, funds are returned to the sender in proportion to
93+
increase.
94+
If the ultimate value of the range exceeds the cap, funds are returned to the sender in proportion to
9395
the amount by which the increase is adjusted to reach the cap.
9496

9597
```solidity

docs/ftso/solidity-reference/IFastUpdater.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ function blockScoreCutoff(
2828

2929
#### Returns
3030

31-
- `_cutoff`: The upper endpoint of the acceptable range of "scores" that providers generate for sortition. A score below the cutoff indicates eligibility to submit updates in the present sortition round.
31+
- `_cutoff`: The upper endpoint of the acceptable range of "scores" that providers generate for sortition.
32+
A score below the cutoff indicates eligibility to submit updates in the present sortition round.
3233

3334
### currentRewardEpochId
3435

@@ -54,7 +55,8 @@ function currentScoreCutoff(
5455

5556
#### Returns
5657

57-
- `_cutoff`: The upper endpoint of the acceptable range of "scores" that providers generate for sortition. A score below the cutoff indicates eligibility to submit updates in the present sortition round.
58+
- `_cutoff`: The upper endpoint of the acceptable range of "scores" that providers generate for sortition.
59+
A score below the cutoff indicates eligibility to submit updates in the present sortition round.
5860

5961
### currentSortitionWeight
6062

@@ -70,11 +72,13 @@ function currentSortitionWeight(
7072

7173
#### Parameters
7274

73-
- `_signingPolicyAddress`: The signing policy address of the specified provider. This is different from the sender of an update transaction, due to the signature included in the `FastUpdates` type.
75+
- `_signingPolicyAddress`: The signing policy address of the specified provider.
76+
This is different from the sender of an update transaction, due to the signature included in the `FastUpdates` type.
7477

7578
#### Returns
7679

77-
- `_weight`: The specified provider's weight for sortition purposes. This is derived from the provider's delegation weight for the FTSO, but rescaled against a fixed number of "virtual providers", indicating how many potential updates a single provider may make in a sortition round.
80+
- `_weight`: The specified provider's weight for sortition purposes.
81+
This is derived from the provider's delegation weight for the FTSO, but rescaled against a fixed number of "virtual providers", indicating how many potential updates a single provider may make in a sortition round.
7882

7983
### fetchAllCurrentFeeds
8084

@@ -140,7 +144,8 @@ function numberOfUpdates(
140144

141145
#### Returns
142146

143-
- `_noOfUpdates`: The number of updates submitted in each block for the last `_historySize` blocks. The array is ordered from the current block to the oldest block.
147+
- `_noOfUpdates`: The number of updates submitted in each block for the last `_historySize` blocks.
148+
The array is ordered from the current block to the oldest block.
144149

145150
### numberOfUpdatesInBlock
146151

@@ -165,7 +170,8 @@ function numberOfUpdatesInBlock(
165170
### submissionWindow
166171

167172
The submission window is a number of blocks forming a "grace period" after a round of sortition starts,
168-
during which providers may submit updates for that round. In other words, each block starts a new round of
173+
during which providers may submit updates for that round.
174+
In other words, each block starts a new round of
169175
sortition and that round lasts `submissionWindow` blocks.
170176

171177
```solidity

docs/ftso/solidity-reference/IFastUpdatesConfiguration.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ function getFeedConfigurations(
2323

2424
### getFeedId
2525

26-
Returns the feed id at a given index. Removed (unused) feed index will return bytes21(0).
26+
Returns the feed id at a given index.
27+
Removed (unused) feed index will return bytes21(0).
2728

2829
```solidity
2930
function getFeedId(
@@ -43,7 +44,8 @@ function getFeedId(
4344

4445
### getFeedIds
4546

46-
Returns all feed ids. For removed (unused) feed indices, the feed id will be bytes21(0).
47+
Returns all feed ids.
48+
For removed (unused) feed indices, the feed id will be bytes21(0).
4749

4850
```solidity
4951
function getFeedIds(

0 commit comments

Comments
 (0)