Skip to content

Commit 9d0f38c

Browse files
committed
fix(docs): remove unused references
1 parent cf8c742 commit 9d0f38c

File tree

1 file changed

+6
-223
lines changed

1 file changed

+6
-223
lines changed

docs/ftso/solidity-reference/FtsoV2Interface.md

Lines changed: 6 additions & 223 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,8 @@ description: Primary interface for interacting with FTSOv2.
77
import Remix from "@site/src/components/remix";
88
import CodeBlock from "@theme/CodeBlock";
99
import FTSOV2FeedById from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedById.sol";
10-
import FTSOV2FeedByIdWei from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedByIdWei.sol";
11-
import FTSOV2FeedByIndex from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedByIndex.sol";
12-
import FTSOV2FeedByIndexWei from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedByIndexWei.sol";
13-
import FTSOV2FeedByIdIndex from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedByIdIndex.sol";
1410
import FTSOV2FeedsById from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedsById.sol";
1511
import FTSOV2FeedsByIdWei from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedsByIdWei.sol";
16-
import FTSOV2FeedsByIndex from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedsByIndex.sol";
17-
import FTSOV2FeedsByIndexWei from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2FeedsByIndexWei.sol";
1812
import FTSOV2VerifyProof from "!!raw-loader!/examples/developer-hub-solidity/FTSOV2VerifyProof.sol";
1913

