Skip to content

Commit 1f7da56

Browse files
ross-spencerChristian-MK
ross-spencer
and
Christian-MK
committed
Document Orcfax CER schemas
Co-Authored-by: Christian-MK <[email protected]>
1 parent 206e687 commit 1f7da56

31 files changed

+1304
-2
lines changed

‎.markdownlint.yaml

+3
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ default: true
77

88
# In-line HTML.
99
MD033: false
10+
# Line lengths
1011
MD013:
1112
line_length: 80
1213
tables: false
14+
# First line in a file should be a top-level heading
15+
MD041: false

‎.vscode/settings.json

+4-2
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
"cSpell.words": [
2727
"Arkly",
2828
"Bagit",
29+
"bytearray",
2930
"Cardano",
3031
"CBOR",
3132
"datapoints",
@@ -35,12 +36,13 @@
3536
"permissionlessly",
3637
"POSIX",
3738
"preprod",
39+
"pubkey",
3840
"recordkeeping",
39-
"Wingriders",
40-
"bytearray",
41+
"subproperty",
4142
"timeframe",
4243
"pubkey",
4344
"readablility",
4445
"remediative"
46+
"Wingriders"
4547
]
4648
}

‎docs/Feeds/CER/CEX/_category.json

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

‎docs/Feeds/CER/CEX/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/Feeds/CER/CEX/fact-statement-datum.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
id: cex-2
3+
sidebar_position: 2
4+
slug: /cex-fact-statement-datum
5+
---
6+
7+
import CodeBlock from '@theme/CodeBlock';
8+
import factStatementDatum from '!!raw-loader!/schema/cer/cex/fact-statement-datum.json';
9+
10+
# Fact Statement Datum
11+
12+
A place for Orcfax to describe 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+
| [`Message`][type-1] | A single message from a sender to one or more organizations or people. | Information from a sender to one or more entities.|
28+
| [`Organization`][type-2] | An \[entity\] such as a school, NGO, corporation, club, etc.| |
29+
30+
[type-1]: https://schema.org/Message
31+
[type-2]: https://schema.org/Organization
32+
33+
## Schema.org Properties
34+
35+
| Property | Type | Schema.org description | Orcfax definition |
36+
| ------------ | -------- | ---------------------------| --------------------- |
37+
| [`dateCreated`][prop-1] | Message | The date on which the `CreativeWork` was created or the item was added to a DataFeed.| |
38+
| [`encoding`][prop-2] | Message | A media object that encodes this `CreativeWork`.| |
39+
| [`identifier`][prop-3] | Message | Used to represent any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc.| |
40+
| [`messageAttachment`][prop-4] | Message | A `CreativeWork` attached to the message.| |
41+
| [`name`][prop-5] | Message, Organization | The name of the item.| |
42+
| [`publisher`][prop-6] | Message | The publisher of the creative work.| The entity responsible for making a resource available, but not necessarily its authorship. |
43+
| [`text`][prop-7] | Message | The textual content of this `CreativeWork`.| |
44+
| [`url`][prop-8] | Organization | The uniform resource locator of the item.| |
45+
46+
[prop-1]: https://schema.org/dateCreated
47+
[prop-2]: https://schema.org/encoding
48+
[prop-3]: https://schema.org/identifier
49+
[prop-4]: https://schema.org/messageAttachment
50+
[prop-5]: https://schema.org/name
51+
[prop-6]: https://schema.org/publisher
52+
[prop-7]: https://schema.org/text
53+
[prop-8]: https://schema.org/url
54+
55+
## Fact Statement Datum example
56+
57+
<CodeBlock language="jsx">{factStatementDatum}</CodeBlock>
58+
59+
<a target="_blank" href="/schema/cer/cex/fact-statement-datum.json" download="fact-statement-datum.json">Download</a>

