From 9c1aa48c23215e967cda798cc8f3d8770bdc6002 Mon Sep 17 00:00:00 2001 From: Christian-MK <105018870+Christian-MK@users.noreply.github.com> Date: Mon, 23 Sep 2024 13:51:43 -0700 Subject: [PATCH 01/15] first draft of xerberus feed w/ FS --- .../centralized-review/_category.json | 4 + .../fact-statement-datum.json | 16 ++++ .../fact-statement-datum.md | 41 ++++++++ .../centralized-review/fact-statement.json | 36 +++++++ .../centralized-review/fact-statement.md | 49 ++++++++++ .../centralized-review/message.json | 19 ++++ .../centralized-review/message.md | 39 ++++++++ .../centralized-review/validation.json | 93 +++++++++++++++++++ .../centralized-review/validation.md | 41 ++++++++ .../decentralized-review/_category.json | 4 + .../fact-statement-datum.json | 16 ++++ .../fact-statement-datum.md | 41 ++++++++ .../decentralized-review/fact-statement.json | 36 +++++++ .../decentralized-review/fact-statement.md | 48 ++++++++++ .../decentralized-review/message.json | 19 ++++ .../decentralized-review/message.md | 39 ++++++++ .../decentralized-review/validation.json | 93 +++++++++++++++++++ .../decentralized-review/validation.md | 41 ++++++++ .../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 + 26 files changed, 854 insertions(+) create mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/_category.json create mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.json create mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.md create mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.json create mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.md create mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/message.json create mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/message.md create mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/validation.json create mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/validation.md create mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/_category.json create mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.json create mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.md create mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.json create mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.md create mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/message.json create mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/message.md create mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/validation.json create mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/validation.md 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/orcfax-feeds/risk-ratings/centralized-review/_category.json b/docs/orcfax-feeds/risk-ratings/centralized-review/_category.json new file mode 100644 index 00000000..8ee30b1c --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/centralized-review/_category.json @@ -0,0 +1,4 @@ +{ + "label": "centralized-review", + "position": 2 + } diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.json b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.json new file mode 100644 index 00000000..daf565f2 --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/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/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.md b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.md new file mode 100644 index 00000000..ce0e18fe --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.md @@ -0,0 +1,41 @@ +--- +id: centralized-review-2 +sidebar_position: 2 +slug: /centralized-review-fact-statement-datum +--- + +import CodeBlock from '@theme/CodeBlock'; +import factStatementDatum from '!!raw-loader!/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 + +{factStatementDatum} + + +Download + diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.json b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.json new file mode 100644 index 00000000..1598a601 --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.json @@ -0,0 +1,36 @@ +{ + "@context": "https://schema.org", + "type": "Claim", + "description": "ADA price in USD", + "identifier": "urn:orcfax:70722c2b-8905-47a1-8be3-5032290a44b9", + "dateCreated": "2024-08-28T16:20:35Z", + "text": "The price of 1 ADA at 2024-08-28T16:20:35Z is 0.342465 USD", + "about": { + "@type": "ExchangeRateSpecification", + "currency": "ADA", + "currentExchangeRate": { + "@type": "UnitPriceSpecification", + "price": 0.342465, + "priceCurrency": "USD" + } + }, + "claimInterpreter": { + "@type": "Organization", + "name": "Orcfax", + "url": "https://orcfax.io/" + }, + "appearance": [ + "message-ADA-USD-bitstamp.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json", + "message-ADA-USD-coinbase.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-20Z.json", + "message-ADA-USD-kraken.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json", + "message-ADA-USD-kucoin_prices_simple.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json", + "message-ADA-USD-bitfinex_simple.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json" + ], + "isBasedOn": { + "@type": "CreativeWork", + "name": "validation-ADA-USD-2024-08-28T16-20-35Z.json", + "creator": "Orcfax Validator Node: 1.0.0rc23", + "identifier": "urn:orcfax:11ceadf4-69d6-4b96-9401-c0a1e7e5d3eb", + "license": "https://creativecommons.org/licenses/by/4.0/" + } + } diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.md b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.md new file mode 100644 index 00000000..910298d8 --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.md @@ -0,0 +1,49 @@ +--- +id: centralized-review-1 +sidebar_position: 1 +slug: /centralized-review-fact-statement +--- + +import CodeBlock from '@theme/CodeBlock'; +import factStatement from '!!raw-loader!/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 | +| ------------ | -------- | ---------------------------| --------------------- | +| ------------ | -------- | ---------------------------| --------------------- | + +## Fact Statement example + +{factStatement} + + +Download + diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/message.json b/docs/orcfax-feeds/risk-ratings/centralized-review/message.json new file mode 100644 index 00000000..690a109f --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/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/docs/orcfax-feeds/risk-ratings/centralized-review/message.md b/docs/orcfax-feeds/risk-ratings/centralized-review/message.md new file mode 100644 index 00000000..de1e65cb --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/centralized-review/message.md @@ -0,0 +1,39 @@ +--- +id: centralized-review-3 +sidebar_position: 3 +slug: /centralized-review-message +--- + +import CodeBlock from '@theme/CodeBlock'; +import Message from '!!raw-loader!/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 + +{Message} + +Download diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/validation.json b/docs/orcfax-feeds/risk-ratings/centralized-review/validation.json new file mode 100644 index 00000000..a39803ee --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/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/docs/orcfax-feeds/risk-ratings/centralized-review/validation.md b/docs/orcfax-feeds/risk-ratings/centralized-review/validation.md new file mode 100644 index 00000000..81984b8a --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/centralized-review/validation.md @@ -0,0 +1,41 @@ +--- +id: centralized-review-4 +sidebar_position: 4 +slug: /centralized-review-validation +--- + +import CodeBlock from '@theme/CodeBlock'; +import Validation from '!!raw-loader!/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 + +{Validation} + + +Download + diff --git a/docs/orcfax-feeds/risk-ratings/decentralized-review/_category.json b/docs/orcfax-feeds/risk-ratings/decentralized-review/_category.json new file mode 100644 index 00000000..6382d9a7 --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/decentralized-review/_category.json @@ -0,0 +1,4 @@ +{ + "label": "decentralized-review", + "position": 2 + } diff --git a/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.json b/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.json new file mode 100644 index 00000000..daf565f2 --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/decentralized-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/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.md b/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.md new file mode 100644 index 00000000..e379904c --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.md @@ -0,0 +1,41 @@ +--- +id: decentralized-review-2 +sidebar_position: 2 +slug: /decentralized-review-fact-statement-datum +--- + +import CodeBlock from '@theme/CodeBlock'; +import factStatementDatum from '!!raw-loader!/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 + +{factStatementDatum} + + +Download + diff --git a/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.json b/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.json new file mode 100644 index 00000000..1598a601 --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.json @@ -0,0 +1,36 @@ +{ + "@context": "https://schema.org", + "type": "Claim", + "description": "ADA price in USD", + "identifier": "urn:orcfax:70722c2b-8905-47a1-8be3-5032290a44b9", + "dateCreated": "2024-08-28T16:20:35Z", + "text": "The price of 1 ADA at 2024-08-28T16:20:35Z is 0.342465 USD", + "about": { + "@type": "ExchangeRateSpecification", + "currency": "ADA", + "currentExchangeRate": { + "@type": "UnitPriceSpecification", + "price": 0.342465, + "priceCurrency": "USD" + } + }, + "claimInterpreter": { + "@type": "Organization", + "name": "Orcfax", + "url": "https://orcfax.io/" + }, + "appearance": [ + "message-ADA-USD-bitstamp.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json", + "message-ADA-USD-coinbase.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-20Z.json", + "message-ADA-USD-kraken.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json", + "message-ADA-USD-kucoin_prices_simple.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json", + "message-ADA-USD-bitfinex_simple.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json" + ], + "isBasedOn": { + "@type": "CreativeWork", + "name": "validation-ADA-USD-2024-08-28T16-20-35Z.json", + "creator": "Orcfax Validator Node: 1.0.0rc23", + "identifier": "urn:orcfax:11ceadf4-69d6-4b96-9401-c0a1e7e5d3eb", + "license": "https://creativecommons.org/licenses/by/4.0/" + } + } diff --git a/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.md b/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.md new file mode 100644 index 00000000..9fffee11 --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.md @@ -0,0 +1,48 @@ +--- +id: decentralized-review-1 +sidebar_position: 1 +slug: /decentralized-review-fact-statement +--- + +import CodeBlock from '@theme/CodeBlock'; +import factStatement from '!!raw-loader!/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 + +{factStatement} + + +Download + diff --git a/docs/orcfax-feeds/risk-ratings/decentralized-review/message.json b/docs/orcfax-feeds/risk-ratings/decentralized-review/message.json new file mode 100644 index 00000000..690a109f --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/decentralized-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/docs/orcfax-feeds/risk-ratings/decentralized-review/message.md b/docs/orcfax-feeds/risk-ratings/decentralized-review/message.md new file mode 100644 index 00000000..36a925de --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/decentralized-review/message.md @@ -0,0 +1,39 @@ +--- +id: decentralized-review-3 +sidebar_position: 3 +slug: /decentralized-review-message +--- + +import CodeBlock from '@theme/CodeBlock'; +import Message from '!!raw-loader!/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 + +{Message} + +Download diff --git a/docs/orcfax-feeds/risk-ratings/decentralized-review/validation.json b/docs/orcfax-feeds/risk-ratings/decentralized-review/validation.json new file mode 100644 index 00000000..a39803ee --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/decentralized-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/docs/orcfax-feeds/risk-ratings/decentralized-review/validation.md b/docs/orcfax-feeds/risk-ratings/decentralized-review/validation.md new file mode 100644 index 00000000..b2413f03 --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/decentralized-review/validation.md @@ -0,0 +1,41 @@ +--- +id: decentralized-review-4 +sidebar_position: 4 +slug: /decentralized-review-validation +--- + +import CodeBlock from '@theme/CodeBlock'; +import Validation from '!!raw-loader!/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 + +{Validation} + + +Download + 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..daf565f2 --- /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..6374b716 --- /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": "DDD", + "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..690a109f --- /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..a39803ee --- /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 dc1c4349d8e7eb479d6747dad282af300b016892 Mon Sep 17 00:00:00 2001 From: Christian-MK <105018870+Christian-MK@users.noreply.github.com> Date: Tue, 24 Sep 2024 10:40:49 -0700 Subject: [PATCH 02/15] fixes worstRating & removes json from docs/ --- .../fact-statement-datum.json | 16 ---- .../centralized-review/fact-statement.json | 36 ------- .../centralized-review/message.json | 19 ---- .../centralized-review/validation.json | 93 ------------------- .../fact-statement-datum.json | 16 ---- .../decentralized-review/fact-statement.json | 36 ------- .../decentralized-review/message.json | 19 ---- .../decentralized-review/validation.json | 93 ------------------- .../centralized-review/fact-statement.json | 2 +- 9 files changed, 1 insertion(+), 329 deletions(-) delete mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.json delete mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.json delete mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/message.json delete mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/validation.json delete mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.json delete mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.json delete mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/message.json delete mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/validation.json diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.json b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.json deleted file mode 100644 index daf565f2..00000000 --- a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "@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/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.json b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.json deleted file mode 100644 index 1598a601..00000000 --- a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "@context": "https://schema.org", - "type": "Claim", - "description": "ADA price in USD", - "identifier": "urn:orcfax:70722c2b-8905-47a1-8be3-5032290a44b9", - "dateCreated": "2024-08-28T16:20:35Z", - "text": "The price of 1 ADA at 2024-08-28T16:20:35Z is 0.342465 USD", - "about": { - "@type": "ExchangeRateSpecification", - "currency": "ADA", - "currentExchangeRate": { - "@type": "UnitPriceSpecification", - "price": 0.342465, - "priceCurrency": "USD" - } - }, - "claimInterpreter": { - "@type": "Organization", - "name": "Orcfax", - "url": "https://orcfax.io/" - }, - "appearance": [ - "message-ADA-USD-bitstamp.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json", - "message-ADA-USD-coinbase.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-20Z.json", - "message-ADA-USD-kraken.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json", - "message-ADA-USD-kucoin_prices_simple.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json", - "message-ADA-USD-bitfinex_simple.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json" - ], - "isBasedOn": { - "@type": "CreativeWork", - "name": "validation-ADA-USD-2024-08-28T16-20-35Z.json", - "creator": "Orcfax Validator Node: 1.0.0rc23", - "identifier": "urn:orcfax:11ceadf4-69d6-4b96-9401-c0a1e7e5d3eb", - "license": "https://creativecommons.org/licenses/by/4.0/" - } - } diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/message.json b/docs/orcfax-feeds/risk-ratings/centralized-review/message.json deleted file mode 100644 index 690a109f..00000000 --- a/docs/orcfax-feeds/risk-ratings/centralized-review/message.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "@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/docs/orcfax-feeds/risk-ratings/centralized-review/validation.json b/docs/orcfax-feeds/risk-ratings/centralized-review/validation.json deleted file mode 100644 index a39803ee..00000000 --- a/docs/orcfax-feeds/risk-ratings/centralized-review/validation.json +++ /dev/null @@ -1,93 +0,0 @@ -{ - "@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/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.json b/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.json deleted file mode 100644 index daf565f2..00000000 --- a/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "@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/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.json b/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.json deleted file mode 100644 index 1598a601..00000000 --- a/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "@context": "https://schema.org", - "type": "Claim", - "description": "ADA price in USD", - "identifier": "urn:orcfax:70722c2b-8905-47a1-8be3-5032290a44b9", - "dateCreated": "2024-08-28T16:20:35Z", - "text": "The price of 1 ADA at 2024-08-28T16:20:35Z is 0.342465 USD", - "about": { - "@type": "ExchangeRateSpecification", - "currency": "ADA", - "currentExchangeRate": { - "@type": "UnitPriceSpecification", - "price": 0.342465, - "priceCurrency": "USD" - } - }, - "claimInterpreter": { - "@type": "Organization", - "name": "Orcfax", - "url": "https://orcfax.io/" - }, - "appearance": [ - "message-ADA-USD-bitstamp.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json", - "message-ADA-USD-coinbase.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-20Z.json", - "message-ADA-USD-kraken.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json", - "message-ADA-USD-kucoin_prices_simple.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json", - "message-ADA-USD-bitfinex_simple.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json" - ], - "isBasedOn": { - "@type": "CreativeWork", - "name": "validation-ADA-USD-2024-08-28T16-20-35Z.json", - "creator": "Orcfax Validator Node: 1.0.0rc23", - "identifier": "urn:orcfax:11ceadf4-69d6-4b96-9401-c0a1e7e5d3eb", - "license": "https://creativecommons.org/licenses/by/4.0/" - } - } diff --git a/docs/orcfax-feeds/risk-ratings/decentralized-review/message.json b/docs/orcfax-feeds/risk-ratings/decentralized-review/message.json deleted file mode 100644 index 690a109f..00000000 --- a/docs/orcfax-feeds/risk-ratings/decentralized-review/message.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "@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/docs/orcfax-feeds/risk-ratings/decentralized-review/validation.json b/docs/orcfax-feeds/risk-ratings/decentralized-review/validation.json deleted file mode 100644 index a39803ee..00000000 --- a/docs/orcfax-feeds/risk-ratings/decentralized-review/validation.json +++ /dev/null @@ -1,93 +0,0 @@ -{ - "@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/centralized-review/fact-statement.json b/static/schema/risk-rating/centralized-review/fact-statement.json index 6374b716..7f0ed745 100644 --- a/static/schema/risk-rating/centralized-review/fact-statement.json +++ b/static/schema/risk-rating/centralized-review/fact-statement.json @@ -28,7 +28,7 @@ "@type": "Rating", "author": "Xerberus", "ratingValue": "{AAA}", - "worstRating": "DDD", + "worstRating": "D", "bestRating": "AAA", "reviewAspect": "Risk" } From afd55078b771cce7340481855d6c0b6430d11968 Mon Sep 17 00:00:00 2001 From: Christian-MK <105018870+Christian-MK@users.noreply.github.com> Date: Tue, 24 Sep 2024 10:45:26 -0700 Subject: [PATCH 03/15] adds xerberus rating context --- .../centralized-review/fact-statement.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.md b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.md index 910298d8..e3592c4a 100644 --- a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.md +++ b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.md @@ -40,6 +40,18 @@ Types under review for development | ------------ | -------- | ---------------------------| --------------------- | | ------------ | -------- | ---------------------------| --------------------- | +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 {factStatement} From 6b08638a3a0234c83cec363a5156fbecb333c16d Mon Sep 17 00:00:00 2001 From: ross-spencer Date: Thu, 20 Feb 2025 10:29:50 +0100 Subject: [PATCH 04/15] Rename md to mdx --- .../{fact-statement-datum.md => fact-statement-datum.mdx} | 0 .../centralized-review/{fact-statement.md => fact-statement.mdx} | 0 .../risk-ratings/centralized-review/{message.md => message.mdx} | 0 .../centralized-review/{validation.md => validation.mdx} | 0 .../{fact-statement-datum.md => fact-statement-datum.mdx} | 0 .../{fact-statement.md => fact-statement.mdx} | 0 .../risk-ratings/decentralized-review/{message.md => message.mdx} | 0 .../decentralized-review/{validation.md => validation.mdx} | 0 8 files changed, 0 insertions(+), 0 deletions(-) rename docs/orcfax-feeds/risk-ratings/centralized-review/{fact-statement-datum.md => fact-statement-datum.mdx} (100%) rename docs/orcfax-feeds/risk-ratings/centralized-review/{fact-statement.md => fact-statement.mdx} (100%) rename docs/orcfax-feeds/risk-ratings/centralized-review/{message.md => message.mdx} (100%) rename docs/orcfax-feeds/risk-ratings/centralized-review/{validation.md => validation.mdx} (100%) rename docs/orcfax-feeds/risk-ratings/decentralized-review/{fact-statement-datum.md => fact-statement-datum.mdx} (100%) rename docs/orcfax-feeds/risk-ratings/decentralized-review/{fact-statement.md => fact-statement.mdx} (100%) rename docs/orcfax-feeds/risk-ratings/decentralized-review/{message.md => message.mdx} (100%) rename docs/orcfax-feeds/risk-ratings/decentralized-review/{validation.md => validation.mdx} (100%) diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.md b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx similarity index 100% rename from docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.md rename to docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.md b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.mdx similarity index 100% rename from docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.md rename to docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.mdx diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/message.md b/docs/orcfax-feeds/risk-ratings/centralized-review/message.mdx similarity index 100% rename from docs/orcfax-feeds/risk-ratings/centralized-review/message.md rename to docs/orcfax-feeds/risk-ratings/centralized-review/message.mdx diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/validation.md b/docs/orcfax-feeds/risk-ratings/centralized-review/validation.mdx similarity index 100% rename from docs/orcfax-feeds/risk-ratings/centralized-review/validation.md rename to docs/orcfax-feeds/risk-ratings/centralized-review/validation.mdx diff --git a/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.md b/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.mdx similarity index 100% rename from docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.md rename to docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.mdx diff --git a/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.md b/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.mdx similarity index 100% rename from docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.md rename to docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.mdx diff --git a/docs/orcfax-feeds/risk-ratings/decentralized-review/message.md b/docs/orcfax-feeds/risk-ratings/decentralized-review/message.mdx similarity index 100% rename from docs/orcfax-feeds/risk-ratings/decentralized-review/message.md rename to docs/orcfax-feeds/risk-ratings/decentralized-review/message.mdx diff --git a/docs/orcfax-feeds/risk-ratings/decentralized-review/validation.md b/docs/orcfax-feeds/risk-ratings/decentralized-review/validation.mdx similarity index 100% rename from docs/orcfax-feeds/risk-ratings/decentralized-review/validation.md rename to docs/orcfax-feeds/risk-ratings/decentralized-review/validation.mdx From f28e8bbd6e45f2bcc47f6a53e2dae9918540ffa4 Mon Sep 17 00:00:00 2001 From: ross-spencer Date: Thu, 20 Feb 2025 10:38:08 +0100 Subject: [PATCH 05/15] Update embeds to current linting style --- .../centralized-review/fact-statement-datum.mdx | 14 +++++++++----- .../centralized-review/fact-statement.mdx | 14 +++++++++----- .../risk-ratings/centralized-review/message.mdx | 12 +++++++++--- .../centralized-review/validation.mdx | 14 +++++++++----- .../decentralized-review/fact-statement-datum.mdx | 15 ++++++++++----- .../decentralized-review/fact-statement.mdx | 14 +++++++++----- .../risk-ratings/decentralized-review/message.mdx | 12 +++++++++--- .../decentralized-review/validation.mdx | 14 +++++++++----- 8 files changed, 73 insertions(+), 36 deletions(-) diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx index ce0e18fe..74b31ae7 100644 --- a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx +++ b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx @@ -5,7 +5,7 @@ slug: /centralized-review-fact-statement-datum --- import CodeBlock from '@theme/CodeBlock'; -import factStatementDatum from '!!raw-loader!/schema/risk-rating/centralized-review/fact-statement-datum.json'; +import factStatementDatum from '/schema/risk-rating/centralized-review/fact-statement-datum.json'; # Fact Statement Datum @@ -34,8 +34,12 @@ be replaced when possible with a \[synonym\] in order to aid understanding. ## Fact Statement Datum example -{factStatementDatum} +{JSON.stringify(factStatement, null, 2)} - -Download - + + Download + diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.mdx b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.mdx index e3592c4a..a7e14196 100644 --- a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.mdx +++ b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.mdx @@ -5,7 +5,7 @@ slug: /centralized-review-fact-statement --- import CodeBlock from '@theme/CodeBlock'; -import factStatement from '!!raw-loader!/schema/risk-rating/centralized-review/fact-statement.json'; +import factStatement from '/schema/risk-rating/centralized-review/fact-statement.json'; # Fact Statement @@ -54,8 +54,12 @@ The values for `bestRating` and `worstRating` are further described in Xerberus ## Fact Statement example -{factStatement} +{JSON.stringify(factStatement, null, 2)} - -Download - + + Download + diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/message.mdx b/docs/orcfax-feeds/risk-ratings/centralized-review/message.mdx index de1e65cb..f818564c 100644 --- a/docs/orcfax-feeds/risk-ratings/centralized-review/message.mdx +++ b/docs/orcfax-feeds/risk-ratings/centralized-review/message.mdx @@ -5,7 +5,7 @@ slug: /centralized-review-message --- import CodeBlock from '@theme/CodeBlock'; -import Message from '!!raw-loader!/schema/risk-rating/centralized-review/message.json'; +import Message from '/schema/risk-rating/centralized-review/message.json'; # Message @@ -34,6 +34,12 @@ be replaced when possible with a \[synonym\] in order to aid understanding. ## Message example -{Message} +{JSON.stringify(factStatement, null, 2)} -Download + + Download + diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/validation.mdx b/docs/orcfax-feeds/risk-ratings/centralized-review/validation.mdx index 81984b8a..b07d5880 100644 --- a/docs/orcfax-feeds/risk-ratings/centralized-review/validation.mdx +++ b/docs/orcfax-feeds/risk-ratings/centralized-review/validation.mdx @@ -5,7 +5,7 @@ slug: /centralized-review-validation --- import CodeBlock from '@theme/CodeBlock'; -import Validation from '!!raw-loader!/schema/risk-rating/centralized-review/validation.json'; +import Validation from '/schema/risk-rating/centralized-review/validation.json'; # Validation @@ -34,8 +34,12 @@ be replaced when possible with a \[synonym\] in order to aid understanding. ## Validation example -{Validation} +{JSON.stringify(factStatement, null, 2)} - -Download - + + Download + diff --git a/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.mdx b/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.mdx index e379904c..bd457350 100644 --- a/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.mdx +++ b/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.mdx @@ -5,7 +5,7 @@ slug: /decentralized-review-fact-statement-datum --- import CodeBlock from '@theme/CodeBlock'; -import factStatementDatum from '!!raw-loader!/schema/risk-rating/decentralized-review/fact-statement-datum.json'; +import factStatementDatum from '/schema/risk-rating/decentralized-review/fact-statement-datum.json'; # Fact Statement Datum @@ -34,8 +34,13 @@ be replaced when possible with a \[synonym\] in order to aid understanding. ## Fact Statement Datum example -{factStatementDatum} - -Download - +{JSON.stringify(factStatement, null, 2)} + + + Download + diff --git a/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.mdx b/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.mdx index 9fffee11..f970b51f 100644 --- a/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.mdx +++ b/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.mdx @@ -5,7 +5,7 @@ slug: /decentralized-review-fact-statement --- import CodeBlock from '@theme/CodeBlock'; -import factStatement from '!!raw-loader!/schema/risk-rating/decentralized-review/fact-statement.json'; +import factStatement from '/schema/risk-rating/decentralized-review/fact-statement.json'; # Fact Statement @@ -41,8 +41,12 @@ be replaced when possible with a \[synonym\] in order to aid understanding. ## Fact Statement example -{factStatement} +{JSON.stringify(factStatement, null, 2)} - -Download - + + Download + diff --git a/docs/orcfax-feeds/risk-ratings/decentralized-review/message.mdx b/docs/orcfax-feeds/risk-ratings/decentralized-review/message.mdx index 36a925de..22619b35 100644 --- a/docs/orcfax-feeds/risk-ratings/decentralized-review/message.mdx +++ b/docs/orcfax-feeds/risk-ratings/decentralized-review/message.mdx @@ -5,7 +5,7 @@ slug: /decentralized-review-message --- import CodeBlock from '@theme/CodeBlock'; -import Message from '!!raw-loader!/schema/risk-rating/decentralized-review/message.json'; +import Message from '/schema/risk-rating/decentralized-review/message.json'; # Message @@ -34,6 +34,12 @@ be replaced when possible with a \[synonym\] in order to aid understanding. ## Message example -{Message} +{JSON.stringify(factStatement, null, 2)} -Download + + Download + diff --git a/docs/orcfax-feeds/risk-ratings/decentralized-review/validation.mdx b/docs/orcfax-feeds/risk-ratings/decentralized-review/validation.mdx index b2413f03..df25eb2d 100644 --- a/docs/orcfax-feeds/risk-ratings/decentralized-review/validation.mdx +++ b/docs/orcfax-feeds/risk-ratings/decentralized-review/validation.mdx @@ -5,7 +5,7 @@ slug: /decentralized-review-validation --- import CodeBlock from '@theme/CodeBlock'; -import Validation from '!!raw-loader!/schema/risk-rating/decentralized-review/validation.json'; +import Validation from '/schema/risk-rating/decentralized-review/validation.json'; # Validation @@ -34,8 +34,12 @@ be replaced when possible with a \[synonym\] in order to aid understanding. ## Validation example -{Validation} +{JSON.stringify(factStatement, null, 2)} - -Download - + + Download + From 7b8300dd05a84527c8c80a8512cd29126a56ad1d Mon Sep 17 00:00:00 2001 From: ross-spencer Date: Thu, 20 Feb 2025 10:46:29 +0100 Subject: [PATCH 06/15] Update _category_.json for feeds --- docs/orcfax-feeds/CER/_category_.json | 5 +++++ docs/orcfax-feeds/risk-ratings/_category_.json | 5 +++++ .../centralized-review/{_category.json => _category_.json} | 0 .../decentralized-review/{_category.json => _category_.json} | 0 4 files changed, 10 insertions(+) create mode 100644 docs/orcfax-feeds/CER/_category_.json create mode 100644 docs/orcfax-feeds/risk-ratings/_category_.json rename docs/orcfax-feeds/risk-ratings/centralized-review/{_category.json => _category_.json} (100%) rename docs/orcfax-feeds/risk-ratings/decentralized-review/{_category.json => _category_.json} (100%) diff --git a/docs/orcfax-feeds/CER/_category_.json b/docs/orcfax-feeds/CER/_category_.json new file mode 100644 index 00000000..a0a98932 --- /dev/null +++ b/docs/orcfax-feeds/CER/_category_.json @@ -0,0 +1,5 @@ +{ + "label": "CER", + "position": 2, + "link": null +} diff --git a/docs/orcfax-feeds/risk-ratings/_category_.json b/docs/orcfax-feeds/risk-ratings/_category_.json new file mode 100644 index 00000000..ca485ebc --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/_category_.json @@ -0,0 +1,5 @@ +{ + "label": "Risk Ratings", + "position": 3, + "link": null +} diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/_category.json b/docs/orcfax-feeds/risk-ratings/centralized-review/_category_.json similarity index 100% rename from docs/orcfax-feeds/risk-ratings/centralized-review/_category.json rename to docs/orcfax-feeds/risk-ratings/centralized-review/_category_.json diff --git a/docs/orcfax-feeds/risk-ratings/decentralized-review/_category.json b/docs/orcfax-feeds/risk-ratings/decentralized-review/_category_.json similarity index 100% rename from docs/orcfax-feeds/risk-ratings/decentralized-review/_category.json rename to docs/orcfax-feeds/risk-ratings/decentralized-review/_category_.json From 3491096595c88111c64ea4375fb7e0caee013cef Mon Sep 17 00:00:00 2001 From: ross-spencer Date: Thu, 20 Feb 2025 11:35:01 +0100 Subject: [PATCH 07/15] Fixup JSON references and variables --- .../risk-ratings/centralized-review/fact-statement-datum.mdx | 2 +- docs/orcfax-feeds/risk-ratings/centralized-review/message.mdx | 2 +- .../orcfax-feeds/risk-ratings/centralized-review/validation.mdx | 2 +- .../risk-ratings/decentralized-review/fact-statement-datum.mdx | 2 +- docs/orcfax-feeds/risk-ratings/decentralized-review/message.mdx | 2 +- .../risk-ratings/decentralized-review/validation.mdx | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx index 74b31ae7..489f8afe 100644 --- a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx +++ b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx @@ -34,7 +34,7 @@ be replaced when possible with a \[synonym\] in order to aid understanding. ## Fact Statement Datum example -{JSON.stringify(factStatement, null, 2)} +{JSON.stringify(factStatementDatum, null, 2)} {JSON.stringify(factStatement, null, 2)} +{JSON.stringify(Message, null, 2)} {JSON.stringify(factStatement, null, 2)} +{JSON.stringify(Validation, null, 2)} {JSON.stringify(factStatement, null, 2)} +{JSON.stringify(factStatementDatum, null, 2)} {JSON.stringify(factStatement, null, 2)} +{JSON.stringify(Message, null, 2)} {JSON.stringify(factStatement, null, 2)} +{JSON.stringify(Validation, null, 2)} Date: Thu, 20 Feb 2025 11:42:31 +0100 Subject: [PATCH 08/15] Remove husky.sh --- .husky/pre-commit | 1 - 1 file changed, 1 deletion(-) diff --git a/.husky/pre-commit b/.husky/pre-commit index 36af2198..3b608ae6 100755 --- a/.husky/pre-commit +++ b/.husky/pre-commit @@ -1,4 +1,3 @@ #!/bin/sh -. "$(dirname "$0")/_/husky.sh" npx lint-staged From da3d46d1383580fce9abf586b154a5d28cd279b7 Mon Sep 17 00:00:00 2001 From: ross-spencer Date: Thu, 20 Feb 2025 11:46:57 +0100 Subject: [PATCH 09/15] Revert "Remove husky.sh" This reverts commit 4142689a71b809229d7874f40ef2cf71bfc06c11. --- .husky/pre-commit | 1 + 1 file changed, 1 insertion(+) diff --git a/.husky/pre-commit b/.husky/pre-commit index 3b608ae6..36af2198 100755 --- a/.husky/pre-commit +++ b/.husky/pre-commit @@ -1,3 +1,4 @@ #!/bin/sh +. "$(dirname "$0")/_/husky.sh" npx lint-staged From 3f433ccaa80e8fd2ba131fee2afd9378b3843bb7 Mon Sep 17 00:00:00 2001 From: Gabriel Chartier Date: Thu, 20 Feb 2025 12:41:10 -0500 Subject: [PATCH 10/15] fix husky prepare script command --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index cfcaba06..9931c08c 100644 --- a/package.json +++ b/package.json @@ -16,7 +16,7 @@ "lint": "prettier --check . && eslint .", "format": "prettier --write .", "pre-commit": "pre-commit run --all-files", - "prepare": "husky install" + "prepare": "husky" }, "dependencies": { "@docusaurus/core": "^3.6.1", From 6915603620cc76948038903fed65463ce97029f5 Mon Sep 17 00:00:00 2001 From: Gabriel Chartier Date: Thu, 20 Feb 2025 12:44:12 -0500 Subject: [PATCH 11/15] run npm run format --- .github/workflows/dependabot.yml | 12 +- .../centralized-review/_category_.json | 2 +- .../fact-statement-datum.mdx | 23 +-- .../centralized-review/fact-statement.mdx | 50 +++--- .../centralized-review/message.mdx | 27 ++- .../centralized-review/validation.mdx | 27 ++- .../decentralized-review/_category_.json | 2 +- .../fact-statement-datum.mdx | 24 +-- .../decentralized-review/fact-statement.mdx | 39 +++-- .../decentralized-review/message.mdx | 27 ++- .../decentralized-review/validation.mdx | 27 ++- .../fact-statement-datum.json | 12 +- .../centralized-review/fact-statement.json | 48 +++--- .../centralized-review/message.json | 14 +- .../centralized-review/validation.json | 158 +++++++++--------- 15 files changed, 244 insertions(+), 248 deletions(-) diff --git a/.github/workflows/dependabot.yml b/.github/workflows/dependabot.yml index 18560b57..4b49fa29 100644 --- a/.github/workflows/dependabot.yml +++ b/.github/workflows/dependabot.yml @@ -1,8 +1,8 @@ version: 2 updates: - - package-ecosystem: npm - directory: / - schedule: - interval: weekly - allow: - - dependency-type: direct + - package-ecosystem: npm + directory: / + schedule: + interval: weekly + allow: + - dependency-type: direct diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/_category_.json b/docs/orcfax-feeds/risk-ratings/centralized-review/_category_.json index 8ee30b1c..a30f2ac3 100644 --- a/docs/orcfax-feeds/risk-ratings/centralized-review/_category_.json +++ b/docs/orcfax-feeds/risk-ratings/centralized-review/_category_.json @@ -1,4 +1,4 @@ { "label": "centralized-review", "position": 2 - } +} diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx index 489f8afe..a3181508 100644 --- a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx +++ b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx @@ -4,13 +4,12 @@ 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'; +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`. +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] @@ -22,19 +21,21 @@ be replaced when possible with a \[synonym\] in order to aid understanding. ## Schema.org Types -| Type | Schema.org description | Orcfax description | -| -------- | ---------------------------| ---------------------- | -| -------- | ---------------------------| ---------------------- | +| Type | Schema.org description | Orcfax description | +| -------- | --------------------------- | ---------------------- | +| -------- | --------------------------- | ---------------------- | ## Schema.org Properties -| Property | Type | Schema.org description | Orcfax definition | -| ------------ | -------- | ---------------------------| --------------------- | -| ------------ | -------- | ---------------------------| --------------------- | +| Property | Type | Schema.org description | Orcfax definition | +| ------------ | -------- | --------------------------- | --------------------- | +| ------------ | -------- | --------------------------- | --------------------- | ## Fact Statement Datum example -{JSON.stringify(factStatementDatum, null, 2)} + + {JSON.stringify(factStatementDatum, null, 2)} + {JSON.stringify(factStatementDatum, null, 2)} + + {JSON.stringify(factStatementDatum, null, 2)} + Date: Thu, 20 Feb 2025 12:47:20 -0500 Subject: [PATCH 12/15] add vscode extensions recommendations --- .vscode/extensions.json | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .vscode/extensions.json diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 00000000..bee275d2 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,6 @@ +{ + "recommendations": [ + "DavidAnson.vscode-markdownlint", // Markdown linting + "esbenp.prettier-vscode" // General formatting + ] +} From c64692620e323f58e9b004250a86d7e8b45980d2 Mon Sep 17 00:00:00 2001 From: Gabriel Chartier Date: Thu, 20 Feb 2025 13:23:29 -0500 Subject: [PATCH 13/15] fix vscode extensions json --- .vscode/extensions.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.vscode/extensions.json b/.vscode/extensions.json index bee275d2..2db5ae2f 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -1,6 +1,6 @@ { "recommendations": [ - "DavidAnson.vscode-markdownlint", // Markdown linting - "esbenp.prettier-vscode" // General formatting + "DavidAnson.vscode-markdownlint", + "esbenp.prettier-vscode" ] } From 1f8e93d49b72cb11bee096e159f449b757e199e5 Mon Sep 17 00:00:00 2001 From: Christian-MK <105018870+Christian-MK@users.noreply.github.com> Date: Mon, 24 Feb 2025 15:21:23 -0800 Subject: [PATCH 14/15] adds feed type intros and removes risk rating content for now --- docs/orcfax-feeds/CER/cer-intro.md | 12 ++++ .../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 ------------- .../risk-ratings/risk-rating-introduction.md | 16 +++++ 12 files changed, 28 insertions(+), 392 deletions(-) create mode 100644 docs/orcfax-feeds/CER/cer-intro.md delete mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/_category_.json delete mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx delete mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.mdx delete mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/message.mdx delete mode 100644 docs/orcfax-feeds/risk-ratings/centralized-review/validation.mdx delete mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/_category_.json delete mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.mdx delete mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.mdx delete mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/message.mdx delete mode 100644 docs/orcfax-feeds/risk-ratings/decentralized-review/validation.mdx create mode 100644 docs/orcfax-feeds/risk-ratings/risk-rating-introduction.md diff --git a/docs/orcfax-feeds/CER/cer-intro.md b/docs/orcfax-feeds/CER/cer-intro.md new file mode 100644 index 00000000..9af8b449 --- /dev/null +++ b/docs/orcfax-feeds/CER/cer-intro.md @@ -0,0 +1,12 @@ +--- +id: cer intro +sidebar_position: 1 +slug: /cer-intro +--- + +# Introduction to CER + +Current Exchange Rate feeds represent the most well known feed type offered by +oracle services and are a critical component in a mature DeFi ecosystem. Feeds +are offered for Centralized Exchange (CEX) data and Cardano Native Tokens (CNT) +via liquidity pools hosted by Cardano Decentralized Exchanges (DEX). diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/_category_.json b/docs/orcfax-feeds/risk-ratings/centralized-review/_category_.json deleted file mode 100644 index a30f2ac3..00000000 --- a/docs/orcfax-feeds/risk-ratings/centralized-review/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "centralized-review", - "position": 2 -} diff --git a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx deleted file mode 100644 index a3181508..00000000 --- a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -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/orcfax-feeds/risk-ratings/centralized-review/fact-statement.mdx b/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.mdx deleted file mode 100644 index 746d18c3..00000000 --- a/docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -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/orcfax-feeds/risk-ratings/centralized-review/message.mdx b/docs/orcfax-feeds/risk-ratings/centralized-review/message.mdx deleted file mode 100644 index 595f83d7..00000000 --- a/docs/orcfax-feeds/risk-ratings/centralized-review/message.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -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/orcfax-feeds/risk-ratings/centralized-review/validation.mdx b/docs/orcfax-feeds/risk-ratings/centralized-review/validation.mdx deleted file mode 100644 index 438f984d..00000000 --- a/docs/orcfax-feeds/risk-ratings/centralized-review/validation.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -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/orcfax-feeds/risk-ratings/decentralized-review/_category_.json b/docs/orcfax-feeds/risk-ratings/decentralized-review/_category_.json deleted file mode 100644 index d5341672..00000000 --- a/docs/orcfax-feeds/risk-ratings/decentralized-review/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "decentralized-review", - "position": 2 -} diff --git a/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.mdx b/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.mdx deleted file mode 100644 index 1de3addf..00000000 --- a/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -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/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.mdx b/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.mdx deleted file mode 100644 index a467f64c..00000000 --- a/docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -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/orcfax-feeds/risk-ratings/decentralized-review/message.mdx b/docs/orcfax-feeds/risk-ratings/decentralized-review/message.mdx deleted file mode 100644 index 85ed8064..00000000 --- a/docs/orcfax-feeds/risk-ratings/decentralized-review/message.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -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/orcfax-feeds/risk-ratings/decentralized-review/validation.mdx b/docs/orcfax-feeds/risk-ratings/decentralized-review/validation.mdx deleted file mode 100644 index 1fab393c..00000000 --- a/docs/orcfax-feeds/risk-ratings/decentralized-review/validation.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -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/orcfax-feeds/risk-ratings/risk-rating-introduction.md b/docs/orcfax-feeds/risk-ratings/risk-rating-introduction.md new file mode 100644 index 00000000..0391020e --- /dev/null +++ b/docs/orcfax-feeds/risk-ratings/risk-rating-introduction.md @@ -0,0 +1,16 @@ +--- +id: risk rating intro +sidebar_position: 1 +slug: /risk-rating-intro +--- + +# Introduction to Risk Ratings + +Risk Ratings represent additional data that can be used in smart contracts to +trigger specific events (e.g. the risk of a given CNT increasing or decreasing +against a set threshold). A decrease in a token's risk rating could trigger an +investment opportunity, while a decrease in risk ratings could prompt a +liquidation event. + +Orcfax believes that providing these values through its oracle service as inline +datum can better support DeFi use cases. From 1cee9e2ef77ffeb8f69f0fe6d7974e4f4709a16d Mon Sep 17 00:00:00 2001 From: Christian-MK <105018870+Christian-MK@users.noreply.github.com> Date: Mon, 24 Feb 2025 15:33:58 -0800 Subject: [PATCH 15/15] adds under development to risk ratings intro --- docs/orcfax-feeds/risk-ratings/risk-rating-introduction.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/orcfax-feeds/risk-ratings/risk-rating-introduction.md b/docs/orcfax-feeds/risk-ratings/risk-rating-introduction.md index 0391020e..b0a6e359 100644 --- a/docs/orcfax-feeds/risk-ratings/risk-rating-introduction.md +++ b/docs/orcfax-feeds/risk-ratings/risk-rating-introduction.md @@ -14,3 +14,10 @@ liquidation event. Orcfax believes that providing these values through its oracle service as inline datum can better support DeFi use cases. + +:::note + +This feed type is under active development. Additional documentation and +developer resources will be made available as development progresses. + +:::