Skip to content

Commit fb4335a

Browse files
Christian-MKChristian-MK
committed
first draft of xerberus feed w/ FS
1 parent c2b66de commit fb4335a

26 files changed

+854
-0
lines changed

‎docs/orcfax-feeds/risk-ratings/centralized-review/_category.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "centralized-review",
3+
"position": 2
4+
}

‎docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.json

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"@context": "https://schema.org",
3+
"type": "Message",
4+
"name": "CER/ADA-USD/3",
5+
"identifier": "urn:orcfax:83f5ba93-6bf3-4204-a03b-ab85bd9f955c",
6+
"publisher": {
7+
"@type": "Organization",
8+
"name": "Orcfax",
9+
"url": "https://orcfax.io/"
10+
},
11+
"dateCreated": "2024-08-28T16:20:35Z",
12+
"messageAttachment": {
13+
"encoding": "application/json:base64",
14+
"text": "ewogICJmZWVkX2lkIjogIkNFUi9BREEtVVNELzMiLAogICJjcmVhdGVkX2F0IjogMTcyNDg2MjAzNTUxMSwKICAiYm9keSI6IHsKICAgICJudW1lcmF0b3IiOiA2ODQ5MywKICAgICJkZW5vbWluYXRvciI6IDIwMDAwMAogIH0KfQ=="
15+
}
16+
}

‎docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement-datum.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
id: centralized-review-2
3+
sidebar_position: 2
4+
slug: /centralized-review-fact-statement-datum
5+
---
6+
7+
import CodeBlock from '@theme/CodeBlock';
8+
import factStatementDatum from '!!raw-loader!/schema/risk-rating/centralized-review/fact-statement-datum.json';
9+
10+
# Fact Statement Datum
11+
12+
A description of the types/properties relevant to a
13+
`fact-statement-datum.json`.
14+
15+
Orcfax utilizes the following Schema.org types and properties in its Fact
16+
Statement Datum records. The description provided by [Schema.org][schema-1]
17+
follows each; if Orcfax maintains a more nuanced understanding, an additional
18+
definition will be provided. If the term appears in its own definition, it will
19+
be replaced when possible with a \[synonym\] in order to aid understanding.
20+
21+
[schema-1]: https://schema.org/
22+
23+
## Schema.org Types
24+
25+
| Type | Schema.org description | Orcfax description |
26+
| -------- | ---------------------------| ---------------------- |
27+
| -------- | ---------------------------| ---------------------- |
28+
29+
## Schema.org Properties
30+
31+
| Property | Type | Schema.org description | Orcfax definition |
32+
| ------------ | -------- | ---------------------------| --------------------- |
33+
| ------------ | -------- | ---------------------------| --------------------- |
34+
35+
## Fact Statement Datum example
36+
37+
<CodeBlock language="jsx">{factStatementDatum}</CodeBlock>
38+
39+
<!-- markdownlint-disable MD013 -->
40+
<a target="_blank" href="/schema/risk-rating/centralized-review/fact-statement-datum.json" download="fact-statement-datum.json">Download</a>
41+
<!-- markdownlint-enable MD013 -->

‎docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.json

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
"@context": "https://schema.org",
3+
"type": "Claim",
4+
"description": "ADA price in USD",
5+
"identifier": "urn:orcfax:70722c2b-8905-47a1-8be3-5032290a44b9",
6+
"dateCreated": "2024-08-28T16:20:35Z",
7+
"text": "The price of 1 ADA at 2024-08-28T16:20:35Z is 0.342465 USD",
8+
"about": {
9+
"@type": "ExchangeRateSpecification",
10+
"currency": "ADA",
11+
"currentExchangeRate": {
12+
"@type": "UnitPriceSpecification",
13+
"price": 0.342465,
14+
"priceCurrency": "USD"
15+
}
16+
},
17+
"claimInterpreter": {
18+
"@type": "Organization",
19+
"name": "Orcfax",
20+
"url": "https://orcfax.io/"
21+
},
22+
"appearance": [
23+
"message-ADA-USD-bitstamp.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json",
24+
"message-ADA-USD-coinbase.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-20Z.json",
25+
"message-ADA-USD-kraken.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json",
26+
"message-ADA-USD-kucoin_prices_simple.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json",
27+
"message-ADA-USD-bitfinex_simple.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e-2024-08-28T16-20-26Z.json"
28+
],
29+
"isBasedOn": {
30+
"@type": "CreativeWork",
31+
"name": "validation-ADA-USD-2024-08-28T16-20-35Z.json",
32+
"creator": "Orcfax Validator Node: 1.0.0rc23",
33+
"identifier": "urn:orcfax:11ceadf4-69d6-4b96-9401-c0a1e7e5d3eb",
34+
"license": "https://creativecommons.org/licenses/by/4.0/"
35+
}
36+
}