‎docs/Feeds/CER/CEX/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/Feeds/CER/CEX/fact-statement.md

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
id: cex-1
3+
sidebar_position: 1
4+
slug: /cex-fact-statement
5+
---
6+
7+
import CodeBlock from '@theme/CodeBlock';
8+
import factStatement from '!!raw-loader!/schema/cer/cex/fact-statement.json';
9+
10+
# Fact Statement
11+
12+
A place for Orcfax to describe 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+
| [`Claim`][type-1] | used to represent a specific, factually-oriented claim.| |
28+
| [`CreativeWork`][type-2] | The most generic kind of creative work, including books, movies, photographs, software programs, etc.| A generic term to encompass a broad spectrum of creative works, including text, images, software programs, their outputs, etc.|
29+
| [`ExchangeRateSpecification`][type-3] | A structured value representing exchange rate.| |
30+
| [`Organization`][type-4] | An \[entity\] such as a school, NGO, corporation, club, etc.| |
31+
| [`UnitPriceSpecification`][type-5] | The price asked for a given offer by the respective organization or person.| |
32+
33+
[type-1]: https://schema.org/Claim
34+
[type-2]: https://schema.org/CreativeWork
35+
[type-3]: https://schema.org/ExchangeRateSpecification
36+
[type-4]: https://schema.org/Organization
37+
[type-5]: https://schema.org/UnitPriceSpecification
38+
39+
## Schema.org Properties
40+
41+
| Property | Type | Schema.org description | Orcfax definition |
42+
| ------------ | -------- | ---------------------------| --------------------- |
43+
| [`about`][prop-1] | Claim | The subject matter of the content.| |
44+
| [`appearance`][prop-2] | Claim | Indicates an occurrence of a `Claim` in some `CreativeWork`.| |
45+
| [`claimInterpreter`][prop-3] | Claim | Used to indicate a claim contained, implied or refined from the content of a MediaObject.| An entity that has derived a `Claim`, implied or refined from, the content of one or more `MediaObjects`.|
46+
| [`creator`][prop-4] | CreativeWork | The creator or author of this `CreativeWork`.| |
47+
| [`currency`][prop-5] | ExchangeRateSpecification | The \[medium\] in which \[a\] monetary amount is expressed.| |
48+
| [`currentExchangeRate`][prop-6] | ExchangeRateSpecification | The current price of a currency.| The current value of the quote currency against a base currency.|
49+
| [`dateCreated`][prop-7] | Claim | The date on which the `CreativeWork` was created or the item was added to a DataFeed.| |
50+
| [`description`][prop-8] | Claim | A description of the item.| |
51+
| [`identifier`][prop-9] | Claim, CreativeWork | Used to represent any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc.| |
52+
| [`isBasedOn`][prop-10] | Claim | A resource from which this work is derived or from which it is a modification or adaptation.| |
53+
| [`license`][prop-11] | CreativeWork | A license document that applies to this content, typically indicated by URL.| |
54+
| [`name`][prop-12] | CreativeWork, Organization | The name of the item.| |
55+
| [`price`][prop-13] | UnitPriceSpecification | The offer price of a product.| The stated cost of a thing.|
56+
| [`priceCurrency`][prop-14] | UnitPriceSpecification | The currency of the price.| The currency in which the price is expressed.|
57+
| [`text`][prop-15] | Claim | The textual content of this `CreativeWork`.| |
58+
| [`url`][prop-16] | Organization | The uniform resource locator of the item.| |
59+
60+
[prop-1]: https://schema.org/about
61+
[prop-2]: https://schema.org/appearance
62+
[prop-3]: https://schema.org/claimInterpreter
63+
[prop-4]: https://schema.org/creator
64+
[prop-5]: https://schema.org/currency
65+
[prop-6]: https://schema.org/currentExchangeRate
66+
[prop-7]: https://schema.org/dateCreated
67+
[prop-8]: https://schema.org/description
68+
[prop-9]: https://schema.org/identifier
69+
[prop-10]: https://schema.org/isBasedOn
70+
[prop-11]: https://schema.org/license
71+
[prop-12]: https://schema.org/name
72+
[prop-13]: https://schema.org/price
73+
[prop-14]: https://schema.org/priceCurrency
74+
[prop-15]: https://schema.org/text
75+
[prop-16]: https://schema.org/url
76+
77+
## Fact Statement example
78+
79+
<CodeBlock language="jsx">{factStatement}</CodeBlock>
80+
81+
<a target="_blank" href="/schema/cer/cex/fact-statement.json" download="fact-statement.json">Download</a>

‎docs/Feeds/CER/CEX/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/Feeds/CER/CEX/message.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
id: cex-3
3+
sidebar_position: 3
4+
slug: /cex-message
5+
---
6+
7+
import CodeBlock from '@theme/CodeBlock';
8+
import Message from '!!raw-loader!/schema/cer/cex/message.json';
9+
10+
# Message
11+
12+
A place for Orcfax to describe 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+
| [`MediaObject`][type-1] | An object such as an image, video, audio, or text object embedded in a web page or a downloadable dataset.| |
28+
| [`Message`][type-2] | A single message from a sender to one or more organizations or people.| Information from a sender to one or more entities.|
29+
30+
[type-1]: https://schema.org/MediaObject
31+
[type-2]: https://schema.org/Message
32+
33+
## Schema.org Properties
34+
35+
| Property | Type | Schema.org description | Orcfax definition |
36+
| ------------ | -------- | ---------------------------| --------------------- |
37+
| [`additionalType`][prop-1] | MediaObject | Used to add more specific types from external vocabularies when a schema.org equivalent is not available.| |
38+
| [`dateReceived`][prop-2] | Message | The date/time the message was received if a single `recipient` exists.| |
39+
| [`description`][prop-3] | MediaObject | A description of the item.| |
40+
| [`encoding`][prop-4] | Message | A media object that encodes this `CreativeWork`.| |
41+
| [`identifier`][prop-5] | Message | Used to represent any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc.| |
42+
| [`isBasedOn`][prop-6] | Message | A resource from which this work is derived or from which it is a modification or adaptation.| |
43+
| [`messageAttachment`][prop-7] | Message | A `CreativeWork` attached to the message.| |
44+
| [`name`][prop-8] | MediaObject, Message | The name of the item.| |
45+
| [`recipient`][prop-9] | Message | The participant who is at the receiving end of the action.| |
46+
| [`sender`][prop-10] | Message | The participant who is at the sending end of the action.| |
47+
| [`text`][prop-11] | Message | The textual content of this `CreativeWork`| |
48+
49+
[prop-1]: https://schema.org/additionalType
50+
[prop-2]: https://schema.org/dateReceived
51+
[prop-3]: https://schema.org/description
52+
[prop-4]: https://schema.org/encoding
53+
[prop-5]: https://schema.org/identifier
54+
[prop-6]: https://schema.org/isBasedOn
55+
[prop-7]: https://schema.org/messageAttachment
56+
[prop-8]: https://schema.org/name
57+
[prop-9]: https://schema.org/recipient
58+
[prop-10]: https://schema.org/sender
59+
[prop-11]: https://schema.org/text
60+
61+
## Message example
62+
63+
<CodeBlock language="jsx">{Message}</CodeBlock>
64+
65+
<a target="_blank" href="/schema/cer/cex/Message.json" download="Message.json">Download</a>

0 commit comments

Comments
 (0)