Skip to content

Commit 5d9ed39

Browse files
committed
chore: update front matter to match new schema
1 parent 53e66d2 commit 5d9ed39

Some content is hidden

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

64 files changed

+463
-3
lines changed

apps/developer-hub/content/docs/pyth-core/api-instances-and-providers/pythnet-rpc.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Pythnet RPC
3+
description: 'Documentation for Pythnet RPC, including usage and configuration details.'
4+
---
15
# Pythnet RPC
26

37
You will need a Pythnet RPC to run Hermes, which you can obtain from any of the Pythnet RPC

apps/developer-hub/content/docs/pyth-core/api-reference/aptos.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Aptos
3+
description: >-
4+
This document provides a comprehensive overview of the Pyth Network Aptos
5+
contract, detailing how to submit and retrieve price updates for on-chain
6+
verification and usage.
7+
---
18
# Pyth Price Feeds Aptos Contract Reference
29

310
The Pyth Network Aptos contract allows users to submit price updates for verification and store them for later use.

apps/developer-hub/content/docs/pyth-core/api-reference/aptos/get-ema-price-no-older-than.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
1+
---
2+
title: get_ema_price_no_older_than
3+
description: >-
4+
Get the latest exponentially-weighted moving average (EMA) price and
5+
confidence interval for the requested price feed id. The price feed id is a
6+
32-byte id written as a hexadecimal string; see the [price feed
7+
ids](https://pyth.network/developers/price-feed-ids) page to look up the id
8+
for a given symbol. The returned price and confidence are decimal numbers
9+
written in the form `a * 10^e`, where `e` is an exponent included in the
10+
result. For example, a price of 1234 with an exponent of -2 represents the
11+
number 12.34. The result also includes a `timestamp` which is the unix
12+
timestamp for the price update. The EMA methodology is described in more
13+
detail in this [blog
14+
post](https://pythnetwork.medium.com/whats-in-a-name-302a03e6c3e1). The caller
15+
provides a `max_age_secs` argument that specifies how old the price can be.
16+
The call reverts if the on-chain price is from more than `max_age_secs`
17+
seconds in the past (with respect to the current on-chain timestamp). Users of
18+
this method will typically invoke [update_price_feeds](update-price-feeds) to
19+
update the on-chain price before reading it. This step ensures that the
20+
on-chain price is fresh and the call does not revert.
21+
---
122
import Input from "../../../../components/Input";
223
import Arg from "../../../../components/Arg";
324
import Example from "../../../../components/Example";

apps/developer-hub/content/docs/pyth-core/api-reference/aptos/get-ema-price-unsafe.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Get EMA Price Unsafe
3+
description: >-
4+
Get the latest exponentially-weighted moving average (EMA) price and
5+
confidence interval for a specified price feed ID, including timestamp and
6+
detailed methodology.
7+
---
18
import Input from "../../../../components/Input";
29
import Arg from "../../../../components/Arg";
310
import Example from "../../../../components/Example";

apps/developer-hub/content/docs/pyth-core/api-reference/aptos/get-ema-price.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: get_ema_price
3+
description: >-
4+
Get the latest exponentially-weighted moving average (EMA) price and
5+
confidence interval for the requested price feed id.
6+
---
17
import Input from "../../../../components/Input";
28
import Arg from "../../../../components/Arg";
39
import { InputFormats } from "../../../../utils/InputFormat";

apps/developer-hub/content/docs/pyth-core/api-reference/aptos/get-price-no-older-than.mdx

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
---
2+
title: get_price_no_older_than
3+
description: >-
4+
Get the latest price and confidence interval for the requested price feed id,
5+
if it has been updated sufficiently recently. The price feed id is a 32-byte
6+
id written as a hexadecimal string; see the [price feed
7+
ids](https://pyth.network/developers/price-feed-ids) page to look up the id
8+
for a given symbol. The returned price and confidence are decimal numbers
9+
written in the form `a * 10^e`, where `e` is an exponent included in the
10+
result. For example, a price of 1234 with an exponent of -2 represents the
11+
number 12.34. The result also includes a `timestamp` which is the unix
12+
timestamp for the price update. The caller provides a `max_age_secs` argument
13+
that specifies how old the price can be. The call reverts if the on-chain
14+
price is from more than `max_age_secs` seconds in the past (with respect to
15+
the current on-chain timestamp). Users of this method will typically invoke
16+
[update_price_feeds](update-price-feeds) to update the on-chain price before
17+
reading it. This step ensures that the on-chain price is fresh and the call
18+
does not revert.
19+
---
120
import Input from "../../../../components/Input";
221
import Arg from "../../../../components/Arg";
322
import Example from "../../../../components/Example";

apps/developer-hub/content/docs/pyth-core/api-reference/aptos/get-price-unsafe.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Get Price Unsafe
3+
description: >-
4+
Get the latest price and confidence interval for the requested price feed id,
5+
including details on how to interpret the data and usage considerations.
6+
---
17
import Input from "../../../../components/Input";
28
import Arg from "../../../../components/Arg";
39
import Example from "../../../../components/Example";

apps/developer-hub/content/docs/pyth-core/api-reference/aptos/get-price.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
1+
---
2+
title: get_price
3+
description: >-
4+
Get the latest price and confidence interval for the requested price feed id.
5+
The price feed id is a 32-byte id written as a hexadecimal string; see the
6+
[price feed ids](https://pyth.network/developers/price-feed-ids) page to look
7+
up the id for a given symbol. The returned price and confidence are decimal
8+
numbers written in the form `a * 10^e`, where `e` is an exponent included in
9+
the result. For example, a price of 1234 with an exponent of -2 represents the
10+
number 12.34. The result also includes a `timestamp` which is the unix
11+
timestamp for the price update. This function reverts if the on-chain price
12+
has not been updated within the last
13+
[get_stale_price_threshold_secs](get-stale-price-threshold-secs) seconds. The
14+
default valid time period is set to a reasonable default on each chain and is
15+
typically around 1 minute. If you would like to configure the valid time
16+
period, see [get_price_no_older_than](get-price-no-older-than). If you want
17+
the latest price regardless of when it was updated, see
18+
[get_price_unsafe](get-price-unsafe). Users of this method will typically
19+
invoke [update_price_feeds](update-price-feeds) to update the on-chain price
20+
before reading it. This step ensures that the on-chain price is fresh.
21+
---
122
import Input from "../../../../components/Input";
223
import Arg from "../../../../components/Arg";
324
import { InputFormats } from "../../../../utils/InputFormat";

apps/developer-hub/content/docs/pyth-core/api-reference/aptos/get-stale-price-threshold-secs.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
---
2+
title: get_stale_price_threshold_secs
3+
description: >-
4+
Get the default stale price threshold in seconds. This quantity is the maximum
5+
age of price updates returned by functions like get_price and get_ema_price;
6+
these functions revert if the current on-chain price is older than this
7+
threshold.
8+
---
19
import DynamicCode from "../../../../components/DynamicCode";
210
import { Tab, Tabs } from "nextra-theme-docs";
311

apps/developer-hub/content/docs/pyth-core/api-reference/aptos/get-update-fee.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
title: get_update_fee
3+
description: >-
4+
Get the fee required to update the on-chain price feeds with the provided
5+
`update_data`. The returned number of Octa should be sent as the transaction
6+
value when calling [update_price_feeds](update-price-feeds). The `update_data`
7+
can be retrieved from the [Hermes API](https://hermes.pyth.network/docs). By
8+
default, the data is returned as a base64-encoded string that you must
9+
deserialize into a vector of bytes before calling this method.
10+
---
111
import Input from "../../../../components/Input";
212
import Arg from "../../../../components/Arg";
313
import { InputFormats } from "../../../../utils/InputFormat";

0 commit comments

Comments
 (0)