From 2a86afe3b9d5692f1885216b1a930684c60a2093 Mon Sep 17 00:00:00 2001 From: Christian-MK <105018870+Christian-MK@users.noreply.github.com> Date: Mon, 2 Feb 2026 13:21:32 -0800 Subject: [PATCH 1/9] updates feed-overview and removes tables --- docs/orcfax-feeds/feed-overview.md | 70 ++++++++++-------------------- 1 file changed, 24 insertions(+), 46 deletions(-) diff --git a/docs/orcfax-feeds/feed-overview.md b/docs/orcfax-feeds/feed-overview.md index ed5d4c96..94cc7649 100644 --- a/docs/orcfax-feeds/feed-overview.md +++ b/docs/orcfax-feeds/feed-overview.md @@ -6,13 +6,12 @@ slug: /feed-overview # Available feeds -Currently, Orcfax provides support for CER type feeds. Integrators may review -the full list of available feeds for both [mainnet][mainnet] and -[preview][preview]. - - +Currently, Orcfax provides support for Current Exchange Rate (CER) type feeds. +Integrators may review the full list of available [cer-feeds][cer]; feed +activity for [mainnet][mainnet] and [preview][preview] may be monitored through +the Orcfax Explorer. +[cer]: https://github.com/orcfax/cer-feeds [mainnet]: https://github.com/orcfax/cer-feeds/blob/main/feeds/mainnet/cer-feeds.json [preview]: @@ -60,25 +59,15 @@ standard adopted by Orcfax. ## Subsidized feeds -There are feeds which Orcfax has identified for their broad utility across -Cardano projects and has therefore committed to supporting their publication in -order to aid in development initiatives. These feeds have been selected in an -effort to provide developers with opportunities to design their solutions from -the beginning with authentic and verifiable data as a foundation. - -A subsidized feed is one which Orcfax has committed to maintaining even without -a sponsor. - -Orcfax is currently offering the following subsidized feeds: - -| Feed name | Start Date | End date | -| --------- | -------------------------- | -------- | -| ADA-USD | Sep 12th 2024 17:01:24 UTC | TBA | -| FACT-ADA | Sep 12th 2024 17:01:24 UTC | TBA | +Orcfax may periodically identify feeds which it will commit to supporting +through subsidized publication. These feeds will be designated as `Subsidized` +on the Explorer, and are provided so developers have opportunities to design +their solutions from the beginning with authentic and verifiable data as a +foundation. -when an integrator activates a subscription for a subsidized feed it will no -longer be identified as such and will instead be labeled a -[sponsored][sponsored] feed. +when an integrator activates a subscription for a feed which had previously +published as a subsidized feed it will no longer be identified as such and will +instead be labeled a [sponsored][sponsored] feed. [sponsored]: #sponsored-feeds @@ -90,46 +79,35 @@ production because Orcfax has agreed to cover the cost of their support. While Orcfax has committed to maintaining access to these feeds, integrators who wish to utilize these feeds without a subscription should do so at their own risk; Orcfax still reserves the right to adjust or remove support for these -feeds as business needs dictate. Orcfax has agreed to cover the cost of -supporting subsidized feeds enabling them to be used in production. Changes to -services relating to subsidized feeds will be announced three months in advance -to provide integrators with adequate forewarning. +feeds as business needs dictate. Changes to services relating to subsidized +feeds will be announced three months in advance to provide integrators with +adequate forewarning. [showcase]: #showcase-feeds ## Sponsored feeds -When an integrator agrees to support a given feed through a heartbeat -publication subscription, that feed will be designated as a sponsored feed for -the duration of that agreement. +When an integrator agrees to financially support a given feed, it will be +designated as a `Sponsored` feed on the Explorer for the duration of that +agreement. Sponsored feeds are those supported by an integrator through a subscription (e.g. heartbeat or deviation). Projects utilizing sponsored feeds, but are not paying for the feed, should do so at their own risk. Sponsors may change or remove support at their own discretion. -Orcfax has the following sponsored feeds: - -| Feed name | Start Date | -| --------- | ---------- | -| TBA | TBA | - ## Sunsetting sponsored feeds Projects which fail to adhere to subscription agreements risk disruptions to -their feeds. - -Orcfax will remove support for sponsored feeds 2 weeks after non-payment where -there are no subscribed integrators. +their feeds; Orcfax maintains the right to halt feed publication for +non-payment. ## Showcase feeds To demonstrate the kinds of feeds which integrators can utilize in their dApps, -Orcfax will periodically select feeds from its catalogue and highlight them -through publication as showcase feeds. - -Feeds being published and not currently listed as subsidized or sponsored are -showcase feeds. +Orcfax may periodically select feeds from its catalogue and highlight them +through publication on productions and/or preproduction networks. These feeds +will be designated as `Sponsored` on the Explorer. :::warning From f58a2b370cc89a8eec8dc1ebc3037f179104bc9e Mon Sep 17 00:00:00 2001 From: Christian-MK <105018870+Christian-MK@users.noreply.github.com> Date: Mon, 2 Feb 2026 13:26:40 -0800 Subject: [PATCH 2/9] moves the CER tab to developer-manual and renames --- .../CER => developer-manual/CER-feeds}/CEX/_category.json | 0 .../CER-feeds}/CEX/fact-statement-datum.mdx | 0 .../CER => developer-manual/CER-feeds}/CEX/fact-statement.mdx | 0 .../CER => developer-manual/CER-feeds}/CEX/message.mdx | 0 .../CER => developer-manual/CER-feeds}/CEX/validation.mdx | 0 .../CER => developer-manual/CER-feeds}/DEX/_category.json | 0 .../CER-feeds}/DEX/fact-statement-datum.mdx | 0 .../CER => developer-manual/CER-feeds}/DEX/fact-statement.mdx | 0 .../CER => developer-manual/CER-feeds}/DEX/message.mdx | 0 .../CER => developer-manual/CER-feeds}/DEX/validation.mdx | 0 10 files changed, 0 insertions(+), 0 deletions(-) rename docs/{orcfax-feeds/CER => developer-manual/CER-feeds}/CEX/_category.json (100%) rename docs/{orcfax-feeds/CER => developer-manual/CER-feeds}/CEX/fact-statement-datum.mdx (100%) rename docs/{orcfax-feeds/CER => developer-manual/CER-feeds}/CEX/fact-statement.mdx (100%) rename docs/{orcfax-feeds/CER => developer-manual/CER-feeds}/CEX/message.mdx (100%) rename docs/{orcfax-feeds/CER => developer-manual/CER-feeds}/CEX/validation.mdx (100%) rename docs/{orcfax-feeds/CER => developer-manual/CER-feeds}/DEX/_category.json (100%) rename docs/{orcfax-feeds/CER => developer-manual/CER-feeds}/DEX/fact-statement-datum.mdx (100%) rename docs/{orcfax-feeds/CER => developer-manual/CER-feeds}/DEX/fact-statement.mdx (100%) rename docs/{orcfax-feeds/CER => developer-manual/CER-feeds}/DEX/message.mdx (100%) rename docs/{orcfax-feeds/CER => developer-manual/CER-feeds}/DEX/validation.mdx (100%) diff --git a/docs/orcfax-feeds/CER/CEX/_category.json b/docs/developer-manual/CER-feeds/CEX/_category.json similarity index 100% rename from docs/orcfax-feeds/CER/CEX/_category.json rename to docs/developer-manual/CER-feeds/CEX/_category.json diff --git a/docs/orcfax-feeds/CER/CEX/fact-statement-datum.mdx b/docs/developer-manual/CER-feeds/CEX/fact-statement-datum.mdx similarity index 100% rename from docs/orcfax-feeds/CER/CEX/fact-statement-datum.mdx rename to docs/developer-manual/CER-feeds/CEX/fact-statement-datum.mdx diff --git a/docs/orcfax-feeds/CER/CEX/fact-statement.mdx b/docs/developer-manual/CER-feeds/CEX/fact-statement.mdx similarity index 100% rename from docs/orcfax-feeds/CER/CEX/fact-statement.mdx rename to docs/developer-manual/CER-feeds/CEX/fact-statement.mdx diff --git a/docs/orcfax-feeds/CER/CEX/message.mdx b/docs/developer-manual/CER-feeds/CEX/message.mdx similarity index 100% rename from docs/orcfax-feeds/CER/CEX/message.mdx rename to docs/developer-manual/CER-feeds/CEX/message.mdx diff --git a/docs/orcfax-feeds/CER/CEX/validation.mdx b/docs/developer-manual/CER-feeds/CEX/validation.mdx similarity index 100% rename from docs/orcfax-feeds/CER/CEX/validation.mdx rename to docs/developer-manual/CER-feeds/CEX/validation.mdx diff --git a/docs/orcfax-feeds/CER/DEX/_category.json b/docs/developer-manual/CER-feeds/DEX/_category.json similarity index 100% rename from docs/orcfax-feeds/CER/DEX/_category.json rename to docs/developer-manual/CER-feeds/DEX/_category.json diff --git a/docs/orcfax-feeds/CER/DEX/fact-statement-datum.mdx b/docs/developer-manual/CER-feeds/DEX/fact-statement-datum.mdx similarity index 100% rename from docs/orcfax-feeds/CER/DEX/fact-statement-datum.mdx rename to docs/developer-manual/CER-feeds/DEX/fact-statement-datum.mdx diff --git a/docs/orcfax-feeds/CER/DEX/fact-statement.mdx b/docs/developer-manual/CER-feeds/DEX/fact-statement.mdx similarity index 100% rename from docs/orcfax-feeds/CER/DEX/fact-statement.mdx rename to docs/developer-manual/CER-feeds/DEX/fact-statement.mdx diff --git a/docs/orcfax-feeds/CER/DEX/message.mdx b/docs/developer-manual/CER-feeds/DEX/message.mdx similarity index 100% rename from docs/orcfax-feeds/CER/DEX/message.mdx rename to docs/developer-manual/CER-feeds/DEX/message.mdx diff --git a/docs/orcfax-feeds/CER/DEX/validation.mdx b/docs/developer-manual/CER-feeds/DEX/validation.mdx similarity index 100% rename from docs/orcfax-feeds/CER/DEX/validation.mdx rename to docs/developer-manual/CER-feeds/DEX/validation.mdx From 6dfcb002abf89cb291f57d08d4a414af7176d17f Mon Sep 17 00:00:00 2001 From: Christian-MK <105018870+Christian-MK@users.noreply.github.com> Date: Mon, 2 Feb 2026 13:35:24 -0800 Subject: [PATCH 3/9] renames feed-overview -> available-feeds to match frontmatter --- docs/orcfax-feeds/{feed-overview.md => available-feeds.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/orcfax-feeds/{feed-overview.md => available-feeds.md} (100%) diff --git a/docs/orcfax-feeds/feed-overview.md b/docs/orcfax-feeds/available-feeds.md similarity index 100% rename from docs/orcfax-feeds/feed-overview.md rename to docs/orcfax-feeds/available-feeds.md From 98c6bd716fe05a331a16292317f8f47c8f85f634 Mon Sep 17 00:00:00 2001 From: Christian-MK <105018870+Christian-MK@users.noreply.github.com> Date: Mon, 9 Mar 2026 10:52:24 -0700 Subject: [PATCH 4/9] reorganizes available feeds with tos --- .../CER}/CEX/_category.json | 0 .../CER}/CEX/fact-statement-datum.mdx | 0 .../CER}/CEX/fact-statement.mdx | 0 .../CER}/CEX/message.mdx | 0 .../CER}/CEX/validation.mdx | 0 .../CER}/DEX/_category.json | 0 .../CER}/DEX/fact-statement-datum.mdx | 0 .../CER}/DEX/fact-statement.mdx | 0 .../CER}/DEX/message.mdx | 0 .../CER}/DEX/validation.mdx | 0 .../_category_.json | 2 +- .../feed-overview.md} | 24 ++++++++++++------- docs/available-feeds/feed-use.md | 16 +++++++++++++ .../terms-of-service.md | 0 14 files changed, 32 insertions(+), 10 deletions(-) rename docs/{developer-manual/CER-feeds => available-feeds/CER}/CEX/_category.json (100%) rename docs/{developer-manual/CER-feeds => available-feeds/CER}/CEX/fact-statement-datum.mdx (100%) rename docs/{developer-manual/CER-feeds => available-feeds/CER}/CEX/fact-statement.mdx (100%) rename docs/{developer-manual/CER-feeds => available-feeds/CER}/CEX/message.mdx (100%) rename docs/{developer-manual/CER-feeds => available-feeds/CER}/CEX/validation.mdx (100%) rename docs/{developer-manual/CER-feeds => available-feeds/CER}/DEX/_category.json (100%) rename docs/{developer-manual/CER-feeds => available-feeds/CER}/DEX/fact-statement-datum.mdx (100%) rename docs/{developer-manual/CER-feeds => available-feeds/CER}/DEX/fact-statement.mdx (100%) rename docs/{developer-manual/CER-feeds => available-feeds/CER}/DEX/message.mdx (100%) rename docs/{developer-manual/CER-feeds => available-feeds/CER}/DEX/validation.mdx (100%) rename docs/{orcfax-feeds => available-feeds}/_category_.json (55%) rename docs/{orcfax-feeds/available-feeds.md => available-feeds/feed-overview.md} (85%) create mode 100644 docs/available-feeds/feed-use.md rename docs/{developer-manual => available-feeds}/terms-of-service.md (100%) diff --git a/docs/developer-manual/CER-feeds/CEX/_category.json b/docs/available-feeds/CER/CEX/_category.json similarity index 100% rename from docs/developer-manual/CER-feeds/CEX/_category.json rename to docs/available-feeds/CER/CEX/_category.json diff --git a/docs/developer-manual/CER-feeds/CEX/fact-statement-datum.mdx b/docs/available-feeds/CER/CEX/fact-statement-datum.mdx similarity index 100% rename from docs/developer-manual/CER-feeds/CEX/fact-statement-datum.mdx rename to docs/available-feeds/CER/CEX/fact-statement-datum.mdx diff --git a/docs/developer-manual/CER-feeds/CEX/fact-statement.mdx b/docs/available-feeds/CER/CEX/fact-statement.mdx similarity index 100% rename from docs/developer-manual/CER-feeds/CEX/fact-statement.mdx rename to docs/available-feeds/CER/CEX/fact-statement.mdx diff --git a/docs/developer-manual/CER-feeds/CEX/message.mdx b/docs/available-feeds/CER/CEX/message.mdx similarity index 100% rename from docs/developer-manual/CER-feeds/CEX/message.mdx rename to docs/available-feeds/CER/CEX/message.mdx diff --git a/docs/developer-manual/CER-feeds/CEX/validation.mdx b/docs/available-feeds/CER/CEX/validation.mdx similarity index 100% rename from docs/developer-manual/CER-feeds/CEX/validation.mdx rename to docs/available-feeds/CER/CEX/validation.mdx diff --git a/docs/developer-manual/CER-feeds/DEX/_category.json b/docs/available-feeds/CER/DEX/_category.json similarity index 100% rename from docs/developer-manual/CER-feeds/DEX/_category.json rename to docs/available-feeds/CER/DEX/_category.json diff --git a/docs/developer-manual/CER-feeds/DEX/fact-statement-datum.mdx b/docs/available-feeds/CER/DEX/fact-statement-datum.mdx similarity index 100% rename from docs/developer-manual/CER-feeds/DEX/fact-statement-datum.mdx rename to docs/available-feeds/CER/DEX/fact-statement-datum.mdx diff --git a/docs/developer-manual/CER-feeds/DEX/fact-statement.mdx b/docs/available-feeds/CER/DEX/fact-statement.mdx similarity index 100% rename from docs/developer-manual/CER-feeds/DEX/fact-statement.mdx rename to docs/available-feeds/CER/DEX/fact-statement.mdx diff --git a/docs/developer-manual/CER-feeds/DEX/message.mdx b/docs/available-feeds/CER/DEX/message.mdx similarity index 100% rename from docs/developer-manual/CER-feeds/DEX/message.mdx rename to docs/available-feeds/CER/DEX/message.mdx diff --git a/docs/developer-manual/CER-feeds/DEX/validation.mdx b/docs/available-feeds/CER/DEX/validation.mdx similarity index 100% rename from docs/developer-manual/CER-feeds/DEX/validation.mdx rename to docs/available-feeds/CER/DEX/validation.mdx diff --git a/docs/orcfax-feeds/_category_.json b/docs/available-feeds/_category_.json similarity index 55% rename from docs/orcfax-feeds/_category_.json rename to docs/available-feeds/_category_.json index d866c427..aaa31b19 100644 --- a/docs/orcfax-feeds/_category_.json +++ b/docs/available-feeds/_category_.json @@ -1,5 +1,5 @@ { - "label": "Orcfax feeds", + "label": "Available feeds", "position": 3, "link": null } diff --git a/docs/orcfax-feeds/available-feeds.md b/docs/available-feeds/feed-overview.md similarity index 85% rename from docs/orcfax-feeds/available-feeds.md rename to docs/available-feeds/feed-overview.md index 94cc7649..70f50ba9 100644 --- a/docs/orcfax-feeds/available-feeds.md +++ b/docs/available-feeds/feed-overview.md @@ -1,13 +1,13 @@ --- -id: Available feeds +id: feed overview sidebar_position: 1 slug: /feed-overview --- -# Available feeds +# Overview -Currently, Orcfax provides support for Current Exchange Rate (CER) type feeds. -Integrators may review the full list of available [cer-feeds][cer]; feed +Currently, Orcfax provides support for Current Exchange Rate ([CER][cer-1]) type +feeds. Integrators may review the full list of available [cer-feeds][cer]; feed activity for [mainnet][mainnet] and [preview][preview] may be monitored through the Orcfax Explorer. @@ -19,9 +19,8 @@ the Orcfax Explorer. ## Current Exchange Rate feeds -Current Exchange Rate ([CER][cer-1]) feeds publish statements relating to the -current price of a given currency against another. Feeds of this type include -ADA-USD and FACT-ADA. +CER feeds publish statements relating to the current price of a given currency +against another. Feeds of this type include ADA-USD and FACT-ADA. For a feed of type CER, the naming convention is [\{\{base-currency\}\}-\{\{quote-currency\}\}][cer-2]. @@ -44,8 +43,13 @@ exchanges. :::info -The [Glossary][glossary] provides more information on the terminology and -standard adopted by Orcfax. +Additional details on the form of CER feeds, their published datum, and archived +records depend on whether their data is sourced from a CEX or DEX; we have +separated design documents for each respectively. + +[CEX][cex-form] + +[DEX][dex-form] ::: @@ -55,6 +59,8 @@ standard adopted by Orcfax. [dex-1]: https://glossary.orcfax.io/#dex [cex-2]: https://en.wikipedia.org/wiki/ISO_4217 [cex-3]: https://tradenation.com/articles/base-currency-and-quote-currency/ +[cex-form]: available-feeds/CER/CEX/fact-statement.mdx +[dex-form]: available-feeds/CER/DEX/fact-statement.mdx [glossary]: https://glossary.orcfax.io ## Subsidized feeds diff --git a/docs/available-feeds/feed-use.md b/docs/available-feeds/feed-use.md new file mode 100644 index 00000000..309f1d3e --- /dev/null +++ b/docs/available-feeds/feed-use.md @@ -0,0 +1,16 @@ +--- +id: feed use +sidebar_position: 2 +slug: /feed-use +--- + +# Feed use + +Those intending to use Orcfax feeds should ensure that they have reviewed the +Orcfax [Terms of Service][tos] + +By default, once an Orcfax feed has resulted in a published datum, that data is +publicly available to the network. This is intentional as Orcfax has +purposefully designed its solution as an ecosystem utility + +[tos]: docs/available-feeds/terms-of-service.md diff --git a/docs/developer-manual/terms-of-service.md b/docs/available-feeds/terms-of-service.md similarity index 100% rename from docs/developer-manual/terms-of-service.md rename to docs/available-feeds/terms-of-service.md From e2f7938bd16b8a9fc8de206e37cc2e302b920162 Mon Sep 17 00:00:00 2001 From: Christian-MK <105018870+Christian-MK@users.noreply.github.com> Date: Thu, 19 Mar 2026 11:11:55 -0700 Subject: [PATCH 5/9] adds content re feed use w/o sla --- docs/available-feeds/feed-use.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/available-feeds/feed-use.md b/docs/available-feeds/feed-use.md index 309f1d3e..3f3afea8 100644 --- a/docs/available-feeds/feed-use.md +++ b/docs/available-feeds/feed-use.md @@ -6,11 +6,20 @@ slug: /feed-use # Feed use -Those intending to use Orcfax feeds should ensure that they have reviewed the -Orcfax [Terms of Service][tos] +Orcfax is a service provider which partners with integrators to meet their data +needs; these partnerships may use service level agreements to define each +party's responsibility to the other. By default, once an Orcfax feed has resulted in a published datum, that data is -publicly available to the network. This is intentional as Orcfax has -purposefully designed its solution as an ecosystem utility +publicly available to the network; this is intentional as Orcfax has +purposefully designed its solution as an ecosystem utility. However, the use of +Orcfax data by integrators outside of these agreements, or the downstream use of +historical data, are outside the scope of these agreements and responsibilities. + +To that end, those intending to use Orcfax feeds on production networks should +ensure that they have reviewed the Orcfax [Terms of Service][tos]. + +We encourage potential integrators and partners to reach out with any questions +or concerns. [tos]: docs/available-feeds/terms-of-service.md From 4b457deeb92a4fd897aa9b59447e486e4b954d7a Mon Sep 17 00:00:00 2001 From: Christian-MK <105018870+Christian-MK@users.noreply.github.com> Date: Fri, 20 Mar 2026 11:55:12 -0700 Subject: [PATCH 6/9] migrates risk-rating content --- docs/available-feeds/CER/_category_.json | 5 + .../risk-ratings/_category_.json | 5 + .../centralized-review/_category.json | 4 + .../fact-statement-datum.mdx | 46 +++++++++ .../centralized-review/fact-statement.mdx | 65 +++++++++++++ .../centralized-review/message.mdx | 44 +++++++++ .../centralized-review/validation.mdx | 44 +++++++++ .../decentralized-review/_category.json | 4 + .../fact-statement-datum.mdx | 46 +++++++++ .../decentralized-review/fact-statement.mdx | 51 ++++++++++ .../decentralized-review/message.mdx | 44 +++++++++ .../decentralized-review/validation.mdx | 44 +++++++++ docs/available-feeds/terms-of-service.md | 2 +- .../fact-statement-datum.json | 16 ++++ .../centralized-review/fact-statement.json | 35 +++++++ .../centralized-review/message.json | 19 ++++ .../centralized-review/validation.json | 93 +++++++++++++++++++ .../fact-statement-datum.json | 4 + .../decentralized-review/fact-statement.json | 4 + .../decentralized-review/message.json | 4 + .../decentralized-review/validation.json | 4 + 21 files changed, 582 insertions(+), 1 deletion(-) create mode 100644 docs/available-feeds/CER/_category_.json create mode 100644 docs/available-feeds/risk-ratings/_category_.json create mode 100644 docs/available-feeds/risk-ratings/centralized-review/_category.json create mode 100644 docs/available-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx create mode 100644 docs/available-feeds/risk-ratings/centralized-review/fact-statement.mdx create mode 100644 docs/available-feeds/risk-ratings/centralized-review/message.mdx create mode 100644 docs/available-feeds/risk-ratings/centralized-review/validation.mdx create mode 100644 docs/available-feeds/risk-ratings/decentralized-review/_category.json create mode 100644 docs/available-feeds/risk-ratings/decentralized-review/fact-statement-datum.mdx create mode 100644 docs/available-feeds/risk-ratings/decentralized-review/fact-statement.mdx create mode 100644 docs/available-feeds/risk-ratings/decentralized-review/message.mdx create mode 100644 docs/available-feeds/risk-ratings/decentralized-review/validation.mdx create mode 100644 static/schema/risk-rating/centralized-review/fact-statement-datum.json create mode 100644 static/schema/risk-rating/centralized-review/fact-statement.json create mode 100644 static/schema/risk-rating/centralized-review/message.json create mode 100644 static/schema/risk-rating/centralized-review/validation.json create mode 100644 static/schema/risk-rating/decentralized-review/fact-statement-datum.json create mode 100644 static/schema/risk-rating/decentralized-review/fact-statement.json create mode 100644 static/schema/risk-rating/decentralized-review/message.json create mode 100644 static/schema/risk-rating/decentralized-review/validation.json diff --git a/docs/available-feeds/CER/_category_.json b/docs/available-feeds/CER/_category_.json new file mode 100644 index 00000000..df74f311 --- /dev/null +++ b/docs/available-feeds/CER/_category_.json @@ -0,0 +1,5 @@ +{ + "label": "CER", + "position": 4, + "link": null +} diff --git a/docs/available-feeds/risk-ratings/_category_.json b/docs/available-feeds/risk-ratings/_category_.json new file mode 100644 index 00000000..bccbbdc8 --- /dev/null +++ b/docs/available-feeds/risk-ratings/_category_.json @@ -0,0 +1,5 @@ +{ + "label": "Risk Ratings", + "position": 5, + "link": null +} diff --git a/docs/available-feeds/risk-ratings/centralized-review/_category.json b/docs/available-feeds/risk-ratings/centralized-review/_category.json new file mode 100644 index 00000000..a30f2ac3 --- /dev/null +++ b/docs/available-feeds/risk-ratings/centralized-review/_category.json @@ -0,0 +1,4 @@ +{ + "label": "centralized-review", + "position": 2 +} diff --git a/docs/available-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx b/docs/available-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx new file mode 100644 index 00000000..a3181508 --- /dev/null +++ b/docs/available-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx @@ -0,0 +1,46 @@ +--- +id: centralized-review-2 +sidebar_position: 2 +slug: /centralized-review-fact-statement-datum +--- + +import CodeBlock from "@theme/CodeBlock"; +import factStatementDatum from "/schema/risk-rating/centralized-review/fact-statement-datum.json"; + +# Fact Statement Datum + +A description of the types/properties relevant to a `fact-statement-datum.json`. + +Orcfax utilizes the following Schema.org types and properties in its Fact +Statement Datum records. The description provided by [Schema.org][schema-1] +follows each; if Orcfax maintains a more nuanced understanding, an additional +definition will be provided. If the term appears in its own definition, it will +be replaced when possible with a \[synonym\] in order to aid understanding. + +[schema-1]: https://schema.org/ + +## Schema.org Types + +| Type | Schema.org description | Orcfax description | +| -------- | --------------------------- | ---------------------- | +| -------- | --------------------------- | ---------------------- | + +## Schema.org Properties + +| Property | Type | Schema.org description | Orcfax definition | +| ------------ | -------- | --------------------------- | --------------------- | +| ------------ | -------- | --------------------------- | --------------------- | + +## Fact Statement Datum example + + + {JSON.stringify(factStatementDatum, null, 2)} + + + + Download + diff --git a/docs/available-feeds/risk-ratings/centralized-review/fact-statement.mdx b/docs/available-feeds/risk-ratings/centralized-review/fact-statement.mdx new file mode 100644 index 00000000..746d18c3 --- /dev/null +++ b/docs/available-feeds/risk-ratings/centralized-review/fact-statement.mdx @@ -0,0 +1,65 @@ +--- +id: centralized-review-1 +sidebar_position: 1 +slug: /centralized-review-fact-statement +--- + +import CodeBlock from "@theme/CodeBlock"; +import factStatement from "/schema/risk-rating/centralized-review/fact-statement.json"; + +# Fact Statement + +A description of the types/properties relevant to a `fact-statement.json`. + +Orcfax utilizes the following Schema.org types and properties in its Fact +Statement records. The description provided by [Schema.org][schema-1] follows +each; if Orcfax maintains a more nuanced understanding, an additional definition +will be provided. If the term appears in its own definition, it will be replaced +when possible with a \[synonym\] in order to aid understanding. + +[schema-1]: https://schema.org/ + +## Schema.org Types + +| Type | Schema.org description | Orcfax description | +| -------- | --------------------------- | ---------------------- | +| -------- | --------------------------- | ---------------------- | + +Types under review for development + +- [Review](https://schema.org/Review) +- [Claim](https://schema.org/Claim) +- [FinancialProduct](https://schema.org/FinancialProduct) +- [Rating](https://schema.org/Rating) +- [ProductGroup](https://schema.org/ProductGroup) + +## Schema.org Properties + +| Property | Type | Schema.org description | Orcfax definition | +| ------------ | -------- | --------------------------- | --------------------- | +| ------------ | -------- | --------------------------- | --------------------- | + +The values for `bestRating` and `worstRating` are further described in Xerberus +[docs][x-1]. + +| Rating | Explanation | +| ------- | ------------------ | +| AAA - A | Investment Grade | +| BBB - B | Speculative | +| CCC - C | Highly Speculative | +| D | Junk | + +[x-1]: + https://xerberus.gitbook.io/documentation/apis/risk-ratings/cardano#risk-scores + +## Fact Statement example + +{JSON.stringify(factStatement, null, 2)} + + + Download + diff --git a/docs/available-feeds/risk-ratings/centralized-review/message.mdx b/docs/available-feeds/risk-ratings/centralized-review/message.mdx new file mode 100644 index 00000000..595f83d7 --- /dev/null +++ b/docs/available-feeds/risk-ratings/centralized-review/message.mdx @@ -0,0 +1,44 @@ +--- +id: centralized-review-3 +sidebar_position: 3 +slug: /centralized-review-message +--- + +import CodeBlock from "@theme/CodeBlock"; +import Message from "/schema/risk-rating/centralized-review/message.json"; + +# Message + +A description of the types/properties relevant to a `message.json`. + +Orcfax utilizes the following Schema.org types and properties in its Message +records. The description provided by [Schema.org][schema-1] follows each; if +Orcfax maintains a more nuanced understanding, an additional definition will be +provided. If the term appears in its own definition, it will be replaced when +possible with a \[synonym\] in order to aid understanding. + +[schema-1]: https://schema.org/ + +## Schema.org Types + +| Type | Schema.org description | Orcfax description | +| -------- | --------------------------- | ---------------------- | +| -------- | --------------------------- | ---------------------- | + +## Schema.org Properties + +| Property | Type | Schema.org description | Orcfax definition | +| ------------ | -------- | --------------------------- | --------------------- | +| ------------ | -------- | --------------------------- | --------------------- | + +## Message example + +{JSON.stringify(Message, null, 2)} + + + Download + diff --git a/docs/available-feeds/risk-ratings/centralized-review/validation.mdx b/docs/available-feeds/risk-ratings/centralized-review/validation.mdx new file mode 100644 index 00000000..438f984d --- /dev/null +++ b/docs/available-feeds/risk-ratings/centralized-review/validation.mdx @@ -0,0 +1,44 @@ +--- +id: centralized-review-4 +sidebar_position: 4 +slug: /centralized-review-validation +--- + +import CodeBlock from "@theme/CodeBlock"; +import Validation from "/schema/risk-rating/centralized-review/validation.json"; + +# Validation + +A description of the types/properties relevant to a `validation.json`. + +Orcfax utilizes the following Schema.org types and properties in its Validation +records. The description provided by [Schema.org][schema-1] follows each; if +Orcfax maintains a more nuanced understanding, an additional definition will be +provided. If the term appears in its own definition, it will be replaced when +possible with a \[synonym\] in order to aid understanding. + +[schema-1]: https://schema.org/ + +## Schema.org Types + +| Type | Schema.org description | Orcfax description | +| -------- | --------------------------- | ---------------------- | +| -------- | --------------------------- | ---------------------- | + +## Schema.org Properties + +| Property | Type | Schema.org description | Orcfax definition | +| ------------ | -------- | --------------------------- | --------------------- | +| ------------ | -------- | --------------------------- | --------------------- | + +## Validation example + +{JSON.stringify(Validation, null, 2)} + + + Download + diff --git a/docs/available-feeds/risk-ratings/decentralized-review/_category.json b/docs/available-feeds/risk-ratings/decentralized-review/_category.json new file mode 100644 index 00000000..d5341672 --- /dev/null +++ b/docs/available-feeds/risk-ratings/decentralized-review/_category.json @@ -0,0 +1,4 @@ +{ + "label": "decentralized-review", + "position": 2 +} diff --git a/docs/available-feeds/risk-ratings/decentralized-review/fact-statement-datum.mdx b/docs/available-feeds/risk-ratings/decentralized-review/fact-statement-datum.mdx new file mode 100644 index 00000000..1de3addf --- /dev/null +++ b/docs/available-feeds/risk-ratings/decentralized-review/fact-statement-datum.mdx @@ -0,0 +1,46 @@ +--- +id: decentralized-review-2 +sidebar_position: 2 +slug: /decentralized-review-fact-statement-datum +--- + +import CodeBlock from "@theme/CodeBlock"; +import factStatementDatum from "/schema/risk-rating/decentralized-review/fact-statement-datum.json"; + +# Fact Statement Datum + +A description of the types/properties relevant to a `fact-statement-datum.json`. + +Orcfax utilizes the following Schema.org types and properties in its Fact +Statement Datum records. The description provided by [Schema.org][schema-1] +follows each; if Orcfax maintains a more nuanced understanding, an additional +definition will be provided. If the term appears in its own definition, it will +be replaced when possible with a \[synonym\] in order to aid understanding. + +[schema-1]: https://schema.org/ + +## Schema.org Types + +| Type | Schema.org description | Orcfax description | +| -------- | --------------------------- | ---------------------- | +| -------- | --------------------------- | ---------------------- | + +## Schema.org Properties + +| Property | Type | Schema.org description | Orcfax definition | +| ------------ | -------- | --------------------------- | --------------------- | +| ------------ | -------- | --------------------------- | --------------------- | + +## Fact Statement Datum example + + + {JSON.stringify(factStatementDatum, null, 2)} + + + + Download + diff --git a/docs/available-feeds/risk-ratings/decentralized-review/fact-statement.mdx b/docs/available-feeds/risk-ratings/decentralized-review/fact-statement.mdx new file mode 100644 index 00000000..34c37c59 --- /dev/null +++ b/docs/available-feeds/risk-ratings/decentralized-review/fact-statement.mdx @@ -0,0 +1,51 @@ +--- +id: decentralized-review-1 +sidebar_position: 1 +slug: /decentralized-review-fact-statement +--- + +import CodeBlock from "@theme/CodeBlock"; +import factStatement from "/schema/risk-rating/decentralized-review/fact-statement.json"; + +# Fact Statement + +A description of the types/properties relevant to a `fact-statement.json`. + +Orcfax utilizes the following Schema.org types and properties in its Fact +Statement records. The description provided by [Schema.org][schema-1] follows +each; if Orcfax maintains a more nuanced understanding, an additional definition +will be provided. If the term appears in its own definition, it will be replaced +when possible with a \[synonym\] in order to aid understanding. + +[schema-1]: https://schema.org/ + +## Schema.org Types + +| Type | Schema.org description | Orcfax description | +| -------- | --------------------------- | ---------------------- | +| -------- | --------------------------- | ---------------------- | + +- [Review](https://schema.org/Review) +- [Claim](https://schema.org/Claim) +- [FinancialProduct](https://schema.org/FinancialProduct) +- [Rating](https://schema.org/Rating) +- [AggregateRating](https://schema.org/AggregateRating) +- [ProductGroup](https://schema.org/ProductGroup) + +## Schema.org Properties + +| Property | Type | Schema.org description | Orcfax definition | +| ------------ | -------- | --------------------------- | --------------------- | +| ------------ | -------- | --------------------------- | --------------------- | + +## Fact Statement example + +{JSON.stringify(factStatement, null, 2)} + + + Download + diff --git a/docs/available-feeds/risk-ratings/decentralized-review/message.mdx b/docs/available-feeds/risk-ratings/decentralized-review/message.mdx new file mode 100644 index 00000000..85ed8064 --- /dev/null +++ b/docs/available-feeds/risk-ratings/decentralized-review/message.mdx @@ -0,0 +1,44 @@ +--- +id: decentralized-review-3 +sidebar_position: 3 +slug: /decentralized-review-message +--- + +import CodeBlock from "@theme/CodeBlock"; +import Message from "/schema/risk-rating/decentralized-review/message.json"; + +# Message + +A description of the types/properties relevant to a `message.json`. + +Orcfax utilizes the following Schema.org types and properties in its Message +records. The description provided by [Schema.org][schema-1] follows each; if +Orcfax maintains a more nuanced understanding, an additional definition will be +provided. If the term appears in its own definition, it will be replaced when +possible with a \[synonym\] in order to aid understanding. + +[schema-1]: https://schema.org/ + +## Schema.org Types + +| Type | Schema.org description | Orcfax description | +| -------- | --------------------------- | ---------------------- | +| -------- | --------------------------- | ---------------------- | + +## Schema.org Properties + +| Property | Type | Schema.org description | Orcfax definition | +| ------------ | -------- | --------------------------- | --------------------- | +| ------------ | -------- | --------------------------- | --------------------- | + +## Message example + +{JSON.stringify(Message, null, 2)} + + + Download + diff --git a/docs/available-feeds/risk-ratings/decentralized-review/validation.mdx b/docs/available-feeds/risk-ratings/decentralized-review/validation.mdx new file mode 100644 index 00000000..1fab393c --- /dev/null +++ b/docs/available-feeds/risk-ratings/decentralized-review/validation.mdx @@ -0,0 +1,44 @@ +--- +id: decentralized-review-4 +sidebar_position: 4 +slug: /decentralized-review-validation +--- + +import CodeBlock from "@theme/CodeBlock"; +import Validation from "/schema/risk-rating/decentralized-review/validation.json"; + +# Validation + +A description of the types/properties relevant to a `validation.json`. + +Orcfax utilizes the following Schema.org types and properties in its Validation +records. The description provided by [Schema.org][schema-1] follows each; if +Orcfax maintains a more nuanced understanding, an additional definition will be +provided. If the term appears in its own definition, it will be replaced when +possible with a \[synonym\] in order to aid understanding. + +[schema-1]: https://schema.org/ + +## Schema.org Types + +| Type | Schema.org description | Orcfax description | +| -------- | --------------------------- | ---------------------- | +| -------- | --------------------------- | ---------------------- | + +## Schema.org Properties + +| Property | Type | Schema.org description | Orcfax definition | +| ------------ | -------- | --------------------------- | --------------------- | +| ------------ | -------- | --------------------------- | --------------------- | + +## Validation example + +{JSON.stringify(Validation, null, 2)} + + + Download + diff --git a/docs/available-feeds/terms-of-service.md b/docs/available-feeds/terms-of-service.md index a82dd13a..3b6cbc12 100644 --- a/docs/available-feeds/terms-of-service.md +++ b/docs/available-feeds/terms-of-service.md @@ -1,6 +1,6 @@ --- id: terms of service -sidebar_position: 5 +sidebar_position: 3 slug: /terms-of-service --- diff --git a/static/schema/risk-rating/centralized-review/fact-statement-datum.json b/static/schema/risk-rating/centralized-review/fact-statement-datum.json new file mode 100644 index 00000000..820ad6e8 --- /dev/null +++ b/static/schema/risk-rating/centralized-review/fact-statement-datum.json @@ -0,0 +1,16 @@ +{ + "@context": "https://schema.org", + "type": "Message", + "name": "CER/ADA-USD/3", + "identifier": "urn:orcfax:83f5ba93-6bf3-4204-a03b-ab85bd9f955c", + "publisher": { + "@type": "Organization", + "name": "Orcfax", + "url": "https://orcfax.io/" + }, + "dateCreated": "2024-08-28T16:20:35Z", + "messageAttachment": { + "encoding": "application/json:base64", + "text": "ewogICJmZWVkX2lkIjogIkNFUi9BREEtVVNELzMiLAogICJjcmVhdGVkX2F0IjogMTcyNDg2MjAzNTUxMSwKICAiYm9keSI6IHsKICAgICJudW1lcmF0b3IiOiA2ODQ5MywKICAgICJkZW5vbWluYXRvciI6IDIwMDAwMAogIH0KfQ==" + } +} diff --git a/static/schema/risk-rating/centralized-review/fact-statement.json b/static/schema/risk-rating/centralized-review/fact-statement.json new file mode 100644 index 00000000..3768a9cb --- /dev/null +++ b/static/schema/risk-rating/centralized-review/fact-statement.json @@ -0,0 +1,35 @@ +{ + "context": "https://schema.org", + "type": "Review", + "reviewBody": { + "@type": "CreativeWork", + "creator": "Xerberus Node: 1.0.0rc23", + "about": "The Xerberus review of the {ASSET-NAME} risk rating", + "identifier": "urn:", + "dateCreated": "2024-08-28T16:20:14Z", + "license": "https://creativecommons.org/licenses/by/4.0/", + "description": { + "@type": "Claim", + "appearance": "message-{ASSET-NAME}-xerberus.tick_generic.json", + "claimInterpreter": { + "@type": "Organization", + "name": "Orcfax", + "url": "https://orcfax.io/" + } + } + }, + "itemReviewed": { + "additionalType": "CardanoNativeToken", + "name": "{ASSET-NAME", + "description": "{ASSET-SUBJECT}", + "identifier": "{ASSET-FINGERPRINT}" + }, + "reviewRating": { + "@type": "Rating", + "author": "Xerberus", + "ratingValue": "{AAA}", + "worstRating": "D", + "bestRating": "AAA", + "reviewAspect": "Risk" + } +} diff --git a/static/schema/risk-rating/centralized-review/message.json b/static/schema/risk-rating/centralized-review/message.json new file mode 100644 index 00000000..6d6456f5 --- /dev/null +++ b/static/schema/risk-rating/centralized-review/message.json @@ -0,0 +1,19 @@ +{ + "@context": "https://schema.org", + "type": "Message", + "name": "ADA-USD", + "isBasedOn": { + "@type": "MediaObject", + "name": "Exchange data", + "additionalType": "Central Exchange Data", + "description": "the raw information received by an Orcfax collector from a central exchange (CEX) API" + }, + "sender": "https://api.pro.coinbase.com/products/ADA-USD/ticker", + "recipient": "coinbase.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e", + "identifier": "urn:orcfax:e4e54362-4c14-49f6-9d80-08617d81243e", + "dateReceived": "2024-08-28T16:20:20Z", + "messageAttachment": { + "encoding": "application/json;base64", + "text": "eyJyZXF1ZXN0X3VybCI6ICJodHRwczovL2FwaS5wcm8uY29pbmJhc2UuY29tL3Byb2R1Y3RzL0FEQS1VU0QvdGlja2VyIiwgInJlc3BvbnNlIjogeyJib2R5IjogeyJhc2siOiAiMC4zNDIyIiwgImJpZCI6ICIwLjM0MjEiLCAicHJpY2UiOiAiMC4zNDIzIiwgInJmcV92b2x1bWUiOiAiMTQ3MDcyNS4zMzYwNTAiLCAic2l6ZSI6ICI3Ny4yOTU2NjA4OCIsICJ0aW1lIjogIjIwMjQtMDgtMjhUMTY6MjA6MjAuNjQ4MTg2WiIsICJ0cmFkZV9pZCI6IDExMDM4MzE5NSwgInZvbHVtZSI6ICIyNDE0ODA1Ni42OTI2OTkzMyJ9LCAiaGVhZGVycyI6IHsiQWNjZXB0LVJhbmdlcyI6IFsiYnl0ZXMiXSwgIkFjY2Vzcy1Db250cm9sLUFsbG93LUhlYWRlcnMiOiBbIkNvbnRlbnQtVHlwZSwgQWNjZXB0LCBjYi1zZXNzaW9uLCBjYi1mcCwgY2ItZm9ybS1mYWN0b3IiXSwgIkFjY2Vzcy1Db250cm9sLUFsbG93LU1ldGhvZHMiOiBbIkdFVCxQT1NULERFTEVURSxQVVQiXSwgIkFjY2Vzcy1Db250cm9sLUFsbG93LU9yaWdpbiI6IFsiKiJdLCAiQWNjZXNzLUNvbnRyb2wtRXhwb3NlLUhlYWRlcnMiOiBbImNiLWJlZm9yZSwgY2ItYWZ0ZXIsIGNiLWdkcHIiXSwgIkFjY2Vzcy1Db250cm9sLU1heC1BZ2UiOiBbIjcyMDAiXSwgIkNhY2hlLUNvbnRyb2wiOiBbInB1YmxpYywgbWF4LWFnZT0xLCBtdXN0LXJldmFsaWRhdGUiXSwgIkNmLUNhY2hlLVN0YXR1cyI6IFsiSElUIl0sICJDZi1SYXkiOiBbIjhiYTVhMGVmYWQ2YjYzZTktTEhSIl0sICJDb250ZW50LVR5cGUiOiBbImFwcGxpY2F0aW9uL2pzb247IGNoYXJzZXQ9dXRmLTgiXSwgIkRhdGUiOiBbIldlZCwgMjggQXVnIDIwMjQgMTY6MjA6MjYgR01UIl0sICJFdGFnIjogWyJXL1wiYTEtNGtPdHdKc0VPY29DMGViKzRtV3B4dys0bnBvXCIiXSwgIlNlcnZlciI6IFsiY2xvdWRmbGFyZSJdLCAiU2V0LUNvb2tpZSI6IFsiX19jZl9ibT1aeklRV185bWhjWjFyaE1JWG9lcXBvMF8zd1lqcXRHT205ZVFjZ1ROT2F3LTE3MjQ4NjIwMjYtMS4wLjEuMS1CeDJjTFBQQVllYWtsOS5VT3NldndGRGZDd3JNbE1LMXZmVkE0aVJvNTFMRDdBRmZtSUNPSzJ2NEZqWS5VQThOT3dHRHdXZm5RbktXemgwSTltdk9zQTsgcGF0aD0vOyBleHBpcmVzPVdlZCwgMjgtQXVnLTI0IDE2OjUwOjI2IEdNVDsgZG9tYWluPS5wcm8uY29pbmJhc2UuY29tOyBIdHRwT25seTsgU2VjdXJlOyBTYW1lU2l0ZT1Ob25lIl0sICJTdHJpY3QtVHJhbnNwb3J0LVNlY3VyaXR5IjogWyJtYXgtYWdlPTE1NTUyMDAwOyBpbmNsdWRlU3ViRG9tYWlucyJdLCAiVmFyeSI6IFsiQWNjZXB0LUVuY29kaW5nIl0sICJYLUNvbnRlbnQtVHlwZS1PcHRpb25zIjogWyJub3NuaWZmIl0sICJYLURucy1QcmVmZXRjaC1Db250cm9sIjogWyJvZmYiXSwgIlgtRG93bmxvYWQtT3B0aW9ucyI6IFsibm9vcGVuIl0sICJYLUZyYW1lLU9wdGlvbnMiOiBbIlNBTUVPUklHSU4iXSwgIlgtWHNzLVByb3RlY3Rpb24iOiBbIjE7IG1vZGU9YmxvY2siXX19fQ==" + } +} diff --git a/static/schema/risk-rating/centralized-review/validation.json b/static/schema/risk-rating/centralized-review/validation.json new file mode 100644 index 00000000..c9f2abb8 --- /dev/null +++ b/static/schema/risk-rating/centralized-review/validation.json @@ -0,0 +1,93 @@ +{ + "@context": "https://schema.org", + "type": "MediaObject", + "identifier": "urn:orcfax:11ceadf4-69d6-4b96-9401-c0a1e7e5d3eb", + "isBasedOn": { + "@type": "MediaObject", + "name": "the raw information sent to an Orcfax validator by an Orcfax node", + "identifier": "urn:orcfax:node:2a531a7e-4961-4895-985d-1fa9aaaf50a2" + }, + "contributor": { + "@type": "Organization", + "name": "AS14061 DigitalOcean, LLC", + "locationCreated": { + "address": { + "@type": "PostalAddress", + "addressLocality": "London", + "addressRegion": "England, GB,", + "geo": "51.5085,-0.1257" + } + } + }, + "additionalType": [ + { + "@type": "Event", + "description": "successful content signature generation for Orcfax node data", + "startDate": "2024-08-28T16:20:35Z", + "recordedIn": { + "@type": "CreativeWork", + "description": { + "@type": "TextObject", + "comment": "an Orcfax content signature is a sha256 digest of a node's 'collected timestamp', 'data-points' in-order and the 'node identifier' (uuid)", + "sha256": "33ac6c61317e8909871a759e025c82f8155a1739d7e4128f9231e527e1584572" + }, + "hasPart": [ + { + "@type": "CreativeWork", + "description": "collecting timestamp", + "text": "2024-08-28T16:20:26Z" + }, + { + "@type": "CreativeWork", + "description": "data points for ADA-USD", + "text": [ + "0.34541", + "0.3423", + "0.342465", + "0.3420342", + "0.34335" + ] + }, + { + "@type": "CreativeWork", + "description": "node identifier (uuid)", + "text": "2a531a7e-4961-4895-985d-1fa9aaaf50a2" + } + ] + } + }, + { + "@type": "Event", + "description": "selection of median value from collected node data", + "startDate": "2024-08-28T16:20:35Z", + "about": { + "@type": "StatisticalVariable", + "measurementMethod": "median calculation of a minimum of three data sources from the selected collector node", + "measurementTechnique": [ + { + "@type": "PropertyValue", + "name": "SoftwareApplication", + "value": "Python 3.11.6 (main, Apr 10 2024, 17:26:07) [GCC 13.2.0] on Linux-6.5.0-44-generic-x86_64-with-glibc2.38" + }, + { + "@type": "PropertyValue", + "name": "SoftwarePackage", + "value": "statistics" + } + ], + "variableMeasured": { + "@type": "Observation", + "measurementMethod": "median value", + "value": 0.342465, + "valueReference": [ + "0.34541", + "0.3423", + "0.342465", + "0.3420342", + "0.34335" + ] + } + } + } + ] +} diff --git a/static/schema/risk-rating/decentralized-review/fact-statement-datum.json b/static/schema/risk-rating/decentralized-review/fact-statement-datum.json new file mode 100644 index 00000000..600554f5 --- /dev/null +++ b/static/schema/risk-rating/decentralized-review/fact-statement-datum.json @@ -0,0 +1,4 @@ +{ + "context": "https://schema.org", + "TBD": "TBD" +} diff --git a/static/schema/risk-rating/decentralized-review/fact-statement.json b/static/schema/risk-rating/decentralized-review/fact-statement.json new file mode 100644 index 00000000..600554f5 --- /dev/null +++ b/static/schema/risk-rating/decentralized-review/fact-statement.json @@ -0,0 +1,4 @@ +{ + "context": "https://schema.org", + "TBD": "TBD" +} diff --git a/static/schema/risk-rating/decentralized-review/message.json b/static/schema/risk-rating/decentralized-review/message.json new file mode 100644 index 00000000..600554f5 --- /dev/null +++ b/static/schema/risk-rating/decentralized-review/message.json @@ -0,0 +1,4 @@ +{ + "context": "https://schema.org", + "TBD": "TBD" +} diff --git a/static/schema/risk-rating/decentralized-review/validation.json b/static/schema/risk-rating/decentralized-review/validation.json new file mode 100644 index 00000000..600554f5 --- /dev/null +++ b/static/schema/risk-rating/decentralized-review/validation.json @@ -0,0 +1,4 @@ +{ + "context": "https://schema.org", + "TBD": "TBD" +} From 634503b1cae80a800f50f0842c57f90c94b01457 Mon Sep 17 00:00:00 2001 From: Christian-MK <105018870+Christian-MK@users.noreply.github.com> Date: Fri, 20 Mar 2026 12:12:09 -0700 Subject: [PATCH 7/9] adds section for custom feed components --- docs/available-feeds/custom/_category.json | 5 ++ .../custom/fact-statement-datum.mdx | 46 ++++++++++++++++++ .../available-feeds/custom/fact-statement.mdx | 48 +++++++++++++++++++ docs/available-feeds/custom/message.mdx | 44 +++++++++++++++++ docs/available-feeds/custom/validation.mdx | 44 +++++++++++++++++ .../custom-feeds/fact-statement-datum.json | 4 ++ .../custom/custom-feeds/fact-statement.json | 4 ++ .../schema/custom/custom-feeds/message.json | 4 ++ .../custom/custom-feeds/validation.json | 4 ++ 9 files changed, 203 insertions(+) create mode 100644 docs/available-feeds/custom/_category.json create mode 100644 docs/available-feeds/custom/fact-statement-datum.mdx create mode 100644 docs/available-feeds/custom/fact-statement.mdx create mode 100644 docs/available-feeds/custom/message.mdx create mode 100644 docs/available-feeds/custom/validation.mdx create mode 100644 static/schema/custom/custom-feeds/fact-statement-datum.json create mode 100644 static/schema/custom/custom-feeds/fact-statement.json create mode 100644 static/schema/custom/custom-feeds/message.json create mode 100644 static/schema/custom/custom-feeds/validation.json diff --git a/docs/available-feeds/custom/_category.json b/docs/available-feeds/custom/_category.json new file mode 100644 index 00000000..b69305a1 --- /dev/null +++ b/docs/available-feeds/custom/_category.json @@ -0,0 +1,5 @@ +{ + "label": "Custom", + "position": 6, + "link": null +} diff --git a/docs/available-feeds/custom/fact-statement-datum.mdx b/docs/available-feeds/custom/fact-statement-datum.mdx new file mode 100644 index 00000000..e571d041 --- /dev/null +++ b/docs/available-feeds/custom/fact-statement-datum.mdx @@ -0,0 +1,46 @@ +--- +id: centralized-review-2 +sidebar_position: 2 +slug: /custom-fact-statement-datum +--- + +import CodeBlock from "@theme/CodeBlock"; +import factStatementDatum from "/schema/custom/custom-feeds/fact-statement-datum.json"; + +# Fact Statement Datum + +A description of the types/properties relevant to a `fact-statement-datum.json`. + +Orcfax utilizes the following Schema.org types and properties in its Fact +Statement Datum records. The description provided by [Schema.org][schema-1] +follows each; if Orcfax maintains a more nuanced understanding, an additional +definition will be provided. If the term appears in its own definition, it will +be replaced when possible with a \[synonym\] in order to aid understanding. + +[schema-1]: https://schema.org/ + +## Schema.org Types + +| Type | Schema.org description | Orcfax description | +| -------- | --------------------------- | ---------------------- | +| -------- | --------------------------- | ---------------------- | + +## Schema.org Properties + +| Property | Type | Schema.org description | Orcfax definition | +| ------------ | -------- | --------------------------- | --------------------- | +| ------------ | -------- | --------------------------- | --------------------- | + +## Fact Statement Datum example + + + {JSON.stringify(factStatementDatum, null, 2)} + + + + Download + diff --git a/docs/available-feeds/custom/fact-statement.mdx b/docs/available-feeds/custom/fact-statement.mdx new file mode 100644 index 00000000..6cc3cf5c --- /dev/null +++ b/docs/available-feeds/custom/fact-statement.mdx @@ -0,0 +1,48 @@ +--- +id: centralized-review-1 +sidebar_position: 1 +slug: /custom-fact-statement +--- + +import CodeBlock from "@theme/CodeBlock"; +import factStatement from "/schema/custom/custom-feeds/fact-statement.json"; + +# Fact Statement + +A description of the types/properties relevant to a `fact-statement.json`. + +Orcfax utilizes the following Schema.org types and properties in its Fact +Statement records. The description provided by [Schema.org][schema-1] follows +each; if Orcfax maintains a more nuanced understanding, an additional definition +will be provided. If the term appears in its own definition, it will be replaced +when possible with a \[synonym\] in order to aid understanding. + +[schema-1]: https://schema.org/ + +## Schema.org Types + +| Type | Schema.org description | Orcfax description | +| -------- | --------------------------- | ---------------------- | +| -------- | --------------------------- | ---------------------- | + +Types under review for development + +TBD + +## Schema.org Properties + +| Property | Type | Schema.org description | Orcfax definition | +| ------------ | -------- | --------------------------- | --------------------- | +| ------------ | -------- | --------------------------- | --------------------- | + +## Fact Statement example + +{JSON.stringify(factStatement, null, 2)} + + + Download + diff --git a/docs/available-feeds/custom/message.mdx b/docs/available-feeds/custom/message.mdx new file mode 100644 index 00000000..bc3c7782 --- /dev/null +++ b/docs/available-feeds/custom/message.mdx @@ -0,0 +1,44 @@ +--- +id: centralized-review-3 +sidebar_position: 3 +slug: /custom-message +--- + +import CodeBlock from "@theme/CodeBlock"; +import Message from "/schema/custom/custom-feeds/message.json"; + +# Message + +A description of the types/properties relevant to a `message.json`. + +Orcfax utilizes the following Schema.org types and properties in its Message +records. The description provided by [Schema.org][schema-1] follows each; if +Orcfax maintains a more nuanced understanding, an additional definition will be +provided. If the term appears in its own definition, it will be replaced when +possible with a \[synonym\] in order to aid understanding. + +[schema-1]: https://schema.org/ + +## Schema.org Types + +| Type | Schema.org description | Orcfax description | +| -------- | --------------------------- | ---------------------- | +| -------- | --------------------------- | ---------------------- | + +## Schema.org Properties + +| Property | Type | Schema.org description | Orcfax definition | +| ------------ | -------- | --------------------------- | --------------------- | +| ------------ | -------- | --------------------------- | --------------------- | + +## Message example + +{JSON.stringify(Message, null, 2)} + + + Download + diff --git a/docs/available-feeds/custom/validation.mdx b/docs/available-feeds/custom/validation.mdx new file mode 100644 index 00000000..fad4d94f --- /dev/null +++ b/docs/available-feeds/custom/validation.mdx @@ -0,0 +1,44 @@ +--- +id: centralized-review-4 +sidebar_position: 4 +slug: /custom-validation +--- + +import CodeBlock from "@theme/CodeBlock"; +import Validation from "/schema/custom/custom-feeds/validation.json"; + +# Validation + +A description of the types/properties relevant to a `validation.json`. + +Orcfax utilizes the following Schema.org types and properties in its Validation +records. The description provided by [Schema.org][schema-1] follows each; if +Orcfax maintains a more nuanced understanding, an additional definition will be +provided. If the term appears in its own definition, it will be replaced when +possible with a \[synonym\] in order to aid understanding. + +[schema-1]: https://schema.org/ + +## Schema.org Types + +| Type | Schema.org description | Orcfax description | +| -------- | --------------------------- | ---------------------- | +| -------- | --------------------------- | ---------------------- | + +## Schema.org Properties + +| Property | Type | Schema.org description | Orcfax definition | +| ------------ | -------- | --------------------------- | --------------------- | +| ------------ | -------- | --------------------------- | --------------------- | + +## Validation example + +{JSON.stringify(Validation, null, 2)} + + + Download + diff --git a/static/schema/custom/custom-feeds/fact-statement-datum.json b/static/schema/custom/custom-feeds/fact-statement-datum.json new file mode 100644 index 00000000..600554f5 --- /dev/null +++ b/static/schema/custom/custom-feeds/fact-statement-datum.json @@ -0,0 +1,4 @@ +{ + "context": "https://schema.org", + "TBD": "TBD" +} diff --git a/static/schema/custom/custom-feeds/fact-statement.json b/static/schema/custom/custom-feeds/fact-statement.json new file mode 100644 index 00000000..600554f5 --- /dev/null +++ b/static/schema/custom/custom-feeds/fact-statement.json @@ -0,0 +1,4 @@ +{ + "context": "https://schema.org", + "TBD": "TBD" +} diff --git a/static/schema/custom/custom-feeds/message.json b/static/schema/custom/custom-feeds/message.json new file mode 100644 index 00000000..600554f5 --- /dev/null +++ b/static/schema/custom/custom-feeds/message.json @@ -0,0 +1,4 @@ +{ + "context": "https://schema.org", + "TBD": "TBD" +} diff --git a/static/schema/custom/custom-feeds/validation.json b/static/schema/custom/custom-feeds/validation.json new file mode 100644 index 00000000..600554f5 --- /dev/null +++ b/static/schema/custom/custom-feeds/validation.json @@ -0,0 +1,4 @@ +{ + "context": "https://schema.org", + "TBD": "TBD" +} From de7038eb8a2d1295b3862ebd85d0fac1e4985169 Mon Sep 17 00:00:00 2001 From: Christian-MK <105018870+Christian-MK@users.noreply.github.com> Date: Fri, 20 Mar 2026 12:18:51 -0700 Subject: [PATCH 8/9] corrects previous commit issue --- docs/available-feeds/feed-overview.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/available-feeds/feed-overview.md b/docs/available-feeds/feed-overview.md index 70f50ba9..83574226 100644 --- a/docs/available-feeds/feed-overview.md +++ b/docs/available-feeds/feed-overview.md @@ -61,7 +61,6 @@ separated design documents for each respectively. [cex-3]: https://tradenation.com/articles/base-currency-and-quote-currency/ [cex-form]: available-feeds/CER/CEX/fact-statement.mdx [dex-form]: available-feeds/CER/DEX/fact-statement.mdx -[glossary]: https://glossary.orcfax.io ## Subsidized feeds From 6c34761e251116855a7f395bacd3f5f45fd780d9 Mon Sep 17 00:00:00 2001 From: Gabriel Chartier Date: Fri, 20 Mar 2026 14:41:06 -0500 Subject: [PATCH 9/9] fix pre-commit hook to format and then lint --- .github/workflows/pre-commit.yml | 41 ++++----- package.json | 137 +++++++++++++++---------------- 2 files changed, 89 insertions(+), 89 deletions(-) diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml index e18c54dd..e12fa0a7 100644 --- a/.github/workflows/pre-commit.yml +++ b/.github/workflows/pre-commit.yml @@ -1,24 +1,25 @@ name: pre-commit on: - pull_request: - push: - branches: [main] + pull_request: + push: + branches: [main] jobs: - pre-commit: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 - with: - python-version: "3.14" - - uses: actions/setup-node@v4 - with: - node-version: ">=18.0" - - name: Install dependencies - run: npm install - - uses: pre-commit/action@v3.0.0 - - name: Run eslint and prettier linting checks - run: | - npm cache clean --force - npm run lint + pre-commit: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + with: + python-version: "3.14" + - uses: actions/setup-node@v4 + with: + node-version: ">=18.0" + - name: Install dependencies + run: npm install + - uses: pre-commit/action@v3.0.0 + - name: Run eslint and prettier linting checks + run: | + npm cache clean --force + npm run format + npm run lint diff --git a/package.json b/package.json index c0646dd4..50f3b312 100644 --- a/package.json +++ b/package.json @@ -1,71 +1,70 @@ { - "name": "docs", - "version": "0.0.0", - "private": true, - "scripts": { - "docusaurus": "docusaurus", - "start": "docusaurus start", - "build": "docusaurus build", - "swizzle": "docusaurus swizzle", - "deploy": "docusaurus deploy", - "clear": "docusaurus clear", - "serve": "docusaurus serve", - "write-translations": "docusaurus write-translations", - "write-heading-ids": "docusaurus write-heading-ids", - "typecheck": "tsc", - "lint": "prettier --check . && eslint .", - "lint-write": "prettier --write .", - "format": "prettier --write .", - "pre-commit": "pre-commit run --all-files", - "prepare": "husky" - }, - "dependencies": { - "@docusaurus/core": "^3.6.1", - "@docusaurus/preset-classic": "^3.6.1", - "@docusaurus/theme-mermaid": "^3.6.1", - "@easyops-cn/docusaurus-search-local": "^0.52.2", - "@mdx-js/react": "^3.0.0", - "clsx": "^2.0.0", - "inquirer": "^13.1.0", - "prism-react-renderer": "^2.3.0", - "react": "^18.0.0", - "react-dom": "^18.0.0", - "rehype-katex": "^7.0.1", - "remark-math": "^6.0.0" - }, - "devDependencies": { - "@docusaurus/module-type-aliases": "3.9.2", - "@docusaurus/tsconfig": "3.9.2", - "@docusaurus/types": "3.6.0", - "@eslint/js": "^9.14.0", - "@types/eslint-config-prettier": "^6.11.3", - "eslint": "^9.39.2", - "eslint-config-prettier": "^10.1.8", - "eslint-plugin-react": "^7.37.2", - "globals": "^17.0.0", - "husky": "^9.1.7", - "lint-staged": "^15.2.10", - "prettier": "3.3.3", - "typescript": "~5.6.2", - "typescript-eslint": "^8.13.0" - }, - "browserslist": { - "production": [ - ">0.5%", - "not dead", - "not op_mini all" - ], - "development": [ - "last 3 chrome version", - "last 3 firefox version", - "last 5 safari version" - ] - }, - "engines": { - "node": ">=18.0" - }, - "lint-staged": { - "*.js": "eslint --cache --fix", - "*.{js,css,md}": "prettier --write" - } + "name": "docs", + "version": "0.0.0", + "private": true, + "scripts": { + "docusaurus": "docusaurus", + "start": "docusaurus start", + "build": "docusaurus build", + "swizzle": "docusaurus swizzle", + "deploy": "docusaurus deploy", + "clear": "docusaurus clear", + "serve": "docusaurus serve", + "write-translations": "docusaurus write-translations", + "write-heading-ids": "docusaurus write-heading-ids", + "typecheck": "tsc", + "lint": "eslint .", + "format": "prettier --write .", + "pre-commit": "pre-commit run --all-files", + "prepare": "husky" + }, + "dependencies": { + "@docusaurus/core": "^3.6.1", + "@docusaurus/preset-classic": "^3.6.1", + "@docusaurus/theme-mermaid": "^3.6.1", + "@easyops-cn/docusaurus-search-local": "^0.52.2", + "@mdx-js/react": "^3.0.0", + "clsx": "^2.0.0", + "inquirer": "^13.1.0", + "prism-react-renderer": "^2.3.0", + "react": "^18.0.0", + "react-dom": "^18.0.0", + "rehype-katex": "^7.0.1", + "remark-math": "^6.0.0" + }, + "devDependencies": { + "@docusaurus/module-type-aliases": "3.9.2", + "@docusaurus/tsconfig": "3.9.2", + "@docusaurus/types": "3.6.0", + "@eslint/js": "^9.14.0", + "@types/eslint-config-prettier": "^6.11.3", + "eslint": "^9.39.2", + "eslint-config-prettier": "^10.1.8", + "eslint-plugin-react": "^7.37.2", + "globals": "^17.0.0", + "husky": "^9.1.7", + "lint-staged": "^15.2.10", + "prettier": "3.3.3", + "typescript": "~5.6.2", + "typescript-eslint": "^8.13.0" + }, + "browserslist": { + "production": [ + ">0.5%", + "not dead", + "not op_mini all" + ], + "development": [ + "last 3 chrome version", + "last 3 firefox version", + "last 5 safari version" + ] + }, + "engines": { + "node": ">=18.0" + }, + "lint-staged": { + "*.js": "eslint --cache --fix", + "*.{js,css,md}": "prettier --write" + } }