‎docs/orcfax-feeds/risk-ratings/centralized-review/fact-statement.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
id: centralized-review-1
3+
sidebar_position: 1
4+
slug: /centralized-review-fact-statement
5+
---
6+
7+
import CodeBlock from '@theme/CodeBlock';
8+
import factStatement from '!!raw-loader!/schema/risk-rating/centralized-review/fact-statement.json';
9+
10+
# Fact Statement
11+
12+
A description of the types/properties relevant to a
13+
`fact-statement.json`.
14+
15+
Orcfax utilizes the following Schema.org types and properties in its Fact
16+
Statement records. The description provided by [Schema.org][schema-1]
17+
follows each; if Orcfax maintains a more nuanced understanding, an additional
18+
definition will be provided. If the term appears in its own definition, it will
19+
be replaced when possible with a \[synonym\] in order to aid understanding.
20+
21+
[schema-1]: https://schema.org/
22+
23+
## Schema.org Types
24+
25+
| Type | Schema.org description | Orcfax description |
26+
| -------- | ---------------------------| ---------------------- |
27+
| -------- | ---------------------------| ---------------------- |
28+
29+
Types under review for development
30+
31+
* [Review](https://schema.org/Review)
32+
* [Claim](https://schema.org/Claim)
33+
* [FinancialProduct](https://schema.org/FinancialProduct)
34+
* [Rating](https://schema.org/Rating)
35+
* [ProductGroup](https://schema.org/ProductGroup)
36+
37+
## Schema.org Properties
38+
39+
| Property | Type | Schema.org description | Orcfax definition |
40+
| ------------ | -------- | ---------------------------| --------------------- |
41+
| ------------ | -------- | ---------------------------| --------------------- |
42+
43+
## Fact Statement example
44+
45+
<CodeBlock language="jsx">{factStatement}</CodeBlock>
46+
47+
<!-- markdownlint-disable MD013 -->
48+
<a target="_blank" href="/schema/risk-rating/centralized-review/fact-statement.json" download="fact-statement.json">Download</a>
49+
<!-- markdownlint-enable MD013 -->

‎docs/orcfax-feeds/risk-ratings/centralized-review/message.json

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"@context": "https://schema.org",
3+
"type": "Message",
4+
"name": "ADA-USD",
5+
"isBasedOn": {
6+
"@type": "MediaObject",
7+
"name": "Exchange data",
8+
"additionalType": "Central Exchange Data",
9+
"description": "the raw information received by an Orcfax collector from a central exchange (CEX) API"
10+
},
11+
"sender": "https://api.pro.coinbase.com/products/ADA-USD/ticker",
12+
"recipient": "coinbase.tick_generic_jq.0.4.0-rc.4.b637b854f875a71de2ce18a57a8e576cff1d468e",
13+
"identifier": "urn:orcfax:e4e54362-4c14-49f6-9d80-08617d81243e",
14+
"dateReceived": "2024-08-28T16:20:20Z",
15+
"messageAttachment": {
16+
"encoding": "application/json;base64",
17+
"text": "eyJyZXF1ZXN0X3VybCI6ICJodHRwczovL2FwaS5wcm8uY29pbmJhc2UuY29tL3Byb2R1Y3RzL0FEQS1VU0QvdGlja2VyIiwgInJlc3BvbnNlIjogeyJib2R5IjogeyJhc2siOiAiMC4zNDIyIiwgImJpZCI6ICIwLjM0MjEiLCAicHJpY2UiOiAiMC4zNDIzIiwgInJmcV92b2x1bWUiOiAiMTQ3MDcyNS4zMzYwNTAiLCAic2l6ZSI6ICI3Ny4yOTU2NjA4OCIsICJ0aW1lIjogIjIwMjQtMDgtMjhUMTY6MjA6MjAuNjQ4MTg2WiIsICJ0cmFkZV9pZCI6IDExMDM4MzE5NSwgInZvbHVtZSI6ICIyNDE0ODA1Ni42OTI2OTkzMyJ9LCAiaGVhZGVycyI6IHsiQWNjZXB0LVJhbmdlcyI6IFsiYnl0ZXMiXSwgIkFjY2Vzcy1Db250cm9sLUFsbG93LUhlYWRlcnMiOiBbIkNvbnRlbnQtVHlwZSwgQWNjZXB0LCBjYi1zZXNzaW9uLCBjYi1mcCwgY2ItZm9ybS1mYWN0b3IiXSwgIkFjY2Vzcy1Db250cm9sLUFsbG93LU1ldGhvZHMiOiBbIkdFVCxQT1NULERFTEVURSxQVVQiXSwgIkFjY2Vzcy1Db250cm9sLUFsbG93LU9yaWdpbiI6IFsiKiJdLCAiQWNjZXNzLUNvbnRyb2wtRXhwb3NlLUhlYWRlcnMiOiBbImNiLWJlZm9yZSwgY2ItYWZ0ZXIsIGNiLWdkcHIiXSwgIkFjY2Vzcy1Db250cm9sLU1heC1BZ2UiOiBbIjcyMDAiXSwgIkNhY2hlLUNvbnRyb2wiOiBbInB1YmxpYywgbWF4LWFnZT0xLCBtdXN0LXJldmFsaWRhdGUiXSwgIkNmLUNhY2hlLVN0YXR1cyI6IFsiSElUIl0sICJDZi1SYXkiOiBbIjhiYTVhMGVmYWQ2YjYzZTktTEhSIl0sICJDb250ZW50LVR5cGUiOiBbImFwcGxpY2F0aW9uL2pzb247IGNoYXJzZXQ9dXRmLTgiXSwgIkRhdGUiOiBbIldlZCwgMjggQXVnIDIwMjQgMTY6MjA6MjYgR01UIl0sICJFdGFnIjogWyJXL1wiYTEtNGtPdHdKc0VPY29DMGViKzRtV3B4dys0bnBvXCIiXSwgIlNlcnZlciI6IFsiY2xvdWRmbGFyZSJdLCAiU2V0LUNvb2tpZSI6IFsiX19jZl9ibT1aeklRV185bWhjWjFyaE1JWG9lcXBvMF8zd1lqcXRHT205ZVFjZ1ROT2F3LTE3MjQ4NjIwMjYtMS4wLjEuMS1CeDJjTFBQQVllYWtsOS5VT3NldndGRGZDd3JNbE1LMXZmVkE0aVJvNTFMRDdBRmZtSUNPSzJ2NEZqWS5VQThOT3dHRHdXZm5RbktXemgwSTltdk9zQTsgcGF0aD0vOyBleHBpcmVzPVdlZCwgMjgtQXVnLTI0IDE2OjUwOjI2IEdNVDsgZG9tYWluPS5wcm8uY29pbmJhc2UuY29tOyBIdHRwT25seTsgU2VjdXJlOyBTYW1lU2l0ZT1Ob25lIl0sICJTdHJpY3QtVHJhbnNwb3J0LVNlY3VyaXR5IjogWyJtYXgtYWdlPTE1NTUyMDAwOyBpbmNsdWRlU3ViRG9tYWlucyJdLCAiVmFyeSI6IFsiQWNjZXB0LUVuY29kaW5nIl0sICJYLUNvbnRlbnQtVHlwZS1PcHRpb25zIjogWyJub3NuaWZmIl0sICJYLURucy1QcmVmZXRjaC1Db250cm9sIjogWyJvZmYiXSwgIlgtRG93bmxvYWQtT3B0aW9ucyI6IFsibm9vcGVuIl0sICJYLUZyYW1lLU9wdGlvbnMiOiBbIlNBTUVPUklHSU4iXSwgIlgtWHNzLVByb3RlY3Rpb24iOiBbIjE7IG1vZGU9YmxvY2siXX19fQ=="
18+
}
19+
}

‎docs/orcfax-feeds/risk-ratings/centralized-review/message.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
id: centralized-review-3
3+
sidebar_position: 3
4+
slug: /centralized-review-message
5+
---
6+
7+
import CodeBlock from '@theme/CodeBlock';
8+
import Message from '!!raw-loader!/schema/risk-rating/centralized-review/message.json';
9+
10+
# Message
11+
12+
A description of the types/properties relevant to a
13+
`message.json`.
14+
15+
Orcfax utilizes the following Schema.org types and properties in its Message
16+
records. The description provided by [Schema.org][schema-1]
17+
follows each; if Orcfax maintains a more nuanced understanding, an additional
18+
definition will be provided. If the term appears in its own definition, it will
19+
be replaced when possible with a \[synonym\] in order to aid understanding.
20+
21+
[schema-1]: https://schema.org/
22+
23+
## Schema.org Types
24+
25+
| Type | Schema.org description | Orcfax description |
26+
| -------- | ---------------------------| ---------------------- |
27+
| -------- | ---------------------------| ---------------------- |
28+
29+
## Schema.org Properties
30+
31+
| Property | Type | Schema.org description | Orcfax definition |
32+
| ------------ | -------- | ---------------------------| --------------------- |
33+
| ------------ | -------- | ---------------------------| --------------------- |
34+
35+
## Message example
36+
37+
<CodeBlock language="jsx">{Message}</CodeBlock>
38+
39+
<a target="_blank" href="/schema/risk-rating/centralized-review/Message.json" download="Message.json">Download</a>

‎docs/orcfax-feeds/risk-ratings/centralized-review/validation.json

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
{
2+
"@context": "https://schema.org",
3+
"type": "MediaObject",
4+
"identifier": "urn:orcfax:11ceadf4-69d6-4b96-9401-c0a1e7e5d3eb",
5+
"isBasedOn": {
6+
"@type": "MediaObject",
7+
"name": "the raw information sent to an Orcfax validator by an Orcfax node",
8+
"identifier": "urn:orcfax:node:2a531a7e-4961-4895-985d-1fa9aaaf50a2"
9+
},
10+
"contributor": {
11+
"@type": "Organization",
12+
"name": "AS14061 DigitalOcean, LLC",
13+
"locationCreated": {
14+
"address": {
15+
"@type": "PostalAddress",
16+
"addressLocality": "London",
17+
"addressRegion": "England, GB,",
18+
"geo": "51.5085,-0.1257"
19+
}
20+
}
21+
},
22+
"additionalType": [
23+
{
24+
"@type": "Event",
25+
"description": "successful content signature generation for Orcfax node data",
26+
"startDate": "2024-08-28T16:20:35Z",
27+
"recordedIn": {
28+
"@type": "CreativeWork",
29+
"description": {
30+
"@type": "TextObject",
31+
"comment": "an Orcfax content signature is a sha256 digest of a node's 'collected timestamp', 'data-points' in-order and the 'node identifier' (uuid)",
32+
"sha256": "33ac6c61317e8909871a759e025c82f8155a1739d7e4128f9231e527e1584572"
33+
},
34+
"hasPart": [
35+
{
36+
"@type": "CreativeWork",
37+
"description": "collecting timestamp",
38+
"text": "2024-08-28T16:20:26Z"
39+
},
40+
{
41+
"@type": "CreativeWork",
42+
"description": "data points for ADA-USD",
43+
"text": [
44+
"0.34541",
45+
"0.3423",
46+
"0.342465",
47+
"0.3420342",
48+
"0.34335"
49+
]
50+
},
51+
{
52+
"@type": "CreativeWork",
53+
"description": "node identifier (uuid)",
54+
"text": "2a531a7e-4961-4895-985d-1fa9aaaf50a2"
55+
}
56+
]
57+
}
58+
},
59+
{
60+
"@type": "Event",
61+
"description": "selection of median value from collected node data",
62+
"startDate": "2024-08-28T16:20:35Z",
63+
"about": {
64+
"@type": "StatisticalVariable",
65+
"measurementMethod": "median calculation of a minimum of three data sources from the selected collector node",
66+
"measurementTechnique": [
67+
{
68+
"@type": "PropertyValue",
69+
"name": "SoftwareApplication",
70+
"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"
71+
},
72+
{
73+
"@type": "PropertyValue",
74+
"name": "SoftwarePackage",
75+
"value": "statistics"
76+
}
77+
],
78+
"variableMeasured": {
79+
"@type": "Observation",
80+
"measurementMethod": "median value",
81+
"value": 0.342465,
82+
"valueReference": [
83+
"0.34541",
84+
"0.3423",
85+
"0.342465",
86+
"0.3420342",
87+
"0.34335"
88+
]
89+
}
90+
}
91+
}
92+
]
93+
}

‎docs/orcfax-feeds/risk-ratings/centralized-review/validation.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
id: centralized-review-4
3+
sidebar_position: 4
4+
slug: /centralized-review-validation
5+
---
6+
7+
import CodeBlock from '@theme/CodeBlock';
8+
import Validation from '!!raw-loader!/schema/risk-rating/centralized-review/validation.json';
9+
10+
# Validation
11+
12+
A description of the types/properties relevant to a
13+
`validation.json`.
14+
15+
Orcfax utilizes the following Schema.org types and properties in its Validation
16+
records. The description provided by [Schema.org][schema-1]
17+
follows each; if Orcfax maintains a more nuanced understanding, an additional
18+
definition will be provided. If the term appears in its own definition, it will
19+
be replaced when possible with a \[synonym\] in order to aid understanding.
20+
21+
[schema-1]: https://schema.org/
22+
23+
## Schema.org Types
24+
25+
| Type | Schema.org description | Orcfax description |
26+
| -------- | ---------------------------| ---------------------- |
27+
| -------- | ---------------------------| ---------------------- |
28+
29+
## Schema.org Properties
30+
31+
| Property | Type | Schema.org description | Orcfax definition |
32+
| ------------ | -------- | ---------------------------| --------------------- |
33+
| ------------ | -------- | ---------------------------| --------------------- |
34+
35+
## Validation example
36+
37+
<CodeBlock language="jsx">{Validation}</CodeBlock>
38+
39+
<!-- markdownlint-disable MD013 -->
40+
<a target="_blank" href="/schema/risk-rating/centralized-review/validation.json" download="validation.json">Download</a>
41+
<!-- markdownlint-enable MD013 -->

‎docs/orcfax-feeds/risk-ratings/decentralized-review/_category.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "decentralized-review",
3+
"position": 2
4+
}

‎docs/orcfax-feeds/risk-ratings/decentralized-review/fact-statement-datum.json

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"@context": "https://schema.org",
3+
"type": "Message",
4+
"name": "CER/ADA-USD/3",
5+
"identifier": "urn:orcfax:83f5ba93-6bf3-4204-a03b-ab85bd9f955c",
6+
"publisher": {
7+
"@type": "Organization",
8+
"name": "Orcfax",
9+
"url": "https://orcfax.io/"
10+
},
11+
"dateCreated": "2024-08-28T16:20:35Z",
12+
"messageAttachment": {
13+
"encoding": "application/json:base64",
14+
"text": "ewogICJmZWVkX2lkIjogIkNFUi9BREEtVVNELzMiLAogICJjcmVhdGVkX2F0IjogMTcyNDg2MjAzNTUxMSwKICAiYm9keSI6IHsKICAgICJudW1lcmF0b3IiOiA2ODQ5MywKICAgICJkZW5vbWluYXRvciI6IDIwMDAwMAogIH0KfQ=="
15+
}
16+
}

0 commit comments

Comments
 (0)