From 11576ac2396b087063f9185a94342a64cdbcddca Mon Sep 17 00:00:00 2001 From: Dwight Lyle Date: Fri, 10 May 2024 08:52:51 -0700 Subject: [PATCH] Condense conceptual information on Data Feed lists --- src/content/data-feeds/selecting-data-feeds.mdx | 8 ++++++++ .../feeds/callouts/FeedsCommonCallout.astro | 6 +----- src/features/feeds/callouts/etf-best-practices.mdx | 5 ----- src/features/feeds/callouts/feed-quality.mdx | 13 +++++-------- src/features/feeds/components/FeedPage.astro | 1 - src/features/feeds/components/Tables.tsx | 12 ++++++------ 6 files changed, 20 insertions(+), 25 deletions(-) delete mode 100644 src/features/feeds/callouts/etf-best-practices.mdx diff --git a/src/content/data-feeds/selecting-data-feeds.mdx b/src/content/data-feeds/selecting-data-feeds.mdx index 2dfae6e4d5b..b9e5599c2a0 100644 --- a/src/content/data-feeds/selecting-data-feeds.mdx +++ b/src/content/data-feeds/selecting-data-feeds.mdx @@ -241,3 +241,11 @@ These feeds relay a value across blockchains from a specified contract. Chainlin The best practices above are provided for informational purposes only. You are responsible for reviewing the quality of the data that you integrate into your smart contracts. + +## ETF and Forex feeds + +When you use Data Feeds for ETFs or Foreign Exchange (Forex) data, be aware of the following best practices: + +- Offchain equity and ETF assets are traded only during [standard market hours](/data-feeds/selecting-data-feeds#market-hours). Do not use these feeds outside those windows. +- Assets on the Forex (Foreign Exchange) markets are traded only during [defined market hours](/data-feeds/selecting-data-feeds#market-hours). Additionally, some currencies might trade only during local banking hours. Do not use Forex feeds outside market hours for the specific currency. +- UK ETF price feed answers are 15 minutes delayed from their original published source. Assets are traded only during [standard market hours](/data-feeds/selecting-data-feeds#market-hours). Do not use these feeds outside their specified hours. diff --git a/src/features/feeds/callouts/FeedsCommonCallout.astro b/src/features/feeds/callouts/FeedsCommonCallout.astro index 0059f9135bb..7e0bc4f9e17 100644 --- a/src/features/feeds/callouts/FeedsCommonCallout.astro +++ b/src/features/feeds/callouts/FeedsCommonCallout.astro @@ -2,9 +2,6 @@ const feedQuality = await Astro.glob("./feed-quality.mdx") const FeedQualityComponent = feedQuality[0].Content -const etfBestPractices = await Astro.glob("./etf-best-practices.mdx") -const EtfBestPracticesComponent = etfBestPractices[0].Content - const porVerification = await Astro.glob("./por-verification.mdx") const PorVerificationComponent = porVerification[0].Content @@ -12,12 +9,11 @@ const porWalletAddressManager = await Astro.glob("./por-wallet-address-manager.m const PorWalletAddressManagerComponent = porWalletAddressManager[0].Content export type Props = { - callout?: "quality" | "etfBestPractices" | "porVerification" | "porWalletAddressManager" + callout?: "quality" | "porVerification" | "porWalletAddressManager" } const { callout } = Astro.props as Props --- {callout === "quality" && } -{callout === "etfBestPractices" && } {callout === "porVerification" && } {callout === "porWalletAddressManager" && } diff --git a/src/features/feeds/callouts/etf-best-practices.mdx b/src/features/feeds/callouts/etf-best-practices.mdx deleted file mode 100644 index b56210e2cfd..00000000000 --- a/src/features/feeds/callouts/etf-best-practices.mdx +++ /dev/null @@ -1,5 +0,0 @@ -### Best practices for ETF and Forex feeds - -- Offchain equity and ETF assets are traded only during [standard market hours](/data-feeds/selecting-data-feeds#market-hours). {" "} Do not use these feeds outside those windows. -- Assets on the Forex (Foreign Exchange) markets are traded only during [defined market hours](/data-feeds/selecting-data-feeds#market-hours). Additionally, some currencies might trade only during local banking hours. Do not use Forex feeds outside market hours for the specific currency. -- UK ETF price feed answers are 15 minutes delayed from their original published source. Assets are traded only during [standard market hours](/data-feeds/selecting-data-feeds#market-hours). Do not use these feeds outside their specified hours. diff --git a/src/features/feeds/callouts/feed-quality.mdx b/src/features/feeds/callouts/feed-quality.mdx index 783dd70a8ce..6c2f4306213 100644 --- a/src/features/feeds/callouts/feed-quality.mdx +++ b/src/features/feeds/callouts/feed-quality.mdx @@ -1,10 +1,7 @@ -### Data feed categories +### Data Feed Best Practices -- 🟢 [**Low Market Risk Feeds**](/data-feeds/selecting-data-feeds/#-low-market-risk-feeds): Feeds that deliver a market price for liquid assets with robust market structure. -- 🟡 [**Medium Market Risk Feeds**](/data-feeds/selecting-data-feeds/#-medium-market-risk-feeds): Feeds that deliver a market price for assets that show signs of liquidity-related risk or other market structure-related risk. -- 🔴 [**High Market Risk Feeds**](/data-feeds/selecting-data-feeds/#-high-market-risk-feeds): Feeds that deliver a heightened degree of some of the risk factors associated with Medium Market Risk Feeds, or a separate risk that makes the market price subject to uncertainty or volatile. In using a high market risk data feed you acknowledge that you understand the risks associated with such a feed and that you are solely responsible for monitoring and mitigating such risks. -- 🟠 [**New Token Feeds**](/data-feeds/selecting-data-feeds/#-new-token-feeds): Tokens without the historical data required to implement a risk assessment framework may be launched in this category. Users must understand the additional market and volatility risks inherent with such assets. Users of New Token Feeds are responsible for independently verifying the liquidity and stability of the assets priced by feeds that they use. -- 🔵 [**Custom Feeds**](/data-feeds/selecting-data-feeds/#-custom-feeds): Feeds built to serve a specific use case or rely on external contracts or data sources. These might not be suitable for general use or your use case's risk parameters. Users must evaluate the properties of a feed to make sure it aligns with their intended use case. -- ⭕ [**Deprecating**](/data-feeds/deprecating-feeds): These feeds are scheduled for deprecation. See the [Deprecation](/data-feeds/deprecating-feeds) page to learn more. +Before you use Data Feeds, read and understand the best practices on the [Selecting Quality Data Feeds](/data-feeds/selecting-data-feeds) page. For best practices about data for specific asset types, see the following sections: -See the [Selecting Quality Data Feeds](/data-feeds/selecting-data-feeds) page for complete details about each category. +- [Best Practices for ETF and Forex feeds](/data-feeds/selecting-data-feeds#etf-and-forex-feeds) +- [Best Practices for Exchange Rate Feeds](/data-feeds/selecting-data-feeds#exchange-rate-feeds) +- [Risk Categories](/data-feeds/selecting-data-feeds#data-feed-categories) diff --git a/src/features/feeds/components/FeedPage.astro b/src/features/feeds/components/FeedPage.astro index 581170765d0..7b85f5f84cd 100644 --- a/src/features/feeds/components/FeedPage.astro +++ b/src/features/feeds/components/FeedPage.astro @@ -145,7 +145,6 @@ const feedItems: FeedDataItem[] = monitoredFeeds.mainnet

- )} diff --git a/src/features/feeds/components/Tables.tsx b/src/features/feeds/components/Tables.tsx index 15f100d48bd..3271d24045c 100644 --- a/src/features/feeds/components/Tables.tsx +++ b/src/features/feeds/components/Tables.tsx @@ -15,42 +15,42 @@ const verifierProxies = new Map([ const feedItems = monitoredFeeds.mainnet const feedCategories = { low: ( - + 🟢 ), medium: ( - + 🟡 ), high: ( - + 🔴 ), new: ( - + 🟠 ), custom: ( - + 🔵 ), deprecating: ( - + ⭕