2014
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.
@@ -60,145 +54,6 @@ function getFeedById(
6054
<Remix fileName="FTSOV2FeedById.sol">Open sample in Remix</Remix>
6155
<br></br>
6256

63-
### getFeedByIdInWei
64-
65-
Returns value in wei and timestamp of a feed.
66-
A fee (calculated by the FeeCalculator contract) may need to be paid.
67-
68-
```solidity
69-
function getFeedByIdInWei(
70-
bytes21 _feedId
71-
) external payable returns (
72-
uint256 _value,
73-
uint64 _timestamp
74-
);
75-
```
76-
77-
#### Parameters
78-
79-
- `_feedId`: The id of the feed.
80-
81-
#### Returns
82-
83-
- `_value`: The value for the requested feed in wei (i.e. with 18 decimal places).
84-
- `_timestamp`: The timestamp of the last update.
85-
86-
<details>
87-
<summary>Sample contract usage</summary>
88-
89-
<CodeBlock language="solidity" title="FTSOV2FeedByIdWei.sol">
90-
{FTSOV2FeedByIdWei}
91-
</CodeBlock>
92-
93-
</details>
94-
95-
<Remix fileName="FTSOV2FeedByIdWei.sol">Open sample in Remix</Remix>
96-
<br></br>
97-
98-
### getFeedByIndex
99-
100-
Returns stored data of a feed.
101-
A fee (calculated by the FeeCalculator contract) may need to be paid.
102-
103-
```solidity
104-
function getFeedByIndex(
105-
uint256 _index
106-
) external payable returns (
107-
uint256 _value,
108-
int8 _decimals,
109-
uint64 _timestamp
110-
);
111-
```
112-
113-
#### Parameters
114-
115-
- `_index`: The index of the feed, corresponding to feed id in the FastUpdatesConfiguration contract.
116-
117-
#### Returns
118-
119-
- `_value`: The value for the requested feed.
120-
- `_decimals`: The decimal places for the requested feed.
121-
- `_timestamp`: The timestamp of the last update.
122-
123-
<details>
124-
<summary>Sample contract usage</summary>
125-
126-
<CodeBlock language="solidity" title="FTSOV2FeedByIndex.sol">
127-
{FTSOV2FeedByIndex}
128-
</CodeBlock>
129-
130-
</details>
131-
132-
<Remix fileName="FTSOV2FeedByIndex.sol">Open sample in Remix</Remix>
133-
<br></br>
134-
135-
### getFeedByIndexInWei
136-
137-
Returns value in wei and timestamp of a feed.
138-
A fee (calculated by the FeeCalculator contract) may need to be paid.
139-
140-
```solidity
141-
function getFeedByIndexInWei(
142-
uint256 _index
143-
) external payable returns (
144-
uint256 _value,
145-
uint64 _timestamp
146-
);
147-
```
148-
149-
#### Parameters
150-
151-
- `_index`: The index of the feed, corresponding to feed id in the FastUpdatesConfiguration contract.
152-
153-
#### Returns
154-
155-
- `_value`: The value for the requested feed in wei (i.e. with 18 decimal places).
156-
- `_timestamp`: The timestamp of the last update.
157-
158-
<details>
159-
<summary>Sample contract usage</summary>
160-
161-
<CodeBlock language="solidity" title="FTSOV2FeedByIndexWei.sol">
162-
{FTSOV2FeedByIndexWei}
163-
</CodeBlock>
164-
165-
</details>
166-
167-
<Remix fileName="FTSOV2FeedByIndexWei.sol">Open sample in Remix</Remix>
168-
<br></br>
169-
170-
### getFeedId
171-
172-
Returns the feed id at a given index. Removed (unused) feed index will return bytes21(0).
173-
174-
```solidity
175-
function getFeedId(
176-
uint256 _index
177-
) external view returns (
178-
bytes21 _feedId
179-
);
180-
```
181-
182-
#### Parameters
183-
184-
- `_index`: The index.
185-
186-
#### Returns
187-
188-
- `_feedId`: The feed id.
189-
190-
<details>
191-
<summary>Sample contract usage</summary>
192-
193-
<CodeBlock language="solidity" title="FTSOV2FeedByIdIndex.sol">
194-
{FTSOV2FeedByIdIndex}
195-
</CodeBlock>
196-
197-
</details>
198-
199-
<Remix fileName="FTSOV2FeedByIdIndex.sol">Open sample in Remix</Remix>
200-
<br></br>
201-
20257
### getFeedIndex
20358

20459
Returns the index of a feed.
@@ -291,78 +146,6 @@ function getFeedsByIdInWei(
291146
<Remix fileName="FTSOV2FeedsByIdWei.sol">Open sample in Remix</Remix>
292147
<br></br>
293148

294-
### getFeedsByIndex
295-
296-
Returns stored data of each feed.
297-
A fee (calculated by the FeeCalculator contract) may need to be paid.
298-
299-
```solidity
300-
function getFeedsByIndex(
301-
uint256[] _indices
302-
) external payable returns (
303-
uint256[] _values,
304-
int8[] _decimals,
305-
uint64 _timestamp
306-
);
307-
```
308-
309-
#### Parameters
310-
311-
- `_indices`: Indices of the feeds, corresponding to feed ids in the FastUpdatesConfiguration contract.
312-
313-
#### Returns
314-
315-
- `_values`: The list of values for the requested feeds.
316-
- `_decimals`: The list of decimal places for the requested feeds.
317-
- `_timestamp`: The timestamp of the last update.
318-
319-
<details>
320-
<summary>Sample contract usage</summary>
321-
322-
<CodeBlock language="solidity" title="FTSOV2FeedsByIndex.sol">
323-
{FTSOV2FeedsByIndex}
324-
</CodeBlock>
325-
326-
</details>
327-
328-
<Remix fileName="FTSOV2FeedsByIndex.sol">Open sample in Remix</Remix>
329-
<br></br>
330-
331-
### getFeedsByIndexInWei
332-
333-
Returns value in wei of each feed and a timestamp.
334-
For some feeds, a fee (calculated by the FeeCalculator contract) may need to be paid.
335-
336-
```solidity
337-
function getFeedsByIndexInWei(
338-
uint256[] _indices
339-
) external payable returns (
340-
uint256[] _values,
341-
uint64 _timestamp
342-
);
343-
```
344-
345-
#### Parameters
346-
347-
- `_indices`: Indices of the feeds, corresponding to feed ids in the FastUpdatesConfiguration contract.
348-
349-
#### Returns
350-
351-
- `_values`: The list of values for the requested feeds in wei (i.e. with 18 decimal places).
352-
- `_timestamp`: The timestamp of the last update.
353-
354-
<details>
355-
<summary>Sample contract usage</summary>
356-
357-
<CodeBlock language="solidity" title="FTSOV2FeedsByIndexWei.sol">
358-
{FTSOV2FeedsByIndexWei}
359-
</CodeBlock>
360-
361-
</details>
362-
363-
<Remix fileName="FTSOV2FeedsByIndexWei.sol">Open sample in Remix</Remix>
364-
<br></br>
365-
366149
### verifyFeedData
367150

368151
Checks if the feed data is valid (i.e. is part of the confirmed Merkle tree).
@@ -371,7 +154,7 @@ Checks if the feed data is valid (i.e. is part of the confirmed Merkle tree).
371154
function verifyFeedData(
372155
struct FtsoV2Interface.FeedDataWithProof _feedData
373156
) external view returns (
374-
bool
157+
bool
375158
);
376159
```
377160

@@ -403,11 +186,11 @@ Feed data structure
403186

404187
```solidity
405188
struct FeedData {
406-
uint32 votingRoundId;
407-
bytes21 id;
408-
int32 value;
409-
uint16 turnoutBIPS;
410-
int8 decimals;
189+
uint32 votingRoundId;
190+
bytes21 id;
191+
int32 value;
192+
uint16 turnoutBIPS;
193+
int8 decimals;
411194
}
412195
```
413196

0 commit comments

Comments
 (0)