File tree Expand file tree Collapse file tree 7 files changed +17
-16
lines changed
apps/api-reference/src/apis/evm Expand file tree Collapse file tree 7 files changed +17
-16
lines changed Original file line number Diff line number Diff line change @@ -11,7 +11,7 @@ it has been updated sufficiently recently.
11
11
12
12
The caller provides an **\`age\`** argument that specifies how old the price can be.
13
13
14
- The \` price\` object contains the following fields:
14
+ The price object contains the following fields:
15
15
1. \`price\`: The latest price of the price feed.
16
16
2. \`conf\`: The confidence level of the price feed.
17
17
3. \`expo\`: The exponent of the price feed.
@@ -27,7 +27,7 @@ Sample \`price\` object:
27
27
}
28
28
\`\`\`
29
29
30
- The price above is in the format of \`price * 10^expo\`. So, the price in above
30
+ The \` price\` above is in the format of \`price * 10^expo\`. So, the \` price\` in above
31
31
mentioned sample represents the number \`123456789 * 10(-8) = 1.23456789\` in
32
32
this case.
33
33
Original file line number Diff line number Diff line change @@ -12,7 +12,7 @@ export const getEmaPriceUnsafe = readApi<"id">({
12
12
caller's responsibility to check the returned \`publishTime\` to ensure that the
13
13
update is recent enough for their use case. If you need the latest price, update the price using [\`updatePriceFeeds()\`](updatePriceFeeds) and then call [\`getEmaPrice()\`](getEmaPrice).
14
14
15
- The \` price\` object contains the following fields:
15
+ The price object contains the following fields:
16
16
1. \`price\`: The latest price of the price feed.
17
17
2. \`conf\`: The confidence level of the price feed.
18
18
3. \`expo\`: The exponent of the price feed.
@@ -28,7 +28,7 @@ export const getEmaPriceUnsafe = readApi<"id">({
28
28
}
29
29
\`\`\`
30
30
31
- The price above is in the format of \`price * 10^expo\`. So, the price in above
31
+ The \` price\` above is in the format of \`price * 10^expo\`. So, the \` price\` in above
32
32
mentioned sample represents the number \`123456789 * 10(-8) = 1.23456789\` in
33
33
this case.
34
34
Original file line number Diff line number Diff line change @@ -13,7 +13,7 @@ export const getEmaPrice = readApi<"id">({
13
13
3. \`expo\`: The exponent of the price feed.
14
14
4. \`publishtime\`: The time when the price feed was last updated.
15
15
16
- Sample \` price\` object:
16
+ Sample price object:
17
17
\`\`\`json
18
18
{
19
19
price: 123456789,
@@ -23,7 +23,7 @@ export const getEmaPrice = readApi<"id">({
23
23
}
24
24
\`\`\`
25
25
26
- The price above is in the format of \`price * 10^expo\`. So, the price in above
26
+ The \` price\` above is in the format of \`price * 10^expo\`. So, the \` price\` in above
27
27
mentioned sample represents the number \`123456789 * 10(-8) = 1.23456789\` in
28
28
this case.
29
29
Original file line number Diff line number Diff line change @@ -11,7 +11,7 @@ it has been updated sufficiently recently.
11
11
12
12
The caller provides an **\`age\`** argument that specifies how old the price can be.
13
13
14
- The \` price\` object contains the following fields:
14
+ The price object contains the following fields:
15
15
1. \`price\`: The latest price of the price feed.
16
16
2. \`conf\`: The confidence level of the price feed.
17
17
3. \`expo\`: The exponent of the price feed.
@@ -27,7 +27,7 @@ Sample \`price\` object:
27
27
}
28
28
\`\`\`
29
29
30
- The price above is in the format of \`price * 10^expo\`. So, the price in above
30
+ The \` price\` above is in the format of \`price * 10^expo\`. So, the \` price\` in above
31
31
mentioned sample represents the number \`123456789 * 10(-8) = 1.23456789\` in
32
32
this case.
33
33
Original file line number Diff line number Diff line change @@ -12,7 +12,7 @@ export const getPriceUnsafe = readApi<"id">({
12
12
caller's responsibility to check the returned \`publishTime\` to ensure that the
13
13
update is recent enough for their use case. If you need the latest price, update the price using [\`updatePriceFeeds()\`](updatePriceFeeds) and then call [\`getPrice()\`](getPrice).
14
14
15
- The \` price\` object contains the following fields:
15
+ The price object contains the following fields:
16
16
1. \`price\`: The latest price of the price feed.
17
17
2. \`conf\`: The confidence level of the price feed.
18
18
3. \`expo\`: The exponent of the price feed.
@@ -28,7 +28,7 @@ export const getPriceUnsafe = readApi<"id">({
28
28
}
29
29
\`\`\`
30
30
31
- The price above is in the format of \`price * 10^expo\`. So, the price in above
31
+ The \` price\` above is in the format of \`price * 10^expo\`. So, the \` price\` in above
32
32
mentioned sample represents the number \`123456789 * 10(-8) = 1.23456789\` in
33
33
this case.
34
34
Original file line number Diff line number Diff line change @@ -7,7 +7,7 @@ export const getPrice = readApi<"id">({
7
7
description : `
8
8
This method returns the latest price object for the requested price feed ID.
9
9
10
- The \` price\` object contains the following fields:
10
+ The price object contains the following fields:
11
11
1. \`price\`: The latest price of the price feed.
12
12
2. \`conf\`: The confidence level of the price feed.
13
13
3. \`expo\`: The exponent of the price feed.
@@ -23,7 +23,7 @@ Sample \`price\` object:
23
23
}
24
24
\`\`\`
25
25
26
- The price above is in the format of \`price * 10^expo\`. So, the price in above
26
+ The \` price\` above is in the format of \`price * 10^expo\`. So, the \` price\` in above
27
27
mentioned sample represents the number \`123456789 * 10(-8) = 1.23456789\` in
28
28
this case.
29
29
Original file line number Diff line number Diff line change @@ -5,10 +5,11 @@ export const getValidTimePeriod = readApi<never>({
5
5
summary : "Get the default valid time period of price freshness in seconds." ,
6
6
description : `
7
7
This method returns the default valid time period of price freshness in **seconds**.
8
- This quantity is the maximum age of price updates returned by functions like [getPrice](getPrice) and
9
- [getEmaPrice](getEmaPrice); these functions revert if the current on-chain price
10
- is older than this period. The valid time period is configured to be a sane
11
- default for each blockchain.
8
+ This quantity is the maximum age of price updates returned by functions like [getPrice](getPrice) and
9
+ [getEmaPrice](getEmaPrice); these functions revert if the current on-chain price
10
+ is older than this period.
11
+
12
+ The valid time period is configured to be a same default for each blockchain.
12
13
` ,
13
14
parameters : [ ] ,
14
15
code : [
You can’t perform that action at this time.
0 commit comments